Skip to content

Commit

Permalink
review
Browse files Browse the repository at this point in the history
  • Loading branch information
atovpeko committed Jul 25, 2024
1 parent b62800b commit bbefe74
Show file tree
Hide file tree
Showing 16 changed files with 28 additions and 29 deletions.
2 changes: 1 addition & 1 deletion broadcast-streaming/advanced-features/beauty-effect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 14.2
type: docs
excluded_platforms: ["android", "ios", "macos", "windows", "flutter", "react-native", "electron", "react-js", "unity", "unreal", "blueprint"]
description: >
Integrate the beauty effect extension to achieve a natural beauty effect.
Integrate the beauty effect extension to achieve a natural beauty effect
---

import BeautyEffect from '@docs/shared/extensions-marketplace/_beauty-effect.mdx';
Expand Down
2 changes: 1 addition & 1 deletion broadcast-streaming/advanced-features/super-clarity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 14.7
type: docs
excluded_platforms: ["android", "ios", "macos", "windows", "flutter", "react-native", "electron", "react-js", "unity", "unreal", "blueprint"]
description: >
Use AI Image Quality plugin to improve image quality.
Improve image quality with the Super Clarity extension
---

import ImageQuality from '@docs/shared/extensions-marketplace/_super-clarity.mdx';
Expand Down
2 changes: 1 addition & 1 deletion broadcast-streaming/advanced-features/video-compositor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 14.5
type: docs
excluded_platforms: ["android", "ios", "macos", "windows", "flutter", "react-native", "electron", "react-js", "unity", "unreal", "blueprint"]
description: >
Integrate the video compositor extension to combine multiple local video streams.
Integrate the Video Compositor extension to combine multiple local video streams
---

import CombineImages from '@docs/shared/extensions-marketplace/_video-compositor.mdx';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ import VirtualBackground from '@docs/shared/extensions-marketplace/virtual-backg

export const toc = [{}];

<VirtualBackground PRODUCT="Video Calling" COMPANY="Agora" PATH="video-calling" CLIENT="app" />
<VirtualBackground PRODUCT="Broadcast Streaming" COMPANY="Agora" PATH="broadcast-streaming" CLIENT="app" />

2 changes: 1 addition & 1 deletion extensions-marketplace/develop/integrate/super-clarity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 7
type: docs
excluded_platforms: ["android", "ios", "macos", "windows", "flutter", "react-native", "electron", "react-js", "unity", "unreal", "blueprint"]
description: >
Use AI Image Quality plugin to improve image quality.
Improve image quality with the Super Clarity extension
---

import ImageQuality from '@docs/shared/extensions-marketplace/_super-clarity.mdx';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 14.2
type: docs
excluded_platforms: ["android", "ios", "macos", "windows", "flutter", "react-native", "electron", "react-js", "unity", "unreal", "blueprint"]
description: >
Integrate the beauty effect extension to achieve a natural beauty effect.
Integrate the Beauty Effect extension to achieve natural beautification
---

import BeautyEffect from '@docs/shared/extensions-marketplace/_beauty-effect.mdx';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 14.7
type: docs
excluded_platforms: ["android", "ios", "macos", "windows", "flutter", "react-native", "electron", "react-js", "unity", "unreal", "blueprint"]
description: >
Use AI Image Quality plugin to improve image quality.
Improve image quality with the Super Clarity extension
---

import ImageQuality from '@docs/shared/extensions-marketplace/_super-clarity.mdx';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 14.5
type: docs
excluded_platforms: ["android", "ios", "macos", "windows", "flutter", "react-native", "electron", "react-js", "unity", "unreal", "blueprint"]
description: >
Integrate the video compositor extension to combine multiple local video streams.
Integrate the Video Compositor extension to combine multiple local video streams
---

import CombineImages from '@docs/shared/extensions-marketplace/_video-compositor.mdx';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ import VirtualBackground from '@docs/shared/extensions-marketplace/virtual-backg

