From 422e68cb6e16819e6c559ecab2903fabbcaae471 Mon Sep 17 00:00:00 2001 From: Cilla-luodan Date: Fri, 1 Sep 2023 09:51:58 +0000 Subject: [PATCH] Sync cn prototype to en prototype --- ...ediaengine_registervideoframeobserver.dita | 32 +++---- .../API/api_irtcengine_enablevideo.dita | 6 +- ..._irtcengine_muteallremotevideostreams.dita | 8 +- .../api_irtcengine_mutelocalvideostream.dita | 20 ++-- .../API/api_irtcengine_setchannelprofile.dita | 10 +- .../API/api_irtcengine_setclientrole2.dita | 10 +- .../API/api_irtcengine_setcloudproxy.dita | 6 +- .../api_irtcengine_setlocalrendermode2.dita | 8 +- ...pi_irtcengine_setlocalvideomirrormode.dita | 6 +- ...cengineex_muteallremotevideostreamsex.dita | 22 ++--- ...i_irtcengineex_mutelocalvideostreamex.dita | 20 ++-- .../RTC-NG/API/class_imagetrackoptions.dita | 8 +- .../RTC-NG/API/class_livetranscoding.dita | 96 +++++++++---------- .../API/class_videoencoderconfiguration.dita | 78 ++++++++------- 14 files changed, 164 insertions(+), 166 deletions(-) diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita index 16157307ae7..c8e24a500fa 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="registerVideoFrameObserver"/> + <ph keyref="registerVideoFrameObserver" /> Registers a raw video frame observer object. - + @@ -20,13 +20,13 @@ public abstract int RegisterVideoFrameObserver(IVideoFrameObserver videoFrameObserver, VIDEO_OBSERVER_FRAME_TYPE formatPreference, VIDEO_OBSERVER_POSITION position, OBSERVER_MODE mode = OBSERVER_MODE.INTPTR); abstract registerVideoFrameObserver(observer: IVideoFrameObserver): number; void registerVideoFrameObserver(VideoFrameObserver observer); -

+

Details -

If you want to observe raw video frames (such as YUV or RGBA format), Agora recommends that you implement one class with this method.

-

When calling this method to register a video observer, you can register callbacks in the class as needed. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.

-

+

If you want to observe raw video frames (such as YUV or RGBA format), Agora recommends that you implement one class with this method.

+

When calling this method to register a video observer, you can register callbacks in the class as needed. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.

+

  • Ensure that you call this method before joining a channel.
    • @@ -35,7 +35,7 @@
  • If the user adjusts the video profile, the resolution of the video returned in the callbacks also changes.
- After registering the raw video observer, you can use the obtained raw video data in various video pre-processing scenarios, such as implementing virtual backgrounds and image enhacement scenarios by yourself, Agora provides an open source sample project on GitHub for your reference.
+ After registering the raw video observer, you can use the obtained raw video data in various video pre-processing scenarios, such as implementing virtual backgrounds and image enhacement scenarios by yourself, Agora provides an open source sample project on GitHub for your reference.
Parameters @@ -43,31 +43,31 @@ observer delegate videoFrameObserver - The observer instance. See . To release the instance, set the value as . + The observer instance. See . To release the instance, set the value as . mode - The video data callback mode. See . + The video data callback mode. See . formatPreference - The video frame type. See . + The video frame type. See . position - A bit mask that controls the frame position of the video observer. See . + A bit mask that controls the frame position of the video observer. See .
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

  • 0: Success.
  • < 0: Failure.
    -
  • : Success.
    • -
  • : Failure.
    • +
  • : Success.
    • +
  • : Failure.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablevideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablevideo.dita index 95e1410d00b..7145eb21bbc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablevideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablevideo.dita @@ -20,7 +20,7 @@ public abstract int EnableVideo(); abstract enableVideo(): number; Future<void> enableVideo(); -

+

