Skip to content

Commit

Permalink
docs: update doc (#198)
Browse files Browse the repository at this point in the history 
Co-authored-by: guoxianzhe <[email protected]>
  • Loading branch information
@github-actions @guoxianzhe
github-actions[bot] and guoxianzhe authored Jun 13, 2024
1 parent 4898d26 commit f992908
Show file tree
Hide file tree
Showing 9 changed files with 29 additions and 29 deletions.
14 changes: 7 additions & 7 deletions packages/agora-rtc-react/docs/components-en.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ If you need the capability to set the camera device, use the Web SDK's [`ICamera
| `play` | `boolean` | `false` | <li>`true`: Play the track.</li><li>`false`: Stop playing the track.</li> |
| `disabled` | `boolean` | `false` | <li>`true`: Disable the track. When disabled, the SDK will stop playing and publishing the track.</li><li>`false`: Enable the track.</li> |
| `muted` | `boolean` | `false` | <li>`true`: Pause sending media data of the track.</li><li>`false`: Resume sending media data of the track.</li> |
| `videoPlayerConfig` | `VideoPlayerConfig` | None | Playback configurations for a video track including setting the mirror and display mode. The SDK enables mirror mode for the local video track by default. See [`VideoPlayerConfig`](TODO:) for details. |
| `videoPlayerConfig` | `VideoPlayerConfig` | None | Playback configurations for a video track including setting the mirror and display mode. The SDK enables mirror mode for the local video track by default. See [`VideoPlayerConfig`](https://api-ref.agora.io/en/video-sdk/web/4.x/interfaces/videoplayerconfig.html) for details. |

#### Caveats

Expand Down Expand Up @@ -220,11 +220,11 @@ This component plays the video track of a remote user and does not support speci

#### Props

| Prop | Type | Default value | Description |
| ------------------- | ------------------------------------------------------------------------------------------------------ | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `track` | [`IRemoteVideoTrack`](https://api-ref.agora.io/en/video-sdk/web/4.x/interfaces/iremotevideotrack.html) | None | The remote video track object. |
| `play` | `boolean` | None | <li>`true`: Play the track.</li><li>`false`: Stop playing the track.</li> |
| `videoPlayerConfig` | `VideoPlayerConfig` | None | Playback configurations for a video track including setting the mirror and display mode. The SDK enables mirror mode for the local video track by default. See [`VideoPlayerConfig`](TODO:) for details. |
| Prop | Type | Default value | Description |
| ------------------- | ------------------------------------------------------------------------------------------------------ | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `track` | [`IRemoteVideoTrack`](https://api-ref.agora.io/en/video-sdk/web/4.x/interfaces/iremotevideotrack.html) | None | The remote video track object. |
| `play` | `boolean` | None | <li>`true`: Play the track.</li><li>`false`: Stop playing the track.</li> |
| `videoPlayerConfig` | `VideoPlayerConfig` | None | Playback configurations for a video track including setting the mirror and display mode. The SDK enables mirror mode for the local video track by default. See [`VideoPlayerConfig`](https://api-ref.agora.io/en/video-sdk/web/4.x/interfaces/videoplayerconfig.html) for details. |

#### Sample code

Expand Down Expand Up @@ -262,7 +262,7 @@ This component plays the video and audio tracks of a remote user and supports sp
| `volume` | `number` | None | The volume. The value ranges from 0 (mute) to 100 (the original volume). |
| `cover` | `string` &VerticalLine; `() => ReactNode` | None | The cover image or custom component to be displayed when `playVideo` is `false`, replacing the video frame. You can pass the URL of an online image or the relative path of a local image. |
| `children` | `ReactNode` | None | The React nodes to be rendered. |
| `videoPlayerConfig` | `VideoPlayerConfig` | None | Playback configurations for a video track including setting the mirror and display mode. The SDK enables mirror mode for the local video track by default. See [`VideoPlayerConfig`](TODO:) for details. |
| `videoPlayerConfig` | `VideoPlayerConfig` | None | Playback configurations for a video track including setting the mirror and display mode. The SDK enables mirror mode for the local video track by default. See [`VideoPlayerConfig`](https://api-ref.agora.io/en/video-sdk/web/4.x/interfaces/videoplayerconfig.html) for details. |

#### Sample code

Expand Down
2 changes: 1 addition & 1 deletion packages/agora-rtc-react/docs/components/LocalVideoTrack.en-US.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ If you need the capability to set the camera device, use the Web SDK's [`ICamera
| `play` | `boolean` | `false` | <li>`true`: Play the track.</li><li>`false`: Stop playing the track.</li> |
| `disabled` | `boolean` | `false` | <li>`true`: Disable the track. When disabled, the SDK will stop playing and publishing the track.</li><li>`false`: Enable the track.</li> |
| `muted` | `boolean` | `false` | <li>`true`: Pause sending media data of the track.</li><li>`false`: Resume sending media data of the track.</li> |
| `videoPlayerConfig` | `VideoPlayerConfig` | None | Playback configurations for a video track including setting the mirror and display mode. The SDK enables mirror mode for the local video track by default. See [`VideoPlayerConfig`](https://api-ref.agora.io/en/video-sdk/reactjs/2.x//VideoPlayerConfig.html) for details. |
| `videoPlayerConfig` | `VideoPlayerConfig` | None | Playback configurations for a video track including setting the mirror and display mode. The SDK enables mirror mode for the local video track by default. See [`VideoPlayerConfig`](https://api-ref.agora.io/en/video-sdk/web/4.x/interfaces/videoplayerconfig.html) for details. |

#### Caveats

Expand Down
2 changes: 1 addition & 1 deletion packages/agora-rtc-react/docs/components/RemoteUser.en-US.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This component plays the video and audio tracks of a remote user and supports sp
| `volume` | `number` | None | The volume. The value ranges from 0 (mute) to 100 (the original volume). |
| `cover` | `string` &VerticalLine; `() => ReactNode` | None | The cover image or custom component to be displayed when `playVideo` is `false`, replacing the video frame. You can pass the URL of an online image or the relative path of a local image. |
| `children` | `ReactNode` | None | The React nodes to be rendered. |
| `videoPlayerConfig` | `VideoPlayerConfig` | None | Playback configurations for a video track including setting the mirror and display mode. The SDK enables mirror mode for the local video track by default. See [`VideoPlayerConfig`](https://api-ref.agora.io/en/video-sdk/reactjs/2.x//VideoPlayerConfig.html) for details. |
| `videoPlayerConfig` | `VideoPlayerConfig` | None | Playback configurations for a video track including setting the mirror and display mode. The SDK enables mirror mode for the local video track by default. See [`VideoPlayerConfig`](https://api-ref.agora.io/en/video-sdk/web/4.x/interfaces/videoplayerconfig.html) for details. |

#### Sample code

Expand Down
10 changes: 5 additions & 5 deletions packages/agora-rtc-react/docs/components/RemoteVideoTrack.en-US.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ This component plays the video track of a remote user and does not support speci

#### Props

| Prop | Type | Default value | Description |
| ------------------- | ------------------------------------------------------------------------------------------------------ | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `track` | [`IRemoteVideoTrack`](https://api-ref.agora.io/en/video-sdk/web/4.x/interfaces/iremotevideotrack.html) | None | The remote video track object. |
| `play` | `boolean` | None | <li>`true`: Play the track.</li><li>`false`: Stop playing the track.</li> |
| `videoPlayerConfig` | `VideoPlayerConfig` | None | Playback configurations for a video track including setting the mirror and display mode. The SDK enables mirror mode for the local video track by default. See [`VideoPlayerConfig`](https://api-ref.agora.io/en/video-sdk/reactjs/2.x//VideoPlayerConfig.html) for details. |
| Prop | Type | Default value | Description |
| ------------------- | ------------------------------------------------------------------------------------------------------ | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `track` | [`IRemoteVideoTrack`](https://api-ref.agora.io/en/video-sdk/web/4.x/interfaces/iremotevideotrack.html) | None | The remote video track object. |
| `play` | `boolean` | None | <li>`true`: Play the track.</li><li>`false`: Stop playing the track.</li> |
| `videoPlayerConfig` | `VideoPlayerConfig` | None | Playback configurations for a video track including setting the mirror and display mode. The SDK enables mirror mode for the local video track by default. See [`VideoPlayerConfig`](https://api-ref.agora.io/en/video-sdk/web/4.x/interfaces/videoplayerconfig.html) for details. |

#### Sample code

Expand Down
Loading

0 comments on commit f992908

Please sign in to comment.