export const toc = [{}];

<VirtualBackground PRODUCT="Video Calling" COMPANY="Agora" PATH="video-calling" CLIENT="app" />
<VirtualBackground PRODUCT="Interactive Live Streaming" COMPANY="Agora" PATH="interactive-live-streaming" CLIENT="app" />

4 changes: 2 additions & 2 deletions shared/extensions-marketplace/_beauty-effect.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import ProjectImplement from '@docs/shared/extensions-marketplace/beauty-effect/project-implementation/index.mdx';
import Reference from '@docs/shared/extensions-marketplace/beauty-effect/reference/index.mdx';
import NotAvailable from '@docs/shared/common/not-available.mdx'
import NotSupported from '@docs/shared/extensions-marketplace/not-supported.mdx'

<PlatformWrapper platform="web">

Expand Down Expand Up @@ -38,5 +38,5 @@ This section contains content that completes the information in this page, or po

</PlatformWrapper>
<PlatformWrapper notAllowed="web">
<NotAvailable />
<NotSupported />
</PlatformWrapper>
4 changes: 2 additions & 2 deletions shared/extensions-marketplace/_super-clarity.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import ProjectImplement from '@docs/shared/extensions-marketplace/super-clarity/project-implementation/index.mdx';
import Reference from '@docs/shared/extensions-marketplace/super-clarity/reference/index.mdx';
import NotAvailable from '@docs/shared/common/not-available.mdx'
import NotSupported from '@docs/shared/extensions-marketplace/not-supported.mdx'

<PlatformWrapper platform="web">
The <Vg k="RTEE_CLARITY" /> extension leverages Agora's AI quality enhancement algorithm, which intelligently improves video quality without altering the resolution, thereby optimizing the viewing experience at the receiving end. The AI enhancement algorithm supports over 95% of mobile devices and ensures high-quality video rendering on low-end devices.
Expand Down Expand Up @@ -29,5 +29,5 @@ This section completes the information on this page, or points you to documentat
</PlatformWrapper>

<PlatformWrapper notAllowed="web">
<NotAvailable />
<NotSupported />
</PlatformWrapper>
11 changes: 5 additions & 6 deletions shared/extensions-marketplace/_video-compositor.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import ProjectImplement from '@docs/shared/extensions-marketplace/video-compositor/project-implementation/index.mdx';
import Reference from '@docs/shared/extensions-marketplace/video-compositor/reference/index.mdx';
import NotAvailable from '@docs/shared/common/not-available.mdx'
import NotSupported from '@docs/shared/extensions-marketplace/not-supported.mdx'

<PlatformWrapper platform="web">