Details @@ -38,8 +38,8 @@
  • A successful call of this method resets , , and . Proceed it with caution.
    • - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

    • 0: Success.
    • < 0: Failure.
      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita index f62821555ba..72b563a14b9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita @@ -20,14 +20,14 @@ public abstract int MuteAllRemoteVideoStreams(bool mute); abstract muteAllRemoteVideoStreams(mute: boolean): number; Future<void> muteAllRemoteVideoStreams(bool mute); -

      +

    Details

    After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.

    • Call this method after joining a channel.
      • -
    • If you do not want to subscribe the video streams of remote users before joining a channel, you can call and set autoSubscribeVideo as .
      • +
    • If you do not want to subscribe the video streams of remote users before joining a channel, you can call and set autoSubscribeVideo as .
    @@ -45,8 +45,8 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

    • 0: Success.
    • < 0: Failure.
      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita b/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita index 10af83a796a..2e922169fbd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita @@ -1,12 +1,12 @@ - <ph keyref="muteLocalVideoStream"/> + <ph keyref="muteLocalVideoStream" /> Stops or resumes publishing the local video stream. - + @@ -20,14 +20,14 @@ public abstract int MuteLocalVideoStream(bool mute); abstract muteLocalVideoStream(mute: boolean): number; Future<void> muteLocalVideoStream(bool mute); -

      +

    Details -

    A successful call of this method triggers the callback on the remote client.

    +

    A successful call of this method triggers the callback on the remote client.

      -
    • This method executes faster than the () method, which controls the sending of the local video stream.
      • +
    • This method executes faster than the () method, which controls the sending of the local video stream.
    • This method does not affect any ongoing video recording, because it does not disable the camera.
    @@ -38,18 +38,18 @@ mute

    Whether to stop publishing the local video stream.

      -
    • : Stop publishing the local video stream.
      • -
    • : (Default) Publish the local video stream.
      • +
    • : Stop publishing the local video stream.
      • +
    • : (Default) Publish the local video stream.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

    • 0: Success.
    • < 0: Failure.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita index 6fd6de76b7d..0e7c1b59c49 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita @@ -20,7 +20,7 @@ public abstract int SetChannelProfile(CHANNEL_PROFILE_TYPE profile); abstract setChannelProfile(profile: ChannelProfileType): number; Future<void> setChannelProfile(ChannelProfileType profile); -

    +

    Details @@ -45,13 +45,13 @@
  • (2): Gaming.
    Deprecated:
    -
    Use instead.
    +
    Use instead.
  • (3): Interaction. The scenario is optimized for latency. Use this profile if the use case requires frequent interactions between users.
    Deprecated:
    -
    Use instead.
    +
    Use instead.

    • @@ -59,8 +59,8 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

    • 0(ERR_OK): Success.
    • < 0: Failure.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita index 65507fb2d97..f210b4a6cb3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita @@ -29,7 +29,7 @@ int SetClientRole(ECLIENT_ROLE_TYPE clientroletype, const FClientRoleOptions& ): number; Future<void> setClientRole( {required ClientRoleType role, ClientRoleOptions? options}); -

        +

    Details @@ -41,7 +41,7 @@ int SetClientRole(ECLIENT_ROLE_TYPE clientroletype, const FClientRoleOptions&
  • Triggers on the local client.
  • Triggers or on the remote client.

    • -

    The difference between this method and is that this method can set the user level in addition to the user role.

      +

      The difference between this method and is that this method can set the user level in addition to the user role.

      • The user role (role) determines the permissions that the SDK grants to a user, such as permission to send local streams, receive remote streams, and push streams to a CDN address.
      • The user level (level) determines the level of services that a user can enjoy within the permissions of the user's role. For example, an audience member can choose to receive remote streams with low latency or ultra-low latency. User level affects the pricing of services.

      @@ -63,8 +63,8 @@ int SetClientRole(ECLIENT_ROLE_TYPE clientroletype, const FClientRoleOptions&
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

    • 0: Success.
    • < 0: Failure.
        @@ -75,4 +75,4 @@ int SetClientRole(ECLIENT_ROLE_TYPE clientroletype, const FClientRoleOptions&
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita index 6974bfec82d..3dbcc871263 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita @@ -20,7 +20,7 @@ public abstract int SetCloudProxy(CLOUD_PROXY_TYPE proxyType); abstract setCloudProxy(proxyType: CloudProxyType): number; Future<void> setCloudProxy(CloudProxyType proxyType); -

    +

    Details @@ -51,8 +51,8 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

    • 0: Success.
    • < 0: Failure.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita index 2062436bccc..68e4eb393a5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita @@ -32,7 +32,7 @@ int SetLocalRenderMode(ERENDER_MODE_TYPE renderMode, EVIDEO_MIRROR_MODE_TYPE mir {required RenderModeType renderMode, VideoMirrorModeType mirrorMode = VideoMirrorModeType.videoMirrorModeAuto}); -

        +

    Details @@ -71,11 +71,11 @@ int SetLocalRenderMode(ERENDER_MODE_TYPE renderMode, EVIDEO_MIRROR_MODE_TYPE mir
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

    • 0: Success.
    • < 0: Failure.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita index 3c279e1b973..6cbe4989c84 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita @@ -20,7 +20,7 @@ public abstract int SetLocalVideoMirrorMode(VIDEO_MIRROR_MODE_TYPE mirrorMode); abstract setLocalVideoMirrorMode(mirrorMode: VideoMirrorModeType): number; Future<void> setLocalVideoMirrorMode(VideoMirrorModeType mirrorMode); -

    +

    Details @@ -49,8 +49,8 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

    • 0: Success.
    • < 0: Failure.
      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita index 0fdea6bb0d9..dc9abcea6bd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita @@ -1,12 +1,12 @@ - <ph keyref="muteAllRemoteVideoStreamsEx"/> + <ph keyref="muteAllRemoteVideoStreamsEx" /> Stops or resumes subscribing to the video streams of all remote users. - + @@ -26,7 +26,7 @@ mute: boolean, connection: RtcConnection ): number; - Future<void> muteAllRemoteVideoStreamsEx( + Future<void> muteAllRemoteVideoStreamsEx( {required bool mute, required RtcConnection connection});

    @@ -37,27 +37,27 @@
    v4.1.0
    -

    +

    Parameters - - + + - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

    • 0: Success.
    • < 0: Failure.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita index a2e1eff4aea..01c4bf68623 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita @@ -1,12 +1,12 @@ - <ph keyref="muteLocalVideoStreamEx"/> + <ph keyref="muteLocalVideoStreamEx" /> Stops or resumes publishing the local video stream. - + @@ -25,7 +25,7 @@ mute: boolean, connection: RtcConnection ): number;     - Future<void> muteLocalVideoStreamEx( + Future<void> muteLocalVideoStreamEx( {required bool mute, required RtcConnection connection});

    @@ -46,21 +46,21 @@ Parameters - - + + - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly.

    • 0: Success.
    • < 0: Failure.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_imagetrackoptions.dita b/en-US/dita/RTC-NG/API/class_imagetrackoptions.dita index a2ec309eddb..8d1762b2665 100644 --- a/en-US/dita/RTC-NG/API/class_imagetrackoptions.dita +++ b/en-US/dita/RTC-NG/API/class_imagetrackoptions.dita @@ -58,12 +58,12 @@ @JsonKey(name: 'fps') final int? fps; - factory ImageTrackOptions.fromJson(Map<String, dynamic> json) => + factory ImageTrackOptions.fromJson(Map<String, dynamic> json) => _$ImageTrackOptionsFromJson(json); - Map<String, dynamic> toJson() => _$ImageTrackOptionsToJson(this); + Map<String, dynamic> toJson() => _$ImageTrackOptionsToJson(this); }     -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -79,4 +79,4 @@
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_livetranscoding.dita b/en-US/dita/RTC-NG/API/class_livetranscoding.dita index 93da02453da..f0015ba006e 100644 --- a/en-US/dita/RTC-NG/API/class_livetranscoding.dita +++ b/en-US/dita/RTC-NG/API/class_livetranscoding.dita @@ -1,7 +1,7 @@ - <ph keyref="LiveTranscoding"/> + <ph keyref="LiveTranscoding" /> Transcoding configurations for Media Push.
    @@ -513,7 +513,7 @@ final int? userCount; @JsonKey(name: 'transcodingUsers') - final List<TranscodingUser>? transcodingUsers; + final List<TranscodingUser>? transcodingUsers; @JsonKey(name: 'transcodingExtraInfo') final String? transcodingExtraInfo; @@ -522,13 +522,13 @@ final String? metadata; @JsonKey(name: 'watermark') - final List<RtcImage>? watermark; + final List<RtcImage>? watermark; @JsonKey(name: 'watermarkCount') final int? watermarkCount; @JsonKey(name: 'backgroundImage') - final List<RtcImage>? backgroundImage; + final List<RtcImage>? backgroundImage; @JsonKey(name: 'backgroundImageCount') final int? backgroundImageCount; @@ -546,20 +546,20 @@ final AudioCodecProfileType? audioCodecProfile; @JsonKey(name: 'advancedFeatures') - final List<LiveStreamAdvancedFeature>? advancedFeatures; + final List<LiveStreamAdvancedFeature>? advancedFeatures; @JsonKey(name: 'advancedFeatureCount') final int? advancedFeatureCount; - factory LiveTranscoding.fromJson(Map<String, dynamic> json) => + factory LiveTranscoding.fromJson(Map<String, dynamic> json) => _$LiveTranscodingFromJson(json); - Map<String, dynamic> toJson() => _$LiveTranscodingToJson(this); + Map<String, dynamic> toJson() => _$LiveTranscodingToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> width @@ -615,8 +615,8 @@

    Latency mode:

      -
    • : Low latency with unassured quality.
      • -
    • : (Default) High latency with assured quality.
      • +
    • : Low latency with unassured quality.
      • +
    • : (Default) High latency with assured quality.
     @@ -626,17 +626,17 @@ videoCodecProfile -

    Video codec profile type for Media Push. Set it as 66, 77, or 100 (default). See for details.

    +

    Video codec profile type for Media Push. Set it as 66, 77, or 100 (default). See for details.

    If you set this parameter to any other value, Agora adjusts it to the default value.         videoCodecType - Video codec profile types for Media Push. See . + Video codec profile types for Media Push. See . transcodingUsers -

    Manages the user layout configuration in the Media Push. Agora supports a maximum of 17 transcoding users in a Media Push channel. See .

    +

    Manages the user layout configuration in the Media Push. Agora supports a maximum of 17 transcoding users in a Media Push channel. See .

         @@ -663,7 +663,7 @@
    Deprecated
    -
    Obsolete and not recommended for use. Use instead.
    +
    Obsolete and not recommended for use. Use instead.
    @@ -677,7 +677,7 @@
    Deprecated
    -
    Obsolete and not recommended for use. Use instead.
    +
    Obsolete and not recommended for use. Use instead.

    The number of users in the Media Push. The value range is [0,17].

    @@ -698,25 +698,25 @@ watermark -

    The watermark on the live video. The image format needs to be PNG. See .

    +

    The watermark on the live video. The image format needs to be PNG. See .

    You can add one watermark, or add multiple watermarks using an array. This parameter is used with watermarkCount.

         backgroundImage -

    The number of background images on the live video. The image format needs to be PNG. See .

    +

    The number of background images on the live video. The image format needs to be PNG. See .

    You can add a background image or use an array to add multiple background images. This parameter is used with backgroundImageCount.

         backgroundImageArray - An array of background images on the live video. See . You can use backgroundImageArray to add one or more background images. The image format needs to be PNG. The total number of watermarks and background images on a live video must be greater than or equal to 0 and less than or equal to 10. + An array of background images on the live video. See . You can use backgroundImageArray to add one or more background images. The image format needs to be PNG. The total number of watermarks and background images on a live video must be greater than or equal to 0 and less than or equal to 10. audioSampleRate -

    The audio sampling rate (Hz) of the output media stream. See .

    +

    The audio sampling rate (Hz) of the output media stream. See .

         @@ -739,11 +739,11 @@ audioCodecProfile - Audio codec profile type for Media Push. See . + Audio codec profile type for Media Push. See . watermarkArray - The array of watermarks on the live video. See . You can add one or more watermarks using watermarkArray. The image format needs to be PNG. The total number of watermarks and background images on a live video must be greater than or equal to 0 and less than or equal to 10. + The array of watermarks on the live video. See . You can add one or more watermarks using watermarkArray. The image format needs to be PNG. The total number of watermarks and background images on a live video must be greater than or equal to 0 and less than or equal to 10. watermarkCount @@ -755,7 +755,7 @@ advancedFeatures - Advanced features of the Media Push with transcoding. See . + Advanced features of the Media Push with transcoding. See . advancedFeatureCount @@ -767,27 +767,27 @@ addBackgroundImage - Adds a background image. See . + Adds a background image. See . addUser - Adds a user for video mixing during the CDN live streaming. See . + Adds a user for video mixing during the CDN live streaming. See . addWatermark - Adds a watermark. See . + Adds a watermark. See . getAdvancedFeatures - Gets the status of the advanced features of streaming with transcoding. See . + Gets the status of the advanced features of streaming with transcoding. See . getBackgroundColor - Gets the background color in hex. See . + Gets the background color in hex. See . getBackgroundImageList - Gets the list of background images. See . + Gets the list of background images. See . getBlue @@ -798,7 +798,7 @@
    Obsolete and not recommended for use.
    -

    Gets the background color's blue component. See .

    +

    Gets the background color's blue component. See .

     @@ -810,7 +810,7 @@
    Obsolete and not recommended for use.
    -

    Gets the background color's green component. See .

    +

    Gets the background color's green component. See .

     @@ -822,44 +822,44 @@
    Obsolete and not recommended for use.
    -

    Gets the background color's red component. See .

    +

    Gets the background color's red component. See .

     getUserCount - Gets the number of users transcoded in the CDN live streaming. See . + Gets the number of users transcoded in the CDN live streaming. See . getUsers - Gets the user list in the CDN live streaming. See . + Gets the user list in the CDN live streaming. See . getWatermarkList - Gets the watermark list. See . + Gets the watermark list. See . removeBackgroundImage - Removes a background image from the background image list. See . + Removes a background image from the background image list. See . removeUser - Removes a user from video mixing during the CDN live streaming. See . + Removes a user from video mixing during the CDN live streaming. See . removeWatermark - Removes a watermark from the watermark list. See . + Removes a watermark from the watermark list. See . setAdvancedFeatures - Sets whether to enable the advanced features of streaming with transcoding. See . + Sets whether to enable the advanced features of streaming with transcoding. See . setBackgroundColor [1/2] - Sets the background color of the CDN live stream in the format of RGB hex. See . + Sets the background color of the CDN live stream in the format of RGB hex. See . setBackgroundColor [2/2] - Sets the background color in RGB format. See . + Sets the background color in RGB format. See . setBlue @@ -870,7 +870,7 @@
    Obsolete and not recommended for use.
    -

    Sets the background color's blue component. See .

    +

    Sets the background color's blue component. See .

     @@ -882,7 +882,7 @@
    Obsolete and not recommended for use.
    -

    Sets the background color's green component. See .

    +

    Sets the background color's green component. See .

     @@ -894,22 +894,22 @@
    Obsolete and not recommended for use.
    -

    Sets the background color's red component. See .

    +

    Sets the background color's red component. See .

     setUsers [1/2] - Sets the users in batches in the CDN live streaming. See . + Sets the users in batches in the CDN live streaming. See . setUsers [2/2] - Sets the users in batches in the CDN live streaming. See . + Sets the users in batches in the CDN live streaming. See . defaultTranscoding - Applies the default transcoding settings, see . + Applies the default transcoding settings, see .
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita index 48e0b338350..2e6db39c0d6 100644 --- a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita @@ -1,7 +1,7 @@ - <ph keyref="VideoEncoderConfiguration"/> + <ph keyref="VideoEncoderConfiguration" /> Video encoder configurations.
    @@ -426,43 +426,41 @@ @JsonKey(name: 'advanceOptions') final AdvanceOptions? advanceOptions; - factory VideoEncoderConfiguration.fromJson(Map<String, dynamic> json) => + factory VideoEncoderConfiguration.fromJson(Map<String, dynamic> json) => _$VideoEncoderConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$VideoEncoderConfigurationToJson(this); + Map<String, dynamic> toJson() => _$VideoEncoderConfigurationToJson(this); } -

    +

    - <text - conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" - /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> dimensions -

    The dimensions of the encoded video (px). See . This parameter measures the video encoding quality in the format of length × width. The default value is 960 × 540. You can set a custom value.

    +

    The dimensions of the encoded video (px). See . This parameter measures the video encoding quality in the format of length × width. The default value is 960 × 540. You can set a custom value.

    Users can set the resolution by themselves, or directly select the desired resolution from the following list:

      -
    • : The video resolution is 120 × 120.
      • -
    • : The video resolution is 160 × 120.
      • -
    • : The video resolution is 180 × 180.
      • -
    • : The video resolution is 240 × 180.
      • -
    • : The video resolution is 320 × 180.
      • -
    • : The video resolution is 240 × 240.
      • -
    • : The video resolution is 320 × 240.
      • -
    • : The video resolution is 424 × 240.
      • -
    • : The video resolution is 360 × 360.
      • -
    • : The video resolution is 480 × 360.
      • -
    • : The video resolution is 640 × 360.
      • -
    • : The video resolution is 480 × 480.
      • -
    • : The video resolution is 640 × 480.
      • -
    • : The video resolution is 840 × 480.
      • -
    • : The video resolution is 960 × 540.
      • -
    • : The video resolution is 960 × 720.
      • -
    • : The video resolution is 1280 × 720.
      • -
    • : The video resolution is 1920 × 1080.
      • -
    • : The video resolution is 2540 × 1440.
      • -
    • : The video resolution is 3840 × 2160.
      • +
    • : The video resolution is 120 × 120.
      • +
    • : The video resolution is 160 × 120.
      • +
    • : The video resolution is 180 × 180.
      • +
    • : The video resolution is 240 × 180.
      • +
    • : The video resolution is 320 × 180.
      • +
    • : The video resolution is 240 × 240.
      • +
    • : The video resolution is 320 × 240.
      • +
    • : The video resolution is 424 × 240.
      • +
    • : The video resolution is 360 × 360.
      • +
    • : The video resolution is 480 × 360.
      • +
    • : The video resolution is 640 × 360.
      • +
    • : The video resolution is 480 × 480.
      • +
    • : The video resolution is 640 × 480.
      • +
    • : The video resolution is 840 × 480.
      • +
    • : The video resolution is 960 × 540.
      • +
    • : The video resolution is 960 × 720.
      • +
    • : The video resolution is 1280 × 720.
      • +
    • : The video resolution is 1920 × 1080.
      • +
    • : The video resolution is 2540 × 1440.
      • +
    • : The video resolution is 3840 × 2160.
      @@ -473,11 +471,11 @@ codecType - The codec type of the local video stream. See . + The codec type of the local video stream. See . frameRate - The frame rate (fps) of the encoding video frame. The default value is 15. See . + The frame rate (fps) of the encoding video frame. The default value is 15. See . minFramerate @@ -486,10 +484,10 @@ bitrate -

      The encoding bitrate (Kbps) of the video. See .

      +

      The encoding bitrate (Kbps) of the video. See .

        -
        • -
        • +
        • +
      @@ -501,16 +499,16 @@ orientationMode - The orientation mode of the encoded video. See . + The orientation mode of the encoded video. See . degradationPreference - Video degradation preference under limited bandwidth. See . + Video degradation preference under limited bandwidth. See . mirrorMode -

      Sets the mirror mode of the published local video stream. It only affects the video that the remote user sees. See .

      +

      Sets the mirror mode of the published local video stream. It only affects the video that the remote user sees. See .

      The mirror mode specified in video encoder configurations only affect the view of remote users.

      • (0): The SDK determines whether to enable the mirror mode. The SDK disables mirror mode by default.
      • (1): Enables the mirror mode for remote users.
        • @@ -520,7 +518,7 @@ advanceOptions - Advanced options for video encoding. See . + Advanced options for video encoding. See .
    @@ -528,13 +526,13 @@ initWithSize - Specifies the video resolution and initializes the object. See . + Specifies the video resolution and initializes the object. See . initWithWidth - Specifies the video width and height, and initializes the object. See . + Specifies the video width and height, and initializes the object. See .
    -     + \ No newline at end of file