Expand All @@ -9,7 +9,7 @@ The <Vg k="RTEE_COMPOSITOR" /> extension for the Web SDK enables local users to
Try out the [online demo](https://webdemo-global.agora.io/example/plugin/videoCompositor/index.html) to experience the <Vg k="RTEE_COMPOSITOR" /> extension.

<Admonition>
To integrating the <Vg k="RTEE_COMPOSITOR" /> extension, use version 4.12.0 or later of the Web SDK.
To integrate the <Vg k="RTEE_COMPOSITOR" /> extension, use version 4.12.0 or later of the Web SDK.
</Admonition>

## Understand the tech
Expand All @@ -21,9 +21,8 @@ The following figure shows how the <Vg k="RTEE_COMPOSITOR" /> extension creates
To share a composite video you implement the following steps:

1. Create a video input layer `IBaseProcessor` for each video track and an image input layer `HTMLImageElement` for each image.
2. Connect the pipeline between each video track and its corresponding input layer, injecting the video stream into the input layer.
The compositor combines all input layers.
4. Connect the pipeline between the compositor and the local video track, then output the combined video to the SDK.
1. Connect the pipeline between each video track and its corresponding input layer, injecting the video stream into the input layer. The compositor combines all input layers.
1. Connect the pipeline between the compositor and the local video track, then output the combined video to the SDK.

## Prerequisites

Expand All @@ -43,5 +42,5 @@ This section contains content that completes the information in this page, or po

</PlatformWrapper>
<PlatformWrapper notAllowed="web">
<NotAvailable />
<NotSupported />
</PlatformWrapper>
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ import CodeBlock from '@theme/CodeBlock';

To integrate the extension, take the following steps:

1. Run the following command to install the beauty extension:
1. Run the following command to install the extension:

```typescript
npm install agora-extension-beauty-effect
```

2. Use either of the following methods to integrate the beauty extension.
1. Use either of the following methods to integrate the extension.

- **Method 1**: Add the following code to your JavaScript file.
- **Method 1**: Add the following code to your JavaScript file:

```typescript
import BeautyExtension from "agora-extension-beauty-effect";
Expand Down Expand Up @@ -49,20 +49,20 @@ To enable the extension, follow these steps:
const processor = extension.createProcessor();
```

2. After creating the local camera video track, use the `pipe()` method to pass the video track through the beauty pre-processor. Then, direct the processed video track to `videoTrack.processorDestination`, integrating it back into the SDK's media processing pipeline.
1. After creating the local camera video track, use the `pipe()` method to pass the video track through the beauty pre-processor. Then, direct the processed video track to `videoTrack.processorDestination`, integrating it back into the SDK's media processing pipeline.

```typescript
localTracks.videoTrack.pipe(processor).pipe(localTracks.videoTrack.processorDestination);
```

3. Call `processor.enable()` to activate the beauty effect.
1. Call `processor.enable()` to activate the beauty effects.

```typescript
await processor.enable();
```

<Admonition>
If you do not call `processor.enable()` before calling `setOptions()`, the SDK uses the default values of the beauty parameters in `BeautyEffectOptions`.
If you do not call `processor.enable()` before calling `setOptions()`, the SDK uses the default values of the beauty parameters in `BeautyEffectOptions`.
</Admonition>

### Apply a beauty effect
Expand All @@ -88,7 +88,7 @@ Refer to the [API reference](#api-reference) for details.

### Complete sample code

This section presents the minimum code to integrate the Beauty effect extension into your project. Copy the following into your script file:
This section presents the minimum code to integrate the <Vg k="RTEE_BEAUTY" /> extension into your project. Copy the following into your script file:

<details>
<summary>Complete sample code for beauty effect extension</summary>
Expand Down
2 changes: 1 addition & 1 deletion video-calling/advanced-features/beauty-effect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 14.2
type: docs
excluded_platforms: ["android", "ios", "macos", "windows", "flutter", "react-native", "electron", "react-js", "unity", "unreal", "blueprint"]
description: >
Integrate the beauty effect extension to achieve a natural beauty effect.
Integrate the Beauty Effect extension to achieve natural beautification
---

import BeautyEffect from '@docs/shared/extensions-marketplace/_beauty-effect.mdx';
Expand Down
2 changes: 1 addition & 1 deletion video-calling/advanced-features/super-clarity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 14.7
type: docs
excluded_platforms: ["android", "ios", "macos", "windows", "flutter", "react-native", "electron", "react-js", "unity", "unreal", "blueprint"]
description: >
Use AI Image Quality plugin to improve image quality.
Improve image quality with the Super Clarity extension
---

import ImageQuality from '@docs/shared/extensions-marketplace/_super-clarity.mdx';
Expand Down
2 changes: 1 addition & 1 deletion video-calling/advanced-features/video-compositor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 14.5
type: docs
excluded_platforms: ["android", "ios", "macos", "windows", "flutter", "react-native", "electron", "react-js", "unity", "unreal", "blueprint"]
description: >
Integrate the video compositor extension to combine multiple local video streams.
Integrate the Video Compositor extension to combine multiple local video streams
---

import CombineImages from '@docs/shared/extensions-marketplace/_video-compositor.mdx';
Expand Down

0 comments on commit bbefe74

Please sign in to comment.