From a2c500ec0f409478a9209722a8293403065f8c8b Mon Sep 17 00:00:00 2001 From: Suri539 Date: Thu, 7 Sep 2023 10:25:11 +0800 Subject: [PATCH 01/13] 0907 bugfix --- dita/RTC-NG/API/api_irtcengine_preloadchannel.dita | 3 ++- dita/RTC-NG/API/rtc_api_overview_ng.dita | 4 ++-- dita/RTC-NG/RTC_NG_API_Blueprint.ditamap | 2 +- dita/RTC-NG/RTC_NG_API_CPP.ditamap | 2 +- dita/RTC-NG/RTC_NG_API_Unreal.ditamap | 2 +- dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap | 2 +- dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap | 2 +- dita/RTC-NG/config/keys-rtc-ng-api-unreal.ditamap | 2 +- dita/RTC-NG/config/relations-rtc-ng-api.ditamap | 2 +- 9 files changed, 11 insertions(+), 10 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita b/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita index 088e2246de2..8ae6b3eb4a2 100644 --- a/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita +++ b/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita @@ -55,7 +55,8 @@ 在服务端生成的用于鉴权的动态密钥。详见。

Token 过期后，根据预加载频道的数量，你可以通过不同方式来传入用于预加载频道的新 Token：

  • 预加载一个频道时：调用此方法来传入新的 Token。
    • -
  • 预加载多个频道时：
    • 如果你使用了通配的 Token，调用 来更新所有预加载频道的 Token。
      • +
    • 预加载多个频道时：
      • 如果你使用了通配的 Token，调用 来更新所有预加载频道的 Token。 + 生成通配 Token 时，用户 ID 不得设为 0。详见 。
      • 如果你使用了不同的 Token：调用此方法并传入你的用户 ID、对应的频道名和更新后的 Token。

    diff --git a/dita/RTC-NG/API/rtc_api_overview_ng.dita b/dita/RTC-NG/API/rtc_api_overview_ng.dita index 455204d88bf..291c8d3d571 100644 --- a/dita/RTC-NG/API/rtc_api_overview_ng.dita +++ b/dita/RTC-NG/API/rtc_api_overview_ng.dita @@ -1937,7 +1937,7 @@ - + 事件 @@ -2562,7 +2562,7 @@ - + diff --git a/dita/RTC-NG/RTC_NG_API_Blueprint.ditamap b/dita/RTC-NG/RTC_NG_API_Blueprint.ditamap index fdeab75bc23..b93fae4eb15 100644 --- a/dita/RTC-NG/RTC_NG_API_Blueprint.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Blueprint.ditamap @@ -568,7 +568,7 @@ - + diff --git a/dita/RTC-NG/RTC_NG_API_CPP.ditamap b/dita/RTC-NG/RTC_NG_API_CPP.ditamap index b850a4fb24d..ae0b10166a3 100644 --- a/dita/RTC-NG/RTC_NG_API_CPP.ditamap +++ b/dita/RTC-NG/RTC_NG_API_CPP.ditamap @@ -576,7 +576,7 @@ - + diff --git a/dita/RTC-NG/RTC_NG_API_Unreal.ditamap b/dita/RTC-NG/RTC_NG_API_Unreal.ditamap index a217279790d..364d8eb00f9 100644 --- a/dita/RTC-NG/RTC_NG_API_Unreal.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Unreal.ditamap @@ -568,7 +568,7 @@ - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap index aa769f8bbdf..7d71ea58c5a 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap @@ -3204,7 +3204,7 @@ - + isApplicationMute diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap index af845af9d13..d17b859d737 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap @@ -3225,7 +3225,7 @@ - + isApplicationMute diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-unreal.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-unreal.ditamap index b77de4b12dd..c67ea9f80ba 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-unreal.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-unreal.ditamap @@ -3204,7 +3204,7 @@ - + isApplicationMute diff --git a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap index 44a953c0fc3..f7900204d1d 100644 --- a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap +++ b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap @@ -2835,7 +2835,7 @@ - + From a6c6512fae8501a25b86bd0ce033008156bcf3bd Mon Sep 17 00:00:00 2001 From: Suri539 Date: Fri, 8 Sep 2023 10:45:41 +0800 Subject: [PATCH 02/13] android keyword --- dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap index 120784b3a2c..20c5b9b784a 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap @@ -508,7 +508,7 @@ - isMuted + getMute @@ -9744,7 +9744,7 @@ - + From 04cb270b3f0f8a6cbaf26ef9520bc8e1fe732a99 Mon Sep 17 00:00:00 2001 From: Cilla-luodan Date: Fri, 8 Sep 2023 10:46:20 +0800 Subject: [PATCH 03/13] delete redundant member --- dita/RTC-NG/API/class_videoencoderconfiguration.dita | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/dita/RTC-NG/API/class_videoencoderconfiguration.dita b/dita/RTC-NG/API/class_videoencoderconfiguration.dita index 73277571246..4492e5c0802 100644 --- a/dita/RTC-NG/API/class_videoencoderconfiguration.dita +++ b/dita/RTC-NG/API/class_videoencoderconfiguration.dita @@ -136,7 +136,6 @@ public static final int DEFAULT_MIN_BITRATE_EQUAL_TO_TARGET_BITRATE = -2; public VideoDimensions dimensions; public int frameRate; - public int minFrameRate; public int bitrate; public int minBitrate; public ORIENTATION_MODE orientationMode; @@ -146,7 +145,6 @@ public VideoEncoderConfiguration() { this.dimensions = new VideoDimensions(640, 480); this.frameRate = FRAME_RATE.FRAME_RATE_FPS_15.getValue(); - this.minFrameRate = DEFAULT_MIN_FRAMERATE; this.bitrate = STANDARD_BITRATE; this.minBitrate = DEFAULT_MIN_BITRATE; this.orientationMode = ORIENTATION_MODE.ORIENTATION_MODE_ADAPTIVE; @@ -159,7 +157,6 @@ ORIENTATION_MODE orientationMode) { this.dimensions = dimensions; this.frameRate = frameRate.getValue(); - this.minFrameRate = DEFAULT_MIN_FRAMERATE; this.bitrate = bitrate; this.minBitrate = DEFAULT_MIN_BITRATE; this.orientationMode = orientationMode; @@ -172,7 +169,6 @@ ORIENTATION_MODE orientationMode, MIRROR_MODE_TYPE mirrorMode) { this.dimensions = dimensions; this.frameRate = frameRate.getValue(); - this.minFrameRate = DEFAULT_MIN_FRAMERATE; this.bitrate = bitrate; this.minBitrate = DEFAULT_MIN_BITRATE; this.orientationMode = orientationMode; @@ -185,7 +181,6 @@ int width, int height, FRAME_RATE frameRate, int bitrate, ORIENTATION_MODE orientationMode) { this.dimensions = new VideoDimensions(width, height); this.frameRate = frameRate.getValue(); - this.minFrameRate = DEFAULT_MIN_FRAMERATE; this.bitrate = bitrate; this.minBitrate = DEFAULT_MIN_BITRATE; this.orientationMode = orientationMode; @@ -198,7 +193,6 @@ ORIENTATION_MODE orientationMode, MIRROR_MODE_TYPE mirrorMode) { this.dimensions = new VideoDimensions(width, height); this.frameRate = frameRate.getValue(); - this.minFrameRate = DEFAULT_MIN_FRAMERATE; this.bitrate = bitrate; this.minBitrate = DEFAULT_MIN_BITRATE; this.orientationMode = orientationMode; @@ -481,10 +475,6 @@ frameRate 视频编码的帧率(fps)，默认值为 15。详见 。 - - minFramerate - 视频的最小帧率。默认值为 -1。 - bitrate From 63c26dc30f1bc7839c4e271ec3e2fd1926ad504d Mon Sep 17 00:00:00 2001 From: Cilla-luodan Date: Fri, 8 Sep 2023 03:00:00 +0000 Subject: [PATCH 04/13] Sync cn prototype to en prototype --- en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita | 6 ------ 1 file changed, 6 deletions(-) diff --git a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita index 2e6db39c0d6..664cb776215 100644 --- a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita @@ -136,7 +136,6 @@ public static final int DEFAULT_MIN_BITRATE_EQUAL_TO_TARGET_BITRATE = -2; public VideoDimensions dimensions; public int frameRate; - public int minFrameRate; public int bitrate; public int minBitrate; public ORIENTATION_MODE orientationMode; @@ -146,7 +145,6 @@ public VideoEncoderConfiguration() { this.dimensions = new VideoDimensions(640, 480); this.frameRate = FRAME_RATE.FRAME_RATE_FPS_15.getValue(); - this.minFrameRate = DEFAULT_MIN_FRAMERATE; this.bitrate = STANDARD_BITRATE; this.minBitrate = DEFAULT_MIN_BITRATE; this.orientationMode = ORIENTATION_MODE.ORIENTATION_MODE_ADAPTIVE; @@ -159,7 +157,6 @@ ORIENTATION_MODE orientationMode) { this.dimensions = dimensions; this.frameRate = frameRate.getValue(); - this.minFrameRate = DEFAULT_MIN_FRAMERATE; this.bitrate = bitrate; this.minBitrate = DEFAULT_MIN_BITRATE; this.orientationMode = orientationMode; @@ -172,7 +169,6 @@ ORIENTATION_MODE orientationMode, MIRROR_MODE_TYPE mirrorMode) { this.dimensions = dimensions; this.frameRate = frameRate.getValue(); - this.minFrameRate = DEFAULT_MIN_FRAMERATE; this.bitrate = bitrate; this.minBitrate = DEFAULT_MIN_BITRATE; this.orientationMode = orientationMode; @@ -185,7 +181,6 @@ int width, int height, FRAME_RATE frameRate, int bitrate, ORIENTATION_MODE orientationMode) { this.dimensions = new VideoDimensions(width, height); this.frameRate = frameRate.getValue(); - this.minFrameRate = DEFAULT_MIN_FRAMERATE; this.bitrate = bitrate; this.minBitrate = DEFAULT_MIN_BITRATE; this.orientationMode = orientationMode; @@ -198,7 +193,6 @@ ORIENTATION_MODE orientationMode, MIRROR_MODE_TYPE mirrorMode) { this.dimensions = new VideoDimensions(width, height); this.frameRate = frameRate.getValue(); - this.minFrameRate = DEFAULT_MIN_FRAMERATE; this.bitrate = bitrate; this.minBitrate = DEFAULT_MIN_BITRATE; this.orientationMode = orientationMode; From 08beed362f38b5d7f49723fd3969de66a3db686c Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Fri, 8 Sep 2023 13:04:06 +0800 Subject: [PATCH 05/13] New translations --- .../API/api_irtcengine_joinchannel2.dita | 14 ++++---- .../API/api_irtcengine_preloadchannel.dita | 26 +++++++------- .../API/api_irtcengine_preloadchannel2.dita | 34 +++++++++---------- .../API/class_videoencoderconfiguration.dita | 10 ------ .../dita/RTC-NG/API/rtc_api_overview_ng.dita | 4 +-- 5 files changed, 39 insertions(+), 49 deletions(-) diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita index fa0545d7148..32784eff09f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita @@ -38,12 +38,12 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia uid: number, options: ChannelMediaOptions ): number; - Future<void> joinChannel( + Future<void> joinChannel( {required String token, required String channelId, required int uid, required ChannelMediaOptions options}); -

    +

    Details @@ -64,7 +64,7 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia token - The token generated on your server for authentication. See .If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See . + The token generated on your server for authentication. See .If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See . channelId @@ -74,7 +74,7 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia
  • All uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
  • Space
    • -
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
    • +
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

 @@ -93,8 +93,8 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia
- <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.

- \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita index 78c9cc34430..ab5af097601 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita @@ -1,12 +1,12 @@ - <ph keyref="preloadChannel" /> + <ph keyref="preloadChannel"/> Preloads a channel with token, channelIdchannelName, and uidoptionalUid. - + @@ -29,7 +29,7 @@ channelId: string, uid: number ): number; - Future<void> preloadChannel( + Future<void> preloadChannel( {required String token, required String channelId, required int uid});

@@ -41,9 +41,9 @@

When audience members need to switch between different channels frequently, calling the method can help shortening the time of joining a channel, thus reducing the time it takes for audience members to hear and see the host. As it may take a while for the SDK to preload a channel, Agora recommends that you call this method as soon as possible after obtaining the channel name and user ID to join a channel.

-
  • When calling this method, ensure you set the user role as audience and do not set the audio scenario as , otherwise, this method does not take effect.
    • +
    • When calling this method, ensure you set the user role as audience and do not set the audio scenario as , otherwise, this method does not take effect.
    • You also need to make sure that the channel name, user ID and token passed in for preloading are the same as the values passed in when joinning the channel, otherwise, this method does not take effect.
      • -
    • One instance supports preloading 20 channels at most. When exceeding this limit, the latest 20 preloaded channels take effect.
      • +
    • One instance supports preloading 20 channels at most. When exceeding this limit, the latest 20 preloaded channels take effect.
    • Failing to preload a channel does not mean that you can't join a channel, nor will it increase the time of joining a channel.

    If you join a preloaded channel, leave it and want to rejoin the same channel, you do not need to call this method unless the token for preloading the channel expires.

@@ -52,8 +52,8 @@ token - The token generated on your server for authentication. See .

When the token for preloading channels expires, you can update the token based on the number of channels you preload.

  • When preloading one channel, calling this method to pass in the new token.
    • -
  • When preloading more than one channels:
    • If you use a wildcard token for all preloaded channels, call to update the token.
      • + The token generated on your server for authentication. See .

      When the token for preloading channels expires, you can update the token based on the number of channels you preload.

      • When preloading one channel, calling this method to pass in the new token.
        • +
      • When preloading more than one channels:
        • If you use a wildcard token for all preloaded channels, call to update the token.生成通配 Token 时，用户 ID 不得设为 0。 See .
        • If you use different tokens to preload different channels, call this method to pass in your user ID, channel name and the new token.

       @@ -65,17 +65,17 @@
    • All uppercase English letters: A to Z.
    • All numeric characters: 0 to 9.
    • Space
      • -
    • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
      • +
    • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

    - - + +
    - <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.
        @@ -84,4 +84,4 @@
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita index 12fa874d11a..f7ea30f5080 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita @@ -1,12 +1,12 @@ - <ph keyref="preloadChannel2" /> + <ph keyref="preloadChannel2"/> Preloads a channel with token, channelIdchannelName, and userAccount. - + @@ -29,7 +29,7 @@ channelId: string, userAccount: string ): number; - Future<void> preloadChannelWithUserAccount( + Future<void> preloadChannelWithUserAccount( {required String token, required String channelId, required String userAccount});

    @@ -42,34 +42,34 @@
    v4.2.2
    -

    +

    -
    • +
      • You also need to make sure that the User Account, channel ID and token passed in for preloading are the same as the values passed in when joining the channel, otherwise, this method does not take effect.
        • -
      • -
      -

      +

    • +
    +

    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.
        @@ -79,4 +79,4 @@
    -     \ 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..18cd6142db9 100644 --- a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita @@ -136,7 +136,6 @@ public static final int DEFAULT_MIN_BITRATE_EQUAL_TO_TARGET_BITRATE = -2; public VideoDimensions dimensions; public int frameRate; - public int minFrameRate; public int bitrate; public int minBitrate; public ORIENTATION_MODE orientationMode; @@ -146,7 +145,6 @@ public VideoEncoderConfiguration() { this.dimensions = new VideoDimensions(640, 480); this.frameRate = FRAME_RATE.FRAME_RATE_FPS_15.getValue(); - this.minFrameRate = DEFAULT_MIN_FRAMERATE; this.bitrate = STANDARD_BITRATE; this.minBitrate = DEFAULT_MIN_BITRATE; this.orientationMode = ORIENTATION_MODE.ORIENTATION_MODE_ADAPTIVE; @@ -159,7 +157,6 @@ ORIENTATION_MODE orientationMode) { this.dimensions = dimensions; this.frameRate = frameRate.getValue(); - this.minFrameRate = DEFAULT_MIN_FRAMERATE; this.bitrate = bitrate; this.minBitrate = DEFAULT_MIN_BITRATE; this.orientationMode = orientationMode; @@ -172,7 +169,6 @@ ORIENTATION_MODE orientationMode, MIRROR_MODE_TYPE mirrorMode) { this.dimensions = dimensions; this.frameRate = frameRate.getValue(); - this.minFrameRate = DEFAULT_MIN_FRAMERATE; this.bitrate = bitrate; this.minBitrate = DEFAULT_MIN_BITRATE; this.orientationMode = orientationMode; @@ -185,7 +181,6 @@ int width, int height, FRAME_RATE frameRate, int bitrate, ORIENTATION_MODE orientationMode) { this.dimensions = new VideoDimensions(width, height); this.frameRate = frameRate.getValue(); - this.minFrameRate = DEFAULT_MIN_FRAMERATE; this.bitrate = bitrate; this.minBitrate = DEFAULT_MIN_BITRATE; this.orientationMode = orientationMode; @@ -198,7 +193,6 @@ ORIENTATION_MODE orientationMode, MIRROR_MODE_TYPE mirrorMode) { this.dimensions = new VideoDimensions(width, height); this.frameRate = frameRate.getValue(); - this.minFrameRate = DEFAULT_MIN_FRAMERATE; this.bitrate = bitrate; this.minBitrate = DEFAULT_MIN_BITRATE; this.orientationMode = orientationMode; @@ -479,10 +473,6 @@ frameRate The frame rate (fps) of the encoding video frame. The default value is 15. See . - - minFramerate - The minimum encoding frame rate of the video. The default value is -1. - bitrate diff --git a/en-US/dita/RTC-NG/API/rtc_api_overview_ng.dita b/en-US/dita/RTC-NG/API/rtc_api_overview_ng.dita index 0e0b7b5af56..574e09f69d5 100644 --- a/en-US/dita/RTC-NG/API/rtc_api_overview_ng.dita +++ b/en-US/dita/RTC-NG/API/rtc_api_overview_ng.dita @@ -1937,7 +1937,7 @@ - + Event @@ -2562,7 +2562,7 @@ - + From 1e758287819d41fd5c1eec1613e88445cc5dc7ac Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Fri, 8 Sep 2023 14:15:53 +0800 Subject: [PATCH 06/13] New translations --- ...onfiguration_getdestchannelmediainfos.dita | 24 +- ...evicemanager_getplaybackdefaultdevice.dita | 20 +- ...vicemanager_getrecordingdefaultdevice.dita | 20 +- ...laudioengine_updateplayerpositioninfo.dita | 12 +- ...i_ilocalspatialaudioengine_initialize.dita | 26 +-- ...atialaudioengine_updateremoteposition.dita | 12 +- .../API/api_imediaengine_addlistener.dita | 30 +-- ...i_imediaengine_createcustomaudiotrack.dita | 18 +- .../API/api_imediaengine_pushaudioframe.dita | 24 +- .../API/api_imediaengine_pushaudioframe0.dita | 10 +- ...pi_imediaengine_pushencodedvideoimage.dita | 24 +- .../API/api_imediaengine_pushvideoframe.dita | 24 +- ...ediaengine_registeraudioframeobserver.dita | 32 +-- ...ine_registervideoencodedframeobserver.dita | 36 +-- ...ediaengine_registervideoframeobserver.dita | 4 +- .../API/api_imediaplayer_addlistener.dita | 28 +-- ...api_imediaplayer_openwithcustomsource.dita | 6 +- ...ediaplayer_registervideoframeobserver.dita | 20 +- .../API/api_imediaplayer_setrendermode.dita | 8 +- ...pi_imediaplayer_setspatialaudioparams.dita | 8 +- .../API/api_imediarecorder_addlistener.dita | 28 +-- .../api_imediarecorder_startrecording.dita | 26 +-- .../API/api_irtcengine_addlistener.dita | 28 +-- .../api_irtcengine_configrhythmplayer.dita | 22 +- .../API/api_irtcengine_createdatastream2.dita | 6 +- .../api_irtcengine_enablecontentinspect.dita | 28 +-- .../api_irtcengine_enabledualstreammode2.dita | 8 +- .../api_irtcengine_enabledualstreammode3.dita | 22 +- .../API/api_irtcengine_enableencryption.dita | 8 +- ...api_irtcengine_enableinearmonitoring2.dita | 26 +-- .../API/api_irtcengine_enablemulticamera.dita | 38 ++-- ...pi_irtcengine_enablevirtualbackground.dita | 36 +-- .../api_irtcengine_getextensionproperty2.dita | 14 +- ...pi_irtcengine_getscreencapturesources.dita | 8 +- .../RTC-NG/API/api_irtcengine_initialize.dita | 32 +-- .../API/api_irtcengine_joinchannel2.dita | 2 +- .../API/api_irtcengine_preloadchannel.dita | 2 +- .../api_irtcengine_pushreverseaudioframe.dita | 8 +- .../API/api_irtcengine_pushvideoframe2.dita | 30 +-- .../api_irtcengine_querycodeccapability.dita | 32 +-- ...tcengine_queryscreencapturecapability.dita | 20 +- ...ine_registeraudioencodedframeobserver.dita | 14 +- ...cengine_registeraudiospectrumobserver.dita | 12 +- ...cengine_registermediametadataobserver.dita | 12 +- .../API/api_irtcengine_removehandler.dita | 8 +- .../API/api_irtcengine_sendmetadata.dita | 12 +- ...pi_irtcengine_setadvancedaudiooptions.dita | 10 +- ...irtcengine_setaudiomixingdualmonomode.dita | 10 +- .../API/api_irtcengine_setchannelprofile.dita | 2 +- .../API/api_irtcengine_setclientrole.dita | 6 +- .../API/api_irtcengine_setclientrole2.dita | 2 +- ...api_irtcengine_setcolorenhanceoptions.dita | 18 +- .../API/api_irtcengine_setdualstreammode.dita | 28 +-- .../api_irtcengine_setdualstreammode2.dita | 30 +-- ...tcengine_setexternalaudiosourcevolume.dita | 22 +- .../api_irtcengine_setheadphoneeqpreset.dita | 16 +- .../api_irtcengine_setlivetranscoding.dita | 8 +- .../api_irtcengine_setlocalaccesspoint.dita | 10 +- ...cengine_setlocalpublishfallbackoption.dita | 8 +- .../api_irtcengine_setlocalrendermode.dita | 8 +- .../api_irtcengine_setlocalrendermode2.dita | 2 +- ...pi_irtcengine_setlocalvideomirrormode.dita | 2 +- ..._irtcengine_setlowlightenhanceoptions.dita | 16 +- ...ngine_setremoteuserspatialaudioparams.dita | 8 +- ...rtcengine_setscreencapturecontenthint.dita | 8 +- .../API/api_irtcengine_setuplocalvideo.dita | 12 +- .../API/api_irtcengine_setupremotevideo.dita | 22 +- ...pi_irtcengine_setvideodenoiseroptions.dita | 32 +-- ...tcengine_setvideoencoderconfiguration.dita | 22 +- .../API/api_irtcengine_setvideoprofile.dita | 24 +- .../api_irtcengine_startaudiorecording3.dita | 8 +- .../api_irtcengine_startcameracapture.dita | 22 +- ...api_irtcengine_startchannelmediarelay.dita | 24 +- ...pi_irtcengine_startdirectcdnstreaming.dita | 14 +- .../API/api_irtcengine_startechotest3.dita | 14 +- ...engine_startorupdatechannelmediarelay.dita | 24 +- .../API/api_irtcengine_startrhythmplayer.dita | 26 +-- .../api_irtcengine_startscreencapture.dita | 30 +-- .../api_irtcengine_startscreencapture2.dita | 28 +-- ...cengine_startscreencapturebydisplayid.dita | 10 +- ...engine_startscreencapturebyscreenrect.dita | 10 +- ...tcengine_startscreencapturebywindowid.dita | 12 +- .../API/api_irtcengine_switchchannel2.dita | 28 +-- ...e_unregisteraudioencodedframeobserver.dita | 20 +- .../api_irtcengine_updatescreencapture.dita | 16 +- ...cengine_updatescreencaptureparameters.dita | 8 +- ..._irtcengine_updatescreencaptureregion.dita | 8 +- ...irtcengine_updatescreencaptureregion2.dita | 18 +- .../api_irtcengineex_createdatastreamex2.dita | 4 +- .../API/api_irtcengineex_joinchannelex.dita | 30 +-- .../api_irtcengineex_setdualstreammodeex.dita | 32 +-- .../api_irtcengineex_setupremotevideoex.dita | 8 +- ...gineex_setvideoencoderconfigurationex.dita | 8 +- ...irtcengineex_startchannelmediarelayex.dita | 30 +-- ...neex_startorupdatechannelmediarelayex.dita | 28 +-- ...api_ivideodevicemanager_getcapability.dita | 8 +- ...ameobserver_onrecordaudioencodedframe.dita | 2 +- ...rver_onplaybackaudioframebeforemixing.dita | 2 +- ...bserverbase_onearmonitoringaudioframe.dita | 2 +- ...ioframeobserverbase_onmixedaudioframe.dita | 2 +- ...oframeobserverbase_onrecordaudioframe.dita | 2 +- .../callback_iaudiopcmframesink_onframe.dita | 4 +- ...spectrumobserver_onlocalaudiospectrum.dita | 2 +- ...dler_ondirectcdnstreamingstatechanged.dita | 4 +- ...venthandler_ondirectcdnstreamingstats.dita | 2 +- ...iaplayercustomdataprovider_onreaddata.dita | 2 +- ...imediaplayercustomdataprovider_onseek.dita | 2 +- ...diaplayersourceobserver_onplayerevent.dita | 2 +- ...iaplayersourceobserver_onpreloadevent.dita | 2 +- ...ecorderobserver_onrecorderinfoupdated.dita | 2 +- ...corderobserver_onrecorderstatechanged.dita | 4 +- ...etadataobserver_onreadytosendmetadata.dita | 4 +- ...venthandler_onaudiodevicestatechanged.dita | 2 +- ...enthandler_onaudiodevicevolumechanged.dita | 2 +- ...irtcengineeventhandler_onaudioquality.dita | 2 +- ...ineeventhandler_onaudioroutingchanged.dita | 2 +- ...eeventhandler_onaudiovolumeindication.dita | 2 +- ...nthandler_oncameraexposureareachanged.dita | 2 +- ...eventhandler_oncamerafocusareachanged.dita | 2 +- ...eventhandler_onchannelmediarelayevent.dita | 2 +- ...ndler_onchannelmediarelaystatechanged.dita | 4 +- ...ngineeventhandler_onclientrolechanged.dita | 4 +- ...eventhandler_onclientrolechangefailed.dita | 4 +- ...engineeventhandler_onconnectionbanned.dita | 2 +- ...eeventhandler_onconnectioninterrupted.dita | 2 +- ...tcengineeventhandler_onconnectionlost.dita | 2 +- ...eventhandler_onconnectionstatechanged.dita | 6 +- ...neeventhandler_oncontentinspectresult.dita | 2 +- ...cengineeventhandler_onencryptionerror.dita | 2 +- ...llback_irtcengineeventhandler_onerror.dita | 2 +- ...ineeventhandler_onfacepositionchanged.dita | 2 +- ...ndler_onfirstlocalaudioframepublished.dita | 2 +- ...ndler_onfirstlocalvideoframepublished.dita | 2 +- ...venthandler_onfirstremotevideodecoded.dita | 2 +- ...eeventhandler_onfirstremotevideoframe.dita | 2 +- ...gineeventhandler_onjoinchannelsuccess.dita | 2 +- ...irtcengineeventhandler_onleavechannel.dita | 2 +- ...eventhandler_onlocalaudiostatechanged.dita | 6 +- ...cengineeventhandler_onlocalaudiostats.dita | 4 +- ...eventhandler_onlocalvideostatechanged.dita | 2 +- ...cengineeventhandler_onlocalvideostats.dita | 4 +- ...nthandler_onlocalvideotranscodererror.dita | 4 +- ...tcengineeventhandler_onnetworkquality.dita | 2 +- ...gineeventhandler_onnetworktypechanged.dita | 4 +- ...cengineeventhandler_onpermissionerror.dita | 2 +- ...tcengineeventhandler_onproxyconnected.dita | 2 +- ...neeventhandler_onrejoinchannelsuccess.dita | 2 +- ...venthandler_onremoteaudiostatechanged.dita | 2 +- ...engineeventhandler_onremoteaudiostats.dita | 2 +- ...nthandler_onremoteaudiotransportstats.dita | 2 +- ...venthandler_onremotevideostatechanged.dita | 2 +- ...engineeventhandler_onremotevideostats.dita | 4 +- ...nthandler_onremotevideotransportstats.dita | 2 +- ...ack_irtcengineeventhandler_onrtcstats.dita | 2 +- ...gineeventhandler_onrtmpstreamingevent.dita | 2 +- ...cengineeventhandler_onuserenablevideo.dita | 2 +- ...k_irtcengineeventhandler_onuserjoined.dita | 2 +- ...rtcengineeventhandler_onusermutevideo.dita | 2 +- ..._irtcengineeventhandler_onuseroffline.dita | 2 +- ...venthandler_onvideodevicestatechanged.dita | 2 +- ...enthandler_onvideopublishstatechanged.dita | 2 +- ...handler_onvideorenderingtracingresult.dita | 4 +- ...rameobserver_getobservedframeposition.dita | 2 +- ...rameobserver_getvideoformatpreference.dita | 2 +- .../callback_ivideoframeobserver_onframe.dita | 6 +- .../class_Localaccesspointconfiguration.dita | 34 +-- .../dita/RTC-NG/API/class_advanceoptions.dita | 18 +- ...class_audioencodedframeobserverconfig.dita | 4 +- en-US/dita/RTC-NG/API/class_audioparams.dita | 40 ++-- .../class_audiorecordingconfiguration.dita | 10 +- .../class_cameracapturerconfiguration.dita | 24 +- .../RTC-NG/API/class_channelmediaoptions.dita | 214 +++++++++--------- .../class_channelmediarelayconfiguration.dita | 40 ++-- en-US/dita/RTC-NG/API/class_codeccapinfo.dita | 18 +- .../dita/RTC-NG/API/class_codeccaplevels.dita | 16 +- .../API/class_contentinspectconfig.dita | 20 +- .../API/class_contentinspectmodule.dita | 22 +- .../API/class_encodedvideoframeinfo.dita | 16 +- .../RTC-NG/API/class_externalvideoframe.dita | 12 +- .../RTC-NG/API/class_injectstreamconfig.dita | 4 +- .../RTC-NG/API/class_lastmileproberesult.dita | 4 +- .../RTC-NG/API/class_livetranscoding.dita | 62 ++--- .../class_localtranscoderconfiguration.dita | 22 +- .../RTC-NG/API/class_localvideostats.dita | 40 ++-- .../API/class_mediarecorderconfiguration.dita | 16 +- en-US/dita/RTC-NG/API/class_mediasource.dita | 18 +- .../RTC-NG/API/class_remoteaudiostats.dita | 6 +- .../RTC-NG/API/class_rtcengineconfig.dita | 46 ++-- .../API/class_screencaptureconfiguration.dita | 6 +- .../API/class_screencaptureparameters.dita | 40 ++-- .../API/class_screencaptureparameters2.dita | 36 +-- .../API/class_screencapturesourceinfo.dita | 34 +-- .../API/class_simulcaststreamconfig.dita | 2 +- .../API/class_transcodingvideostream.dita | 14 +- .../API/class_useraudiospectruminfo.dita | 4 +- en-US/dita/RTC-NG/API/class_videocanvas.dita | 46 ++-- .../API/class_videoencoderconfiguration.dita | 14 +- en-US/dita/RTC-NG/API/class_videoframe.dita | 22 +- .../API/class_videosubscriptionoptions.dita | 30 +-- .../RTC-NG/API/class_watermarkoptions.dita | 22 +- en-US/dita/RTC-NG/API/enum_bitrate.dita | 2 +- 201 files changed, 1410 insertions(+), 1406 deletions(-) diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita index fa098bec720..35a81233274 100644 --- a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita +++ b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita @@ -1,32 +1,32 @@ - <ph keyref="getDestChannelMediaInfos" /> + <ph keyref="getDestChannelMediaInfos"/> Gets the information of the target channel. - +

    - public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { + public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { return destInfos; } - - - - - - -

    + + + + + + +

    Returns -

    The information of the target channel. See .

    +

    The information of the target channel. ensure the user ID is not set as 0.

     -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita index 3eb35a2cb64..8d672fc05d4 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita @@ -1,26 +1,26 @@ - <ph keyref="getPlaybackDefaultDevice" /> + <ph keyref="getPlaybackDefaultDevice"/> Gets the default audio playback device. - +

    - - - + + + abstract getPlaybackDefaultDevice(): AudioDeviceInfo; public abstract int GetPlaybackDefaultDevice(ref string deviceId, ref string deviceName); - - Future<AudioDeviceInfo> getPlaybackDefaultDevice(); -

    + + Future<AudioDeviceInfo> getPlaybackDefaultDevice(); +

    Details @@ -40,11 +40,11 @@
    Returns -

    The details about the default audio playback device. See .

    +

    The details about the default audio playback device. ensure the user ID is not set as 0.

    • 0: Success.
    • < 0: Failure.
     -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita index feb6543aa4f..ffa24260962 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita @@ -1,26 +1,26 @@ - <ph keyref="getRecordingDefaultDevice" /> + <ph keyref="getRecordingDefaultDevice"/> Gets the default audio capture device. - +

    - - - + + + abstract getRecordingDefaultDevice(): AudioDeviceInfo; public abstract int GetRecordingDefaultDevice(ref string deviceId, ref string deviceName); - - Future<AudioDeviceInfo> getRecordingDefaultDevice(); -

    + + Future<AudioDeviceInfo> getRecordingDefaultDevice(); +

    Details @@ -40,11 +40,11 @@
    Returns -

    The details about the default audio capture device. See .

    +

    The details about the default audio capture device. ensure the user ID is not set as 0.

    • 0: Success.
    • < 0: Failure.
     -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita index e6f5b56a852..4ea6cc58980 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita @@ -25,9 +25,9 @@ playerId: number, positionInfo: RemoteVoicePositionInfo ): number; - Future<void> updatePlayerPositionInfo( + Future<void> updatePlayerPositionInfo( {required int playerId, required RemoteVoicePositionInfo positionInfo}); -

    +

    Details @@ -42,15 +42,15 @@ positionInfo - The spatial position of the media player. See . + The spatial position of the media player. ensure the user ID is not set as 0.
    - <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_ilocalspatialaudioengine_initialize.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita index 2c1e60dd5d5..a659bfd6204 100644 --- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita +++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita @@ -1,12 +1,12 @@ - <ph keyref="initialize_ILocalSpatialAudioEngine" /> - Initializes . + <ph keyref="initialize_ILocalSpatialAudioEngine"/> + Initializes . - + @@ -19,32 +19,32 @@ abstract initialize(): number; public abstract int Initialize(); abstract initialize(): number; - Future<void> initialize(); -

    + Future<void> initialize(); +

    Details
      -
    • Call this method after calling ().
      • -
    • Call this method after calling .
      • -
    • Before calling other methods of the class, you need to call this method to initialize .
      • -
    • The SDK supports creating only one instance for an app.
      • +
    • Call this method after calling ().
      • +
    • Call this method after calling .
      • +
    • Before calling other methods of the class, you need to call this method to initialize .
      • +
    • The SDK supports creating only one instance for an app.
    Parameters config - The configuration of . See . + The configuration of . ensure the user ID is not set as 0.
    - <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_ilocalspatialaudioengine_updateremoteposition.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita index 15363e1ebe2..f4017161ced 100644 --- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita +++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita @@ -25,9 +25,9 @@ uid: number, posInfo: RemoteVoicePositionInfo ): number;     - Future<void> updateRemotePosition( + Future<void> updateRemotePosition( {required int uid, required RemoteVoicePositionInfo posInfo}); -

    +

    Details @@ -42,15 +42,15 @@ posInfo - The spatial position of the remote user. See . + The spatial position of the remote user. ensure the user ID is not set as 0.
    - <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_imediaengine_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita index e59d5215833..d9a61a0cb96 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita @@ -1,49 +1,49 @@ - <ph keyref="addListener_IMediaEngine" /> - Adds one listener. + <ph keyref="addListener_IMediaEngine"/> + Adds one listener. - +

    - - - - addListener?<EventType extends keyof IMediaEngineEvent>( + + + + addListener?<EventType extends keyof IMediaEngineEvent>( eventType: EventType, listener: IMediaEngineEvent[EventType] ): void; - - addListener?<EventType extends keyof IMediaEngineEvent>( + + addListener?<EventType extends keyof IMediaEngineEvent>( eventType: EventType, listener: IMediaEngineEvent[EventType] ): void; - -

    + +

    Details -

    After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

    +

    After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

    Parameters eventType - The name of the target event to listen for. See . + The name of the target event to listen for. ensure the user ID is not set as 0. listener - The callback function for eventType. Take adding a listener for as an example:const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {}; + The callback function for eventType. Take adding a listener for as an example:const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {}; engine.addListener('onPlaybackAudioFrameBeforeMixing', onPlaybackAudioFrameBeforeMixing);
    -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita b/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita index 3b13ff2d16b..42f135d0268 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita @@ -1,12 +1,12 @@ - <ph keyref="createCustomAudioTrack" /> + <ph keyref="createCustomAudioTrack"/> Creates a custom audio track. - + @@ -27,9 +27,9 @@ trackType: AudioTrackType, config: AudioTrackConfig ): number;     - Future<int> createCustomAudioTrack( + Future<int> createCustomAudioTrack( {required AudioTrackType trackType, required AudioTrackConfig config}); -

    +

    Details @@ -41,8 +41,8 @@

    To publish a custom audio source to multiple channels, see the following steps:

    1. Call this method to create a custom audio track and get the audio track ID.
      2. -
    2. In of each channel, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
      3. -
    3. If you call , and specify trackId as the audio track ID set in step 2, you can publish the corresponding custom audio source in multiple channels.
      4. +
    4. In of each channel, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
      5. +
    5. If you call , and specify trackId as the audio track ID set in step 2, you can publish the corresponding custom audio source in multiple channels.

    @@ -50,11 +50,11 @@ trackType - The type of the custom audio track. See .If is specified for this parameter, you must set publishMicrophoneTrack to in when calling to join the channel; otherwise, joining the channel fails and returns the error code -2. + The type of the custom audio track. See .If is specified for this parameter, you must set publishMicrophoneTrack to in when calling to join the channel; otherwise, joining the channel fails and returns the error code -2. config - The configuration of the custom audio track. See . + The configuration of the custom audio track. ensure the user ID is not set as 0.
    @@ -64,4 +64,4 @@
  • If the method call fails, a negative value is returned.
- \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita index 5469badee5b..40e41a3a2dc 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita @@ -1,12 +1,12 @@ - <ph keyref="pushAudioFrame1" /> + <ph keyref="pushAudioFrame1"/> Pushes the external audio frame. - + @@ -18,19 +18,19 @@ samples:(NSInteger)samples sourceId:(NSInteger)sourceId timestamp:(NSTimeInterval)timestamp; - - - - - -

+ + + + + +

Parameters frame - The external audio frame. See . + The external audio frame. ensure the user ID is not set as 0. @@ -49,8 +49,8 @@ - - + +
@@ -62,4 +62,4 @@

- \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita index 0703133a029..247c07ff0ae 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita @@ -19,15 +19,15 @@ abstract pushAudioFrame(frame: AudioFrame, trackId?: number): number; public abstract int PushAudioFrame(AudioFrame frame, uint trackId = 0); abstract pushAudioFrame(frame: AudioFrame, trackId?: number): number; - Future<void> pushAudioFrame({required AudioFrame frame, int trackId = 0}); -

+ Future<void> pushAudioFrame({required AudioFrame frame, int trackId = 0}); +

Parameters frame - The external audio frame. See . + The external audio frame. ensure the user ID is not set as 0. trackId @@ -35,8 +35,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_imediaengine_pushencodedvideoimage.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita index b793186827a..d0d3fd84d70 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita @@ -1,12 +1,12 @@ - <ph keyref="pushEncodedVideoImage" /> + <ph keyref="pushEncodedVideoImage"/> Pushes the external encoded video frame to the SDK. - + @@ -16,7 +16,7 @@ public abstract int pushExternalEncodedVideoFrame( ByteBuffer data, EncodedVideoFrameInfo frameInfo); videoTrackId:(NSUInteger)videoTrackId; - + virtual int pushEncodedVideoImage(const uint8_t* imageBuffer, size_t length, const agora::rtc::EncodedVideoFrameInfo& videoEncodedFrameInfo) = 0; abstract pushEncodedVideoImage( @@ -32,16 +32,16 @@ videoEncodedFrameInfo: EncodedVideoFrameInfo, videoTrackId?: number ): number; - Future<void> pushEncodedVideoImage( + Future<void> pushEncodedVideoImage( {required Uint8List imageBuffer, required int length, required EncodedVideoFrameInfo videoEncodedFrameInfo, int videoTrackId = 0}); -

    +

Details -

After calling to enable external video source and set the sourceType parameter to , you can call this method to push the encoded external video frame to the SDK.

+

After calling to enable external video source and set the sourceType parameter to , you can call this method to push the encoded external video frame to the SDK.

Parameters @@ -58,19 +58,19 @@ frameInfo videoEncodedFrameInfo - Information about externally encoded video frames. See . + Information about externally encoded video frames. ensure the user ID is not set as 0. - - + +
- <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: Pushes the external encoded video frame to the SDK successfully.
  • < 0: Fails to push external encoded video frames to the SDK.
- \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita index 53ca8040171..86ff2ddfb4b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita @@ -25,20 +25,20 @@ frame: ExternalVideoFrame, videoTrackId?: number ): number; - Future<void> pushVideoFrame( + Future<void> pushVideoFrame( {required ExternalVideoFrame frame, int videoTrackId = 0}); -

+

Details
Deprecated:
-
If you need to push video frames in I422 format, you need to use this method; otherwise, use instead.
+
If you need to push video frames in I422 format, you need to use this method; otherwise, use instead.
-

If you call and set the enabled parameter as and the encodedFrame parameter as , you can call this method to push the external raw video frame to the SDK. If you call method to get the video track ID, set the customVideoTrackId parameter to the video track ID you want to publish in the of each channel, and set the publishCustomVideoTrack parameter to , you can call this method to push the unencoded external video frame to the SDK.

-

You can push the video frame either by calling this method or by calling . The difference is that the method does not support video data in texture format.

+

If you call and set the enabled parameter as and the encodedFrame parameter as , you can call this method to push the external raw video frame to the SDK. If you call method to get the video track ID, set the customVideoTrackId parameter to the video track ID you want to publish in the of each channel, and set the publishCustomVideoTrack parameter to , you can call this method to push the unencoded external video frame to the SDK.

+

You can push the video frame either by calling this method or by calling . The difference is that the method does not support video data in texture format.

Parameters @@ -46,24 +46,24 @@ frame -

The external raw video frame to be pushed. See .

+

The external raw video frame to be pushed. ensure the user ID is not set as 0.

 videoTrackId - The video track ID returned by calling the method. The default value is 0. + The video track ID returned by calling the method. The default value is 0.
- <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.
    -
  • : Pushes the external raw video frame to the SDK successfully.
    • -
  • : Fails to push external raw video frame to the SDK.
    • +
  • : Pushes the external raw video frame to the SDK successfully.
    • +
  • : Fails to push external raw video frame to the SDK.
- \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita index 04054be0dcc..d3d91fd486d 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="registerAudioFrameObserver" /> + <ph keyref="registerAudioFrameObserver"/> Registers an audio frame observer object. - + @@ -20,11 +20,11 @@ public abstract int RegisterAudioFrameObserver(IAudioFrameObserver audioFrameObserver, AUDIO_FRAME_POSITION position, OBSERVER_MODE mode = OBSERVER_MODE.INTPTR); abstract registerAudioFrameObserver(observer: IAudioFrameObserver): number; void registerAudioFrameObserver(AudioFrameObserver observer); -

+

Details -

Call this method to register an audio frame observer object (register a callback). When you need the SDK to trigger , , or callback, you need to use this method to register the callbacks.

+

Call this method to register an audio frame observer object (register a callback). When you need the SDK to trigger , , or callback, you need to use this method to register the callbacks.

Ensure that you call this method before joining a channel.
Parameters @@ -34,35 +34,35 @@ delegate audioFrameObserver -

The observer instance. See . Set the value as to release the instance. Agora recommends calling this method after receiving to release the audio observer object.

+

The observer instance. ensure the user ID is not set as 0. Set the value as to release the instance. Agora recommends calling this method after receiving to release the audio observer object.

 mode - The audio data callback mode. See . + The audio data callback mode. See . position The frame position of the audio observer.
    -
  • (0x0001): This position can observe the playback audio mixed by all remote users, corresponding to the callback.
    • -
  • (0x0002): This position can observe the collected local user's audio, corresponding to the callback.
    • -
  • (0x0004): This position can observe the playback audio mixed by the loacl user and all remote users, corresponding to the callback.
    • -
  • (0x0008): This position can observe the audio of a single remote user before mixing, corresponding to the callback.
    • -
  • (0x0010): This position can observe the in-ear monitoring audio of the local user, corresponding to the callback.
    • +
  • (0x0001): This position can observe the playback audio mixed by all remote users, corresponding to the callback.
    • +
  • (0x0002): This position can observe the collected local user's audio, corresponding to the callback.
    • +
  • (0x0004): This position can observe the playback audio mixed by the loacl user and all remote users, corresponding to the callback.
    • +
  • (0x0008): This position can observe the audio of a single remote user before mixing, corresponding to the callback.
    • +
  • (0x0010): This position can observe the in-ear monitoring audio of the local user, corresponding to the callback.
- <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_imediaengine_registervideoencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita index b306be33e53..9eab6c17254 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="registerVideoEncodedFrameObserver" /> + <ph keyref="registerVideoEncodedFrameObserver"/> Registers a receiver object for the encoded video image. - + @@ -25,18 +25,18 @@ observer: IVideoEncodedFrameObserver ): number; void registerVideoEncodedFrameObserver(VideoEncodedFrameObserver observer); -

+

Details -

If you only want to observe encoded video frames (such as h.264 format) without decoding and rendering the video, Agora recommends that you implement one class through this method.

+

If you only want to observe encoded video frames (such as h.264 format) without decoding and rendering the video, Agora recommends that you implement one class through this method.

If you want to obtain the original video data of some remote users (referred to as group A) and the encoded video data of other remote users (referred to as group B), you can refer to the following steps:

    -
  1. Call to register the raw video frame observer before joining the channel.
    2. -
  2. Call to register the encoded video frame observer before joining the channel.
    3. -
  3. After joining the channel, get the user IDs of group B users through , and then call to set the encodedFrameOnly of this group of users to .
    4. -
  4. Call () to start receiving the video streams of all remote users. Then:
      -
    • The raw video data of group A users can be obtained through the callback in , and the SDK renders the data by default.
      • -
    • The encoded video data of group B users can be obtained through the callback in .
      • +
    • Call to register the raw video frame observer before joining the channel.
      • +
    • Call to register the encoded video frame observer before joining the channel.
      • +
    • After joining the channel, get the user IDs of group B users through , and then call to set the encodedFrameOnly of this group of users to .
      • +
    • Call () to start receiving the video streams of all remote users. Then:
        +
      • The raw video data of group A users can be obtained through the callback in , and the SDK renders the data by default.
        • +
      • The encoded video data of group B users can be obtained through the callback in .

@@ -51,24 +51,24 @@ receiver observer videoEncodedImageReceiver - The video frame observer object. See . - The observer instance. See . Set the value as to release the instance. + The video frame observer object. See . + The observer instance. ensure the user ID is not set as 0. Set the value as to release the instance. mode - The video data callback mode. See . + The video data callback mode. 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_imediaengine_registervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita index 16157307ae7..7cb0d34e1a4 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita @@ -43,7 +43,7 @@ observer delegate videoFrameObserver - The observer instance. See . To release the instance, set the value as . + The observer instance. ensure the user ID is not set as 0. To release the instance, set the value as . mode @@ -55,7 +55,7 @@ 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. ensure the user ID is not set as 0.
diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita index 95ef3414e73..27d167dbb65 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita @@ -1,48 +1,48 @@ - <ph keyref="addListener_IMediaPlayer" /> - Adds one listener. + <ph keyref="addListener_IMediaPlayer"/> + Adds one listener. - +

- - - - addListener?<EventType extends keyof IMediaPlayerEvent>( + + + + addListener?<EventType extends keyof IMediaPlayerEvent>( eventType: EventType, listener: IMediaPlayerEvent[EventType] ): void; - - addListener?<EventType extends keyof IMediaPlayerEvent>( + + addListener?<EventType extends keyof IMediaPlayerEvent>( eventType: EventType, listener: IMediaPlayerEvent[EventType] ): void; -

+

Details -

After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

+

After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

Parameters eventType - The name of the target event to listen for. See . + The name of the target event to listen for. ensure the user ID is not set as 0. listener - The callback function for eventType. Take adding a listener for as an example:const onPlayerSourceStateChanged = (connection: RtcConnection, elapsed: number) => {}; + The callback function for eventType. Take adding a listener for as an example:const onPlayerSourceStateChanged = (connection: RtcConnection, elapsed: number) => {}; engine.addListener('onPlayerSourceStateChanged', onPlayerSourceStateChanged);
- \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita index 0d9e5196b84..ee2210feb91 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita @@ -45,17 +45,17 @@ provider - The callback for custom media resource files. See . + The callback for custom media resource files. ensure the user ID is not set as 0. onReadDataCallBack - Occurs when the SDK reads the media resource data. See . + Occurs when the SDK reads the media resource data. ensure the user ID is not set as 0. onSeekCallBack - Occurs when the SDK seeks the media resource data. See . + Occurs when the SDK seeks the media resource data. ensure the user ID is not set as 0.
diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita index 20c70a4db8b..6b0969cafa7 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="registerVideoFrameObserver_IMediaPlayer" /> + <ph keyref="registerVideoFrameObserver_IMediaPlayer"/> Registers a video frame observer object. - + @@ -14,7 +14,7 @@

int registerVideoFrameObserver(IMediaPlayerVideoFrameObserver videoFrameObserver); - + virtual int registerVideoFrameObserver(media::base::IVideoFrameObserver* observer) = 0; abstract registerVideoFrameObserver( observer: IMediaPlayerVideoFrameObserver @@ -24,11 +24,11 @@ observer: IMediaPlayerVideoFrameObserver ): number; void registerVideoFrameObserver(MediaPlayerVideoFrameObserver observer); -

+

Details -

You need to implement the class in this method and register callbacks according to your scenarios. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.

+

You need to implement the class in this method and register callbacks according to your scenarios. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.

Parameters @@ -36,16 +36,16 @@ videoFrameObserver observer - The video observer, reporting the reception of each video frame. See . - The video observer, reporting the reception of each video frame. See . + The video observer, reporting the reception of each video frame. ensure the user ID is not set as 0. + The video observer, reporting the reception of each video frame. ensure the user ID is not set as 0.
- <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_imediaplayer_setrendermode.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita index eb8402816d9..630de961ab5 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita @@ -22,7 +22,7 @@ public abstract int SetRenderMode(RENDER_MODE_TYPE renderMode); abstract setRenderMode(renderMode: RenderModeType): number; Future<void> setRenderMode(RenderModeType renderMode); -

+

Parameters @@ -31,7 +31,7 @@ renderMode mode -

Sets the render mode of the view. See .

+

Sets the render mode of the view. ensure the user ID is not set as 0.

Sets the render mode of the view:

@@ -39,8 +39,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_imediaplayer_setspatialaudioparams.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita index bf12669794b..393f1453968 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita @@ -20,7 +20,7 @@ public abstract int SetSpatialAudioParams(SpatialAudioParams spatial_audio_params); abstract setSpatialAudioParams(params: SpatialAudioParams): number; Future<void> setSpatialAudioParams(SpatialAudioParams params); -

    +

Details @@ -33,12 +33,12 @@ params spatial_audio_params - The spatial audio effect parameters of the media player. See . + The spatial audio effect parameters of the media player. ensure the user ID is not set as 0.
- <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_imediarecorder_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita index 2b1ac3a1891..727680ebc57 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita @@ -1,48 +1,48 @@ - <ph keyref="addListener_IMediaRecorder" /> - Adds one listener. + <ph keyref="addListener_IMediaRecorder"/> + Adds one listener. - +

    - - - - addListener?<EventType extends keyof IMediaRecorderEvent>( + + + + addListener?<EventType extends keyof IMediaRecorderEvent>( eventType: EventType, listener: IMediaRecorderEvent[EventType] ): void; - - addListener?<EventType extends keyof IMediaRecorderEvent>( + + addListener?<EventType extends keyof IMediaRecorderEvent>( eventType: EventType, listener: IMediaRecorderEvent[EventType] ): void; -

    +

    Details -

    After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

    +

    After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

    Parameters eventType - The name of the target event to listen for. See . + The name of the target event to listen for. ensure the user ID is not set as 0. listener - The callback function for eventType. Take adding a listener for as an example:const onRecorderStateChanged = (state: RecorderState, error: RecorderErrorCode) => {}; + The callback function for eventType. Take adding a listener for as an example:const onRecorderStateChanged = (state: RecorderState, error: RecorderErrorCode) => {}; engine.addListener('onRecorderStateChanged', onRecorderStateChanged);
    -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita index 59082338f2b..867b8b0e1db 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita @@ -1,12 +1,12 @@ - <ph keyref="startRecording" /> + <ph keyref="startRecording"/> Starts recording audio and video streams. - + @@ -19,15 +19,15 @@ abstract startRecording(config: MediaRecorderConfiguration): number; public abstract int StartRecording(MediaRecorderConfiguration config); abstract startRecording(config: MediaRecorderConfiguration): number; - Future<void> startRecording(MediaRecorderConfiguration config); -

    + Future<void> startRecording(MediaRecorderConfiguration config); +

Details

You can call this method to enable the recording function. Agora supports recording the media streams of local and remote users at the same time.

Before you call this method, ensure the following:

    -
  • The recording object is created through .
    • -
  • The recording observer is registered through .
    • +
  • The recording object is created through .
    • +
  • The recording observer is registered through .
  • You have joined the channel which the remote user that you want to record is in.

Supported formats of recording are listed as below:

    @@ -35,7 +35,7 @@
  • Video captured by a camera and encoded in H.264 or H.265.

Once the recording is started, if the video resolution is changed, the SDK stops the recording; if the sampling rate and audio channel changes, the SDK continues recording and generates audio files respectively.

-

The SDK can generate a recording file only when it detects audio and video streams; when there are no audio and video streams to be recorded or the audio and video streams are interrupted for more than five seconds, the SDK stops the recording and triggers the (, ) callback.

+

The SDK can generate a recording file only when it detects audio and video streams; when there are no audio and video streams to be recorded or the audio and video streams are interrupted for more than five seconds, the SDK stops the recording and triggers the (, ) callback.

    @@ -47,12 +47,12 @@ config - The recording configuration. See . + The recording configuration. ensure the user ID is not set as 0.
- <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.
      @@ -61,9 +61,9 @@
    • The specified format of the recording file is supported.
    • The maximum recording duration is correctly set.
    • -
  • -4: does not support the request. The recording is ongoing or the recording stops because an error occurs.
    • -
  • -7: The method is called before is initialized. Ensure the object is created before calling this method.
    • +
  • -4: does not support the request. The recording is ongoing or the recording stops because an error occurs.
    • +
  • -7: The method is called before is initialized. Ensure the object is created before calling this method.
- \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita b/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita index 814a1738ce8..c077046fc6f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita @@ -1,48 +1,48 @@ - <ph keyref="addListener" /> - Adds one listener. + <ph keyref="addListener"/> + Adds one listener. - +

- - - - addListener?<EventType extends keyof IRtcEngineEvent>( + + + + addListener?<EventType extends keyof IRtcEngineEvent>( eventType: EventType, listener: IRtcEngineEvent[EventType] ): void; - - addListener?<EventType extends keyof IRtcEngineEvent>( + + addListener?<EventType extends keyof IRtcEngineEvent>( eventType: EventType, listener: IRtcEngineEvent[EventType] ): void; -

+

Details -

After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

+

After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

Parameters eventType - The name of the target event to listen for. See . + The name of the target event to listen for. ensure the user ID is not set as 0. listener - The callback function for eventType. Take adding a listener for as an example:const onJoinChannelSuccess = (connection: RtcConnection, elapsed: number) => {}; + The callback function for eventType. Take adding a listener for as an example:const onJoinChannelSuccess = (connection: RtcConnection, elapsed: number) => {}; engine.addListener('onJoinChannelSuccess', onJoinChannelSuccess);
- \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita index 103d2b8703f..7b7df9031a6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita @@ -1,12 +1,12 @@ - <ph keyref="configRhythmPlayer" /> + <ph keyref="configRhythmPlayer"/> Configures the virtual metronome. - + @@ -19,28 +19,28 @@ abstract configRhythmPlayer(config: AgoraRhythmPlayerConfig): number; public abstract int ConfigRhythmPlayer(AgoraRhythmPlayerConfig config); abstract configRhythmPlayer(config: AgoraRhythmPlayerConfig): number; - Future<void> configRhythmPlayer(AgoraRhythmPlayerConfig config); -

+ Future<void> configRhythmPlayer(AgoraRhythmPlayerConfig config); +

Details -

After calling , you can call this method to reconfigure the virtual metronome.

-

After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.

-
+

After calling , you can call this method to reconfigure the virtual metronome.

+

After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.

+
Parameters config - The metronome configuration. See . + The metronome configuration. ensure the user ID is not set as 0.
- <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_createdatastream2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita index 557fe00caeb..fa1ab586255 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita @@ -23,7 +23,7 @@ int CreateDataStream(int& streamId, const FDataStreamConfig& config);public abstract int CreateDataStream(ref int streamId, DataStreamConfig config); abstract createDataStream(config: DataStreamConfig): number; Future<int> createDataStream(DataStreamConfig config); -

+

Details @@ -39,7 +39,7 @@ int CreateDataStream(int& streamId, const FDataStreamConfig& config); config - The configurations for the data stream. See . + The configurations for the data stream. ensure the user ID is not set as 0.
@@ -50,4 +50,4 @@ int CreateDataStream(int& streamId, const FDataStreamConfig& config);< 0: Failure.
- \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita index 2d78d204040..ce5f602840a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita @@ -1,12 +1,12 @@ - <ph keyref="enableContentInspect" /> + <ph keyref="enableContentInspect"/> Enables or disables video screenshot and upload. Enables or disables video content moderation. - + @@ -25,18 +25,18 @@ enabled: boolean, config: ContentInspectConfig ): number; - Future<void> enableContentInspect( + Future<void> enableContentInspect( {required bool enabled, required ContentInspectConfig config}); -

+

Details -

When video screenshot and upload function is enabled, the SDK takes screenshots and upload videos sent by local users based on the type and frequency of the module you set in . After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.

-

When video content moderation is enabled, the SDK takes screenshots, reviews the content, and uploads videos sent by local users based on the type and frequency of the content moderation module you set in . After content moderation, the Agora content moderation server sends the results to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.

+

When video screenshot and upload function is enabled, the SDK takes screenshots and upload videos sent by local users based on the type and frequency of the module you set in . After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.

+

When video content moderation is enabled, the SDK takes screenshots, reviews the content, and uploads videos sent by local users based on the type and frequency of the content moderation module you set in . After content moderation, the Agora content moderation server sends the results to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.

    -
  • Before calling this method, ensure that the video screenshot upload service has been activated. Before calling this method, ensure that Video content moderation service has been activated. See .
    • -
  • This method relies on the video screenshot and upload dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • +
  • Before calling this method, ensure that the video screenshot upload service has been activated. Before calling this method, ensure that Video content moderation service has been activated. ensure the user ID is not set as 0.
    • +
  • This method relies on the video screenshot and upload dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
Parameters @@ -44,21 +44,21 @@ enabled Whether to enable video screenshot and uploadvideo content moderation:
    -
  • : Enables video screenshot and upload. Enables video content moderation.
    • -
  • : Disables video screenshot and upload. Disables video content moderation.
    • +
  • : Enables video screenshot and upload. Enables video content moderation.
    • +
  • : Disables video screenshot and upload. Disables video content moderation.
 config - Configuration of video screenshot and upload. Configuration of video content moderation. See . + Configuration of video screenshot and upload. Configuration of video content moderation. ensure the user ID is not set as 0.
- <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_enabledualstreammode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita index 6541686f050..6258ab385fe 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita @@ -28,14 +28,14 @@ streamConfig?: SimulcastStreamConfig ): number; Future<void> enableDualStreamMode(bool enabled); -

+

Details
Deprecated:
-
This method is deprecated as of v4.2.0. Use instead.
+
This method is deprecated as of v4.2.0. Use instead.

You can call this method to enable or disable the dual-stream mode on the publisher side. Dual streams are a pairing of a high-quality video stream and a low-quality video stream:

    @@ -46,7 +46,7 @@
    • This method is applicable to all types of streams from the sender, including but not limited to video streams collected from cameras, screen sharing streams, and custom-collected video streams.
      • -
    • If you need to enable dual video streams in a multi-channel scenario, you can call the method.
      • +
    • If you need to enable dual video streams in a multi-channel scenario, you can call the method.
    • You can call this method either before or after joining a channel.
@@ -55,7 +55,7 @@ sourceType -

The type of the video source. See .

+

The type of the video source. ensure the user ID is not set as 0.

 diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita index 3ec4f85ba92..18e4e67f8fe 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita @@ -1,12 +1,12 @@ - <ph keyref="enableDualStreamMode3" /> + <ph keyref="enableDualStreamMode3"/> Enables or disables the dual-stream mode on the sender and sets the low-quality video stream. - + @@ -28,11 +28,11 @@ int EnableDualStreamMode(bool enabled, const FSimulcastStreamConfig& streamC enabled: boolean, streamConfig?: SimulcastStreamConfig ): number; - Future<void> enableDualStreamMode( + Future<void> enableDualStreamMode( {required bool enabled, SimulcastStreamConfig? streamConfig}); -

+

-
+
Parameters @@ -40,24 +40,24 @@ int EnableDualStreamMode(bool enabled, const FSimulcastStreamConfig& streamC enabled

Whether to enable dual-stream mode:

    -
  • : Enable dual-stream mode.
    • -
  • : (Default) Disable dual-stream mode.
    • +
  • : Enable dual-stream mode.
    • +
  • : (Default) Disable dual-stream mode.

 streamConfig -

The configuration of the low-quality video stream. See .

+

The configuration of the low-quality video stream. ensure the user ID is not set as 0.
- <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_enableencryption.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita index dc49fd314a6..58d14eba5b3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita @@ -21,7 +21,7 @@ abstract enableEncryption(enabled: boolean, config: EncryptionConfig): number; Future<void> enableEncryption( {required bool enabled, required EncryptionConfig config}); -

+

Details @@ -42,12 +42,12 @@ config - Built-in encryption configurations. See . + Built-in encryption configurations. ensure the user ID is not set as 0.
- <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_enableinearmonitoring2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita index bdf340e976e..3b09e882eb3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita @@ -1,12 +1,12 @@ - <ph keyref="enableInEarMonitoring2" /> + <ph keyref="enableInEarMonitoring2"/> Enables in-ear monitoring. - + @@ -25,10 +25,10 @@ enabled: boolean, includeAudioFilters: EarMonitoringFilterType ): number; - Future<void> enableInEarMonitoring( + Future<void> enableInEarMonitoring( {required bool enabled, required EarMonitoringFilterType includeAudioFilters}); -

      +

Details @@ -44,28 +44,28 @@ enabled Enables or disables in-ear monitoring.
    -
  • : Enables in-ear monitoring.
    • -
  • : (Default) Disables in-ear monitoring.
    • +
  • : Enables in-ear monitoring.
    • +
  • : (Default) Disables in-ear monitoring.
 includeAudioFilters - The audio filter of in-ear monitoring: See . + The audio filter of in-ear monitoring: ensure the user ID is not set as 0. The audio filter of in-ear monitoring:
    -
  • (1 << 0): Do not add an audio filter to the in-ear monitor.
    • -
  • (1 << 1): Add an audio filter to the in-ear monitor. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.
    • -
  • (1 << 2): Enable noise suppression to the in-ear monitor.

    You can use the bitwise or operator (|) to specify multiple audio filters.If you set the enabled parameter to , you do not need to set the includeAudioFilters parameter.

    +
  • (1 << 0): Do not add an audio filter to the in-ear monitor.
    • +
  • (1 << 1): Add an audio filter to the in-ear monitor. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.
    • +
  • (1 << 2): Enable noise suppression to the in-ear monitor.

    You can use the bitwise or operator (|) to specify multiple audio filters.If you set the enabled parameter to , you do not need to set the includeAudioFilters parameter.
- <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.
    • - 8: Make sure the current audio routing is Bluetooth or headset.
- \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita index 62e4d17f881..6e24156200c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita @@ -1,19 +1,19 @@ - <ph keyref="enableMultiCamera" /> + <ph keyref="enableMultiCamera"/> Enables or disables multi-camera capture. - +

- + - (int)enableMultiCamera:(BOOL)enabled config:(AgoraCameraCapturerConfiguration* _Nullable)config NS_SWIFT_NAME(enableMultiCamera(_:config:)); #if defined(__APPLE__) && TARGET_OS_IOS virtual int enableMultiCamera(bool enabled, const CameraCapturerConfiguration& config) = 0; @@ -27,9 +27,9 @@ enabled: boolean, config: CameraCapturerConfiguration ): number; - Future<void> enableMultiCamera( + Future<void> enableMultiCamera( {required bool enabled, required CameraCapturerConfiguration config}); -

+

Details @@ -41,18 +41,18 @@

In scenarios where there are existing cameras to capture video, Agora recommends that you use the following steps to capture and publish video with multiple cameras:

  1. Call this method to enable multi-channel camera capture.
    2. -
  2. Call to start the local video preview.
    3. -
  3. Call , and set sourceType to start video capture with the second camera.
    4. -
  4. Call , and set publishSecondaryCameraTrack to to publish the video stream captured by the second camera in the channel.
    5. +
  5. Call to start the local video preview.
    6. +
  6. Call , and set sourceType to start video capture with the second camera.
    7. +
  7. Call , and set publishSecondaryCameraTrack to to publish the video stream captured by the second camera in the channel.

If you want to disable multi-channel camera capture, use the following steps:

    -
  1. Call .
    2. -
  2. Call this method with enabled set to .
    3. +
  3. Call .
    4. +
  4. Call this method with enabled set to .

-

You can call this method before and after to enable multi-camera capture:

    -
  • If it is enabled before , the local video preview shows the image captured by the two cameras at the same time.
    • -
  • If it is enabled after , the SDK stops the current camera capture first, and then enables the primary camera and the second camera. The local video preview appears black for a short time, and then automatically returns to normal.
    • +

    You can call this method before and after to enable multi-camera capture:

      +
    • If it is enabled before , the local video preview shows the image captured by the two cameras at the same time.
      • +
    • If it is enabled after , the SDK stops the current camera capture first, and then enables the primary camera and the second camera. The local video preview appears black for a short time, and then automatically returns to normal.

    This method applies to iOS only.

    @@ -70,22 +70,22 @@ enabled Whether to enable multi-camera video capture mode:
      -
    • : Enable multi-camera capture mode; the SDK uses multiple cameras to capture video.
      • -
    • : Disable multi-camera capture mode; the SDK uses a single camera to capture video.
      • +
    • : Enable multi-camera capture mode; the SDK uses multiple cameras to capture video.
      • +
    • : Disable multi-camera capture mode; the SDK uses a single camera to capture video.
         config - Capture configuration for the second camera. See . + Capture configuration for the second camera. ensure the user ID is not set as 0.
- <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_enablevirtualbackground.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita index 4065b4eb383..17ae9c3e78b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita @@ -1,12 +1,12 @@ - <ph keyref="enableVirtualBackground" /> + <ph keyref="enableVirtualBackground"/> Enables/Disables the virtual background. - + @@ -32,17 +32,17 @@ segproperty: SegmentationProperty, type?: MediaSourceType ): number; - Future<void> enableVirtualBackground( + Future<void> enableVirtualBackground( {required bool enabled, required VirtualBackgroundSource backgroundSource, required SegmentationProperty segproperty, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

+

Details

The virtual background feature enables the local user to replace their original background with a static image, dynamic video, blurred background, or portrait-background segmentation to achieve picture-in-picture effect. Once the virtual background feature is enabled, all users in the channel can see the custom background.

-

Call this method before calling or .

+

Call this method before calling or .

  • This feature requires high performance devices. Agora recommends that you implement it on devices equipped with the following chips:
      @@ -64,7 +64,7 @@
    • A high-definition camera device is used, and the environment is uniformly lit.
    • There are few objects in the captured video. Portraits are half-length and unobstructed. Ensure that the background is a solid color that is different from the color of the user's clothing.
    • -
  • This method relies on the virtual background dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • +
  • This method relies on the virtual background dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
Parameters @@ -73,38 +73,38 @@ enabled enable Whether to enable virtual background:
    -
  • : Enable virtual background.
    • -
  • : Disable virtual background.
    • +
  • : Enable virtual background.
    • +
  • : Disable virtual background.
 backgroundSource backData - The custom background. See . To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted. + The custom background. ensure the user ID is not set as 0. To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted. segproperty segData - Processing properties for background images. See . + Processing properties for background images. ensure the user ID is not set as 0. type - The type of the video source. See .In this method, this parameter supports only the following two settings:
    -
  • The default value is .
    • -
  • If you want to use the second camera to capture video, set this parameter to .
    • + The type of the video source. See .In this method, this parameter supports only the following two settings:
      +
    • The default value is .
      • +
    • If you want to use the second camera to capture video, set this parameter to .
- <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.
      -
    • -1: The custom background image does not exist. Check the value of source in .
      • -
    • -2: The color format of the custom background image is invalid. Check the value of color in .
      • +
    • -1: The custom background image does not exist. Check the value of source in .
      • +
    • -2: The color format of the custom background image is invalid. Check the value of color in .
    • -3: The device does not support virtual background.
- \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita index 87e9999d393..deeb4892323 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita @@ -1,12 +1,12 @@ - <ph keyref="getExtensionProperty2" /> + <ph keyref="getExtensionProperty2"/> Gets detailed information on the extensions. - + @@ -42,17 +42,17 @@ int GetExtensionProperty(FString provider, FString extension, FString key, FStri bufLen: number, type?: MediaSourceType ): string; - Future<String> getExtensionProperty( + Future<String> getExtensionProperty( {required String provider, required String extension, required String key, required int bufLen, MediaSourceType type = MediaSourceType.unknownMediaSource}); -

+

Details -

+

Parameters @@ -79,7 +79,7 @@ int GetExtensionProperty(FString provider, FString extension, FString key, FStri sourceType type - Source type of the extension. See . + Source type of the extension. ensure the user ID is not set as 0. buf_len @@ -98,4 +98,4 @@ int GetExtensionProperty(FString provider, FString extension, FString key, FStri
  • An empty string, if the method call fails.
    • - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita index 74fc1ddc9a0..907b5d89e10 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita @@ -32,7 +32,7 @@ {required Size thumbSize, required Size iconSize, required bool includeScreen});     -

    +

    Details @@ -44,11 +44,11 @@ thumbSize - The target size of the screen or window thumbnail (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and thumbSize is 100 × 100, the actual size of the thumbnail is 100 × 75. If the target size is larger than the original size, the thumbnail is the original image and the SDK does not scale it. + The target size of the screen or window thumbnail (the width and height are in pixels). ensure the user ID is not set as 0. The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and thumbSize is 100 × 100, the actual size of the thumbnail is 100 × 75. If the target size is larger than the original size, the thumbnail is the original image and the SDK does not scale it. iconSize - The target size of the icon corresponding to the application program (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and iconSize is 100 × 100, the actual size of the icon is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it. + The target size of the icon corresponding to the application program (the width and height are in pixels). ensure the user ID is not set as 0. The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and iconSize is 100 × 100, the actual size of the icon is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it. includeScreen @@ -64,4 +64,4 @@

    The array.

    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita b/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita index 85588b693ac..5d00c225d3c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita @@ -1,12 +1,12 @@ - <ph keyref="initialize" /> - Creates and initializes . Initializes . + <ph keyref="initialize"/> + Creates and initializes . Initializes . - + @@ -24,17 +24,17 @@ int Initialize(const FRtcEngineContext& context);     public abstract int Initialize(RtcEngineContext context); abstract initialize(context: RtcEngineContext): number; Future<void> initialize(RtcEngineContext context); -

    +

    Details -

    All called methods provided by the class are executed asynchronously. Agora recommends calling these methods in the same thread.

    +

    All called methods provided by the class are executed asynchronously. Agora recommends calling these methods in the same thread.

      -
    • Before calling other APIs, you must call and to create and initialize the object.
      • -
    • Before calling other APIs, you must call this method to create the object.
      • -
    • You can create the instance either by calling this method or by calling . The difference between and this method is that this method supports more configurations when creating the instance, for example, specifying the region for connection and setting the log files.
      • -
    • The SDK supports creating only one instance for an app.
      • +
    • Before calling other APIs, you must call and to create and initialize the object.
      • +
    • Before calling other APIs, you must call this method to create the object.
      • +
    • You can create the instance either by calling this method or by calling . The difference between and this method is that this method supports more configurations when creating the instance, for example, specifying the region for connection and setting the log files.
      • +
    • The SDK supports creating only one instance for an app.
    Parameters @@ -43,19 +43,19 @@ int Initialize(const FRtcEngineContext& context); context config -

    Configurations for the instance. See .

    +

    Configurations for the instance. ensure the user ID is not set as 0.

     delegate - +
    - <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.

      -
    • The instance, if the method call succeeds.
      • +
    • The instance, if the method call succeeds.
    • 0: Success.
    • The method call fails and an exception is thrown, you need to catch the exception and handle it.
    • < 0: Failure.
        @@ -66,6 +66,6 @@ int Initialize(const FRtcEngineContext& context);
      • -101: The App ID is invalid.
    -
    +
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita index 32784eff09f..dd42a7ccdab 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita @@ -85,7 +85,7 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia options mediaOptions - The channel media options. See . + The channel media options. ensure the user ID is not set as 0. joinSuccessBlock diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita index ab5af097601..86ac4fdb4b5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita @@ -53,7 +53,7 @@ token The token generated on your server for authentication. See .

    When the token for preloading channels expires, you can update the token based on the number of channels you preload.

    • When preloading one channel, calling this method to pass in the new token.
      • -
    • When preloading more than one channels:
      • If you use a wildcard token for all preloaded channels, call to update the token.生成通配 Token 时，用户 ID 不得设为 0。 See .
        • +
      • When preloading more than one channels:
        • If you use a wildcard token for all preloaded channels, call to update the token.When generating a wildcard token, ensure the user ID is not set as 0.
        • If you use different tokens to preload different channels, call this method to pass in your user ID, channel name and the new token.

      diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita index 824add4a204..1c0b37506cf 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita @@ -20,7 +20,7 @@ abstract pushReverseAudioFrame(frame: AudioFrame): number; Future<void> pushReverseAudioFrame(AudioFrame frame); -

      +

    Details @@ -32,7 +32,7 @@ frame audioFrame - The external audio frame. See . + The external audio frame. ensure the user ID is not set as 0. data @@ -44,8 +44,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_pushvideoframe2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita index 522511a99b2..6c0af3550b1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita @@ -1,12 +1,12 @@ - <ph keyref="pushVideoFrame2" /> + <ph keyref="pushVideoFrame2"/> Pushes the external video frame. - + @@ -14,32 +14,32 @@

      public abstract boolean pushExternalVideoFrame(VideoFrame frame); - - - - - - -

      + + + + + + +

      Details -

      This method actively encapsulates the video frame data with the class and passes it to the SDK. Call the method and set enable as before calling this method; otherwise, a failure returns after calling this method.

      -

      You can push the video frame either by calling this method or by calling . The difference is that the method supports video data in texture format.

      +

      This method actively encapsulates the video frame data with the class and passes it to the SDK. Call the method and set enable as before calling this method; otherwise, a failure returns after calling this method.

      +

      You can push the video frame either by calling this method or by calling . The difference is that the method supports video data in texture format.

      Parameters frame - Video frame to be pushed. See . + Video frame to be pushed. ensure the user ID is not set as 0.
      Returns
        -
      • : Pushes the external raw video frame to the SDK successfully.
        • -
      • : Fails to push external raw video frame to the SDK.
        • +
      • : Pushes the external raw video frame to the SDK successfully.
        • +
      • : Fails to push external raw video frame to the SDK.
      -       \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita b/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita index 1f04f986931..08373156818 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita @@ -1,12 +1,12 @@ - <ph keyref="queryCodecCapability" /> + <ph keyref="queryCodecCapability"/> Queries the current device's supported video codec capabilities. - + @@ -14,13 +14,13 @@

      public abstract CodecCapInfo[] queryCodecCapability(); - - (NSArray <AgoraVideoCodecCapInfo *> *__nullable)queryCodecCapability; + - (NSArray <AgoraVideoCodecCapInfo *> *__nullable)queryCodecCapability; virtual int queryCodecCapability(CodecCapInfo* codecInfo, int& size) = 0; abstract queryCodecCapability(): { codecInfo: CodecCapInfo[]; size: number }; public abstract int QueryCodecCapability(ref CodecCapInfo[] codecInfo, ref int size); abstract queryCodecCapability(): { codecInfo: CodecCapInfo[]; size: number }; - Future<List<CodecCapInfo>> queryCodecCapability(int size);

      + Future<List<CodecCapInfo>> queryCodecCapability(int size);

      Details @@ -30,7 +30,7 @@
      v4.2.0
      -

      +

      Parameters @@ -38,28 +38,28 @@ codecInfo -

      Input and output parameter. An array representing the video codec capabilities of the device. See .

      +

      Input and output parameter. An array representing the video codec capabilities of the device. ensure the user ID is not set as 0.

        -
      • Input value: One defined by the user when executing this method, representing the video codec capability to be queried.
        • -
      • Output value: The after the method is executed, representing the actual video codec capabilities supported by the device.
        • +
      • Input value: One defined by the user when executing this method, representing the video codec capability to be queried.
        • +
      • Output value: The after the method is executed, representing the actual video codec capabilities supported by the device.
             size - Input and output parameter, represent the size of the array.
        -
      • Input value: Size of the defined by the user when executing the method.
        • -
      • Output value: Size of the output after this method is executed.
        • + Input and output parameter, represent the size of the array.
          +
        • Input value: Size of the defined by the user when executing the method.
          • +
        • Output value: Size of the output after this method is executed.
         - The size of . + The size of .
      Returns
      • If the call is successful, an object containing the following attributes is returned:
          -
        • codecInfo: The array, indicating the video codec capabillity of the device.
          • -
        • size: The size of the array.
        • +
      • codecInfo: The array, indicating the video codec capabillity of the device.
        • +
      • size: The size of the array.
    • If the call timeouts, please modify the call logic and do not invoke the method in the main thread.
      @@ -67,8 +67,8 @@
    • < 0: Failure.
      -
    • One array indicating the video encoding capability of the device, if the method call succeeds.
      • +
    • One array indicating the video encoding capability of the device, if the method call succeeds.
    • If the call timeouts, please modify the call logic and do not invoke the method in the main thread.
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita b/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita index d82275073b5..ba1fcea0601 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita @@ -1,12 +1,12 @@ - <ph keyref="queryScreenCaptureCapability" /> + <ph keyref="queryScreenCaptureCapability"/> Queries the highest frame rate supported by the device during screen sharing. - + @@ -18,10 +18,10 @@ #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) virtual int queryScreenCaptureCapability() = 0; #endif - + public abstract int QueryScreenCaptureCapability(); abstract queryScreenCaptureCapability(): number; - Future<int> queryScreenCaptureCapability();

    + Future<int> queryScreenCaptureCapability();

    Details @@ -31,7 +31,7 @@
    v4.2.0
    -

    +

    Applicable scenarios @@ -39,15 +39,15 @@

    To ensure optimal screen sharing performance, particularly in enabling high frame rates like 60 fps, Agora recommends you to query the device's maximum supported frame rate using this method beforehand. This way, if the device cannot support such a high frame rate, you can adjust the screen sharing stream accordingly to avoid any negative impact on the sharing quality. If the device does not support high frame rate, you can reduce the frame rate of the screen sharing stream appropriately when sharing the screen to ensure that the sharing effect meets your expectation.

    - <ph keyref="return-section-title" /> -
    • The highest frame rate supported by the device, if the method is called successfully. See .
      • -
    • If the call fails, returns .
    + <ph keyref="return-section-title"/> +
    • The highest frame rate supported by the device, if the method is called successfully. ensure the user ID is not set as 0.
      • +
    • If the call fails, returns .
      -
    • The highest frame rate supported by the device, if the method is called successfully. See .
        +
      • The highest frame rate supported by the device, if the method is called successfully. See .
        • 0: The device supports the frame rate of up to 15 fps.
        • 1: The device supports the frame rate of up to 30 fps.
        • 2: The device supports the frame rate of up to 60 fps.
      • < 0: Failure.
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita index 99c0d265deb..d75184bb278 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita @@ -30,7 +30,7 @@ void registerAudioEncodedFrameObserver( {required AudioEncodedFrameObserverConfig config, required AudioEncodedFrameObserver observer}); -

    +

    Details @@ -46,23 +46,23 @@ config - Observer settings for the encoded audio. See . + Observer settings for the encoded audio. ensure the user ID is not set as 0. observer delegate - The encoded audio observer. See . + The encoded audio observer. ensure the user ID is not set as 0.
    - <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.
    -

    One object.

    +

    One object.

    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita index 4ae53df7967..e0452ab4046 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita @@ -25,7 +25,7 @@ observer: IAudioSpectrumObserver ): number;     void registerAudioSpectrumObserver(AudioSpectrumObserver observer); -

    +

    Details @@ -39,18 +39,18 @@ observer delegate -

    The audio spectrum observer. See .

    +

    The audio spectrum observer. ensure the user ID is not set as 0.
    - <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.
    -

    One object.

    +

    One object.

    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita index 38e4f83a975..287497497c8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita @@ -28,7 +28,7 @@ ): number;     void registerMediaMetadataObserver( {required MetadataObserver observer, required MetadataType type}); -

    +

    Details @@ -41,22 +41,22 @@ observer - The metadata observer. See . + The metadata observer. ensure the user ID is not set as 0. type -

    The metadata type. The SDK currently only supports . See .

    +

    The metadata type. The SDK currently only supports . ensure the user ID is not set as 0.
    - <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_removehandler.dita b/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita index 153eb373a2d..665207ae06f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita @@ -24,7 +24,7 @@ eventHandler: IRtcEngineEventHandler ): boolean;     void unregisterEventHandler(RtcEngineEventHandler eventHandler); -

    +

    Details @@ -36,12 +36,12 @@ handler eventHandler - The callback handler to be deleted. See . + The callback handler to be deleted. ensure the user ID is not set as 0.
    - <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.

    • : Success.
    • : Failure.
      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita b/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita index 3a7b760620e..16b1dadd04b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita @@ -21,7 +21,7 @@ abstract sendMetaData(metadata: Metadata, sourceType: VideoSourceType): number; Future<void> sendMetaData( {required Metadata metadata, required VideoSourceType sourceType}); -

      +

    Details @@ -33,20 +33,20 @@ metadata - Media metadata See . + Media metadata ensure the user ID is not set as 0. sourceType source_type - The type of the video source. See . + The type of the video source. 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.
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita index cbfbc0ade95..b0bc89fdfcc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita @@ -19,8 +19,8 @@ abstract setAdvancedAudioOptions(options: AdvancedAudioOptions): number; public abstract int SetAdvancedAudioOptions(AdvancedAudioOptions options); abstract setAdvancedAudioOptions(options: AdvancedAudioOptions): number; - Future<void> setAdvancedAudioOptions(AdvancedAudioOptions options); -

    + Future<void> setAdvancedAudioOptions(AdvancedAudioOptions options); +

    Details @@ -31,12 +31,12 @@ options - The advanced options for audio. See . + The advanced options for audio. ensure the user ID is not set as 0.
    - <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_setaudiomixingdualmonomode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita index 8b48be63691..5445e189db4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita @@ -20,7 +20,7 @@ public abstract int SetAudioMixingDualMonoMode(AUDIO_MIXING_DUAL_MONO_MODE mode); abstract setAudioMixingDualMonoMode(mode: AudioMixingDualMonoMode): number; Future<void> setAudioMixingDualMonoMode(AudioMixingDualMonoMode mode); -

      +

    Details @@ -35,15 +35,15 @@ mode - The channel mode. See . + The channel mode. ensure the user ID is not set as 0.
    - <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..6ff0aff1de1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita @@ -38,7 +38,7 @@ profile -

    The channel profile. See .

    +

    The channel profile. ensure the user ID is not set as 0.

    The channel profile.

    • (0): Communication. Use this profile when there are only two users in the channel.
    • (1): Live streaming. Use this profile when there are more than two users in the channel.
      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita index 59ee4bf4bbd..580186577ff 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita @@ -30,7 +30,7 @@
      Details

      You can call this method either before or after joining the channel to set the user role as audience or host.

      -

      +

      If you call this method to switch the user role after joining the channel, the SDK triggers the following callbacks:

      • The local client: .
      • The remote client: or ().
        • @@ -42,7 +42,7 @@ role -

        The user role. See .

        +

        The user role. ensure the user ID is not set as 0.

        The user role:

        • (1): Host.
        • (2): Audience.
          • @@ -62,4 +62,4 @@
      - \ No newline at end of file + 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..cc7587fa136 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita @@ -59,7 +59,7 @@ int SetClientRole(ECLIENT_ROLE_TYPE clientroletype, const FClientRoleOptions& options - The detailed options of a user, including the user level. See . + The detailed options of a user, including the user level. ensure the user ID is not set as 0.
      diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita index d826cfe52e6..34a942f6dbb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita @@ -30,11 +30,11 @@ options: ColorEnhanceOptions, type?: MediaSourceType ): number; - Future<void> setColorEnhanceOptions( + Future<void> setColorEnhanceOptions( {required bool enabled, required ColorEnhanceOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

      +

      Details @@ -48,7 +48,7 @@
    • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
    • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
    -
  • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • +
  • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • Parameters @@ -63,19 +63,19 @@ options - The color enhancement options. See . + The color enhancement options. ensure the user ID is not set as 0. - - + +
    - <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_setdualstreammode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita index 524130cf3a5..bd0ea2ab444 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita @@ -1,12 +1,12 @@ - <ph keyref="setDualStreamMode" /> + <ph keyref="setDualStreamMode"/> Sets the dual-stream mode on the sender side. - + @@ -16,11 +16,11 @@ public abstract int setDualStreamMode(Constants.SimulcastStreamMode mode); - (int)setDualStreamMode:(AgoraSimulcastStreamMode)mode; virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode) = 0; - + public abstract int SetDualStreamMode(SIMULCAST_STREAM_MODE mode); - - -

    + + +

    Details
    @@ -29,12 +29,12 @@
    v4.0.1
    -

    The SDK enables the low-quality video stream auto mode on the sender side by default (it does not actively sending low-quality video streams). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling . After receiving the application, the sending end automatically switches to the low-quality video stream mode.

      -
    • If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).
      • -
    • If you want to restore the default behavior after making changes, you can call this method again with mode set to .

    - The difference and connection between this method and is as follows:
      -
    • When calling this method and setting mode to , it has the same effect as ().
      • -
    • When calling this method and setting mode to , it has the same effect as ().
      • +

      The SDK enables the low-quality video stream auto mode on the sender side by default (it does not actively sending low-quality video streams). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling . After receiving the application, the sending end automatically switches to the low-quality video stream mode.

        +
      • If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).
        • +
      • If you want to restore the default behavior after making changes, you can call this method again with mode set to .

      + The difference and connection between this method and is as follows:
        +
      • When calling this method and setting mode to , it has the same effect as ().
        • +
      • When calling this method and setting mode to , it has the same effect as ().
      • Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
    @@ -43,7 +43,7 @@ mode - The mode in which the video stream is sent. See . + The mode in which the video stream is sent. ensure the user ID is not set as 0.
    @@ -54,4 +54,4 @@
    -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita index 52fa0d2692b..967c4a972ac 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita @@ -1,12 +1,12 @@ - <ph keyref="setDualStreamMode2" /> + <ph keyref="setDualStreamMode2"/> Sets dual-stream mode configuration on the sender, and sets the low-quality video stream. - + @@ -30,9 +30,9 @@ int SetDualStreamMode(ESIMULCAST_STREAM_MODE mode, const FSimulcastStreamConfig& mode: SimulcastStreamMode, streamConfig?: SimulcastStreamConfig ): number;     - Future<void> setDualStreamMode( + Future<void> setDualStreamMode( {required SimulcastStreamMode mode, SimulcastStreamConfig? streamConfig}); -

    +

    Details @@ -42,11 +42,11 @@ int SetDualStreamMode(ESIMULCAST_STREAM_MODE mode, const FSimulcastStreamConfig&
    v4.0.1
    -

    -

    The difference between this method and is that this method can also configure the low-quality video stream, and the SDK sends the stream according to the configuration in streamConfig.

    - The difference and connection between this method and is as follows:
      -
    • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
      • -
    • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
      • +

      +

      The difference between this method and is that this method can also configure the low-quality video stream, and the SDK sends the stream according to the configuration in streamConfig.

      + The difference and connection between this method and is as follows:
        +
      • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
        • +
      • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
      • Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
    @@ -55,22 +55,22 @@ int SetDualStreamMode(ESIMULCAST_STREAM_MODE mode, const FSimulcastStreamConfig& mode - The mode in which the video stream is sent. See . + The mode in which the video stream is sent. ensure the user ID is not set as 0. streamConfig -

    The configuration of the low-quality video stream. See .

    - When setting mode to , setting streamConfig will not take effect. +

    The configuration of the low-quality video stream. ensure the user ID is not set as 0.

    + When setting mode to , setting streamConfig will not take effect.
    - <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_setexternalaudiosourcevolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita index 03cd3c98c8a..69ff33a5a3e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita @@ -1,26 +1,26 @@ - <ph keyref="setExternalAudioSourceVolume" /> + <ph keyref="setExternalAudioSourceVolume"/> Sets the volume of the external audio frame in the specified position. - +

    - - - - + + + + public abstract int SetExternalAudioSourceVolume(int sourcePos, int volume); - - -

    + + +

    Details @@ -31,7 +31,7 @@ sourcePos - The push position of the external audio frame. See . + The push position of the external audio frame. ensure the user ID is not set as 0. The push position of the external audio frame.
    • 0: The position before local playback. If you need to play the external audio frame on the local client, set this position.
    • 1: The position after audio capture and before audio pre-processing. If you need the audio module of the SDK to process the external audio frame, set this position.
      • @@ -50,4 +50,4 @@
    • < 0: Failure.
     -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita index 3044e7e5387..bd4919ab4fe 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita @@ -1,12 +1,12 @@ - <ph keyref="setHeadphoneEQPreset" /> + <ph keyref="setHeadphoneEQPreset"/> Sets the preset headphone equalization effect. - + @@ -19,8 +19,8 @@ abstract setHeadphoneEQPreset(preset: HeadphoneEqualizerPreset): number; public abstract int SetHeadphoneEQPreset(HEADPHONE_EQUALIZER_PRESET preset); abstract setHeadphoneEQPreset(preset: HeadphoneEqualizerPreset): number; - Future<void> setHeadphoneEQPreset(HeadphoneEqualizerPreset preset); -

    + Future<void> setHeadphoneEQPreset(HeadphoneEqualizerPreset preset); +

    Details @@ -37,12 +37,12 @@ preset - The preset headphone equalization effect. See . + The preset headphone equalization effect. ensure the user ID is not set as 0.
    - <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.
        @@ -50,4 +50,4 @@
    -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita index c3480cc62cb..594b10c4da4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita @@ -20,7 +20,7 @@ public abstract int SetLiveTranscoding(LiveTranscoding transcoding); abstract setLiveTranscoding(transcoding: LiveTranscoding): number; Future<void> setLiveTranscoding(LiveTranscoding transcoding); -

    +

    Details @@ -44,13 +44,13 @@ transcoding -

    The transcoding configurations for the media push. See .

    +

    The transcoding configurations for the media push. ensure the user ID is not set as 0.
    - <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_setlocalaccesspoint.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita index 16099dadaa3..17d4f14447d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita @@ -20,7 +20,7 @@ public abstract int SetLocalAccessPoint(LocalAccessPointConfiguration config); abstract setLocalAccessPoint(config: LocalAccessPointConfiguration): number; Future<void> setLocalAccessPoint(LocalAccessPointConfiguration config); -

      +

    Details @@ -35,15 +35,15 @@ config - The configurations of the Local Access Point. See . + The configurations of the Local Access Point. ensure the user ID is not set as 0.
    - <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_setlocalpublishfallbackoption.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita index 00f11d92787..9882ea0a715 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita @@ -20,7 +20,7 @@ public abstract int SetLocalPublishFallbackOption(STREAM_FALLBACK_OPTIONS option); Future<void> setLocalPublishFallbackOption(StreamFallbackOptions option); -

    +

    Details @@ -35,7 +35,7 @@ option - The stream fallback option. See . + The stream fallback option. ensure the user ID is not set as 0. The stream fallback option.
    • (0): (Default) No fallback behavior for the published video stream when the uplink network condition is poor. The stream quality is not guaranteed.
    • (2): The published video stream falls back to audio only when the uplink network condition is poor.
      • @@ -43,8 +43,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_setlocalrendermode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita index f63c0d5634d..3e132741702 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita @@ -27,7 +27,7 @@ mirrorMode?: VideoMirrorModeType ): number; Future<void> setLocalRenderMode2(RenderModeType renderMode); -

      +

    Details @@ -46,7 +46,7 @@ renderMode mode -

    The local video display mode. See .

    +

    The local video display mode. ensure the user ID is not set as 0.

    The local video display mode.

    @@ -58,8 +58,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..c9ab5c0f65e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita @@ -49,7 +49,7 @@ int SetLocalRenderMode(ERENDER_MODE_TYPE renderMode, EVIDEO_MIRROR_MODE_TYPE mir renderMode mode -

      The local video display mode. See .

      +

      The local video display mode. ensure the user ID is not set as 0.

      The local video display mode.

      • (1): Hidden mode. Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents.
      • (2): Fit mode. Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio are filled with black.
        • 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..6d742803566 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita @@ -40,7 +40,7 @@ mode mirrorMode -

        The local video mirror mode. See .

        +

        The local video mirror mode. ensure the user ID is not set as 0.

        • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita index ca7fff34830..494c5af1039 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita @@ -30,11 +30,11 @@ options: LowlightEnhanceOptions, type?: MediaSourceType ): number; - Future<void> setLowlightEnhanceOptions( + Future<void> setLowlightEnhanceOptions( {required bool enabled, required LowlightEnhanceOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

          +

    Details @@ -48,7 +48,7 @@
  • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
  • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
    • -
  • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • +
  • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • Parameters @@ -63,19 +63,19 @@ options - The low-light enhancement options. See . + The low-light enhancement options. ensure the user ID is not set as 0. type - The type of the video source. See . + The type of the video source. 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.
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita index 333bdd5bf19..08da1afe9b8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita @@ -28,7 +28,7 @@ ): number;     Future<void> setRemoteUserSpatialAudioParams( {required int uid, required SpatialAudioParams params}); -

    +

    Details @@ -44,12 +44,12 @@ params param - The spatial audio parameters. See . + The spatial audio parameters. ensure the user ID is not set as 0.
    - <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_setscreencapturecontenthint.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita index fab2eda96c6..7ce617e704b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita @@ -21,7 +21,7 @@ public abstract int SetScreenCaptureContentHint(VIDEO_CONTENT_HINT contentHint); abstract setScreenCaptureContentHint(contentHint: VideoContentHint): number; Future<void> setScreenCaptureContentHint(VideoContentHint contentHint); -

      +

    Details @@ -32,13 +32,13 @@ contentHint - The content hint for screen sharing. See . + The content hint for screen sharing. ensure the user ID is not set as 0.
    - <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_setuplocalvideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita index 01f5bd4fafc..152b70938a8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita @@ -20,7 +20,7 @@ public abstract int SetupLocalVideo(VideoCanvas canvas); abstract setupLocalVideo(canvas: VideoCanvas): number; Future<void> setupLocalVideo(VideoCanvas canvas); -

      +

    Details @@ -28,7 +28,7 @@

    After initialization, call this method to set the local video and then join the channel. The local video still binds to the view after you leave the channel. To unbind the local video from the view, set the view parameter as .

      -
    • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
      • +
    • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
    • You can call this method either before or after joining a channel.
    • To update the rendering or mirror mode of the local video view during a call, use the method.
    @@ -38,15 +38,15 @@ canvas local - The local video view and settings. See . + The local video view and settings. ensure the user ID is not set as 0.
    - <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_setupremotevideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita index f8de9b0a7ec..6b0a16a0d23 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita @@ -1,12 +1,12 @@ - <ph keyref="setupRemoteVideo" /> + <ph keyref="setupRemoteVideo"/> Initializes the video view of a remote user. - + @@ -20,19 +20,19 @@ public abstract int SetupRemoteVideo(VideoCanvas canvas); abstract setupRemoteVideo(canvas: VideoCanvas): number; Future<void> setupRemoteVideo(VideoCanvas canvas); -

    +

    Details

    This method initializes the video view of a remote stream on the local device. It affects only the video view that the local user sees. Call this method to bind the remote video stream to a video view and to set the rendering and mirror modes of the video view.

    -

    You need to specify the ID of the remote user in this method. If the remote user ID is unknown to the application, set it after the app receives the callback.

    +

    You need to specify the ID of the remote user in this method. If the remote user ID is unknown to the application, set it after the app receives the callback.

    To unbind the remote user from the view, set the view parameter to NULL.

    Once the remote user leaves the channel, the SDK unbinds the remote user.

      -
    • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
      • -
    • To update the rendering or mirror mode of the remote video view during a call, use the method.
      • -
    • If you use the Agora recording function, the recording client joins the channel as a placeholder client, triggering the callback. Do not bind the placeholder client to the app view because the placeholder client does not send any video streams. If your app does not recognize the placeholder client, bind the remote user to the view when the SDK triggers the callback.
      • +
    • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
      • +
    • To update the rendering or mirror mode of the remote video view during a call, use the method.
      • +
    • If you use the Agora recording function, the recording client joins the channel as a placeholder client, triggering the callback. Do not bind the placeholder client to the app view because the placeholder client does not send any video streams. If your app does not recognize the placeholder client, bind the remote user to the view when the SDK triggers the callback.
    Parameters @@ -41,16 +41,16 @@ canvas remote -

    The remote video view and settings. See .

    +

    The remote video view and settings. ensure the user ID is not set as 0.
    - <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_setvideodenoiseroptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita index 6e2f6c0cac2..a334855ee15 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita @@ -1,12 +1,12 @@ - <ph keyref="setVideoDenoiserOptions" /> + <ph keyref="setVideoDenoiserOptions"/> Sets video noise reduction. - + @@ -30,11 +30,11 @@ options: VideoDenoiserOptions, type?: MediaSourceType ): number;     - Future<void> setVideoDenoiserOptions( + Future<void> setVideoDenoiserOptions( {required bool enabled, required VideoDenoiserOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

    +

    Details @@ -42,13 +42,13 @@

    You can call this method to enable the video noise reduction feature and set the options of the video noise reduction effect.

      -
    • Call this method after calling .
      • +
    • Call this method after calling .
    • Video noise reduction has certain requirements for equipment performance. If your device overheats after you enable video noise reduction, Agora recommends modifying the video noise reduction options to a less performance-consuming level or disabling video noise reduction entirely.
      • -
    • Both this method and can turn on video noise reduction function:
        +
      • Both this method and can turn on video noise reduction function:
        • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
          • -
        • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
          • +
        • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
        • -
      • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
        • +
      • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    Parameters @@ -57,25 +57,25 @@ enabled enable Whether to enable video noise reduction:
      -
    • : Enable video noise reduction.
      • -
    • : (Default) Disable video noise reduction.
      • +
    • : Enable video noise reduction.
      • +
    • : (Default) Disable video noise reduction.
     options - The video noise reduction options. See . + The video noise reduction options. ensure the user ID is not set as 0. - - + +
    - <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_setvideoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita index a6c3a58017f..26a3e2b0c8e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita @@ -1,12 +1,12 @@ - <ph keyref="setVideoEncoderConfiguration" /> + <ph keyref="setVideoEncoderConfiguration"/> Sets the video encoder configuration. - + @@ -24,32 +24,32 @@ config: VideoEncoderConfiguration ): number;     Future<void> setVideoEncoderConfiguration(VideoEncoderConfiguration config); -

    +

    Details

    Sets the encoder configuration for the local video.

      -
    • You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.
      • -
    • Both this method and the method support setting the mirroring effect. Agora recommends that you only choose one method to set it up. Using both methods at the same time causes the mirroring effect to overlap, which causes the mirroring settings to fail.
      • +
    • You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.
      • +
    • Both this method and the method support setting the mirroring effect. Agora recommends that you only choose one method to set it up. Using both methods at the same time causes the mirroring effect to overlap, which causes the mirroring settings to fail.
     - You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame. - Call this method before joining a channel. Agora recommends calling this method before to reduce the time to render the first video frame.
    + You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame. + Call this method before joining a channel. Agora recommends calling this method before to reduce the time to render the first video frame.
    Parameters config - Video profile. See . + Video profile. ensure the user ID is not set as 0.
    - <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_setvideoprofile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita index 754ae6046d9..5302309424d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita @@ -1,12 +1,12 @@ - <ph keyref="setVideoProfile" /> + <ph keyref="setVideoProfile"/> Sets the video encoder configuration. - + @@ -17,21 +17,21 @@ - (int)setVideoProfile:(AgoraVideoProfile)profile swapWidthAndHeight:(BOOL)swapWidthAndHeight virtual int setVideoProfile(VIDEO_PROFILE_TYPE profile, bool swapWidthAndHeight) = 0; - + public abstract int SetVideoProfile(VIDEO_PROFILE_TYPE profile, bool swapWidthAndHeight = false); - - -

    + + +

    Details
    Deprecated:
    -
    This method is deprecated. Use instead.
    +
    This method is deprecated. Use instead.
    -

    This method sets the video encoder configuration. You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.

    +

    This method sets the video encoder configuration. You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.

    Parameters @@ -39,7 +39,7 @@ profile -

    Video profile. See .

    +

    Video profile. ensure the user ID is not set as 0.

         @@ -47,8 +47,8 @@

    The SDK outputs video with a fixed width and height according to the video profile (profile) you selected. This parameter sets whether to swap width and height of the video:

      -
    • : Swap the width and height.
      • -
    • : (Default) Do not swap the width and height.
      • +
    • : Swap the width and height.
      • +
    • : (Default) Do not swap the width and height.
    @@ -59,4 +59,4 @@
  • < 0: Failure.
    • -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita index deb45054d86..13a742944ac 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita @@ -22,7 +22,7 @@ int StartAudioRecording(const FAudioRecordingConfiguration& config);public abstract int StartAudioRecording(AudioRecordingConfiguration config);     abstract startAudioRecording(config: AudioRecordingConfiguration): number; Future<void> startAudioRecording(AudioRecordingConfiguration config); -

    +

    Details @@ -37,12 +37,12 @@ int StartAudioRecording(const FAudioRecordingConfiguration& config); config - Recording configurations. See . + Recording configurations. ensure the user ID is not set as 0.
    - <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_startcameracapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita index 3c66e3c082a..3738cb5b449 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita @@ -1,12 +1,12 @@ - <ph keyref="startCameraCapture" /> + <ph keyref="startCameraCapture"/> Starts camera capture. - + @@ -26,10 +26,10 @@ sourceType: VideoSourceType, config: CameraCapturerConfiguration ): number; - Future<void> startCameraCapture( + Future<void> startCameraCapture( {required VideoSourceType sourceType, required CameraCapturerConfiguration config}); -

      +

    Details @@ -40,7 +40,7 @@

    You can call this method to start capturing video from one or more cameras by specifying sourceType.

    - On the iOS platform, if you want to enable multi-camera capture, you need to call and set enabled to before calling this method. + On the iOS platform, if you want to enable multi-camera capture, you need to call and set enabled to before calling this method.
    Parameters @@ -48,7 +48,7 @@ sourceType -

    The type of the video source. See .

    +

    The type of the video source. ensure the user ID is not set as 0.

    • On the mobile platforms, you can capture video from up to 2 cameras, provided the device has dual cameras or supports an external camera.
    • On the desktop platforms, you can capture video from up to 4 cameras.
         @@ -57,13 +57,13 @@ config -

    The configuration of the video capture. See .

    - On the iOS platform, this parameter has no practical function. Use the config parameter in instead to set the video capture configuration.     +

    The configuration of the video capture. ensure the user ID is not set as 0.

    + On the iOS platform, this parameter has no practical function. Use the config parameter in instead to set the video capture configuration.
    - <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.

      @@ -71,4 +71,4 @@
    • < 0: Failure.
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita index 72f0129b966..8a6082eb100 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita @@ -1,12 +1,12 @@ - <ph keyref="startChannelMediaRelay" /> + <ph keyref="startChannelMediaRelay"/> Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels. - + @@ -26,7 +26,7 @@ ): number;     Future<void> startChannelMediaRelay( ChannelMediaRelayConfiguration configuration); -

    +

    Details @@ -36,16 +36,16 @@
    This method is deprecated. Use instead.
    -

    After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.

      -
    • If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
      • -
    • If the callback returns (3), an exception occurs during the media stream relay.
      • +

      After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.

        +
      • If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
        • +
      • If the callback returns (3), an exception occurs during the media stream relay.

      • Call this method after joining the channel.
      • This method takes effect only when you are a host in a live streaming channel.
        • -
      • After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
        • -
      • The relaying media streams across channels function needs to be enabled by contacting .
        • +
      • After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
        • +
      • The relaying media streams across channels function needs to be enabled by contacting .
      • Agora does not support string user accounts in this API.
    @@ -55,12 +55,12 @@ channelMediaRelayConfiguration config configuration - The configuration of the media stream relay. See . + The configuration of the media stream relay. ensure the user ID is not set as 0.
    - <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.
        @@ -71,4 +71,4 @@
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita index 972299535be..65f3f47ea03 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita @@ -28,11 +28,11 @@ publishUrl: string, options: DirectCdnStreamingMediaOptions ): number;     - Future<void> startDirectCdnStreaming( + Future<void> startDirectCdnStreaming( {required DirectCdnStreamingEventHandler eventHandler, required String publishUrl, required DirectCdnStreamingMediaOptions options}); -

    +

    Details

    Aogra does not support pushing media streams to one URL repeatedly.

    @@ -46,7 +46,7 @@
  • publishCameraTrack is set as (the default value)
  • publishMicrophoneTrack is set as (the default value)
    • -

    As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call to push audio streams. As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call or to push audio streams.Agora only supports pushing one audio and video streams or one audio streams to CDN.

    +

    As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call to push audio streams. As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call or to push audio streams.Agora only supports pushing one audio and video streams or one audio streams to CDN.

    Parameters @@ -61,15 +61,15 @@ options - The media setting options for the host. See . + The media setting options for the host. ensure the user ID is not set as 0.
    - <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_startechotest3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita index c59232d3c4e..111664270df 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita @@ -1,12 +1,12 @@ - <ph keyref="startEchoTest3" /> + <ph keyref="startEchoTest3"/> Starts an audio device loopback test. - + @@ -21,8 +21,8 @@ int StartEchoTest(const FEchoTestConfiguration& config);     abstract startEchoTest(config: EchoTestConfiguration): number; public abstract int StartEchoTest(EchoTestConfiguration config); abstract startEchoTest(config: EchoTestConfiguration): number; - Future<void> startEchoTest(EchoTestConfiguration config); -

    + Future<void> startEchoTest(EchoTestConfiguration config); +

    Details @@ -30,7 +30,7 @@ int StartEchoTest(const FEchoTestConfiguration& config);

    After starting the test, the user needs to make a sound or face the camera. The audio or video is output after about two seconds. If the audio playback is normal, the audio device and the user's upstream and downstream networks are working properly; if the video playback is normal, the video device and the user's upstream and downstream networks are working properly.

    • You can call this method either before or after joining a channel. When calling in a channel, make sure that no audio or video stream is being published.
      • -
    • After calling this method, call to end the test; otherwise, the user cannot perform the next audio and video call loop test and cannot join the channel.
      • +
    • After calling this method, call to end the test; otherwise, the user cannot perform the next audio and video call loop test and cannot join the channel.
    • In live streaming scenarios, this method only applies to hosts.

    @@ -39,7 +39,7 @@ int StartEchoTest(const FEchoTestConfiguration& config);     config - The configuration of the audio and video call loop test. See . + The configuration of the audio and video call loop test. ensure the user ID is not set as 0.
    @@ -49,4 +49,4 @@ int StartEchoTest(const FEchoTestConfiguration& config);
  • < 0: Failure.
    • - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita index 6ff8cff1f41..5b0aebe42b1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita @@ -1,12 +1,12 @@ - <ph keyref="startOrUpdateChannelMediaRelay" /> + <ph keyref="startOrUpdateChannelMediaRelay"/> Starts relaying media streams across channels or updates channels for media relay. - + @@ -24,9 +24,9 @@ abstract startOrUpdateChannelMediaRelay( configuration: ChannelMediaRelayConfiguration ): number; - Future<void> startOrUpdateChannelMediaRelay( + Future<void> startOrUpdateChannelMediaRelay( ChannelMediaRelayConfiguration configuration); -

    +

    Details @@ -36,15 +36,15 @@
    v4.2.0

    The first successful call to this method starts relaying media streams from the source channel to the destination channels. To relay the media stream to other channels, or exit one of the current media relays, you can call this method again to update the destination channels. This feature supports relaying media streams to a maximum of six destination channels.

    -

    After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:

      -
    • If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
      • -
    • If the callback returns (3), an exception occurs during the media stream relay.
      • +

      After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:

        +
      • If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
        • +
      • If the callback returns (3), an exception occurs during the media stream relay.

      • Call this method after joining the channel.
      • This method takes effect only when you are a host in a live streaming channel.
        • -
      • The relaying media streams across channels function needs to be enabled by contacting .
        • +
      • The relaying media streams across channels function needs to be enabled by contacting .
      • Agora does not support string user accounts in this API.
    @@ -54,12 +54,12 @@ channelMediaRelayConfiguration config configuration - The configuration of the media stream relay. See . + The configuration of the media stream relay. ensure the user ID is not set as 0.
    - <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.
        @@ -70,4 +70,4 @@
    -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita index 2af22028816..b7276cb754a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita @@ -1,12 +1,12 @@ - <ph keyref="startRhythmPlayer" /> + <ph keyref="startRhythmPlayer"/> Enables the virtual metronome. - + @@ -28,42 +28,42 @@ sound2: string, config: AgoraRhythmPlayerConfig ): number;     - Future<void> startRhythmPlayer( + Future<void> startRhythmPlayer( {required String sound1, required String sound2, required AgoraRhythmPlayerConfig config}); -

    +

    Details

    In music education, physical education and other scenarios, teachers usually need to use a metronome so that students can practice with the correct beat. The meter is composed of a downbeat and upbeats. The first beat of each measure is called a downbeat, and the rest are called upbeats.

    In this method, you need to set the file path of the upbeat and downbeat, the number of beats per measure, the beat speed, and whether to send the sound of the metronome to remote users.

    -

    After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.

    +

    After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.

    • This method is for Android and iOS only.
      • -
    • After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning, and controls the playback duration of each file according to beatsPerMinute you set in . For example, if you set beatsPerMinute as 60, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration.
      • -
    • By default, the sound of the virtual metronome is published in the channel. If you do not want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in as .
      • +
    • After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning, and controls the playback duration of each file according to beatsPerMinute you set in . For example, if you set beatsPerMinute as 60, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration.
      • +
    • By default, the sound of the virtual metronome is published in the channel. If you do not want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in as .
    Parameters sound1 - The absolute path or URL address (including the filename extensions) of the file for the downbeat. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. + The absolute path or URL address (including the filename extensions) of the file for the downbeat. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. sound2 - The absolute path or URL address (including the filename extensions) of the file for the upbeats. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. + The absolute path or URL address (including the filename extensions) of the file for the upbeats. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. config - The metronome configuration. See . + The metronome configuration. ensure the user ID is not set as 0.
    - <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.
        @@ -71,4 +71,4 @@
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita index 1573e53c5e8..62b612604b4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita @@ -1,12 +1,12 @@ - <ph keyref="startScreenCapture" /> + <ph keyref="startScreenCapture"/> Starts screen capture. - + @@ -24,32 +24,32 @@ int StartScreenCapture(const FScreenCaptureParameters2& captureParams);abstract startScreenCapture(captureParams: ScreenCaptureParameters2): number;     public abstract int StartScreenCapture(ScreenCaptureParameters2 captureParams); abstract startScreenCapture(captureParams: ScreenCaptureParameters2): number; - Future<void> startScreenCapture(ScreenCaptureParameters2 captureParams); -

    + Future<void> startScreenCapture(ScreenCaptureParameters2 captureParams); +

    Details

    There are two ways to start screen sharing, you can choose one according to your needs:

      -
    • Call this method before joining a channel, then call to join channel and set publishScreenCaptureVideo to to start screen sharing.
      • -
    • Call this method after joining a channel, then call and set publishScreenCaptureVideo to to start screen sharing.
      • +
    • Call this method before joining a channel, then call to join channel and set publishScreenCaptureVideo to to start screen sharing.
      • +
    • Call this method after joining a channel, then call and set publishScreenCaptureVideo to to start screen sharing.

    -

    When the state of the screen sharing extension process changes, the SDK triggers the callback accordingly. When the type of sourceType is , the state parameter indicates the state of the screen sharing.

    +

    When the state of the screen sharing extension process changes, the SDK triggers the callback accordingly. When the type of sourceType is , the state parameter indicates the state of the screen sharing.

    • This method applies to Android and iOS only.
    • On the iOS platform, screen sharing is only available on iOS 12.0 and later.
      • -
    • The billing for the screen sharing stream is based on the dimensions in . When you do not pass in a value, Agora bills you at 1280 × 720; when you pass a value in, Agora bills you at that value. See .
      • +
    • The billing for the screen sharing stream is based on the dimensions in . When you do not pass in a value, Agora bills you at 1280 × 720; when you pass a value in, Agora bills you at that value. See .
    • If you are using the custom audio source instead of the SDK to capture audio, Agora recommends you add the keep-alive processing logic to your application to avoid screen sharing stopping when the application goes to the background.
    • This feature requires high-performance device, and Agora recommends that you use it on iPhone X and later models.
    • This method relies on the iOS screen sharing dynamic library AgoraReplayKitExtension.xcframework. If the dynamic library is deleted, screen sharing cannot be enabled normally.
    • On the Android platform, make sure the user has granted the app screen capture permission.
      • -
    • Make sure that the Android API level is not earlier than 21, otherwise, the SDK reports error codes (16) and (2).
      • -
    • To capture system audio during screen sharing, ensure that the Android API level is not earlier than 29 as well; otherwise, the SDK reports the error code (3).
      • +
    • Make sure that the Android API level is not earlier than 21, otherwise, the SDK reports error codes (16) and (2).
      • +
    • To capture system audio during screen sharing, ensure that the Android API level is not earlier than 29 as well; otherwise, the SDK reports the error code (3).
    • On Android 9 and later, to avoid the application being killed by the system after going to the background, Agora recommends you add the foreground service android.permission.FOREGROUND_SERVICE to the /app/Manifests/AndroidManifest.xml file.
    • Due to performance limitations, screen sharing is not supported on Android TV.
    • Due to system limitations, if you are using Huawei phones, do not adjust the video encoding resolution of the screen sharing stream during the screen sharing, or you could experience crashes.
    • Due to system limitations, some Xiaomi devices do not support capturing system audio during screen sharing.
      • -
    • To avoid system audio capture failure when screen sharing, Agora recommends that you set the audio application scenario to by using the method before joining the channel.
      • +
    • To avoid system audio capture failure when screen sharing, Agora recommends that you set the audio application scenario to by using the method before joining the channel.
    Parameters @@ -58,12 +58,12 @@ int StartScreenCapture(const FScreenCaptureParameters2& captureParams);parameters screenCaptureParameters captureParams - The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See . + The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. ensure the user ID is not set as 0.
    - <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.
        @@ -71,4 +71,4 @@ int StartScreenCapture(const FScreenCaptureParameters2& captureParams);
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita index def219254a0..1a2576f1fa7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita @@ -24,11 +24,11 @@ int StartScreenCaptureBySourceType(EVIDEO_SOURCE_TYPE sourceType, const FScreenC config: ScreenCaptureConfiguration ): number;     public abstract int StartScreenCapture(VIDEO_SOURCE_TYPE sourceType, ScreenCaptureConfiguration config); - - Future<void> startScreenCaptureBySourceType( + + Future<void> startScreenCaptureBySourceType( {required VideoSourceType sourceType, required ScreenCaptureConfiguration config}); -

    +

    Details @@ -38,15 +38,15 @@ int StartScreenCaptureBySourceType(EVIDEO_SOURCE_TYPE sourceType, const FScreenC
    v4.2.0
    -

    This method, as well as and , all have the capability to start screen capture, with the following differences: -This method, as well as , , and , all have the capability to start screen capture, with the following differences:

      -
    • only applies to Android and iOS, whereas this method only applies to Windows and iOS.
      • -
    • and only support capturing video from a single screen or window. By calling this method and specifying the sourceType parameter, you can capture multiple video streams used for local video mixing or multi-channel publishing.
      • +

      This method, as well as and , all have the capability to start screen capture, with the following differences: +This method, as well as , , and , all have the capability to start screen capture, with the following differences:

        +
      • only applies to Android and iOS, whereas this method only applies to Windows and iOS.
        • +
      • and only support capturing video from a single screen or window. By calling this method and specifying the sourceType parameter, you can capture multiple video streams used for local video mixing or multi-channel publishing.

      • This method applies to the macOS and Windows only.
        • -
      • If you call this method to start screen capture, Agora recommends that you call to stop the capture and avoid using .
       +
    • If you call this method to start screen capture, Agora recommends that you call to stop the capture and avoid using .
    Parameters @@ -54,20 +54,20 @@ int StartScreenCaptureBySourceType(EVIDEO_SOURCE_TYPE sourceType, const FScreenC sourceType -

    The type of the video source. See .

    +

    The type of the video source. See .

    • Windows supports up to four screen capture video streams.
      • -
    • macOS supports only one screen capture video stream. You can only set this parameter to (2).
     +
  • macOS supports only one screen capture video stream. You can only set this parameter to (2).
    •      config - The configuration of the captured screen. See . + The configuration of the captured screen. ensure the user ID is not set as 0.
    - <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.

      @@ -75,4 +75,4 @@ int StartScreenCaptureBySourceType(EVIDEO_SOURCE_TYPE sourceType, const FScreenC
    • < 0: Failure.
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita index 6d9931600c9..a5ddf9b5854 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita @@ -36,7 +36,7 @@ {required int displayId, required Rectangle regionRect, required ScreenCaptureParameters captureParams});     -

    +

    Details @@ -57,7 +57,7 @@ regionRect - (Optional) Sets the relative location of the region to the screen. Pass in nil to share the entire screen. See . It consists of the following parameters:
      + (Optional) Sets the relative location of the region to the screen. Pass in nil to share the entire screen. ensure the user ID is not set as 0. It consists of the following parameters:
      • x: The horizontal offset from the top-left corner.
      • y: The vertical offset from the top-left corner.
      • width: The width of the region.
        • @@ -67,12 +67,12 @@ captureParams - Screen sharing configurations. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See . + Screen sharing configurations. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. ensure the user ID is not set as 0.
    - <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_startscreencapturebyscreenrect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita index 248c1b6d1c2..3c7dc31f43f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita @@ -34,7 +34,7 @@ {required Rectangle screenRect, required Rectangle regionRect, required ScreenCaptureParameters captureParams}); -

        +

    Details @@ -56,17 +56,17 @@ regionRect - (Optional) Sets the relative location of the region to the screen. If you do not set this parameter, the SDK shares the whole screen. See . If the specified region overruns the screen, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen. + (Optional) Sets the relative location of the region to the screen. If you do not set this parameter, the SDK shares the whole screen. ensure the user ID is not set as 0. If the specified region overruns the screen, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen. captureParams - The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See . + The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. ensure the user ID is not set as 0.
    - <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_startscreencapturebywindowid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita index 7addffe1ce7..40d88c530ca 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita @@ -35,7 +35,7 @@ {required int windowId, required Rectangle regionRect, required ScreenCaptureParameters captureParams}); -

      +

    Details @@ -43,7 +43,7 @@

    • This method applies to the macOS and Windows only.
      • -
    • The window sharing feature of the Agora SDK relies on WGC (Windows Graphics Capture) or GDI (Graphics Device Interface) capture, and WGC cannot be set to disable mouse capture on systems earlier than Windows 10 2004. Therefore, captureMouseCursor(false) might not work when you start window sharing on a device with a system earlier than Windows 10 2004. See .
    +
  • The window sharing feature of the Agora SDK relies on WGC (Windows Graphics Capture) or GDI (Graphics Device Interface) capture, and WGC cannot be set to disable mouse capture on systems earlier than Windows 10 2004. Therefore, captureMouseCursor(false) might not work when you start window sharing on a device with a system earlier than Windows 10 2004. ensure the user ID is not set as 0.

    • This method supports window sharing of UWP (Universal Windows Platform) applications. Agora tests the mainstream UWP applications by using the lastest SDK, see details as follows:

    @@ -176,7 +176,7 @@ regionRect - (Optional) Sets the relative location of the region to the screen. If you do not set this parameter, the SDK shares the whole screen. See . If the specified region overruns the window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole window. + (Optional) Sets the relative location of the region to the screen. If you do not set this parameter, the SDK shares the whole screen. ensure the user ID is not set as 0. If the specified region overruns the window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole window. regionRect @@ -192,12 +192,12 @@ captureParams - Screen sharing configurations. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See . + Screen sharing configurations. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. ensure the user ID is not set as 0.
    - <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_switchchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita index 63360150c93..07f4a604081 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita @@ -1,33 +1,33 @@ - <ph keyref="switchChannel2" /> + <ph keyref="switchChannel2"/> Switches to a different channel, and configures whether to automatically subscribe to audio or video streams in the target channel. - +

      - - + + virtual int switchChannel(const char* token, const char* channelId, const ChannelMediaOptions& options) = 0; - + public abstract int SwitchChannel(string token, string channelId, ChannelMediaOptions options); - - -

      + + +

      Details

      This method allows the audience of an interactive live streaming channel to switch to a different channel.

      -

      After the user successfully switches to another channel, the and callbacks are triggered to indicate that the user has left the original channel and joined a new one.

      +

      After the user successfully switches to another channel, the and callbacks are triggered to indicate that the user has left the original channel and joined a new one.

      Once the user switches to another channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.

      @@ -37,10 +37,10 @@ token

      The token generated at your server.

        -
      • In scenarios with low security requirements, token is optional and can be set as .
        • +
      • In scenarios with low security requirements, token is optional and can be set as .
      • In scenarios with high security requirements, set the value to the token generated from your server. If you enable the App Certificate, you must use a token to join the channel.
      - Ensure that the App ID, channel name, and user name used for creating the token are the same ones as those used by the method for initializing the RTC engine.

      + Ensure that the App ID, channel name, and user name used for creating the token are the same ones as those used by the method for initializing the RTC engine.

      @@ -52,13 +52,13 @@
    • All uppercase English letters: A to Z.
    • All numeric characters: 0 to 9.
    • Space
      • -
    • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
      • +
    • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

    options - The channel media options. See . + The channel media options. ensure the user ID is not set as 0.
    @@ -75,4 +75,4 @@
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita index ac2992d4b08..29ee12d91aa 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita @@ -1,21 +1,21 @@ - <ph keyref="unregisterAudioEncodedFrameObserver" /> + <ph keyref="unregisterAudioEncodedFrameObserver"/> Unregisters the encoded audio frame observer. - +

    - - - + + + abstract unregisterAudioEncodedFrameObserver( observer: IAudioEncodedFrameObserver ): number; @@ -26,24 +26,24 @@ ): number; void unregisterAudioEncodedFrameObserver(AudioEncodedFrameObserver observer); -

    +

    Parameters observer - The encoded audio observer. See . + The encoded audio observer. ensure the user ID is not set as 0.
    - <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_updatescreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita index a50469bfaf2..c6ce1e0096d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita @@ -21,13 +21,13 @@ public abstract int UpdateScreenCapture(ScreenCaptureParameters2 captureParams); abstract updateScreenCapture(captureParams: ScreenCaptureParameters2): number; Future<void> updateScreenCapture(ScreenCaptureParameters2 captureParams); -

    +

    Details

    If the system audio is not captured when screen sharing is enabled, and then you want to update the parameter configuration and publish the system audio, you can refer to the following steps:

      -
    1. Call this method, and set captureAudio to .
      2. -
    2. Call , and set publishScreenCaptureAudio to to publish the audio captured by the screen.
      3. +
    3. Call this method, and set captureAudio to .
      4. +
    4. Call , and set publishScreenCaptureAudio to to publish the audio captured by the screen.

      @@ -42,17 +42,17 @@ parameters captureParams - The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See . + The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. ensure the user ID is not set as 0.
    - <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_updatescreencaptureparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita index c2a69e760c3..5afd5276798 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita @@ -27,7 +27,7 @@ ): number;     Future<void> updateScreenCaptureParameters( ScreenCaptureParameters captureParams); -

    +

    Details @@ -42,12 +42,12 @@ screenCaptureParameters captureParams - The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See . + The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. ensure the user ID is not set as 0.
    - <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_updatescreencaptureregion.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita index b2f88a63804..be6fb1e1325 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita @@ -20,7 +20,7 @@ public abstract int UpdateScreenCaptureRegion(Rectangle regionRect); abstract updateScreenCaptureRegion(regionRect: Rectangle): number; Future<void> updateScreenCaptureRegion(Rectangle regionRect); -

        +

    Details @@ -31,7 +31,7 @@ regionRect - The relative location of the screen-share area to the screen or window. If you do not set this parameter, the SDK shares the whole screen or window. See . If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window. + The relative location of the screen-share area to the screen or window. If you do not set this parameter, the SDK shares the whole screen or window. ensure the user ID is not set as 0. If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window. rect @@ -47,8 +47,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_updatescreencaptureregion2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita index 4e7b848dbd4..868067624e5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita @@ -1,26 +1,26 @@ - <ph keyref="updateScreenCaptureRegion2" /> + <ph keyref="updateScreenCaptureRegion2"/> Updates the screen capturing region. - +

      - + - (int)updateScreenCaptureRegion:(CGRect)rect; virtual int updateScreenCaptureRegion(const Rect* rect) = 0; abstract updateScreenCaptureRegion(regionRect: Rectangle): number; public abstract int UpdateScreenCaptureRegion(Rectangle regionRect); - + Future<void> updateScreenCaptureRegion(Rectangle regionRect); -

      +

      Parameters @@ -28,15 +28,15 @@ rect regionRect - The relative location of the region to the screen or window. If you do not set this parameter, the SDK shares the whole screen. See . If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window. + The relative location of the region to the screen or window. If you do not set this parameter, the SDK shares the whole screen. ensure the user ID is not set as 0. If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window.
      - <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_createdatastreamex2.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita index c63a62d4eea..e678621939a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita @@ -32,7 +32,7 @@ ): number; Future<int> createDataStreamEx( {required DataStreamConfig config, required RtcConnection connection}); -

      +

    Details @@ -48,7 +48,7 @@ config - The configurations for the data stream. See . + The configurations for the data stream. ensure the user ID is not set as 0. diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita index 4d296e36cdb..c4b565b46a7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita @@ -1,12 +1,12 @@ - <ph keyref="joinChannelEx" /> + <ph keyref="joinChannelEx"/> Joins a channel with the connection ID. - + @@ -38,7 +38,7 @@ {required String token, required RtcConnection connection, required ChannelMediaOptions options}); -

    +

    Details @@ -47,34 +47,34 @@
    • If you are already in a channel, you cannot rejoin it with the same user ID.
    • If you want to join the same channel from different devices, ensure that the user IDs are different for all devices.
      • -
    • Ensure that the app ID you use to generate the token is the same as the app ID used when creating the instance.
      • -
    • In a multi-camera capture scenario, you need to call the method after calling this method to set the sourceType to , to ensure that the second camera captures normally.
      • +
    • Ensure that the app ID you use to generate the token is the same as the app ID used when creating the instance.
      • +
    • In a multi-camera capture scenario, you need to call the method after calling this method to set the sourceType to , to ensure that the second camera captures normally.
    Parameters - - + + connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. - - + + eventHandler delegate - The callback class of .See . + The callback class of .See . - - + +
    -
    +
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita index bdf7b470be0..916b7a8705a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita @@ -1,12 +1,12 @@ - <ph keyref="setDualStreamModeEx" /> + <ph keyref="setDualStreamModeEx"/> Sets the dual-stream mode on the sender side. - + @@ -32,11 +32,11 @@ streamConfig: SimulcastStreamConfig, connection: RtcConnection ): number; - Future<void> setDualStreamModeEx( + Future<void> setDualStreamModeEx( {required SimulcastStreamMode mode, required SimulcastStreamConfig streamConfig, required RtcConnection connection}); -

    +

    Details @@ -46,10 +46,10 @@
    v4.0.1
    -

    The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to . If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).

    - The difference and connection between this method and is as follows:
      -
    • When calling this method and setting mode to , it has the same effect as ().
      • -
    • When calling this method and setting mode to , it has the same effect as ().
      • +

      The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to . If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).

      + The difference and connection between this method and is as follows:
        +
      • When calling this method and setting mode to , it has the same effect as ().
        • +
      • When calling this method and setting mode to , it has the same effect as ().
      • Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
    @@ -57,23 +57,23 @@ mode - The mode in which the video stream is sent. See . + The mode in which the video stream is sent. ensure the user ID is not set as 0. - - + + - - + +
    - <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_setupremotevideoex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita index b9026e3fde4..d53a435d755 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita @@ -28,7 +28,7 @@ ): number; Future<void> setupRemoteVideoEx( {required VideoCanvas canvas, required RtcConnection connection}); -

    +

    Details @@ -47,7 +47,7 @@ remote canvas -

    The remote video view settings. See .

    +

    The remote video view settings. ensure the user ID is not set as 0.

     @@ -56,8 +56,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_setvideoencoderconfigurationex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita index 31d2394ac99..d0b04a7e2f1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita @@ -30,7 +30,7 @@ Future<void> setVideoEncoderConfigurationEx( {required VideoEncoderConfiguration config, required RtcConnection connection}); -

      +

    Details @@ -42,7 +42,7 @@ config - Video profile. See . + Video profile. ensure the user ID is not set as 0. @@ -50,8 +50,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_startchannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita index c77da9dd34e..df55e372b73 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita @@ -1,12 +1,12 @@ - <ph keyref="startChannelMediaRelayEx" /> + <ph keyref="startChannelMediaRelayEx"/> Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels. - + @@ -26,10 +26,10 @@ configuration: ChannelMediaRelayConfiguration, connection: RtcConnection ): number; - Future<void> startChannelMediaRelayEx( + Future<void> startChannelMediaRelayEx( {required ChannelMediaRelayConfiguration configuration, required RtcConnection connection}); -

      +

    Details @@ -39,16 +39,16 @@
    This method is deprecated. Use instead.
    -

    After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.

      -
    • If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
      • -
    • If the callback returns (3), an exception occurs during the media stream relay.
      • +

      After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.

        +
      • If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
        • +
      • If the callback returns (3), an exception occurs during the media stream relay.

      • Call this method after joining the channel.
      • This method takes effect only when you are a host in a live streaming channel.
        • -
      • After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
        • -
      • The relaying media streams across channels function needs to be enabled by contacting .
        • +
      • After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
        • +
      • The relaying media streams across channels function needs to be enabled by contacting .
      • Agora does not support string user accounts in this API.
    @@ -58,16 +58,16 @@ channelMediaRelayConfiguration config configuration - The configuration of the media stream relay. See . + The configuration of the media stream relay. ensure the user ID is not set as 0. - - + +
    - <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.
        @@ -78,4 +78,4 @@
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita index 2819845594f..fe7eae6b3a5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita @@ -1,12 +1,12 @@ - <ph keyref="startOrUpdateChannelMediaRelayEx" /> + <ph keyref="startOrUpdateChannelMediaRelayEx"/> Starts relaying media streams across channels or updates channels for media relay. - + @@ -26,10 +26,10 @@ configuration: ChannelMediaRelayConfiguration, connection: RtcConnection ): number;     - Future<void> startOrUpdateChannelMediaRelayEx( + Future<void> startOrUpdateChannelMediaRelayEx( {required ChannelMediaRelayConfiguration configuration, required RtcConnection connection}); -

    +

    Details @@ -39,15 +39,15 @@
    v4.2.0

    The first successful call to this method starts relaying media streams from the source channel to the destination channels. To relay the media stream to other channels, or exit one of the current media relays, you can call this method again to update the destination channels. This feature supports relaying media streams to a maximum of six destination channels.

    -

    After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:

      -
    • If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
      • -
    • If the callback returns (3), an exception occurs during the media stream relay.
      • +

      After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:

        +
      • If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
        • +
      • If the callback returns (3), an exception occurs during the media stream relay.

      • Call this method after joining the channel.
      • This method takes effect only when you are a host in a live streaming channel.
        • -
      • The relaying media streams across channels function needs to be enabled by contacting .
        • +
      • The relaying media streams across channels function needs to be enabled by contacting .
      • Agora does not support string user accounts in this API.
    @@ -57,16 +57,16 @@ channelMediaRelayConfiguration config configuration - The configuration of the media stream relay. See . + The configuration of the media stream relay. ensure the user ID is not set as 0. - - + +
    - <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.
        @@ -77,4 +77,4 @@
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita index 2859072794b..3c5f87b9e0a 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita @@ -26,9 +26,9 @@ deviceIdUTF8: string, deviceCapabilityNumber: number ): VideoFormat;     - Future<VideoFormat> getCapability( + Future<VideoFormat> getCapability( {required String deviceIdUTF8, required int deviceCapabilityNumber}); -

    +

    Details @@ -48,7 +48,7 @@ capability - An output parameter. Indicates the specific information of the specified video format, including width (px), height (px), and frame rate (fps). See . + An output parameter. Indicates the specific information of the specified video format, including width (px), height (px), and frame rate (fps). ensure the user ID is not set as 0.
    @@ -56,6 +56,6 @@
    • 0: Success.
    • < 0: Failure.
    -

    The specific information of the specified video format, including width (px), height (px), and frame rate (fps). See .

    +

    The specific information of the specified video format, including width (px), height (px), and frame rate (fps). ensure the user ID is not set as 0.

    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/callback_iaudioencodedframeobserver_onrecordaudioencodedframe.dita b/en-US/dita/RTC-NG/API/callback_iaudioencodedframeobserver_onrecordaudioencodedframe.dita index 7847d083b6d..0edd3f8f979 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioencodedframeobserver_onrecordaudioencodedframe.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioencodedframeobserver_onrecordaudioencodedframe.dita @@ -58,7 +58,7 @@ audioEncodedFrameInfo info - Audio information after encoding. See . + Audio information after encoding. ensure the user ID is not set as 0. diff --git a/en-US/dita/RTC-NG/API/callback_iaudioframeobserver_onplaybackaudioframebeforemixing.dita b/en-US/dita/RTC-NG/API/callback_iaudioframeobserver_onplaybackaudioframebeforemixing.dita index 01c273e37e2..47695662542 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioframeobserver_onplaybackaudioframebeforemixing.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioframeobserver_onplaybackaudioframebeforemixing.dita @@ -57,7 +57,7 @@ audioFrame frame audio_Frame - The raw audio data. See . + The raw audio data. ensure the user ID is not set as 0. diff --git a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onearmonitoringaudioframe.dita b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onearmonitoringaudioframe.dita index bef8a6554c9..c1fcb037dd6 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onearmonitoringaudioframe.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onearmonitoringaudioframe.dita @@ -46,7 +46,7 @@ audioFrame frame - The raw audio data. See . + The raw audio data. ensure the user ID is not set as 0. diff --git a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onmixedaudioframe.dita b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onmixedaudioframe.dita index 224b49792a2..05ef2981c28 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onmixedaudioframe.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onmixedaudioframe.dita @@ -47,7 +47,7 @@ audioFrame audio_Frame frame - The raw audio data. See . + The raw audio data. ensure the user ID is not set as 0. channelId diff --git a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onrecordaudioframe.dita b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onrecordaudioframe.dita index a2627b7bb19..e05fa303536 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onrecordaudioframe.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onrecordaudioframe.dita @@ -46,7 +46,7 @@ audioFrame frame - The raw audio data. See . + The raw audio data. ensure the user ID is not set as 0. channelId diff --git a/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita b/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita index ba4e179a0bd..d50232a9b37 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita @@ -35,11 +35,11 @@ frame audioFrame - The audio frame information. See . See . + The audio frame information. ensure the user ID is not set as 0. ensure the user ID is not set as 0. playerKit - See . + ensure the user ID is not set as 0.
    diff --git a/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onlocalaudiospectrum.dita b/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onlocalaudiospectrum.dita index 4943cd6dfcf..49c3ceb0724 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onlocalaudiospectrum.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onlocalaudiospectrum.dita @@ -35,7 +35,7 @@ data audioSpectrumData - The audio spectrum data of the local user. See . + The audio spectrum data of the local user. ensure the user ID is not set as 0. The audio spectrum data of the local user. Agora divides the audio frequency into 256 frequency domains, and reports the energy value of each frequency domain through this parameter. The value range of each energy type is [-300, 1] and the unit is dBFS.
    diff --git a/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstatechanged.dita b/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstatechanged.dita index d5c7f93ae23..9c06eac1154 100644 --- a/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstatechanged.dita @@ -48,11 +48,11 @@ state - The current CDN streaming state. See . + The current CDN streaming state. ensure the user ID is not set as 0. error - The CDN streaming error. See . + The CDN streaming error. ensure the user ID is not set as 0. message diff --git a/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstats.dita b/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstats.dita index ad2d83e4d15..ed6aa55f381 100644 --- a/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstats.dita +++ b/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstats.dita @@ -32,7 +32,7 @@ stats - The statistics of the current CDN streaming. See . + The statistics of the current CDN streaming. ensure the user ID is not set as 0. diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onreaddata.dita b/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onreaddata.dita index 52da69a5023..e28c36231fc 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onreaddata.dita +++ b/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onreaddata.dita @@ -35,7 +35,7 @@ playerKit - Media player protocol. See . + Media player protocol. ensure the user ID is not set as 0. buffer diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onseek.dita b/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onseek.dita index 01d21289c88..f73023c8bd6 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onseek.dita +++ b/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onseek.dita @@ -36,7 +36,7 @@ playerKit - Media player protocol. See . + Media player protocol. ensure the user ID is not set as 0. offset diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita index 52079db70f0..ca007cd2353 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita +++ b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita @@ -48,7 +48,7 @@ playerKit - See . + ensure the user ID is not set as 0. eventCode diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpreloadevent.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpreloadevent.dita index e5d0215a647..82cc3ddd79e 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpreloadevent.dita +++ b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpreloadevent.dita @@ -40,7 +40,7 @@ event @event - Events that occur when media resources are preloaded. See . + Events that occur when media resources are preloaded. ensure the user ID is not set as 0. diff --git a/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderinfoupdated.dita b/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderinfoupdated.dita index 59c1f12d8af..83c4ca22e81 100644 --- a/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderinfoupdated.dita +++ b/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderinfoupdated.dita @@ -47,7 +47,7 @@ info - The information about the file that is recorded. See . + The information about the file that is recorded. ensure the user ID is not set as 0. recorder diff --git a/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderstatechanged.dita b/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderstatechanged.dita index ed9bfe084fa..5a7c96bba2f 100644 --- a/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderstatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderstatechanged.dita @@ -53,7 +53,7 @@ state - The current recording state. See . + The current recording state. ensure the user ID is not set as 0. The current recording state:
    • (-1): An error occurs during the recording.
    • (2): The audio and video recording starts.
      • @@ -62,7 +62,7 @@ error - The reason for the state change. See . + The reason for the state change. ensure the user ID is not set as 0. The reason for the state change.
      • (0): No error.
      • (1): The SDK fails to write the recorded data to a file.
        • diff --git a/en-US/dita/RTC-NG/API/callback_imetadataobserver_onreadytosendmetadata.dita b/en-US/dita/RTC-NG/API/callback_imetadataobserver_onreadytosendmetadata.dita index 44f8988aa08..aef33037f2f 100644 --- a/en-US/dita/RTC-NG/API/callback_imetadataobserver_onreadytosendmetadata.dita +++ b/en-US/dita/RTC-NG/API/callback_imetadataobserver_onreadytosendmetadata.dita @@ -41,11 +41,11 @@ sourceType source_type - Video data type. See . + Video data type. ensure the user ID is not set as 0. metadata - The metadata that the user wants to send. See . + The metadata that the user wants to send. ensure the user ID is not set as 0.
        diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicestatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicestatechanged.dita index 4a225e8bbed..5c15d144231 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicestatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicestatechanged.dita @@ -49,7 +49,7 @@ deviceType - The device type. See . + The device type. ensure the user ID is not set as 0. diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicevolumechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicevolumechanged.dita index 28444bc5abd..436c045792a 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicevolumechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicevolumechanged.dita @@ -44,7 +44,7 @@ deviceType - The device type. See . + The device type. ensure the user ID is not set as 0. volume diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioquality.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioquality.dita index 7964dca2de5..b13308ec54c 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioquality.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioquality.dita @@ -60,7 +60,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. uid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioroutingchanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioroutingchanged.dita index 65a9d06420e..9c203ace9c7 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioroutingchanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioroutingchanged.dita @@ -40,7 +40,7 @@ routing -

        The current audio routing. See .

        +

        The current audio routing. ensure the user ID is not set as 0.

        The current audio routing.

        • (-1): The default audio route.
        • (0): The audio route is a headset with a microphone.
          • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiovolumeindication.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiovolumeindication.dita index 26a0cedda89..a9ef31ec6ad 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiovolumeindication.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiovolumeindication.dita @@ -52,7 +52,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. speakers diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncameraexposureareachanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncameraexposureareachanged.dita index 33b53dc608f..d0b45d95dfa 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncameraexposureareachanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncameraexposureareachanged.dita @@ -60,7 +60,7 @@ rect - The focus rectangle in the local preview. See . + The focus rectangle in the local preview. ensure the user ID is not set as 0.
        diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita index f61c9323c96..bcf7bb0d462 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita @@ -59,7 +59,7 @@ rect - The focus rectangle in the local preview. See . + The focus rectangle in the local preview. ensure the user ID is not set as 0. diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelayevent.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelayevent.dita index c4973cb74da..be7019ad41e 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelayevent.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelayevent.dita @@ -44,7 +44,7 @@ didReceiveChannelMediaRelayEvent:(AgoraChannelMediaRelayEvent)event; code event -

        The event code of channel media relay. See .

        +

        The event code of channel media relay. ensure the user ID is not set as 0.

        The event code of channel media relay:

        • (0): The user disconnects from the server due to a poor network connection.
        • (1): The user is connected to the server.
          • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita index e27cc185ed1..19a7ad9e785 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita @@ -46,7 +46,7 @@ channelMediaRelayStateDidChange:(AgoraChannelMediaRelayState)state state -

          The state code. See .

          +

          The state code. ensure the user ID is not set as 0.

          The state code:

          • (0): The SDK is initializing.
          • (1): The SDK tries to relay the media stream to the destination channel.
            • @@ -58,7 +58,7 @@ channelMediaRelayStateDidChange:(AgoraChannelMediaRelayState)state code -

            The error code of the channel media relay. See .

            +

            The error code of the channel media relay. ensure the user ID is not set as 0.

            The error code of the channel media relay.

            • (0): Everything is normal.
            • (1): An error occurs in the server response.
              • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita index 0427bba625c..598ba9ac5ed 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita @@ -48,7 +48,7 @@ NS_SWIFT_NAME(rtcEngine(_:didClientRoleChanged:newRole:newRoleOptions:)); connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. oldRole @@ -71,7 +71,7 @@ NS_SWIFT_NAME(rtcEngine(_:didClientRoleChanged:newRole:newRoleOptions:));v4.1.0 -

              Properties of the role that the user switches to. See .

              +

              Properties of the role that the user switches to. ensure the user ID is not set as 0.

               diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita index 6ed744c8753..14ebecaca52 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita @@ -44,7 +44,7 @@ reason - The reason for a user role switch failure. See . + The reason for a user role switch failure. ensure the user ID is not set as 0. The possible reasons for the switch failure include the following:
              • (1): The number of hosts in the channel is already at the upper limit.This enumerator is reported only when the support for 128 users is enabled. The maximum number of hosts is based on the actual number of hosts configured when you enable the 128-user feature.
              • (2): The request is rejected by the Agora server. Agora recommends you prompt the user to try to switch their user role again.
                • @@ -54,7 +54,7 @@ currentRole - Current user role. See . + Current user role. ensure the user ID is not set as 0. Current user role.
                • (1): Host. A host can both send and receive streams.
                • (2): Audience. An audience member can only receive streams.
                  • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionbanned.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionbanned.dita index c8930125ec0..d55a7a1bb4b 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionbanned.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionbanned.dita @@ -39,7 +39,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectioninterrupted.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectioninterrupted.dita index 021c02dbdf9..82ef7d58bff 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectioninterrupted.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectioninterrupted.dita @@ -43,7 +43,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionlost.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionlost.dita index 95c2d0fbc69..68f4f897e86 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionlost.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionlost.dita @@ -34,7 +34,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita index 3cd04c57c2b..7ba9cb95571 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita @@ -48,12 +48,12 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. state -

                  The current connection state. See .

                  +

                  The current connection state. ensure the user ID is not set as 0.

                  • (1): The SDK is disconnected from Agora's edge server.
                  • (2): The SDK is connecting to Agora's edge server.
                    • @@ -65,7 +65,7 @@ reason -

                    The reason for a connection state change. See .

                    +

                    The reason for a connection state change. ensure the user ID is not set as 0.

                    • (0): The SDK is connecting to Agora's edge server.
                      • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncontentinspectresult.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncontentinspectresult.dita index 376ee662939..8ecc92000bd 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncontentinspectresult.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncontentinspectresult.dita @@ -32,7 +32,7 @@ result - Content moderation results. See . + Content moderation results. ensure the user ID is not set as 0.

                      The results of video content moderation:

                      • (1): The image does not contain inappropriate elements.
                        • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onencryptionerror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onencryptionerror.dita index 6d3bf12aa07..77d43786752 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onencryptionerror.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onencryptionerror.dita @@ -45,7 +45,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. errorType diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita index 934682d3331..4840261b5d6 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita @@ -41,7 +41,7 @@ errorCode err - Error code. See . + Error code. ensure the user ID is not set as 0. msg diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfacepositionchanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfacepositionchanged.dita index f58072076ab..db19e001afc 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfacepositionchanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfacepositionchanged.dita @@ -90,7 +90,7 @@
                      • height: The height (px) of the human face in the captured view.

                       - The information of the detected human face. See . + The information of the detected human face. ensure the user ID is not set as 0.                       vecDistance diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalaudioframepublished.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalaudioframepublished.dita index 23ba12aa0b0..126b122276c 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalaudioframepublished.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalaudioframepublished.dita @@ -49,7 +49,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. elapsed diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframepublished.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframepublished.dita index 93da417f32c..d27575ed217 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframepublished.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframepublished.dita @@ -53,7 +53,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideodecoded.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideodecoded.dita index 1dbcde8771f..b2612aa3092 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideodecoded.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideodecoded.dita @@ -72,7 +72,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. remoteUid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita index e5f206babb2..975726dbd43 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita @@ -60,7 +60,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. width diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita index 573d24fec8d..6e4fed9d070 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita @@ -50,7 +50,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. elapsed diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita index 2e16b972394..3e99864f370 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita @@ -37,7 +37,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. stats diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita index 0969832c94c..68cc3daf466 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita @@ -48,11 +48,11 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. state - The state of the local audio. See . + The state of the local audio. ensure the user ID is not set as 0. The state of the local audio.
                      • (0): The local video is in the initial state.
                      • (1): The local video capturing device starts successfully.
                        • @@ -62,7 +62,7 @@ error - Local audio state error codes. See . + Local audio state error codes. ensure the user ID is not set as 0. Local audio state error codes.
                        • 0: The local audio is normal.
                        • 1: No specified reason for the local audio failure. Remind your users to try to rejoin the channel.
                          • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostats.dita index b9ce15c7ab4..4483c20c52d 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostats.dita @@ -38,11 +38,11 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. stats - Local audio statistics. See . + Local audio statistics. ensure the user ID is not set as 0. diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita index 59d3c140a40..da19270bafc 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita @@ -63,7 +63,7 @@ sourceType source - The type of the video source. See . + The type of the video source. ensure the user ID is not set as 0. state diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostats.dita index 425e6d47bad..3b79ebcf4e5 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostats.dita @@ -42,7 +42,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. @@ -50,7 +50,7 @@ stats - The statistics of the local video stream. See . + The statistics of the local video stream. ensure the user ID is not set as 0. diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita index 211867aa8c9..be0f54049db 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita @@ -49,12 +49,12 @@ stream - The video streams that cannot be mixed during video mixing. See . + The video streams that cannot be mixed during video mixing. ensure the user ID is not set as 0. error errorCode - The reason for local video mixing error. See . + The reason for local video mixing error. ensure the user ID is not set as 0. The reason for local video mixing error:
                          • 1: The selected video source has not started video capture. You need to create a video track for it and start video capture.
                          • 2: The video source type is invalid. You need to re-specify the supported video source type.
                            • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita index 27f7ff28e3b..3df265c1a54 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita @@ -53,7 +53,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. uid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworktypechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworktypechanged.dita index 77f57f45e8f..6e99b233b7a 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworktypechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworktypechanged.dita @@ -37,12 +37,12 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. type -

                            The type of the local network connection. See .

                            +

                            The type of the local network connection. ensure the user ID is not set as 0.

                            Network types:

                            • (-1): The network type is unknown.
                            • (0): The SDK disconnects from the network.
                              • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onpermissionerror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onpermissionerror.dita index 2e20b88e329..f9ef693dfab 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onpermissionerror.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onpermissionerror.dita @@ -38,7 +38,7 @@ permission type permissionType - The type of the device permission. See . + The type of the device permission. ensure the user ID is not set as 0. The type of the device permission.
                              • (0): Permission for the audio capture device.
                              • (1): Permission for the camera.
                                • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onproxyconnected.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onproxyconnected.dita index fe7d799511b..eb77ba1fd08 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onproxyconnected.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onproxyconnected.dita @@ -58,7 +58,7 @@ proxyType - The proxy type connected. See . + The proxy type connected. ensure the user ID is not set as 0. The proxy type connected.
                                • (0): Reserved for future use.
                                • (1): The cloud proxy for the UDP protocol, that is, the Force UDP cloud proxy mode. In this mode, the SDK always transmits data over UDP.
                                  • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita index 4e67cb5d06e..9af94a21667 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita @@ -48,7 +48,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. elapsed diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita index 15664166f08..8580ca5137e 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita @@ -60,7 +60,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. uid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostats.dita index ee85ed09753..4532abf69fd 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostats.dita @@ -38,7 +38,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. stats diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiotransportstats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiotransportstats.dita index 9d7ef0ea635..424e6632c83 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiotransportstats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiotransportstats.dita @@ -67,7 +67,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. uid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostatechanged.dita index c6abb27bcef..05c4754116e 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostatechanged.dita @@ -59,7 +59,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. uid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostats.dita index 4f4333a8f30..097a732efef 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostats.dita @@ -36,11 +36,11 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. stats - Statistics of the remote video stream. See . + Statistics of the remote video stream. ensure the user ID is not set as 0. diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideotransportstats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideotransportstats.dita index e6c8a8af98a..04c7a266d43 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideotransportstats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideotransportstats.dita @@ -66,7 +66,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. uid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtcstats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtcstats.dita index 789bb6fa173..757a7d598f8 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtcstats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtcstats.dita @@ -37,7 +37,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. stats diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita index ca176be64c3..9833509c0e6 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita @@ -36,7 +36,7 @@ eventCode event - The event code of Media Push. See . + The event code of Media Push. ensure the user ID is not set as 0. The event code of Media Push.
                                  • (1): An error occurs when you add a background image or a watermark image in the Media Push.
                                  • (2): The streaming URL is already being used for Media Push. If you want to start new streaming, use a new streaming URL.
                                    • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablevideo.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablevideo.dita index 7bab9eb5b50..296dcc2ecb0 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablevideo.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablevideo.dita @@ -58,7 +58,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. uid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserjoined.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserjoined.dita index 394bd25300b..912cab687e7 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserjoined.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserjoined.dita @@ -48,7 +48,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. uid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermutevideo.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermutevideo.dita index 472c8918f5a..e009f571fd6 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermutevideo.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermutevideo.dita @@ -55,7 +55,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. uid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuseroffline.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuseroffline.dita index ef5d105f7a9..8a2b5448a67 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuseroffline.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuseroffline.dita @@ -51,7 +51,7 @@ connection - The connection information. See . + The connection information. ensure the user ID is not set as 0. uid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideodevicestatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideodevicestatechanged.dita index 2003a6a9c98..d5a7d7429d4 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideodevicestatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideodevicestatechanged.dita @@ -47,7 +47,7 @@ deviceType - Media device types. See . + Media device types. ensure the user ID is not set as 0. deviceState diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideopublishstatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideopublishstatechanged.dita index b3e8848e421..f1069e3d30b 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideopublishstatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideopublishstatechanged.dita @@ -70,7 +70,7 @@ elapseSinceLastState:(int)elapseSinceLastState; sourceType source - The type of the video source. See . + The type of the video source. ensure the user ID is not set as 0. oldState diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideorenderingtracingresult.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideorenderingtracingresult.dita index 848ecba2773..83fd45a06b0 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideorenderingtracingresult.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideorenderingtracingresult.dita @@ -62,11 +62,11 @@ currentEvent - The current video frame rendering event. See . + The current video frame rendering event. ensure the user ID is not set as 0. tracingInfo - The indicators during the video frame rendering process. Developers need to reduce the value of indicators as much as possible in order to improve the efficiency of the first video frame rendering. See . + The indicators during the video frame rendering process. Developers need to reduce the value of indicators as much as possible in order to improve the efficiency of the first video frame rendering. ensure the user ID is not set as 0. diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getobservedframeposition.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getobservedframeposition.dita index 2eee26eda55..824db74276f 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getobservedframeposition.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getobservedframeposition.dita @@ -44,7 +44,7 @@
                                  Returns -

                                  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. ensure the user ID is not set as 0.

                                  A bit mask that controls the frame position of the video observer.

                                  • (1 << 0): The position after capturing the video data, which corresponds to the callback.
                                  • (1 << 1): The position of the received remote video data before rendering, which corresponds to the callback.
                                    • diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getvideoformatpreference.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getvideoformatpreference.dita index a73c149badc..3365230a16a 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getvideoformatpreference.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getvideoformatpreference.dita @@ -32,7 +32,7 @@ If you want the video captured by the sender to be the original format, set the original video data format to in the return value. The original video pixel format varies based on different platforms. For the actual video pixel format, see .
                                  Returns -

                                  Sets the video format. See .

                                  +

                                  Sets the video format. ensure the user ID is not set as 0.

                                  According to different observation locations and collection scenarios, the actual video pixel format corresponding to this enumeration value is different. Agora recommends that you do not use this value. Some common situations are listed below.

                                  diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onframe.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onframe.dita index aa4eef52a77..01005ffc786 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onframe.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onframe.dita @@ -40,15 +40,15 @@ audioFrame - Configurations of the video frame. See . + Configurations of the video frame. ensure the user ID is not set as 0. config - The type and source of the video frame. See . + The type and source of the video frame. ensure the user ID is not set as 0. playerKit - See . + ensure the user ID is not set as 0. pixelBuffer diff --git a/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita b/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita index f30f5800980..017a139bb66 100644 --- a/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita @@ -1,8 +1,9 @@ - <ph keyref="LocalAccessPointConfiguration" /> - The configurations of the Local Access Point. + <ph keyref="LocalAccessPointConfiguration"/> + The configurations of the Local Access Point.

                                  @@ -59,8 +60,8 @@ return logUploadServer; } }; - public ArrayList<String> ipList = null; - public ArrayList<String> domainList = null; + public ArrayList<String> ipList = null; + public ArrayList<String> domainList = null; public String verifyDomainName = null; public int mode = Constants.LOCAL_RPOXY_CONNECTIVITY_FIRST; public AdvancedConfigInfo advancedConfig = null; @@ -146,13 +147,13 @@ this.advancedConfig}); @JsonKey(name: 'ipList') - final List<String>? ipList; + final List<String>? ipList; @JsonKey(name: 'ipListSize') final int? ipListSize; @JsonKey(name: 'domainList') - final List<String>? domainList; + final List<String>? domainList; @JsonKey(name: 'domainListSize') final int? domainListSize; @@ -166,15 +167,15 @@ @JsonKey(name: 'advancedConfig') final AdvancedConfigInfo? advancedConfig; - factory LocalAccessPointConfiguration.fromJson(Map<String, dynamic> json) => + factory LocalAccessPointConfiguration.fromJson(Map<String, dynamic> json) => _$LocalAccessPointConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$LocalAccessPointConfigurationToJson(this); + Map<String, dynamic> toJson() => _$LocalAccessPointConfigurationToJson(this); } -

                                  +

                                  - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> ipList @@ -199,17 +200,20 @@ mode -

                                  The connection mode. See .

                                  +

                                  The connection mode. ensure the user ID is not set as 0.

                                  Select one of the following connection modes:

                                    -
                                  • (0): The SDK firstly tries to connect to the specified Agora private media server; if the connection attempt fails, it will connect to the Agora SD-RTN™ instead.
                                    • -
                                  • (1) The SDK only tries to connect to the specified Agora private media server.
                                    • +
                                  • (0): The SDK firstly tries to connect to the specified Agora private media server; if the connection attempt fails, it will connect to the Agora SD-RTN™ instead.
                                    • +
                                  • (1) The SDK only tries to connect to the specified Agora private media server.

                                                                     advancedConfig - The advanced options for the Local Access Point. See . + The advanced options for the Local Access Point. ensure the user ID is not set as 0.
                                  -                                   \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_advanceoptions.dita b/en-US/dita/RTC-NG/API/class_advanceoptions.dita index ec0bc49e668..0704e891398 100644 --- a/en-US/dita/RTC-NG/API/class_advanceoptions.dita +++ b/en-US/dita/RTC-NG/API/class_advanceoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="AdvanceOptions" /> + <ph keyref="AdvanceOptions"/> Advanced options for video encoding.
                                  @@ -75,12 +75,12 @@ @JsonKey(name: 'compressionPreference') final CompressionPreference? compressionPreference; - factory AdvanceOptions.fromJson(Map<String, dynamic> json) => + factory AdvanceOptions.fromJson(Map<String, dynamic> json) => _$AdvanceOptionsFromJson(json); - Map<String, dynamic> toJson() => _$AdvanceOptionsToJson(this); + Map<String, dynamic> toJson() => _$AdvanceOptionsToJson(this); } -

                                  +

                                  @@ -89,19 +89,19 @@
                                  v4.1.0
                                  -

                                  +

                                  - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> encodingPreference - Video encoder preference. See . + Video encoder preference. ensure the user ID is not set as 0. compressionPreference - Compression preference for video encoding. See . + Compression preference for video encoding. ensure the user ID is not set as 0.
                                  -                                   \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_audioencodedframeobserverconfig.dita b/en-US/dita/RTC-NG/API/class_audioencodedframeobserverconfig.dita index 40194641244..36d849e4c09 100644 --- a/en-US/dita/RTC-NG/API/class_audioencodedframeobserverconfig.dita +++ b/en-US/dita/RTC-NG/API/class_audioencodedframeobserverconfig.dita @@ -76,7 +76,7 @@ postionType -

                                  Audio profile. See .

                                  +

                                  Audio profile. ensure the user ID is not set as 0.

                                  Audio profile:

                                  • (1): Only encode the audio of the local user.
                                  • (2): Only encode the audio of all remote users.
                                    • @@ -87,7 +87,7 @@ encodingType -

                                    Audio encoding type. See .

                                    +

                                    Audio encoding type. ensure the user ID is not set as 0.

                                    Audio encoding type:

                                    • : AAC encoding format, 16000 Hz sampling rate, low quality. A file with an audio duration of 10 minutes is approximately 1.2 MB after encoding.
                                    • : AAC encoding format, 16000 Hz sampling rate, medium quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
                                      • diff --git a/en-US/dita/RTC-NG/API/class_audioparams.dita b/en-US/dita/RTC-NG/API/class_audioparams.dita index 141dda8efba..cb037b48704 100644 --- a/en-US/dita/RTC-NG/API/class_audioparams.dita +++ b/en-US/dita/RTC-NG/API/class_audioparams.dita @@ -1,7 +1,7 @@ - <ph keyref="AudioParams" /> + <ph keyref="AudioParams"/> Audio data format.
                                      @@ -98,33 +98,33 @@ @JsonKey(name: 'samples_per_call') final int? samplesPerCall; - factory AudioParams.fromJson(Map<String, dynamic> json) => + factory AudioParams.fromJson(Map<String, dynamic> json) => _$AudioParamsFromJson(json); - Map<String, dynamic> toJson() => _$AudioParamsToJson(this); + Map<String, dynamic> toJson() => _$AudioParamsToJson(this); } -

                                      +

                                      -

                                      You can pass the object in the following APIs to set the audio data format for the corresponding callback:

                                        -
                                      • : Sets the audio data format for the callback.
                                        • -
                                      • : Sets the audio data format for the callback.
                                        • -
                                      • : Sets the audio data format for the callback.
                                        • -
                                      • : Sets the audio data format for the callback.
                                        • -

                                      -

                                      The SDK sets the audio data format in the following callbacks according to .

                                        -
                                        • -
                                        • -
                                        • +

                                        You can pass the object in the following APIs to set the audio data format for the corresponding callback:

                                          +
                                        • : Sets the audio data format for the callback.
                                          • +
                                        • : Sets the audio data format for the callback.
                                          • +
                                        • : Sets the audio data format for the callback.
                                          • +
                                        • : Sets the audio data format for the callback.

                                        +

                                        The SDK sets the audio data format in the following callbacks according to .

                                          +
                                          • +
                                          • +
                                          • +

                                          -
                                        • The SDK calculates the sampling interval through the samplesPerCall, sampleRate, and channel parameters in , and triggers the , , , and callbacks according to the sampling interval.
                                          • +
                                        • The SDK calculates the sampling interval through the samplesPerCall, sampleRate, and channel parameters in , and triggers the , , , and callbacks according to the sampling interval.
                                        • Sample interval (sec) = samplePerCall/(sampleRate × channel).
                                        • Ensure that the sample interval ≥ 0.01 (s).
                                      - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> sampleRate @@ -147,10 +147,10 @@ mode - The use mode of the audio data. See . + The use mode of the audio data. ensure the user ID is not set as 0. The use mode of the audio data, which can be set as either of the following values:
                                        -
                                      • (0): Read-only mode, where users only read the original data from without any modification. For example, when users acquire the data with the Agora SDK, then start the media push.
                                        • -
                                      • (2): Read and write mode, where users read the data from , modify it, and then play it. Users read the data returned by the SDK, modify it, and then play it. For example, when users have their own audio-effect processing module and perform some voice pre-processing, such as a voice change.
                                        • +
                                      • (0): Read-only mode, where users only read the original data from without any modification. For example, when users acquire the data with the Agora SDK, then start the media push.
                                        • +
                                      • (2): Read and write mode, where users read the data from , modify it, and then play it. Users read the data returned by the SDK, modify it, and then play it. For example, when users have their own audio-effect processing module and perform some voice pre-processing, such as a voice change.
                                                                             @@ -160,4 +160,4 @@
                                      -                                       \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita b/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita index d709cc85a1c..9957b429b48 100644 --- a/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita @@ -164,12 +164,12 @@ @JsonKey(name: 'recordingChannel') final int? recordingChannel; - factory AudioRecordingConfiguration.fromJson(Map<String, dynamic> json) => + factory AudioRecordingConfiguration.fromJson(Map<String, dynamic> json) => _$AudioRecordingConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$AudioRecordingConfigurationToJson(this); + Map<String, dynamic> toJson() => _$AudioRecordingConfigurationToJson(this); } -

                                      +

                                  <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -204,7 +204,7 @@ fileRecordingType fileRecordOption -

                                  The recording content. See .

                                  +

                                  The recording content. ensure the user ID is not set as 0.

                                  Recording content:

                                  • (1): Only records the audio of the local user.
                                  • (2): Only records the audio of all remote users.
                                    • @@ -215,7 +215,7 @@ quality -

                                    Recording quality. See .

                                    +

                                    Recording quality. ensure the user ID is not set as 0.

                                    Recording quality:

                                    • (0): Low quality. For example, the size of an AAC file with a sample rate of 32,000 Hz and a recording duration of 10 minutes is around 1.2 MB.
                                    • (1): (Default) Medium quality. For example, the size of an AAC file with a sample rate of 32,000 Hz and a recording duration of 10 minutes is around 2 MB.
                                      • diff --git a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita index 87fe88d06c2..9cfeb4b78c7 100644 --- a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita @@ -1,7 +1,7 @@ - <ph keyref="CameraCapturerConfiguration" /> + <ph keyref="CameraCapturerConfiguration"/> The camera capturer preference.
                                      @@ -199,40 +199,40 @@ @JsonKey(name: 'followEncodeDimensionRatio') final bool? followEncodeDimensionRatio; - factory CameraCapturerConfiguration.fromJson(Map<String, dynamic> json) => + factory CameraCapturerConfiguration.fromJson(Map<String, dynamic> json) => _$CameraCapturerConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$CameraCapturerConfigurationToJson(this); + Map<String, dynamic> toJson() => _$CameraCapturerConfigurationToJson(this); } -

                                      +

                                      - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <title> <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> cameraDirection - This parameter applies to Android and iOS only.The camera direction. See . + This parameter applies to Android and iOS only.The camera direction. ensure the user ID is not set as 0. format captureFormat - The format of the video frame. See . + The format of the video frame. ensure the user ID is not set as 0. deviceId This method applies to Windows only. - This method applies to macOS only.The ID of the camera. The maximum length is . + This method applies to macOS only.The ID of the camera. The maximum length is . followEncodeDimensionRatio - Whether to follow the video aspect ratio set in :
                                        -
                                      • : (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in and .
                                        • -
                                      • : Do not follow the system default audio playback device. The SDK does not change the aspect ratio of the captured video frame.
                                        • + Whether to follow the video aspect ratio set in :
                                          +
                                        • : (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in and .
                                          • +
                                        • : Do not follow the system default audio playback device. The SDK does not change the aspect ratio of the captured video frame.
                                      -                                       \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita index d2e73d40f4a..9ccfabe4d2a 100644 --- a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita +++ b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="ChannelMediaOptions" /> + <ph keyref="ChannelMediaOptions"/> The channel media options.
                                      @@ -80,8 +80,8 @@ struct ChannelMediaOptions { Optional<bool> publishCameraTrack; Optional<bool> publishSecondaryCameraTrack; - Optional<bool> publishThirdCameraTrack; - Optional<bool> publishFourthCameraTrack; + Optional<bool> publishThirdCameraTrack; + Optional<bool> publishFourthCameraTrack; Optional<bool> publishMicrophoneTrack; #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) @@ -90,8 +90,8 @@ #else Optional<bool> publishScreenTrack; Optional<bool> publishSecondaryScreenTrack; - Optional<bool> publishThirdScreenTrack; - Optional<bool> publishFourthScreenTrack; + Optional<bool> publishThirdScreenTrack; + Optional<bool> publishFourthScreenTrack; #endif Optional<bool> publishCustomAudioTrack; @@ -223,37 +223,37 @@ } public class ChannelMediaOptions : OptionalJsonParse { - public Optional<bool> publishCameraTrack = new Optional<bool>(); - public Optional<bool> publishSecondaryCameraTrack = new Optional<bool>(); - public Optional<bool> publishThirdCameraTrack = new Optional<bool>(); - public Optional<bool> publishFourthCameraTrack = new Optional<bool>(); - public Optional<bool> publishMicrophoneTrack = new Optional<bool>(); - public Optional<bool> publishScreenCaptureVideo = new Optional<bool>(); - public Optional<bool> publishScreenCaptureAudio = new Optional<bool>(); - public Optional<bool> publishScreenTrack = new Optional<bool>(); - public Optional<bool> publishSecondaryScreenTrack = new Optional<bool>(); - public Optional<bool> publishThirdScreenTrack = new Optional<bool>(); - public Optional<bool> publishFourthScreenTrack = new Optional<bool>(); - public Optional<bool> publishCustomAudioTrack = new Optional<bool>(); - public Optional<int> publishCustomAudioTrackId = new Optional<int>(); - public Optional<bool> publishCustomVideoTrack = new Optional<bool>(); - public Optional<bool> publishEncodedVideoTrack = new Optional<bool>(); - public Optional<bool> publishMediaPlayerAudioTrack = new Optional<bool>(); - public Optional<bool> publishMediaPlayerVideoTrack = new Optional<bool>(); - public Optional<bool> publishTranscodedVideoTrack = new Optional<bool>(); - public Optional<bool> autoSubscribeAudio = new Optional<bool>(); - public Optional<bool> autoSubscribeVideo = new Optional<bool>(); - public Optional<bool> enableAudioRecordingOrPlayout = new Optional<bool>(); - public Optional<int> publishMediaPlayerId = new Optional<int>(); - public Optional<CLIENT_ROLE_TYPE> clientRoleType = new Optional<CLIENT_ROLE_TYPE>(); - public Optional<AUDIENCE_LATENCY_LEVEL_TYPE> audienceLatencyLevel = new Optional<AUDIENCE_LATENCY_LEVEL_TYPE>(); - public Optional<VIDEO_STREAM_TYPE> defaultVideoStreamType = new Optional<VIDEO_STREAM_TYPE>(); - public Optional<CHANNEL_PROFILE_TYPE> channelProfile = new Optional<CHANNEL_PROFILE_TYPE>(); - public Optional<string> token = new Optional<string>(); - public Optional<bool> publishRhythmPlayerTrack = new Optional<bool>(); - public Optional<bool> isInteractiveAudience = new Optional<bool>(); - public Optional<video_track_id_t> customVideoTrackId = new Optional<video_track_id_t>(); - public Optional<bool> isAudioFilterable = new Optional<bool>(); + public Optional<bool> publishCameraTrack = new Optional<bool>(); + public Optional<bool> publishSecondaryCameraTrack = new Optional<bool>(); + public Optional<bool> publishThirdCameraTrack = new Optional<bool>(); + public Optional<bool> publishFourthCameraTrack = new Optional<bool>(); + public Optional<bool> publishMicrophoneTrack = new Optional<bool>(); + public Optional<bool> publishScreenCaptureVideo = new Optional<bool>(); + public Optional<bool> publishScreenCaptureAudio = new Optional<bool>(); + public Optional<bool> publishScreenTrack = new Optional<bool>(); + public Optional<bool> publishSecondaryScreenTrack = new Optional<bool>(); + public Optional<bool> publishThirdScreenTrack = new Optional<bool>(); + public Optional<bool> publishFourthScreenTrack = new Optional<bool>(); + public Optional<bool> publishCustomAudioTrack = new Optional<bool>(); + public Optional<int> publishCustomAudioTrackId = new Optional<int>(); + public Optional<bool> publishCustomVideoTrack = new Optional<bool>(); + public Optional<bool> publishEncodedVideoTrack = new Optional<bool>(); + public Optional<bool> publishMediaPlayerAudioTrack = new Optional<bool>(); + public Optional<bool> publishMediaPlayerVideoTrack = new Optional<bool>(); + public Optional<bool> publishTranscodedVideoTrack = new Optional<bool>(); + public Optional<bool> autoSubscribeAudio = new Optional<bool>(); + public Optional<bool> autoSubscribeVideo = new Optional<bool>(); + public Optional<bool> enableAudioRecordingOrPlayout = new Optional<bool>(); + public Optional<int> publishMediaPlayerId = new Optional<int>(); + public Optional<CLIENT_ROLE_TYPE> clientRoleType = new Optional<CLIENT_ROLE_TYPE>(); + public Optional<AUDIENCE_LATENCY_LEVEL_TYPE> audienceLatencyLevel = new Optional<AUDIENCE_LATENCY_LEVEL_TYPE>(); + public Optional<VIDEO_STREAM_TYPE> defaultVideoStreamType = new Optional<VIDEO_STREAM_TYPE>(); + public Optional<CHANNEL_PROFILE_TYPE> channelProfile = new Optional<CHANNEL_PROFILE_TYPE>(); + public Optional<string> token = new Optional<string>(); + public Optional<bool> publishRhythmPlayerTrack = new Optional<bool>(); + public Optional<bool> isInteractiveAudience = new Optional<bool>(); + public Optional<video_track_id_t> customVideoTrackId = new Optional<video_track_id_t>(); + public Optional<bool> isAudioFilterable = new Optional<bool>(); } export class ChannelMediaOptions { @@ -462,66 +462,66 @@ class ChannelMediaOptions { @JsonKey(name: 'isAudioFilterable') final bool? isAudioFilterable; - factory ChannelMediaOptions.fromJson(Map<String, dynamic> json) => + factory ChannelMediaOptions.fromJson(Map<String, dynamic> json) => _$ChannelMediaOptionsFromJson(json); - Map<String, dynamic> toJson() => _$ChannelMediaOptionsToJson(this); + Map<String, dynamic> toJson() => _$ChannelMediaOptionsToJson(this); } -

                                      +

                                      -
                                      Agora supports publishing multiple audio streams and one video stream at the same time and in the same . For example, publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as at the same time, but only one of publishCameraTrack, publishScreenCaptureVideopublishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as .Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters. +
                                      Agora supports publishing multiple audio streams and one video stream at the same time and in the same . For example, publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as at the same time, but only one of publishCameraTrack, publishScreenCaptureVideopublishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as .Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters.
                                      - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> publishCameraTrack Whether to publish the video captured by the camera:
                                        -
                                      • : Publish the video captured by the camera.
                                        • -
                                      • : Do not publish the video captured by the camera.
                                        • +
                                      • : Publish the video captured by the camera.
                                        • +
                                      • : Do not publish the video captured by the camera.
                                                                             publishSecondaryCameraTrack Whether to publish the video captured by the second camera:
                                        -
                                      • : Publish the video captured by the second camera.
                                        • -
                                      • : Do not publish the video captured by the second camera.
                                        • +
                                      • : Publish the video captured by the second camera.
                                        • +
                                      • : Do not publish the video captured by the second camera.
                                                                             publishMicrophoneTrack Whether to publish the audio captured by the microphone:
                                        -
                                      • : Publish the audio captured by the microphone.
                                        • -
                                      • : Do not publish the audio captured by the microphone.
                                        • +
                                      • : Publish the audio captured by the microphone.
                                        • +
                                      • : Do not publish the audio captured by the microphone.
                                      • As of v4.0.0, the parameter name is changed from publishAudioTrack to publishMicrophoneTrack.
                                      • As of v6.0.0, the parameter name is changed from publishAudioTrack to publishMicrophoneTrack.
                                        • -
                                      • If you want to publish the audio streams captured by your microphone, ensure enableAudioRecordingOrPlayout is set as .
                                       +
                                    • If you want to publish the audio streams captured by your microphone, ensure enableAudioRecordingOrPlayout is set as .
                                                                         publishThirdCameraTrack Whether to publish the video captured by the third camera:
                                      -
                                    • : Publish the video captured by the third camera.
                                      • -
                                    • : Do not publish the video captured by the third camera.
                                      • +
                                    • : Publish the video captured by the third camera.
                                      • +
                                    • : Do not publish the video captured by the third camera.

                                    This method is for Windows and macOS only.

                                                                         publishFourthCameraTrack Whether to publish the video captured by the fourth camera:
                                      -
                                    • : Publish the video captured by the fourth camera.
                                      • -
                                    • : Do not publish the video captured by the fourth camera.
                                      • +
                                    • : Publish the video captured by the fourth camera.
                                      • +
                                    • : Do not publish the video captured by the fourth camera.

                                    This method is for Windows and macOS only.

                                                                         publishScreenTrack

                                    Whether to publish the video captured from the screen:

                                      -
                                    • : Publish the video captured from the screen.
                                      • -
                                    • : Do not publish the video captured from the screen.
                                      • +
                                    • : Publish the video captured from the screen.
                                      • +
                                    • : Do not publish the video captured from the screen.

                                    This method is for Windows and macOS only.

                                     @@ -530,8 +530,8 @@ class ChannelMediaOptions { publishScreenCaptureVideo

                                    Whether to publish the video captured from the screen:

                                      -
                                    • : Publish the video captured from the screen.
                                      • -
                                    • : Do not publish the video captured from the screen.
                                      • +
                                    • : Publish the video captured from the screen.
                                      • +
                                    • : Do not publish the video captured from the screen.

                                    This parameter applies to Android and iOS only.

                                    As of v4.0.0, the parameter name is changed from publishScreenTrack to publishScreenCaptureVideo.

                                     @@ -540,8 +540,8 @@ class ChannelMediaOptions { publishScreenCaptureAudio

                                    Whether to publish the audio captured from the screen:

                                      -
                                    • : Publish the audio captured from the screen.
                                      • -
                                    • : Publish the audio captured from the screen.
                                      • +
                                    • : Publish the audio captured from the screen.
                                      • +
                                    • : Publish the audio captured from the screen.

                                    This parameter applies to Android and iOS only.

                                    @@ -550,16 +550,16 @@ class ChannelMediaOptions { publishSecondaryScreenTrack Whether to publish the video captured from the second screen:
                                      -
                                    • : Publish the video captured from the second screen.
                                      • -
                                    • : Do not publish the video captured from the second screen.
                                      • +
                                    • : Publish the video captured from the second screen.
                                      • +
                                    • : Do not publish the video captured from the second screen.
                                                                         publishThirdScreenTrack Whether to publish the video captured from the third screen:
                                      -
                                    • : Publish the captured video from the third screen.
                                      • -
                                    • : Do not publish the video captured from the third screen.
                                      • +
                                    • : Publish the captured video from the third screen.
                                      • +
                                    • : Do not publish the video captured from the third screen.

                                    This method is for Windows and macOS only.

                                    @@ -568,8 +568,8 @@ class ChannelMediaOptions { publishFourthScreenTrack Whether to publish the video captured from the fourth screen:
                                      -
                                    • : Publish the captured video from the fourth screen.
                                      • -
                                    • : Do not publish the video captured from the fourth screen.
                                      • +
                                    • : Publish the captured video from the fourth screen.
                                      • +
                                    • : Do not publish the video captured from the fourth screen.

                                    This method is for Windows and macOS only.

                                    @@ -578,8 +578,8 @@ class ChannelMediaOptions { publishTranscodedVideoTrack Whether to publish the local transcoded video:
                                      -
                                    • : Publish the local transcoded video.
                                      • -
                                    • : Do not publish the local transcoded video.
                                      • +
                                    • : Publish the local transcoded video.
                                      • +
                                    • : Do not publish the local transcoded video.

                                    As of v4.2.0, the parameter name is corrected from publishTrancodedVideoTrack to publishTranscodedVideoTrack.

                                     @@ -587,64 +587,64 @@ class ChannelMediaOptions { publishCustomAudioTrack Whether to publish the audio captured from a custom source:
                                      -
                                    • : Publish the audio captured from the custom source.
                                      • -
                                    • : Do not publish the captured audio from a custom source.
                                      • +
                                    • : Publish the audio captured from the custom source.
                                      • +
                                    • : Do not publish the captured audio from a custom source.
                                                                         publishCustomAudioTrackId - The ID of the custom audio source to publish. The default value is 0.

                                    If you have set sourceNumber in to a value greater than 1, the SDK creates the corresponding number of custom audio tracks and assigns an ID to each audio track, starting from 0.

                                    + The ID of the custom audio source to publish. The default value is 0.

                                    If you have set sourceNumber in to a value greater than 1, the SDK creates the corresponding number of custom audio tracks and assigns an ID to each audio track, starting from 0.

                                                                         publishCustomVideoTrack Whether to publish the video captured from a custom source:
                                      -
                                    • : Publish the video captured from the custom source.
                                      • -
                                    • : Do not publish the captured video from a custom source.
                                      • +
                                    • : Publish the video captured from the custom source.
                                      • +
                                    • : Do not publish the captured video from a custom source.
                                                                         publishEncodedVideoTrack Whether to publish the encoded video:
                                      -
                                    • : Publish the encoded video.
                                      • -
                                    • : Do not publish the encoded video.
                                      • +
                                    • : Publish the encoded video.
                                      • +
                                    • : Do not publish the encoded video.
                                                                         publishMediaPlayerAudioTrack Whether to publish the audio from the media player:
                                      -
                                    • : Publish the audio from the media player.
                                      • -
                                    • : Do not publish the audio from the media player.
                                      • +
                                    • : Publish the audio from the media player.
                                      • +
                                    • : Do not publish the audio from the media player.
                                                                         publishMediaPlayerVideoTrack Whether to publish the video from the media player:
                                      -
                                    • : Publish the video from the media player.
                                      • -
                                    • : Do not publish the video from the media player.
                                      • +
                                    • : Publish the video from the media player.
                                      • +
                                    • : Do not publish the video from the media player.
                                                                         autoSubscribeAudio Whether to automatically subscribe to all remote audio streams when the user joins a channel:
                                      -
                                    • : Subscribe to all remote audio streams.
                                      • -
                                    • : Do not automatically subscribe to any remote audio streams.
                                      • +
                                    • : Subscribe to all remote audio streams.
                                      • +
                                    • : Do not automatically subscribe to any remote audio streams.
                                                                         autoSubscribeVideo Whether to automatically subscribe to all remote video streams when the user joins the channel:
                                      -
                                    • : Subscribe to all remote video streams.
                                      • -
                                    • : Do not automatically subscribe to any remote video streams.
                                      • +
                                    • : Subscribe to all remote video streams.
                                      • +
                                    • : Do not automatically subscribe to any remote video streams.
                                                                         enableAudioRecordingOrPlayout Whether to enable audio capturing or playback:
                                      -
                                    • : Enable audio capturing or playback.
                                      • -
                                    • : Do not enable audio capturing or playback.
                                      • +
                                    • : Enable audio capturing or playback.
                                      • +
                                    • : Do not enable audio capturing or playback.
                                    - If you need to publish the audio streams captured by your microphone, ensure this parameter is set as .                                     + If you need to publish the audio streams captured by your microphone, ensure this parameter is set as .                                                                         publishMediaPlayerId @@ -652,23 +652,23 @@ class ChannelMediaOptions { clientRoleType - + clientRoleType - The user role. See . + The user role. ensure the user ID is not set as 0. - - + + defaultVideoStreamType - + channelProfile - + audioDelayMs @@ -680,8 +680,8 @@ class ChannelMediaOptions { publishCustomAudioTrackAec Whether to publish audio frames processed by an external echo cancellation module.
                                      -
                                    • : Publish audio frames processed by the external echo cancellation module.
                                      • -
                                    • : Do not publish to publish audio frames processed by the external echo cancellation module.
                                      • +
                                    • : Publish audio frames processed by the external echo cancellation module.
                                      • +
                                    • : Do not publish to publish audio frames processed by the external echo cancellation module.
                                                                         @@ -690,48 +690,48 @@ class ChannelMediaOptions {

                                    (Optional) The token generated on your server for authentication. See Authenticate Your Users with Token.

                                      -
                                    • This parameter takes effect only when calling or .
                                      • -
                                    • Ensure that the App ID, channel name, and user name used for creating the token are the same as those used by the method for initializing the RTC engine, and those used by the and methods for joining the channel.
                                      • +
                                    • This parameter takes effect only when calling or .
                                      • +
                                    • Ensure that the App ID, channel name, and user name used for creating the token are the same as those used by the method for initializing the RTC engine, and those used by the and methods for joining the channel.
                                                                         startPreview Whether to automatically start the preview when joining a channel:
                                      -
                                    • : Do not automatically start the preview. Ensure that you have called the method to set the local video property; otherwise, the preview is not enabled.
                                      • -
                                    • : Do not automatically start the preview.
                                      • +
                                    • : Do not automatically start the preview. Ensure that you have called the method to set the local video property; otherwise, the preview is not enabled.
                                      • +
                                    • : Do not automatically start the preview.
                                                                         publishRhythmPlayerTrack Whether to publish the sound of a metronome to remote users:
                                      -
                                    • : Publish processed audio frames. Both the local user and remote users can hear the metronome.
                                      • -
                                    • : Do not publish the sound of the metronome. Only the local user can hear the metronome.
                                      • +
                                    • : Publish processed audio frames. Both the local user and remote users can hear the metronome.
                                      • +
                                    • : Do not publish the sound of the metronome. Only the local user can hear the metronome.
                                                                         isInteractiveAudience Whether to enable interactive mode:
                                      -
                                    • : Enable interactive mode. Once this mode is enabled and the user role is set as audience, the user can receive remote video streams with low latency.
                                      • -
                                    • :Do not enable interactive mode. If this mode is disabled, the user receives the remote video streams in default settings.
                                      • +
                                    • : Enable interactive mode. Once this mode is enabled and the user role is set as audience, the user can receive remote video streams with low latency.
                                      • +
                                    • :Do not enable interactive mode. If this mode is disabled, the user receives the remote video streams in default settings.
                                      -
                                    • This parameter only applies to scenarios involving cohosting across channels. The cohosts need to call the method to join the other host's channel as an audience member, and set isInteractiveAudience to .
                                      • -
                                    • This parameter takes effect only when the user role is .
                                      • +
                                    • This parameter only applies to scenarios involving cohosting across channels. The cohosts need to call the method to join the other host's channel as an audience member, and set isInteractiveAudience to .
                                      • +
                                    • This parameter takes effect only when the user role is .
                                                                         customVideoTrackId - The video track ID returned by calling the method. The default value is 0. + The video track ID returned by calling the method. The default value is 0. isAudioFilterable Whether the audio stream being published is filtered according to the volume algorithm:
                                      -
                                    • : The audio stream is filtered. If the audio stream filter is not enabled, this setting does not takes effect.
                                      • -
                                    • : The audio stream is not filtered.
                                      • +
                                    • : The audio stream is filtered. If the audio stream filter is not enabled, this setting does not takes effect.
                                      • +
                                    • : The audio stream is not filtered.
                                    - If you need to enable this function, contact .                                     + If you need to enable this function, contact .
                                  - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita b/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita index 88e2a2d6cc8..b843220f3de 100644 --- a/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita @@ -1,17 +1,17 @@ - <ph keyref="ChannelMediaRelayConfiguration" /> + <ph keyref="ChannelMediaRelayConfiguration"/> Configuration of cross channel media relay.

                                  public class ChannelMediaRelayConfiguration { private ChannelMediaInfo srcInfo = null; - private Map<String, ChannelMediaInfo> destInfos = null; + private Map<String, ChannelMediaInfo> destInfos = null; public ChannelMediaRelayConfiguration() { - destInfos = new HashMap<String, ChannelMediaInfo>(); + destInfos = new HashMap<String, ChannelMediaInfo>(); srcInfo = new ChannelMediaInfo(null, null, 0); } @@ -31,7 +31,7 @@ return srcInfo; } - public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { + public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { return destInfos; } } @@ -104,44 +104,44 @@ _$ChannelMediaRelayConfigurationFromJson(json); Map<String, dynamic> toJson() => _$ChannelMediaRelayConfigurationToJson(this); } -

                                  +

                                  Method setSrcChannelInfo - Sets the information of the source channel. See . + Sets the information of the source channel. ensure the user ID is not set as 0. setDestChannelInfo - Sets the information of the target channel. See . + Sets the information of the target channel. ensure the user ID is not set as 0. removeDestChannelInfo - Deletes the information of target channel. See . + Deletes the information of target channel. ensure the user ID is not set as 0. getSrcChannelMediaInfo - Gets the information of the source channel. See . + Gets the information of the source channel. ensure the user ID is not set as 0. getDestChannelMediaInfos - Gets the information of the target channel. See . + Gets the information of the target channel. ensure the user ID is not set as 0.
                                  - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> srcInfo sourceInfo -

                                  The information of the source channel. See . It contains the following members:

                                    -
                                  • channelName: The name of the source channel. The default value is , which means the SDK applies the name of the current channel.
                                    • +

                                    The information of the source channel. See . It contains the following members:

                                      +
                                    • channelName: The name of the source channel. The default value is , which means the SDK applies the name of the current channel.
                                    • token: The token for joining the source channel. This token is generated with the channelName and uid you set in srcInfo.
                                        -
                                      • If you have not enabled the App Certificate, set this parameter as the default value , which means the SDK applies the App ID.
                                        • +
                                      • If you have not enabled the App Certificate, set this parameter as the default value , which means the SDK applies the App ID.
                                      • If you have enabled the App Certificate, you must use the token generated with the channelName and uid, and the uid must be set as 0.
                                    • uid: The unique user ID to identify the relay stream in the source channel. Agora recommends leaving the default value of 0 unchanged.
                                      • @@ -152,10 +152,10 @@ destInfos destinationInfos -

                                      The information of the target channel . It contains the following members:

                                        +

                                        The information of the target channel . It contains the following members:

                                        • channelName: The name of the target channel.
                                        • token: The token for joining the target channel. It is generated with the channelName and uid you set in destInfos.
                                            -
                                          • If you have not enabled the App Certificate, set this parameter as the default value , which means the SDK applies the App ID.
                                            • +
                                          • If you have not enabled the App Certificate, set this parameter as the default value , which means the SDK applies the App ID.
                                          • If you have enabled the App Certificate, you must use the token generated with the channelName and uid.

                                          If the token of any target channel expires, the whole media relay stops; hence Agora recommends that you specify the same expiration time for the tokens of all the target channels.

                                        • uid: The unique user ID to identify the relay stream in the target channel. The value ranges from 0 to (2 32-1). To avoid user ID conflicts, this user ID must be different from any other user ID in the target channel. The default value is 0, which means the SDK generates a random user ID.
                                          • @@ -164,16 +164,16 @@ destCount - The number of target channels. The default value is 0, and the value range is from 0 to 6. Ensure that the value of this parameter corresponds to the number of structs you define in destInfo. + The number of target channels. The default value is 0, and the value range is from 0 to 6. Ensure that the value of this parameter corresponds to the number of structs you define in destInfo. setDestinationInfo - Sets the information of the target channel. See . + Sets the information of the target channel. ensure the user ID is not set as 0. removeDestinationInfoForChannelName - Deletes the information of target channel. See . + Deletes the information of target channel. ensure the user ID is not set as 0.
                                  -                                   \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_codeccapinfo.dita b/en-US/dita/RTC-NG/API/class_codeccapinfo.dita index 71e0ebb7e66..b6356981e9a 100644 --- a/en-US/dita/RTC-NG/API/class_codeccapinfo.dita +++ b/en-US/dita/RTC-NG/API/class_codeccapinfo.dita @@ -1,7 +1,7 @@ - <ph keyref="CodecCapInfo" /> + <ph keyref="CodecCapInfo"/> The codec capability of the device.
                                  @@ -70,10 +70,10 @@ class CodecCapInfo { @JsonKey(name: 'codecLevels') final CodecCapLevels? codecLevels; - factory CodecCapInfo.fromJson(Map<String, dynamic> json) => + factory CodecCapInfo.fromJson(Map<String, dynamic> json) => _$CodecCapInfoFromJson(json); - Map<String, dynamic> toJson() => _$CodecCapInfoToJson(this); + Map<String, dynamic> toJson() => _$CodecCapInfoToJson(this); }

                                  @@ -83,14 +83,14 @@ class CodecCapInfo {
                                  v4.2.0
                                  -

                                  +

                                  - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> codecType - The video codec types. See . + The video codec types. ensure the user ID is not set as 0.

                                  The video codec types:

                                  • 1: VP8.
                                    • @@ -100,7 +100,7 @@ class CodecCapInfo { codecCapMask - The bit mask of the codec type. See . + The bit mask of the codec type. ensure the user ID is not set as 0.

                                    The bit mask of the codec type:

                                    • (0): The device does not support encoding or decoding.
                                      • @@ -113,8 +113,8 @@ class CodecCapInfo { codecLevels - The level of the codec capability. See . + The level of the codec capability. ensure the user ID is not set as 0.
                                  -                                   \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_codeccaplevels.dita b/en-US/dita/RTC-NG/API/class_codeccaplevels.dita index d06435fd763..b0dcf0143c8 100644 --- a/en-US/dita/RTC-NG/API/class_codeccaplevels.dita +++ b/en-US/dita/RTC-NG/API/class_codeccaplevels.dita @@ -1,7 +1,7 @@ - <ph keyref="CodecCapLevels" /> + <ph keyref="CodecCapLevels"/> The level of the codec capability.
                                  @@ -60,10 +60,10 @@ class CodecCapLevels { @JsonKey(name: 'swDecodingLevel') final VideoCodecCapabilityLevel? swDecodingLevel; - factory CodecCapLevels.fromJson(Map<String, dynamic> json) => + factory CodecCapLevels.fromJson(Map<String, dynamic> json) => _$CodecCapLevelsFromJson(json); - Map<String, dynamic> toJson() => _$CodecCapLevelsToJson(this); + Map<String, dynamic> toJson() => _$CodecCapLevelsToJson(this); }

                                  @@ -73,19 +73,19 @@ class CodecCapLevels {
                                  v4.2.2
                                  -

                                  +

                                  - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> hwDecodingLevel - Hardware decoding capability level, which represents the device's ability to perform hardware decoding on videos of different quality. See . + Hardware decoding capability level, which represents the device's ability to perform hardware decoding on videos of different quality. ensure the user ID is not set as 0. swDecodingLevel - Software decoding capability level, which represents the device's ability to perform software decoding on videos of different quality. See . + Software decoding capability level, which represents the device's ability to perform software decoding on videos of different quality. ensure the user ID is not set as 0.
                                  -                                   \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita b/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita index 4ab52e56e18..7b68552d73e 100644 --- a/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita +++ b/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita @@ -1,7 +1,7 @@ - <ph keyref="ContentInspectConfig" /> + <ph keyref="ContentInspectConfig"/> Configuration of video screenshot and upload.
                                  @@ -22,7 +22,7 @@ type = CONTENT_INSPECT_TYPE_INVALID; interval = 0; } - }> + }> __attribute__((visibility("default"))) @interface AgoraContentInspectConfig: NSObject @property (nonatomic, copy) NSString* _Nullable extraInfo; @property(copy, nonatomic) NSArray<AgoraContentInspectModule*>* _Nullable modules; @@ -76,17 +76,17 @@ final String? extraInfo; @JsonKey(name: 'modules') - final List<ContentInspectModule>? modules; + final List<ContentInspectModule>? modules; @JsonKey(name: 'moduleCount') final int? moduleCount; - factory ContentInspectConfig.fromJson(Map<String, dynamic> json) => + factory ContentInspectConfig.fromJson(Map<String, dynamic> json) => _$ContentInspectConfigFromJson(json); - Map<String, dynamic> toJson() => _$ContentInspectConfigToJson(this); + Map<String, dynamic> toJson() => _$ContentInspectConfigToJson(this); } -

                                  +

                                  Parameters @@ -114,15 +114,15 @@ modules -

                                  Functional module. See .

                                  -

                                  A maximum of 32 instances can be configured, and the value range of MAX_CONTENT_INSPECT_MODULE_COUNT is an integer in [1,32].

                                  +

                                  Functional module. ensure the user ID is not set as 0.

                                  +

                                  A maximum of 32 instances can be configured, and the value range of MAX_CONTENT_INSPECT_MODULE_COUNT is an integer in [1,32].

                                  A function module can only be configured with one instance at most. Currently only the video screenshot and upload function is supported.                                   moduleCount - The number of functional modules, that is,the number of configured instances, must be the same as the number of instances configured in modules. The maximum number is 32. + The number of functional modules, that is,the number of configured instances, must be the same as the number of instances configured in modules. The maximum number is 32.
                                  -                                   \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita b/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita index 904bf6cd0bc..19995c6f982 100644 --- a/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita +++ b/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita @@ -1,8 +1,8 @@ - <ph keyref="ContentInspectModule" /> - A structure used to configure the frequency of video screenshot and upload. + <ph keyref="ContentInspectModule"/> + A structure used to configure the frequency of video screenshot and upload.

                                  @@ -56,24 +56,24 @@ final ContentInspectType? type; @JsonKey(name: 'interval') final int? interval; - factory ContentInspectModule.fromJson(Map<String, dynamic> json) => + factory ContentInspectModule.fromJson(Map<String, dynamic> json) => _$ContentInspectModuleFromJson(json); - Map<String, dynamic> toJson() => _$ContentInspectModuleToJson(this); + Map<String, dynamic> toJson() => _$ContentInspectModuleToJson(this); } -

                                  +

                                  - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> type - Types of functional module. See . + Types of functional module. ensure the user ID is not set as 0.

                                  Types of functional modules:

                                    -
                                  • (0): (Default) This module has no actual function. Do not set to this value.
                                    • -
                                  • (1): Video content moderation. SDK takes screenshots, inspects video content of the video stream in the channel, and uploads the screenshots and moderation results.
                                    • -
                                  • (2): Video screenshot and upload. SDK takes screenshots of the video stream in the channel and uploads them.
                                    • +
                                  • (0): (Default) This module has no actual function. Do not set to this value.
                                    • +
                                  • (1): Video content moderation. SDK takes screenshots, inspects video content of the video stream in the channel, and uploads the screenshots and moderation results.
                                    • +
                                  • (2): Video screenshot and upload. SDK takes screenshots of the video stream in the channel and uploads them.

                                                                     @@ -83,4 +83,4 @@
                                  -                                   \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita b/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita index 4f99a162c4e..1b4f569fadf 100644 --- a/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita +++ b/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita @@ -299,12 +299,12 @@ @JsonKey(name: 'streamType') final VideoStreamType? streamType; - factory EncodedVideoFrameInfo.fromJson(Map<String, dynamic> json) => + factory EncodedVideoFrameInfo.fromJson(Map<String, dynamic> json) => _$EncodedVideoFrameInfoFromJson(json); - Map<String, dynamic> toJson() => _$EncodedVideoFrameInfoToJson(this); + Map<String, dynamic> toJson() => _$EncodedVideoFrameInfoToJson(this); } -

                                  +

                                  <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -313,9 +313,9 @@ codecType The codec type of the local video stream. See . The default value is (2).

                                  The codec type of the video:

                                    -
                                  • (1): VP8.
                                    • -
                                  • (2): (Default) H.264.
                                    • -
                                  • (3): H.265.
                                    • +
                                  • (1): VP8.
                                    • +
                                  • (2): (Default) H.264.
                                    • +
                                  • (3): H.265.

                                   @@ -373,7 +373,7 @@ streamType - The type of video streams. See . + The type of video streams. ensure the user ID is not set as 0.
                                  • (0): High-quality stream, that is, a high-resolution and high-bitrate video stream.
                                    • @@ -382,4 +382,4 @@
                                  - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_externalvideoframe.dita b/en-US/dita/RTC-NG/API/class_externalvideoframe.dita index 2ff2563eb68..273de19112c 100644 --- a/en-US/dita/RTC-NG/API/class_externalvideoframe.dita +++ b/en-US/dita/RTC-NG/API/class_externalvideoframe.dita @@ -250,7 +250,7 @@ final int? textureId; @JsonKey(name: 'matrix') - final List<double>? matrix; + final List<double>? matrix; @JsonKey(name: 'metadata_buffer', ignore: true) final Uint8List? metadataBuffer; @@ -258,12 +258,12 @@ @JsonKey(name: 'metadata_size') final int? metadataSize; - factory ExternalVideoFrame.fromJson(Map<String, dynamic> json) => + factory ExternalVideoFrame.fromJson(Map<String, dynamic> json) => _$ExternalVideoFrameFromJson(json); - Map<String, dynamic> toJson() => _$ExternalVideoFrameToJson(this); + Map<String, dynamic> toJson() => _$ExternalVideoFrameToJson(this); }                                   -

                                  +

                                  @@ -279,12 +279,12 @@ type -

                                  The video type. See .

                                  +

                                  The video type. ensure the user ID is not set as 0.

                                                                     format - The pixel format. See . + The pixel format. ensure the user ID is not set as 0. The format of the incoming video frame. This parameter must be specified as one of the following values:
                                  • 1: I420
                                  • 2: BGRA
                                    • diff --git a/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita b/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita index 3155ea39a73..ddfb4696a23 100644 --- a/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita +++ b/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita @@ -143,7 +143,7 @@ _$InjectStreamConfigFromJson(json); Map<String, dynamic> toJson() => _$InjectStreamConfigToJson(this); } -

                                    +

                                  @@ -180,7 +180,7 @@ audioSampleRate -

                                  The sampling rate (Hz) of injecting the external audio stream. The default value is 48000 Hz. See .

                                  +

                                  The sampling rate (Hz) of injecting the external audio stream. The default value is 48000 Hz. ensure the user ID is not set as 0.

                                  Agora recommends using the default value.                                   diff --git a/en-US/dita/RTC-NG/API/class_lastmileproberesult.dita b/en-US/dita/RTC-NG/API/class_lastmileproberesult.dita index af6147f1f1e..ea7a88f436a 100644 --- a/en-US/dita/RTC-NG/API/class_lastmileproberesult.dita +++ b/en-US/dita/RTC-NG/API/class_lastmileproberesult.dita @@ -111,11 +111,11 @@ uplinkReport - Results of the uplink last-mile network test. See . + Results of the uplink last-mile network test. ensure the user ID is not set as 0. downlinkReport - Results of the downlink last-mile network test. See . + Results of the downlink last-mile network test. ensure the user ID is not set as 0. rtt diff --git a/en-US/dita/RTC-NG/API/class_livetranscoding.dita b/en-US/dita/RTC-NG/API/class_livetranscoding.dita index 93da02453da..6b69bdc4252 100644 --- a/en-US/dita/RTC-NG/API/class_livetranscoding.dita +++ b/en-US/dita/RTC-NG/API/class_livetranscoding.dita @@ -631,12 +631,12 @@ videoCodecType - Video codec profile types for Media Push. See . + Video codec profile types for Media Push. ensure the user ID is not set as 0. 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. ensure the user ID is not set as 0.

                                                                     @@ -698,20 +698,20 @@ 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. ensure the user ID is not set as 0.

                                  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. ensure the user ID is not set as 0.

                                  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. ensure the user ID is not set as 0. 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 @@ -739,11 +739,11 @@ audioCodecProfile - Audio codec profile type for Media Push. See . + Audio codec profile type for Media Push. ensure the user ID is not set as 0. 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. ensure the user ID is not set as 0. 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. ensure the user ID is not set as 0. advancedFeatureCount @@ -767,27 +767,27 @@ addBackgroundImage - Adds a background image. See . + Adds a background image. ensure the user ID is not set as 0. addUser - Adds a user for video mixing during the CDN live streaming. See . + Adds a user for video mixing during the CDN live streaming. ensure the user ID is not set as 0. addWatermark - Adds a watermark. See . + Adds a watermark. ensure the user ID is not set as 0. getAdvancedFeatures - Gets the status of the advanced features of streaming with transcoding. See . + Gets the status of the advanced features of streaming with transcoding. ensure the user ID is not set as 0. getBackgroundColor - Gets the background color in hex. See . + Gets the background color in hex. ensure the user ID is not set as 0. getBackgroundImageList - Gets the list of background images. See . + Gets the list of background images. ensure the user ID is not set as 0. 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. ensure the user ID is not set as 0.

                                                                     @@ -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. ensure the user ID is not set as 0.

                                   @@ -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. ensure the user ID is not set as 0.

                                   getUserCount - Gets the number of users transcoded in the CDN live streaming. See . + Gets the number of users transcoded in the CDN live streaming. ensure the user ID is not set as 0. getUsers - Gets the user list in the CDN live streaming. See . + Gets the user list in the CDN live streaming. ensure the user ID is not set as 0. getWatermarkList - Gets the watermark list. See . + Gets the watermark list. ensure the user ID is not set as 0. removeBackgroundImage - Removes a background image from the background image list. See . + Removes a background image from the background image list. ensure the user ID is not set as 0. removeUser - Removes a user from video mixing during the CDN live streaming. See . + Removes a user from video mixing during the CDN live streaming. ensure the user ID is not set as 0. removeWatermark - Removes a watermark from the watermark list. See . + Removes a watermark from the watermark list. ensure the user ID is not set as 0. setAdvancedFeatures - Sets whether to enable the advanced features of streaming with transcoding. See . + Sets whether to enable the advanced features of streaming with transcoding. ensure the user ID is not set as 0. 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. ensure the user ID is not set as 0. setBackgroundColor [2/2] - Sets the background color in RGB format. See . + Sets the background color in RGB format. ensure the user ID is not set as 0. 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. ensure the user ID is not set as 0.

                                   @@ -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. ensure the user ID is not set as 0.

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

                                  Sets the background color's red component. See .

                                  +

                                  Sets the background color's red component. ensure the user ID is not set as 0.

                                   setUsers [1/2] - Sets the users in batches in the CDN live streaming. See . + Sets the users in batches in the CDN live streaming. ensure the user ID is not set as 0. setUsers [2/2] - Sets the users in batches in the CDN live streaming. See . + Sets the users in batches in the CDN live streaming. ensure the user ID is not set as 0. defaultTranscoding diff --git a/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita b/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita index 08dea2cba91..91ae5b3c215 100644 --- a/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita @@ -1,24 +1,24 @@ - <ph keyref="LocalTranscoderConfiguration" /> + <ph keyref="LocalTranscoderConfiguration"/> The configuration of the video mixing on the local client.

                                  public class LocalTranscoderConfiguration { - public ArrayList<TranscodingVideoStream> transcodingVideoStreams; + public ArrayList<TranscodingVideoStream> transcodingVideoStreams; public VideoEncoderConfiguration videoOutputConfiguration; public LocalTranscoderConfiguration() { - transcodingVideoStreams = new ArrayList<TranscodingVideoStream>(); + transcodingVideoStreams = new ArrayList<TranscodingVideoStream>(); videoOutputConfiguration = new VideoEncoderConfiguration(); } } __attribute__((visibility("default"))) @interface AgoraLocalTranscoderConfiguration: NSObject -@property(copy, nonatomic) NSArray<AgoraTranscodingVideoStream *> *_Nullable videoInputStreams; +@property(copy, nonatomic) NSArray<AgoraTranscodingVideoStream *> *_Nullable videoInputStreams; @property (strong, nonatomic) AgoraVideoEncoderConfiguration *_Nonnull videoOutputConfiguration; @@ -68,19 +68,19 @@ class LocalTranscoderConfiguration { final int? streamCount; @JsonKey(name: 'videoInputStreams') - final List<TranscodingVideoStream>? videoInputStreams; + final List<TranscodingVideoStream>? videoInputStreams; @JsonKey(name: 'videoOutputConfiguration') final VideoEncoderConfiguration? videoOutputConfiguration; - factory LocalTranscoderConfiguration.fromJson(Map<String, dynamic> json) => + factory LocalTranscoderConfiguration.fromJson(Map<String, dynamic> json) => _$LocalTranscoderConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$LocalTranscoderConfigurationToJson(this); + Map<String, dynamic> toJson() => _$LocalTranscoderConfigurationToJson(this); }

                                  - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> streamCount @@ -89,12 +89,12 @@ class LocalTranscoderConfiguration { videoInputStreams transcodingVideoStreams - The video streams for local video mixing. See . + The video streams for local video mixing. ensure the user ID is not set as 0. videoOutputConfiguration - The encoding configuration of the mixed video stream after the local video mixing. See . + The encoding configuration of the mixed video stream after the local video mixing. ensure the user ID is not set as 0.
                                  -                                   \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_localvideostats.dita b/en-US/dita/RTC-NG/API/class_localvideostats.dita index eb327156492..436d017577e 100644 --- a/en-US/dita/RTC-NG/API/class_localvideostats.dita +++ b/en-US/dita/RTC-NG/API/class_localvideostats.dita @@ -1,7 +1,7 @@ - <ph keyref="LocalVideoStats" /> + <ph keyref="LocalVideoStats"/> The statistics of the local video stream.
                                  @@ -296,15 +296,15 @@ @JsonKey(name: 'hwEncoderAccelerating') final int? hwEncoderAccelerating; - factory LocalVideoStats.fromJson(Map<String, dynamic> json) => + factory LocalVideoStats.fromJson(Map<String, dynamic> json) => _$LocalVideoStatsFromJson(json); - Map<String, dynamic> toJson() => _$LocalVideoStatsToJson(this); + Map<String, dynamic> toJson() => _$LocalVideoStatsToJson(this); } -

                                  +

                                  - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> uid @@ -362,11 +362,11 @@ qualityAdaptIndication - The quality adaptation of the local video stream in the reported interval (based on the target frame rate and target bitrate). See .

                                  + The quality adaptation of the local video stream in the reported interval (based on the target frame rate and target bitrate). See .

                                    -
                                  • (0): The local video quality stays the same.
                                    • -
                                  • (1): The local video quality improves because the network bandwidth increases.
                                    • -
                                  • (2): The local video quality deteriorates because the network bandwidth decreases.
                                    • +
                                  • (0): The local video quality stays the same.
                                    • +
                                  • (1): The local video quality improves because the network bandwidth increases.
                                    • +
                                  • (2): The local video quality deteriorates because the network bandwidth decreases.

                                                                     @@ -390,11 +390,11 @@ codecType - The codec type of the local video. See .

                                  + The codec type of the local video. See .

                                    -
                                  • (1): VP8.
                                    • -
                                  • (2): (Default) H.264.
                                    • -
                                  • (3): H.265.
                                    • +
                                  • (1): VP8.
                                    • +
                                  • (2): (Default) H.264.
                                    • +
                                  • (3): H.265.

                                                                     @@ -408,24 +408,24 @@ captureBrightnessLevel - The brightness level of the video image captured by the local camera. See . + The brightness level of the video image captured by the local camera. ensure the user ID is not set as 0. captureBrightnessLevel The brightness level of the video image captured by the local camera.
                                    -
                                  • (-1): The SDK does not detect the brightness level of the video image. Wait a few seconds to get the brightness level from captureBrightnessLevel in the next callback.
                                    • -
                                  • (0): The brightness level of the video image is normal.
                                    • -
                                  • (1): The brightness level of the video image is too bright.
                                    • -
                                  • (2): The brightness level of the video image is too dark.
                                    • +
                                  • (-1): The SDK does not detect the brightness level of the video image. Wait a few seconds to get the brightness level from captureBrightnessLevel in the next callback.
                                    • +
                                  • (0): The brightness level of the video image is normal.
                                    • +
                                  • (1): The brightness level of the video image is too bright.
                                    • +
                                  • (2): The brightness level of the video image is too dark.
                                                                     hwEncoderAccelerating - The local video encoding acceleration type. See .
                                    + The local video encoding acceleration type. See .
                                    • 0: Software encoding is applied without acceleration.
                                    • 1: Hardware encoding is applied for acceleration.
                                  -                                   \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita b/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita index 2c97d0962a9..489b85f1efc 100644 --- a/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita @@ -93,12 +93,12 @@ @JsonKey(name: 'recorderInfoUpdateInterval') final int? recorderInfoUpdateInterval; - factory MediaRecorderConfiguration.fromJson(Map<String, dynamic> json) => + factory MediaRecorderConfiguration.fromJson(Map<String, dynamic> json) => _$MediaRecorderConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$MediaRecorderConfigurationToJson(this); + Map<String, dynamic> toJson() => _$MediaRecorderConfigurationToJson(this); } -

                                  +

                                  @@ -109,21 +109,21 @@ storagePath The absolute path (including the filename extensions) of the recording file. For example:

                                    -
                                  • Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.mp4
                                    • +
                                  • Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.mp4
                                  • iOS: /App Sandbox/Library/Caches/example.mp4
                                  • macOS: ～/Library/Logs/example.mp4
                                    • -
                                  • Android: /storage/emulated/0/Android/data/<package name>/files/agorasdk.mp4
                                    • +
                                  • Android: /storage/emulated/0/Android/data/<package name>/files/agorasdk.mp4
                                  Ensure that the directory for the log files exists and is writable. containerFormat - The format of the recording file. See . + The format of the recording file. ensure the user ID is not set as 0. The format of the recording file. Only is supported. streamType - The recording content. See . + The recording content. ensure the user ID is not set as 0. The recording content:
                                  • : Only audio.
                                  • : Only video.
                                    • @@ -140,4 +140,4 @@
                                  - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_mediasource.dita b/en-US/dita/RTC-NG/API/class_mediasource.dita index 4ec014d350d..e4cec788d5b 100644 --- a/en-US/dita/RTC-NG/API/class_mediasource.dita +++ b/en-US/dita/RTC-NG/API/class_mediasource.dita @@ -1,7 +1,7 @@ - <ph keyref="MediaSource" /> + <ph keyref="MediaSource"/> Information related to the media file to be played and the playback scenario configurations.
                                  @@ -134,12 +134,12 @@ @JsonKey(name: 'isLiveSource') final bool? isLiveSource; - factory MediaSource.fromJson(Map<String, dynamic> json) => + factory MediaSource.fromJson(Map<String, dynamic> json) => _$MediaSourceFromJson(json); - Map<String, dynamic> toJson() => _$MediaSourceToJson(this); + Map<String, dynamic> toJson() => _$MediaSourceToJson(this); } -

                                  +

                                  <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -207,7 +207,7 @@ provider -

                                  The callback for custom media resource files. See .

                                  +

                                  The callback for custom media resource files. ensure the user ID is not set as 0.

                                  If you open a custom media resource, pass in the value to provider. If you open a common media resource, pass in the value to url. Agora recommends that you do not pass in values to both url and provider in one call; otherwise, this call may fail.

                                   @@ -216,19 +216,19 @@ playerOnReadCallback -

                                  Occurs when the SDK reads the media resource data. See .

                                  +

                                  Occurs when the SDK reads the media resource data. ensure the user ID is not set as 0.

                                  -

                                  +

                                  playerOnSeekCallback -

                                  Occurs when the SDK seeks the media resource data. See .

                                  +

                                  Occurs when the SDK seeks the media resource data. ensure the user ID is not set as 0.

                                   -                                   \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita b/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita index 9ba243c3685..47b15c46c83 100644 --- a/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita +++ b/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita @@ -260,10 +260,10 @@ @JsonKey(name: 'qualityChangedReason') final int? qualityChangedReason; - factory RemoteAudioStats.fromJson(Map<String, dynamic> json) => + factory RemoteAudioStats.fromJson(Map<String, dynamic> json) => _$RemoteAudioStatsFromJson(json); - Map<String, dynamic> toJson() => _$RemoteAudioStatsToJson(this); + Map<String, dynamic> toJson() => _$RemoteAudioStatsToJson(this); }

                                  @@ -278,7 +278,7 @@ quality -

                                  The quality of the audio stream sent by the user. See .

                                  +

                                  The quality of the audio stream sent by the user. ensure the user ID is not set as 0.

                                  • (0): The quality is unknown.
                                    • diff --git a/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita b/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita index ab51e60901e..f02de4f50f3 100644 --- a/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita +++ b/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita @@ -1,8 +1,8 @@ - <ph keyref="RtcEngineConfig" /> - Configurations for the instance. + <ph keyref="RtcEngineConfig"/> + Configurations for the instance.

                                    @@ -214,25 +214,25 @@ class RtcEngineContext { @JsonKey(name: 'autoRegisterAgoraExtensions') final bool? autoRegisterAgoraExtensions; - factory RtcEngineContext.fromJson(Map<String, dynamic> json) => + factory RtcEngineContext.fromJson(Map<String, dynamic> json) => _$RtcEngineContextFromJson(json); - Map<String, dynamic> toJson() => _$RtcEngineContextToJson(this); + Map<String, dynamic> toJson() => _$RtcEngineContextToJson(this); } -

                                    +

                                    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> eventHandler mEventHandler - The event handler for . See . + The event handler for . See . appId mAppId - The App ID issued by Agora for your project. Only users in apps with the same App ID can join the same channel and communicate with each other. An App ID can only be used to create one instance. To change your App ID, call to destroy the current instance, and then create a new one. + The App ID issued by Agora for your project. Only users in apps with the same App ID can join the same channel and communicate with each other. An App ID can only be used to create one instance. To change your App ID, call to destroy the current instance, and then create a new one. context @@ -256,33 +256,33 @@ class RtcEngineContext {
                                    • This method is applicable when you integrate the SDK manually but not when you integrate the SDK with Maven Central or JitPack.
                                      • -
                                    • Ensure the specified directory exists; otherwise, the initialization fails.
                                      • +
                                    • Ensure the specified directory exists; otherwise, the initialization fails.
                                                                         channelProfile mChannelProfile - + audioScenario mAudioScenario - + areaCode mAreaCode - The region for connection. This is an advanced feature and applies to scenarios that have regional restrictions. For details on supported regions, see . The area codes support bitwise operation. + The region for connection. This is an advanced feature and applies to scenarios that have regional restrictions. For details on supported regions, see . The area codes support bitwise operation. After specifying the region, the app integrated with the Agora SDK connects to the Agora servers within that region. logConfig mLogConfig -

                                    Sets the log file size. See .

                                    +

                                    Sets the log file size. ensure the user ID is not set as 0.

                                    By default, the SDK generates five SDK log files and five API call log files with the following rules:

                                      -
                                    • +
                                    @@ -292,19 +292,19 @@ class RtcEngineContext { mExtensionObserver eventDelegate - The instance. + The instance. mediaFilterExtensions - The instance. + The instance. mDomainLimit domainLimit

                                    Whether to enable domain name restriction:

                                      -
                                    • : Enables the domain name restriction. This value is suitable for scenarios where IoT devices use IoT cards for network access. The SDK will only connect to servers in the domain name or IP whitelist that has been reported to the operator.
                                      • -
                                    • : (Default) Disables the domain name restriction. This value is suitable for most common scenarios.
                                      • +
                                    • : Enables the domain name restriction. This value is suitable for scenarios where IoT devices use IoT cards for network access. The SDK will only connect to servers in the domain name or IP whitelist that has been reported to the operator.
                                      • +
                                    • : (Default) Disables the domain name restriction. This value is suitable for most common scenarios.

                                                                         @@ -312,9 +312,9 @@ class RtcEngineContext { mAutoRegisterAgoraExtensions autoRegisterAgoraExtensions -

                                    Whether to automatically register the Agora extensions when initializing :

                                      -
                                    • : (Default) Automatically register the Agora extensions when initializing .
                                      • -
                                    • : Do not register the Agora extensions when initializing . You need to call to register the Agora extensions.
                                      • +

                                      Whether to automatically register the Agora extensions when initializing :

                                        +
                                      • : (Default) Automatically register the Agora extensions when initializing .
                                        • +
                                      • : Do not register the Agora extensions when initializing . You need to call to register the Agora extensions.

                                      @@ -324,9 +324,9 @@ class RtcEngineContext { addExtension - Adds the extension. See . + Adds the extension. ensure the user ID is not set as 0.
                                    -                                     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita b/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita index f01c7b2938c..54b1435105f 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita @@ -101,7 +101,7 @@ __attribute__((visibility("default"))) @interface AgoraScreenCaptureConfiguratio _$ScreenCaptureConfigurationFromJson(json); Map<String, dynamic> toJson() => _$ScreenCaptureConfigurationToJson(this); } -

                                    +

                                    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -129,11 +129,11 @@ __attribute__((visibility("default"))) @interface AgoraScreenCaptureConfiguratio params parameters - (For Windows and macOS only) The screen capture configuration. See . + (For Windows and macOS only) The screen capture configuration. ensure the user ID is not set as 0. regionRect - (For Windows and macOS only) The relative position of the shared region to the whole screen. See . If you do not set this parameter, the SDK shares the whole screen. If the region you set exceeds the boundary of the screen, only the region within in the screen is shared. If you set width or height in as 0, the whole screen is shared. + (For Windows and macOS only) The relative position of the shared region to the whole screen. ensure the user ID is not set as 0. If you do not set this parameter, the SDK shares the whole screen. If the region you set exceeds the boundary of the screen, only the region within in the screen is shared. If you set width or height in as 0, the whole screen is shared. The relative position of the shared region to the whole screen. The data type is CGRect.
                                    diff --git a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita index 9af53a7837e..21747080b85 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita @@ -1,12 +1,12 @@ - <ph keyref="ScreenCaptureParameters" /> + <ph keyref="ScreenCaptureParameters"/> Screen sharing configurations.

                                    - + __attribute__((visibility("default"))) @interface AgoraScreenCaptureParameters: NSObject @property (assign, nonatomic) CGSize dimensions; @property (assign, nonatomic) NSInteger frameRate; @@ -206,7 +206,7 @@ final bool? windowFocus; @JsonKey(name: 'excludeWindowList') - final List<int>? excludeWindowList; + final List<int>? excludeWindowList; @JsonKey(name: 'excludeWindowCount') final int? excludeWindowCount; @@ -220,21 +220,21 @@ @JsonKey(name: 'enableHighLight') final bool? enableHighLight; - factory ScreenCaptureParameters.fromJson(Map<String, dynamic> json) => + factory ScreenCaptureParameters.fromJson(Map<String, dynamic> json) => _$ScreenCaptureParametersFromJson(json); - Map<String, dynamic> toJson() => _$ScreenCaptureParametersToJson(this); + Map<String, dynamic> toJson() => _$ScreenCaptureParametersToJson(this); } -

                                    +

                                    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> - The video profiles of the shared screen stream are only set by , independent of . + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + The video profiles of the shared screen stream are only set by , independent of . dimensions -

                                    The video encoding resolution of the shared screen stream. See . The default value is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges.

                                    +

                                    The video encoding resolution of the shared screen stream. ensure the user ID is not set as 0. The default value is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges.

                                    If the screen dimensions are different from the value of this parameter, Agora applies the following strategies for encoding. Suppose dimensions is set to 1920 × 1080:

                                    • If the value of the screen dimensions is lower than that of dimensions, for example, 1000 × 1000 pixels, the SDK uses the screen dimensions, that is, 1000 × 1000 pixels, for encoding.
                                    • If the value of the screen dimensions is higher than that of dimensions, for example, 2000 × 1500, the SDK uses the maximum value under dimensions with the aspect ratio of the screen dimension (4:3) for encoding, that is, 1440 × 1080.
                                      • @@ -253,32 +253,32 @@ captureMouseCursor

                                      Whether to capture the mouse in screen sharing:

                                        -
                                      • : (Default) Capture the mouse.
                                        • -
                                      • : Do not capture the mouse.
                                        • +
                                      • : (Default) Capture the mouse.
                                        • +
                                      • : Do not capture the mouse.

                                       windowFocus -

                                      Whether to bring the window to the front when calling the method to share it:

                                        -
                                      • : Bring the window to the front.
                                        • -
                                      • : (Default) Do not bring the window to the front.
                                        • +

                                        Whether to bring the window to the front when calling the method to share it:

                                          +
                                        • : Bring the window to the front.
                                          • +
                                        • : (Default) Do not bring the window to the front.

                                        excludeWindowList - The ID list of the windows to be blocked. When calling to start screen sharing, you can use this parameter to block a specified window. When calling to update screen sharing configurations, you can use this parameter to dynamically block a specified window. + The ID list of the windows to be blocked. When calling to start screen sharing, you can use this parameter to block a specified window. When calling to update screen sharing configurations, you can use this parameter to dynamically block a specified window. highLighted enableHighLight (For macOS and Windows only) Whether to place a border around the shared window or screen:
                                          -
                                        • : Place a border.
                                          • -
                                        • : (Default) Do not place a border.
                                          • +
                                        • : Place a border.
                                          • +
                                        • : (Default) Do not place a border.
                                        - When you share a part of a window or screen, the SDK places a border around the entire window or screen if you set this parameter to .                                         + When you share a part of a window or screen, the SDK places a border around the entire window or screen if you set this parameter to .                                         highLightColor @@ -288,7 +288,7 @@ highLightWidth - (For macOS and Windows only) The width (px) of the border. The default value is 5, and the value range is (0, 50].This parameter only takes effect when highLighted is set to . + (For macOS and Windows only) The width (px) of the border. The default value is 5, and the value range is (0, 50].This parameter only takes effect when highLighted is set to . excludeWindowCount @@ -297,4 +297,4 @@
                                    -                                     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita index a18bcc92859..4877680c47f 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita @@ -1,7 +1,7 @@ - <ph keyref="ScreenCaptureParameters2" /> + <ph keyref="ScreenCaptureParameters2"/> Screen sharing configurations.
                                    @@ -169,58 +169,58 @@ @JsonKey(name: 'videoParams') final ScreenVideoParameters? videoParams; - factory ScreenCaptureParameters2.fromJson(Map<String, dynamic> json) => + factory ScreenCaptureParameters2.fromJson(Map<String, dynamic> json) => _$ScreenCaptureParameters2FromJson(json); - Map<String, dynamic> toJson() => _$ScreenCaptureParameters2ToJson(this); + Map<String, dynamic> toJson() => _$ScreenCaptureParameters2ToJson(this); } -

                                    +

                                    -

                                    +

                                    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> captureAudio Determines whether to capture system audio during screen sharing:
                                      -
                                    • : Capture system audio.
                                      • -
                                    • : (Default) Do not capture system audio.
                                      • +
                                    • : Capture system audio.
                                      • +
                                    • : (Default) Do not capture system audio.
                                    • Due to system limitations, capturing system audio is only applicable to Android API level 29 and later (that is, Android 10 and later).
                                      • -
                                    • To improve the success rate of capturing system audio during screen sharing, ensure that you have called the method and set the audio scenario to .
                                     +
                                  • To improve the success rate of capturing system audio during screen sharing, ensure that you have called the method and set the audio scenario to .
                                                                     audioParams - The audio configuration for the shared screen stream. See .This parameter only takes effect when captureAudio is . + The audio configuration for the shared screen stream. See .This parameter only takes effect when captureAudio is . captureVideo Whether to capture the screen when screen sharing:
                                    -
                                  • : (Default) Capture the screen.
                                    • -
                                  • : Do not capture the screen.
                                    • +
                                  • : (Default) Capture the screen.
                                    • +
                                  • : Do not capture the screen.
                                  Due to system limitations, the capture screen is only applicable to Android API level 21 and above, that is, Android 5 and above.                                                                     videoParams - The video configuration for the shared screen stream. See .This parameter only takes effect when captureVideo is . + The video configuration for the shared screen stream. See .This parameter only takes effect when captureVideo is .
                                  Subclass - - The video configuration for the shared screen stream. See . + + The video configuration for the shared screen stream. ensure the user ID is not set as 0. - - The audio configuration for the shared screen stream. See . + + The audio configuration for the shared screen stream. ensure the user ID is not set as 0.
                                  - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita index b675d414180..c780a1078ba 100644 --- a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita +++ b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita @@ -1,12 +1,12 @@ - <ph keyref="ScreenCaptureSourceInfo" /> - The information about the specified shareable window or screen. The information is returned in . + <ph keyref="ScreenCaptureSourceInfo"/> + The information about the specified shareable window or screen. The information is returned in .

                                  - + __attribute__((visibility("default"))) @interface AgoraScreenCaptureSourceInfo : NSObject @property(assign, nonatomic) AgoraScreenCaptureSourceType type; @property(assign, nonatomic) CGWindowID sourceId; @@ -76,7 +76,7 @@ public Rectangle position; public view_t sourceDisplayId; }; - + class ScreenCaptureSourceInfo { const ScreenCaptureSourceInfo( {this.type, @@ -124,19 +124,19 @@ @JsonKey(name: 'sourceDisplayId') final int? sourceDisplayId; - factory ScreenCaptureSourceInfo.fromJson(Map<String, dynamic> json) => + factory ScreenCaptureSourceInfo.fromJson(Map<String, dynamic> json) => _$ScreenCaptureSourceInfoFromJson(json); - Map<String, dynamic> toJson() => _$ScreenCaptureSourceInfoToJson(this); + Map<String, dynamic> toJson() => _$ScreenCaptureSourceInfoToJson(this); } -

                                  +

                                  - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> type - The type of the shared target. See . + The type of the shared target. ensure the user ID is not set as 0. sourceId @@ -148,11 +148,11 @@ thumbImage - The image content of the thumbnail. See . + The image content of the thumbnail. ensure the user ID is not set as 0. iconImage - The image content of the icon. See . + The image content of the icon. ensure the user ID is not set as 0. processPath @@ -165,19 +165,19 @@ primaryMonitor Determines whether the screen is the primary display:
                                    -
                                  • : The screen is the primary display.
                                    • -
                                  • : The screen is not the primary display.
                                    • +
                                  • : The screen is the primary display.
                                    • +
                                  • : The screen is not the primary display.
                                                                     position - The position of a window relative to the entire screen space (including all shareable screens). See . See . + The position of a window relative to the entire screen space (including all shareable screens). ensure the user ID is not set as 0. ensure the user ID is not set as 0. minimizeWindow (For Windows only) Whether the window is minimized:
                                    -
                                  • : The window is minimized.
                                    • -
                                  • : The window is not minimized.
                                    • +
                                  • : The window is minimized.
                                    • +
                                  • : The window is not minimized.
                                                                     @@ -186,4 +186,4 @@
                                  -                                   \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita b/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita index 402fa97289d..06117fbe090 100644 --- a/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita +++ b/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita @@ -77,7 +77,7 @@ dimensions - The video dimension. See . The default value is 160 × 120. + The video dimension. ensure the user ID is not set as 0. The default value is 160 × 120. bitrate diff --git a/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita b/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita index 365d0624ba1..5047b7f471f 100644 --- a/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita +++ b/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita @@ -1,7 +1,7 @@ - <ph keyref="TranscodingVideoStream" /> + <ph keyref="TranscodingVideoStream"/> The video streams for local video mixing.
                                  @@ -176,18 +176,18 @@ class TranscodingVideoStream { @JsonKey(name: 'mirror') final bool? mirror; - factory TranscodingVideoStream.fromJson(Map<String, dynamic> json) => + factory TranscodingVideoStream.fromJson(Map<String, dynamic> json) => _$TranscodingVideoStreamFromJson(json); - Map<String, dynamic> toJson() => _$TranscodingVideoStreamToJson(this); + Map<String, dynamic> toJson() => _$TranscodingVideoStreamToJson(this); }

                                  - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> sourceType - The video source type for local video mixing. See . + The video source type for local video mixing. ensure the user ID is not set as 0. remoteUserUid @@ -203,7 +203,7 @@ class TranscodingVideoStream { mediaPlayerId - (Optional) Media player ID. Use the parameter only when you set sourceType to . + (Optional) Media player ID. Use the parameter only when you set sourceType to . x @@ -246,4 +246,4 @@ class TranscodingVideoStream {
                                  -                                   \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita b/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita index 833ab49b07a..134b32bac70 100644 --- a/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita +++ b/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita @@ -53,7 +53,7 @@ _$UserAudioSpectrumInfoFromJson(json); Map<String, dynamic> toJson() => _$UserAudioSpectrumInfoToJson(this); } -

                                  +

                                  <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -67,7 +67,7 @@ audioSpectrumData spectrumData -

                                  Audio spectrum information of the remote user. See .

                                  +

                                  Audio spectrum information of the remote user. ensure the user ID is not set as 0.
                                  diff --git a/en-US/dita/RTC-NG/API/class_videocanvas.dita b/en-US/dita/RTC-NG/API/class_videocanvas.dita index 2c4c0b2f244..b404dd8e529 100644 --- a/en-US/dita/RTC-NG/API/class_videocanvas.dita +++ b/en-US/dita/RTC-NG/API/class_videocanvas.dita @@ -1,7 +1,7 @@ - <ph keyref="VideoCanvas" /> + <ph keyref="VideoCanvas"/> Attributes of the video canvas object.
                                  @@ -173,16 +173,16 @@ class VideoCanvas { @JsonKey(name: 'enableAlphaMask') final bool? enableAlphaMask; - factory VideoCanvas.fromJson(Map<String, dynamic> json) => + factory VideoCanvas.fromJson(Map<String, dynamic> json) => _$VideoCanvasFromJson(json); - Map<String, dynamic> toJson() => _$VideoCanvasToJson(this); + Map<String, dynamic> toJson() => _$VideoCanvasToJson(this); } -

                                  +

                                  - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> view @@ -193,16 +193,16 @@ class VideoCanvas { renderMode - The rendering mode of the video. See . -
                                  + The rendering mode of the video. See . +
                                  mirrorMode -

                                  The mirror mode of the view. See .

                                  +

                                  The mirror mode of the view. See .

                                    -
                                  • +

                                    @@ -216,7 +216,7 @@ class VideoCanvas { sourceType - The type of the video source. See . + The type of the video source. See . sourceId @@ -224,29 +224,29 @@ class VideoCanvas { setupMode - Setting mode of the view. See . + Setting mode of the view. ensure the user ID is not set as 0. Setting mode of the view.
                                      -
                                    • (0): (Default) Replaces a view.
                                      • -
                                    • (1): Adds a view.
                                      • -
                                    • (2): Deletes a view.
                                      • +
                                    • (0): (Default) Replaces a view.
                                      • +
                                    • (1): Adds a view.
                                      • +
                                    • (2): Deletes a view.
                                                                         mediaPlayerId - The ID of the media player. You can get the Device ID by calling . - This parameter is required when sourceType is . + The ID of the media player. You can get the Device ID by calling . + This parameter is required when sourceType is . rect - (Optional) Display area for the video frame. See . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. + (Optional) Display area for the video frame. ensure the user ID is not set as 0. width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. cropArea - (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. + (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. cropArea - (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. + (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. backgroundColor @@ -256,15 +256,15 @@ class VideoCanvas { enableAlphaMask

                                    (Optional) Whether the receiver enables alpha mask rendering:

                                      -
                                    • : The receiver enables alpha mask rendering.
                                      • -
                                    • : (default) The receiver disables alpha mask rendering.
                                      • +
                                    • : The receiver enables alpha mask rendering.
                                      • +
                                    • : (default) The receiver disables alpha mask rendering.

                                    Alpha mask rendering can create images with transparent effects and extract portraits from videos. When used in combination with other methods, you can implement effects such as picture-in-picture and watermarking.

                                    -
                                    • This property applies to macOS only.
                                    • The receiver can render alpha channel information only when the sender enables alpha transmission.
                                    • To enable alpha transmission, .
                                     +
                                    • This property applies to macOS only.
                                    • The receiver can render alpha channel information only when the sender enables alpha transmission.
                                    • To enable alpha transmission, .
                                                                         Reserved.
                                  -                                   \ 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 18cd6142db9..a0829e50e3a 100644 --- a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita @@ -471,14 +471,14 @@                                   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. ensure the user ID is not set as 0. bitrate -

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

                                  +

                                  The encoding bitrate (Kbps) of the video. ensure the user ID is not set as 0.

                                    -
                                    • +
                                  @@ -500,7 +500,7 @@ 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. ensure the user ID is not set as 0.

                                  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.
                                    • @@ -510,7 +510,7 @@ advanceOptions - Advanced options for video encoding. See . + Advanced options for video encoding. ensure the user ID is not set as 0.
                                    @@ -518,11 +518,11 @@ initWithSize - Specifies the video resolution and initializes the object. See . + Specifies the video resolution and initializes the object. ensure the user ID is not set as 0. initWithWidth - Specifies the video width and height, and initializes the object. See . + Specifies the video width and height, and initializes the object. ensure the user ID is not set as 0.
                                    diff --git a/en-US/dita/RTC-NG/API/class_videoframe.dita b/en-US/dita/RTC-NG/API/class_videoframe.dita index 57f7c9cb49c..63d084f4764 100644 --- a/en-US/dita/RTC-NG/API/class_videoframe.dita +++ b/en-US/dita/RTC-NG/API/class_videoframe.dita @@ -1,7 +1,7 @@ - <ph keyref="VideoFrame" /> + <ph keyref="VideoFrame"/> Configurations of the video frame.
                                    @@ -476,28 +476,28 @@ class VideoFrame { final int? textureId; @JsonKey(name: 'matrix') - final List<double>? matrix; + final List<double>? matrix; @JsonKey(name: 'pixelBuffer', ignore: true) final Uint8List? pixelBuffer; - factory VideoFrame.fromJson(Map<String, dynamic> json) => + factory VideoFrame.fromJson(Map<String, dynamic> json) => _$VideoFrameFromJson(json); - Map<String, dynamic> toJson() => _$VideoFrameToJson(this); + Map<String, dynamic> toJson() => _$VideoFrameToJson(this); } -

                                    +

                                    Note that the buffer provides a pointer to a pointer. This interface cannot modify the pointer of the buffer, but it can modify the content of the buffer.

                                    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> type - The pixel format. See . - + The pixel format. ensure the user ID is not set as 0. + width @@ -602,7 +602,7 @@ class VideoFrame { colorSpace - The color space of a video frame. See . + The color space of a video frame. ensure the user ID is not set as 0. sourceType @@ -620,9 +620,9 @@ class VideoFrame { alphaBuffer

                                    Indicates the alpha channel data output by the portrait segmentation algorithm, which is consistent with the size of the video frame. The value range of each pixel is [0,255], where 0 represents the background; 255 represents the foreground (portrait).

                                    -

                                    In the costom video renderer scenario, you can use this parameter to render the video background into various effects, such as: transparent, solid color, picture, video and so on.To use this parameter, contact .

                                    +

                                    In the costom video renderer scenario, you can use this parameter to render the video background into various effects, such as: transparent, solid color, picture, video and so on.To use this parameter, contact .
                                    -                                     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita b/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita index 7f737d56534..63f0911b00f 100644 --- a/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita +++ b/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="VideoSubscriptionOptions" /> + <ph keyref="VideoSubscriptionOptions"/> Video subscription options.
                                    @@ -48,8 +48,8 @@ @end struct VideoSubscriptionOptions { - Optional<VIDEO_STREAM_TYPE> type; - Optional<bool> encodedFrameOnly; + Optional<VIDEO_STREAM_TYPE> type; + Optional<bool> encodedFrameOnly; VideoSubscriptionOptions() {} }; @@ -61,9 +61,9 @@ } public class VideoSubscriptionOptions:OptionalJsonParse { - public Optional<VIDEO_STREAM_TYPE> type = new Optional<VIDEO_STREAM_TYPE>(); + public Optional<VIDEO_STREAM_TYPE> type = new Optional<VIDEO_STREAM_TYPE>(); - public Optional<bool> encodedFrameOnly = new Optional<bool>(); + public Optional<bool> encodedFrameOnly = new Optional<bool>(); } export class VideoSubscriptionOptions { @@ -80,33 +80,33 @@ @JsonKey(name: 'encodedFrameOnly') final bool? encodedFrameOnly; - factory VideoSubscriptionOptions.fromJson(Map<String, dynamic> json) => + factory VideoSubscriptionOptions.fromJson(Map<String, dynamic> json) => _$VideoSubscriptionOptionsFromJson(json); - Map<String, dynamic> toJson() => _$VideoSubscriptionOptionsToJson(this); + Map<String, dynamic> toJson() => _$VideoSubscriptionOptionsToJson(this); } -

                                    +

                                    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> streamType type - The video stream type that you want to subscribe to. The default value is , indicating that the high-quality video streams are subscribed. See . + The video stream type that you want to subscribe to. The default value is , indicating that the high-quality video streams are subscribed. ensure the user ID is not set as 0. The video stream type that you want to subscribe to:
                                      -
                                    • (0): (Default) High-quality video stream, that is, a high-resolution, high-bit-rate video stream.
                                      • -
                                    • (1): Low-quality stream, that is, a low-resolution, low-bitrate video stream.
                                      • +
                                    • (0): (Default) High-quality video stream, that is, a high-resolution, high-bit-rate video stream.
                                      • +
                                    • (1): Low-quality stream, that is, a low-resolution, low-bitrate video stream.
                                                                         encodedFrameOnly Whether to subscribe to encoded video frames only:
                                      -
                                    • : Subscribe to the encoded video data (structured data) only; the SDK does not decode or render raw video data.
                                      • -
                                    • : (Default) Subscribe to both raw video data and encoded video data.
                                      • +
                                    • : Subscribe to the encoded video data (structured data) only; the SDK does not decode or render raw video data.
                                      • +
                                    • : (Default) Subscribe to both raw video data and encoded video data.
                                    -                                     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_watermarkoptions.dita b/en-US/dita/RTC-NG/API/class_watermarkoptions.dita index 266d766b6b0..20e4c476b4b 100644 --- a/en-US/dita/RTC-NG/API/class_watermarkoptions.dita +++ b/en-US/dita/RTC-NG/API/class_watermarkoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="WatermarkOptions" /> + <ph keyref="WatermarkOptions"/> Configurations of the watermark image.
                                    @@ -121,13 +121,13 @@ _$WatermarkOptionsFromJson(json); Map<String, dynamic> toJson() => _$WatermarkOptionsToJson(this); } -

                                    +

                                    -

                                    +

                                    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> visibleInPreview @@ -135,8 +135,8 @@ positionInLandscapeMode - The area to display the watermark image in landscape mode. See . - When the adaptation mode of the watermark is , it is used to set the area of the watermark image in landscape mode. See . + The area to display the watermark image in landscape mode. ensure the user ID is not set as 0. + When the adaptation mode of the watermark is , it is used to set the area of the watermark image in landscape mode. ensure the user ID is not set as 0. The area to display the watermark image in landscape mode. This parameter contains the following members:
                                    • x: The horizontal position of the watermark relative to the upper left corner.
                                    • y: The vertical position of the watermark relative to the upper left corner.
                                      • @@ -146,8 +146,8 @@ positionInPortraitMode - The area to display the watermark image in portrait mode. See . - When the adaptation mode of the watermark is , it is used to set the area of the watermark image in portrait mode. See . + The area to display the watermark image in portrait mode. ensure the user ID is not set as 0. + When the adaptation mode of the watermark is , it is used to set the area of the watermark image in portrait mode. ensure the user ID is not set as 0. The area to display the watermark image in portrait mode. This parameter contains the following members:
                                      • x: The horizontal position of the watermark relative to the upper left corner.
                                      • y: The vertical position of the watermark relative to the upper left corner.
                                        • @@ -157,12 +157,12 @@ watermarkRatio - When the watermark adaptation mode is , this parameter is used to set the watermark coordinates. See . + When the watermark adaptation mode is , this parameter is used to set the watermark coordinates. ensure the user ID is not set as 0. mode - The adaptation mode of the watermark. See . + The adaptation mode of the watermark. ensure the user ID is not set as 0.
                                    -                                     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/enum_bitrate.dita b/en-US/dita/RTC-NG/API/enum_bitrate.dita index 5ca1d506826..f61d996d715 100644 --- a/en-US/dita/RTC-NG/API/enum_bitrate.dita +++ b/en-US/dita/RTC-NG/API/enum_bitrate.dita @@ -9,7 +9,7 @@ - 0: (Recommended) Standard bitrate mode. In this mode, the bitrates of the live broadcasting profile is higher than that of the communication profile. See . + 0: (Recommended) Standard bitrate mode. In this mode, the bitrates of the live broadcasting profile is higher than that of the communication profile. ensure the user ID is not set as 0. From 1df530657547a97938e5fa22c933a19b8f3be9e7 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Fri, 8 Sep 2023 14:28:35 +0800 Subject: [PATCH 07/13] New translations --- ...onfiguration_getdestchannelmediainfos.dita | 2 +- ...evicemanager_getplaybackdefaultdevice.dita | 2 +- ...vicemanager_getrecordingdefaultdevice.dita | 2 +- ...laudioengine_updateplayerpositioninfo.dita | 2 +- ...i_ilocalspatialaudioengine_initialize.dita | 2 +- ...atialaudioengine_updateremoteposition.dita | 2 +- .../API/api_imediaengine_addlistener.dita | 2 +- ...i_imediaengine_createcustomaudiotrack.dita | 2 +- .../API/api_imediaengine_pushaudioframe.dita | 2 +- .../API/api_imediaengine_pushaudioframe0.dita | 2 +- ...pi_imediaengine_pushencodedvideoimage.dita | 2 +- .../API/api_imediaengine_pushvideoframe.dita | 2 +- ...ediaengine_registeraudioframeobserver.dita | 2 +- ...ine_registervideoencodedframeobserver.dita | 2 +- ...ediaengine_registervideoframeobserver.dita | 4 +- .../API/api_imediaplayer_addlistener.dita | 2 +- ...api_imediaplayer_openwithcustomsource.dita | 6 +- ...ediaplayer_registervideoframeobserver.dita | 4 +- .../API/api_imediaplayer_setrendermode.dita | 2 +- ...pi_imediaplayer_setspatialaudioparams.dita | 2 +- .../API/api_imediarecorder_addlistener.dita | 2 +- .../api_imediarecorder_startrecording.dita | 2 +- .../API/api_irtcengine_addlistener.dita | 2 +- .../api_irtcengine_configrhythmplayer.dita | 2 +- .../API/api_irtcengine_createdatastream2.dita | 2 +- .../api_irtcengine_enablecontentinspect.dita | 4 +- .../api_irtcengine_enabledualstreammode2.dita | 2 +- .../api_irtcengine_enabledualstreammode3.dita | 2 +- .../API/api_irtcengine_enableencryption.dita | 2 +- ...api_irtcengine_enableinearmonitoring2.dita | 2 +- .../API/api_irtcengine_enablemulticamera.dita | 2 +- ...pi_irtcengine_enablevirtualbackground.dita | 4 +- .../api_irtcengine_getextensionproperty2.dita | 2 +- ...pi_irtcengine_getscreencapturesources.dita | 4 +- .../RTC-NG/API/api_irtcengine_initialize.dita | 2 +- .../API/api_irtcengine_joinchannel2.dita | 2 +- .../API/api_irtcengine_preloadchannel.dita | 2 +- .../api_irtcengine_pushreverseaudioframe.dita | 2 +- .../API/api_irtcengine_pushvideoframe2.dita | 2 +- .../api_irtcengine_querycodeccapability.dita | 2 +- ...tcengine_queryscreencapturecapability.dita | 2 +- ...ine_registeraudioencodedframeobserver.dita | 4 +- ...cengine_registeraudiospectrumobserver.dita | 2 +- ...cengine_registermediametadataobserver.dita | 4 +- .../API/api_irtcengine_removehandler.dita | 2 +- .../API/api_irtcengine_sendmetadata.dita | 2 +- ...pi_irtcengine_setadvancedaudiooptions.dita | 2 +- ...irtcengine_setaudiomixingdualmonomode.dita | 2 +- .../API/api_irtcengine_setchannelprofile.dita | 2 +- .../API/api_irtcengine_setclientrole.dita | 2 +- .../API/api_irtcengine_setclientrole2.dita | 2 +- ...api_irtcengine_setcolorenhanceoptions.dita | 2 +- .../API/api_irtcengine_setdualstreammode.dita | 2 +- .../api_irtcengine_setdualstreammode2.dita | 4 +- ...tcengine_setexternalaudiosourcevolume.dita | 2 +- .../api_irtcengine_setheadphoneeqpreset.dita | 2 +- .../api_irtcengine_setlivetranscoding.dita | 2 +- .../api_irtcengine_setlocalaccesspoint.dita | 2 +- ...cengine_setlocalpublishfallbackoption.dita | 2 +- .../api_irtcengine_setlocalrendermode.dita | 2 +- .../api_irtcengine_setlocalrendermode2.dita | 2 +- ...pi_irtcengine_setlocalvideomirrormode.dita | 2 +- ..._irtcengine_setlowlightenhanceoptions.dita | 2 +- ...ngine_setremoteuserspatialaudioparams.dita | 2 +- ...rtcengine_setscreencapturecontenthint.dita | 2 +- .../API/api_irtcengine_setuplocalvideo.dita | 2 +- .../API/api_irtcengine_setupremotevideo.dita | 2 +- ...pi_irtcengine_setvideodenoiseroptions.dita | 2 +- ...tcengine_setvideoencoderconfiguration.dita | 2 +- .../API/api_irtcengine_setvideoprofile.dita | 2 +- .../api_irtcengine_startaudiorecording3.dita | 2 +- .../api_irtcengine_startcameracapture.dita | 4 +- ...api_irtcengine_startchannelmediarelay.dita | 2 +- ...pi_irtcengine_startdirectcdnstreaming.dita | 2 +- .../API/api_irtcengine_startechotest3.dita | 2 +- ...engine_startorupdatechannelmediarelay.dita | 2 +- .../API/api_irtcengine_startrhythmplayer.dita | 2 +- .../api_irtcengine_startscreencapture.dita | 2 +- .../api_irtcengine_startscreencapture2.dita | 2 +- ...cengine_startscreencapturebydisplayid.dita | 4 +- ...engine_startscreencapturebyscreenrect.dita | 4 +- ...tcengine_startscreencapturebywindowid.dita | 6 +- .../API/api_irtcengine_switchchannel2.dita | 2 +- ...e_unregisteraudioencodedframeobserver.dita | 2 +- .../api_irtcengine_updatescreencapture.dita | 2 +- ...cengine_updatescreencaptureparameters.dita | 2 +- ..._irtcengine_updatescreencaptureregion.dita | 2 +- ...irtcengine_updatescreencaptureregion2.dita | 2 +- .../api_irtcengineex_createdatastreamex2.dita | 2 +- .../API/api_irtcengineex_joinchannelex.dita | 2 +- .../api_irtcengineex_setdualstreammodeex.dita | 2 +- .../api_irtcengineex_setupremotevideoex.dita | 2 +- ...gineex_setvideoencoderconfigurationex.dita | 2 +- ...irtcengineex_startchannelmediarelayex.dita | 2 +- ...neex_startorupdatechannelmediarelayex.dita | 2 +- ...api_ivideodevicemanager_getcapability.dita | 4 +- ...ameobserver_onrecordaudioencodedframe.dita | 2 +- ...rver_onplaybackaudioframebeforemixing.dita | 2 +- ...bserverbase_onearmonitoringaudioframe.dita | 2 +- ...ioframeobserverbase_onmixedaudioframe.dita | 2 +- ...oframeobserverbase_onrecordaudioframe.dita | 2 +- .../callback_iaudiopcmframesink_onframe.dita | 4 +- ...spectrumobserver_onlocalaudiospectrum.dita | 2 +- ...dler_ondirectcdnstreamingstatechanged.dita | 4 +- ...venthandler_ondirectcdnstreamingstats.dita | 2 +- ...iaplayercustomdataprovider_onreaddata.dita | 2 +- ...imediaplayercustomdataprovider_onseek.dita | 2 +- ...diaplayersourceobserver_onplayerevent.dita | 2 +- ...iaplayersourceobserver_onpreloadevent.dita | 2 +- ...ecorderobserver_onrecorderinfoupdated.dita | 2 +- ...corderobserver_onrecorderstatechanged.dita | 4 +- ...etadataobserver_onreadytosendmetadata.dita | 4 +- ...venthandler_onaudiodevicestatechanged.dita | 2 +- ...enthandler_onaudiodevicevolumechanged.dita | 2 +- ...irtcengineeventhandler_onaudioquality.dita | 2 +- ...ineeventhandler_onaudioroutingchanged.dita | 2 +- ...eeventhandler_onaudiovolumeindication.dita | 2 +- ...nthandler_oncameraexposureareachanged.dita | 2 +- ...eventhandler_oncamerafocusareachanged.dita | 2 +- ...eventhandler_onchannelmediarelayevent.dita | 2 +- ...ndler_onchannelmediarelaystatechanged.dita | 4 +- ...ngineeventhandler_onclientrolechanged.dita | 4 +- ...eventhandler_onclientrolechangefailed.dita | 4 +- ...engineeventhandler_onconnectionbanned.dita | 2 +- ...eeventhandler_onconnectioninterrupted.dita | 2 +- ...tcengineeventhandler_onconnectionlost.dita | 2 +- ...eventhandler_onconnectionstatechanged.dita | 6 +- ...neeventhandler_oncontentinspectresult.dita | 2 +- ...cengineeventhandler_onencryptionerror.dita | 2 +- ...llback_irtcengineeventhandler_onerror.dita | 2 +- ...ineeventhandler_onfacepositionchanged.dita | 2 +- ...ndler_onfirstlocalaudioframepublished.dita | 2 +- ...ndler_onfirstlocalvideoframepublished.dita | 2 +- ...venthandler_onfirstremotevideodecoded.dita | 2 +- ...eeventhandler_onfirstremotevideoframe.dita | 2 +- ...gineeventhandler_onjoinchannelsuccess.dita | 2 +- ...irtcengineeventhandler_onleavechannel.dita | 2 +- ...eventhandler_onlocalaudiostatechanged.dita | 6 +- ...cengineeventhandler_onlocalaudiostats.dita | 4 +- ...eventhandler_onlocalvideostatechanged.dita | 2 +- ...cengineeventhandler_onlocalvideostats.dita | 4 +- ...nthandler_onlocalvideotranscodererror.dita | 4 +- ...tcengineeventhandler_onnetworkquality.dita | 2 +- ...gineeventhandler_onnetworktypechanged.dita | 4 +- ...cengineeventhandler_onpermissionerror.dita | 2 +- ...tcengineeventhandler_onproxyconnected.dita | 2 +- ...neeventhandler_onrejoinchannelsuccess.dita | 2 +- ...venthandler_onremoteaudiostatechanged.dita | 2 +- ...engineeventhandler_onremoteaudiostats.dita | 2 +- ...nthandler_onremoteaudiotransportstats.dita | 2 +- ...venthandler_onremotevideostatechanged.dita | 2 +- ...engineeventhandler_onremotevideostats.dita | 4 +- ...nthandler_onremotevideotransportstats.dita | 2 +- ...ack_irtcengineeventhandler_onrtcstats.dita | 2 +- ...gineeventhandler_onrtmpstreamingevent.dita | 2 +- ...cengineeventhandler_onuserenablevideo.dita | 2 +- ...k_irtcengineeventhandler_onuserjoined.dita | 2 +- ...rtcengineeventhandler_onusermutevideo.dita | 2 +- ..._irtcengineeventhandler_onuseroffline.dita | 2 +- ...venthandler_onvideodevicestatechanged.dita | 2 +- ...enthandler_onvideopublishstatechanged.dita | 2 +- ...handler_onvideorenderingtracingresult.dita | 4 +- ...rameobserver_getobservedframeposition.dita | 2 +- ...rameobserver_getvideoformatpreference.dita | 2 +- .../callback_ivideoframeobserver_onframe.dita | 6 +- .../class_Localaccesspointconfiguration.dita | 6 +- .../dita/RTC-NG/API/class_advanceoptions.dita | 4 +- ...class_audioencodedframeobserverconfig.dita | 4 +- en-US/dita/RTC-NG/API/class_audioparams.dita | 2 +- .../class_audiorecordingconfiguration.dita | 4 +- .../class_cameracapturerconfiguration.dita | 4 +- .../RTC-NG/API/class_channelmediaoptions.dita | 2 +- .../class_channelmediarelayconfiguration.dita | 14 ++--- en-US/dita/RTC-NG/API/class_codeccapinfo.dita | 6 +- .../dita/RTC-NG/API/class_codeccaplevels.dita | 4 +- .../API/class_contentinspectconfig.dita | 2 +- .../API/class_contentinspectmodule.dita | 2 +- .../API/class_encodedvideoframeinfo.dita | 2 +- .../RTC-NG/API/class_externalvideoframe.dita | 4 +- .../RTC-NG/API/class_injectstreamconfig.dita | 2 +- .../RTC-NG/API/class_lastmileproberesult.dita | 4 +- .../RTC-NG/API/class_livetranscoding.dita | 62 +++++++++---------- .../class_localtranscoderconfiguration.dita | 4 +- .../RTC-NG/API/class_localvideostats.dita | 2 +- .../API/class_mediarecorderconfiguration.dita | 4 +- en-US/dita/RTC-NG/API/class_mediasource.dita | 6 +- .../RTC-NG/API/class_remoteaudiostats.dita | 2 +- .../RTC-NG/API/class_rtcengineconfig.dita | 4 +- .../API/class_screencaptureconfiguration.dita | 4 +- .../API/class_screencaptureparameters.dita | 2 +- .../API/class_screencaptureparameters2.dita | 4 +- .../API/class_screencapturesourceinfo.dita | 8 +-- .../API/class_simulcaststreamconfig.dita | 2 +- .../API/class_transcodingvideostream.dita | 2 +- .../API/class_useraudiospectruminfo.dita | 2 +- en-US/dita/RTC-NG/API/class_videocanvas.dita | 4 +- .../API/class_videoencoderconfiguration.dita | 14 ++--- en-US/dita/RTC-NG/API/class_videoframe.dita | 4 +- .../API/class_videosubscriptionoptions.dita | 2 +- .../RTC-NG/API/class_watermarkoptions.dita | 12 ++-- en-US/dita/RTC-NG/API/enum_bitrate.dita | 2 +- 201 files changed, 306 insertions(+), 306 deletions(-) diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita index 35a81233274..63360b78f69 100644 --- a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita +++ b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita @@ -26,7 +26,7 @@
                                    Returns -

                                    The information of the target channel. ensure the user ID is not set as 0.

                                    +

                                    The information of the target channel. See .

                                    diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita index 8d672fc05d4..ad66080d805 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita @@ -40,7 +40,7 @@
                                    Returns -

                                    The details about the default audio playback device. ensure the user ID is not set as 0.

                                    +

                                    The details about the default audio playback device. See .

                                    • 0: Success.
                                    • < 0: Failure.
                                      • diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita index ffa24260962..cdd5bc4b4e0 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita @@ -40,7 +40,7 @@
                                    Returns -

                                    The details about the default audio capture device. ensure the user ID is not set as 0.

                                    +

                                    The details about the default audio capture device. See .

                                    • 0: Success.
                                    • < 0: Failure.
                                      • diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita index 4ea6cc58980..50f58fee7e2 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita @@ -42,7 +42,7 @@ positionInfo - The spatial position of the media player. ensure the user ID is not set as 0. + The spatial position of the media player. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita index a659bfd6204..c16560e5d12 100644 --- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita +++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita @@ -36,7 +36,7 @@ config - The configuration of . ensure the user ID is not set as 0. + The configuration of . See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita index f4017161ced..cce77628f8c 100644 --- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita +++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita @@ -42,7 +42,7 @@ posInfo - The spatial position of the remote user. ensure the user ID is not set as 0. + The spatial position of the remote user. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita index d9a61a0cb96..330082aef13 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita @@ -37,7 +37,7 @@ eventType - The name of the target event to listen for. ensure the user ID is not set as 0. + The name of the target event to listen for. See . listener diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita b/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita index 42f135d0268..b88531a5e03 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita @@ -54,7 +54,7 @@ config - The configuration of the custom audio track. ensure the user ID is not set as 0. + The configuration of the custom audio track. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita index 40e41a3a2dc..f806a5ae147 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita @@ -30,7 +30,7 @@ frame - The external audio frame. ensure the user ID is not set as 0. + The external audio frame. See . diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita index 247c07ff0ae..36f74c2f58f 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita @@ -27,7 +27,7 @@ frame - The external audio frame. ensure the user ID is not set as 0. + The external audio frame. See . trackId diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita index d0d3fd84d70..a6ef41473a6 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita @@ -58,7 +58,7 @@ frameInfo videoEncodedFrameInfo - Information about externally encoded video frames. ensure the user ID is not set as 0. + Information about externally encoded video frames. See . diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita index 86ff2ddfb4b..e46fe5634be 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita @@ -46,7 +46,7 @@ frame -

                                    The external raw video frame to be pushed. ensure the user ID is not set as 0.

                                    +

                                    The external raw video frame to be pushed. See .

                                                                         diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita index d3d91fd486d..3b426e844a9 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita @@ -34,7 +34,7 @@ delegate audioFrameObserver -

                                    The observer instance. ensure the user ID is not set as 0. Set the value as to release the instance. Agora recommends calling this method after receiving to release the audio observer object.

                                    +

                                    The observer instance. See . Set the value as to release the instance. Agora recommends calling this method after receiving to release the audio observer object.

                                                                         diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita index 9eab6c17254..80225a0428e 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita @@ -52,7 +52,7 @@ observer videoEncodedImageReceiver The video frame observer object. See . - The observer instance. ensure the user ID is not set as 0. Set the value as to release the instance. + The observer instance. See . Set the value as to release the instance. mode 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 7cb0d34e1a4..be0ea8f64bd 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita @@ -43,7 +43,7 @@ observer delegate videoFrameObserver - The observer instance. ensure the user ID is not set as 0. To release the instance, set the value as . + The observer instance. See . To release the instance, set the value as . mode @@ -55,7 +55,7 @@ position - A bit mask that controls the frame position of the video observer. ensure the user ID is not set as 0. + A bit mask that controls the frame position of the video observer. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita index 27d167dbb65..b2d92853a33 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita @@ -36,7 +36,7 @@ eventType - The name of the target event to listen for. ensure the user ID is not set as 0. + The name of the target event to listen for. See . listener diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita index ee2210feb91..0d9e5196b84 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita @@ -45,17 +45,17 @@ provider - The callback for custom media resource files. ensure the user ID is not set as 0. + The callback for custom media resource files. See . onReadDataCallBack - Occurs when the SDK reads the media resource data. ensure the user ID is not set as 0. + Occurs when the SDK reads the media resource data. See . onSeekCallBack - Occurs when the SDK seeks the media resource data. ensure the user ID is not set as 0. + Occurs when the SDK seeks the media resource data. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita index 6b0969cafa7..1a33f837eb9 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita @@ -36,8 +36,8 @@ videoFrameObserver observer - The video observer, reporting the reception of each video frame. ensure the user ID is not set as 0. - The video observer, reporting the reception of each video frame. ensure the user ID is not set as 0. + The video observer, reporting the reception of each video frame. See . + The video observer, reporting the reception of each video frame. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita index 630de961ab5..0caf1834012 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita @@ -31,7 +31,7 @@ renderMode mode -

                                    Sets the render mode of the view. ensure the user ID is not set as 0.

                                    +

                                    Sets the render mode of the view. See .

                                    Sets the render mode of the view:

                                    diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita index 393f1453968..25f89891793 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita @@ -33,7 +33,7 @@ params spatial_audio_params - The spatial audio effect parameters of the media player. ensure the user ID is not set as 0. + The spatial audio effect parameters of the media player. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita index 727680ebc57..384d63cf763 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita @@ -36,7 +36,7 @@ eventType - The name of the target event to listen for. ensure the user ID is not set as 0. + The name of the target event to listen for. See . listener diff --git a/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita index 867b8b0e1db..7c2d5fbedc0 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita @@ -47,7 +47,7 @@ config - The recording configuration. ensure the user ID is not set as 0. + The recording configuration. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita b/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita index c077046fc6f..7dc0cf78c6c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita @@ -36,7 +36,7 @@ eventType - The name of the target event to listen for. ensure the user ID is not set as 0. + The name of the target event to listen for. See . listener diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita index 7b7df9031a6..4ce10a923db 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita @@ -32,7 +32,7 @@ config - The metronome configuration. ensure the user ID is not set as 0. + The metronome configuration. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita index fa1ab586255..40333241f21 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita @@ -39,7 +39,7 @@ int CreateDataStream(int& streamId, const FDataStreamConfig& config); config - The configurations for the data stream. ensure the user ID is not set as 0. + The configurations for the data stream. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita index ce5f602840a..06d219bfbcd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita @@ -35,7 +35,7 @@

                                    When video content moderation is enabled, the SDK takes screenshots, reviews the content, and uploads videos sent by local users based on the type and frequency of the content moderation module you set in . After content moderation, the Agora content moderation server sends the results to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.

                                      -
                                    • Before calling this method, ensure that the video screenshot upload service has been activated. Before calling this method, ensure that Video content moderation service has been activated. ensure the user ID is not set as 0.
                                      • +
                                    • Before calling this method, ensure that the video screenshot upload service has been activated. Before calling this method, ensure that Video content moderation service has been activated. See .
                                    • This method relies on the video screenshot and upload dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
                                    @@ -50,7 +50,7 @@ config - Configuration of video screenshot and upload. Configuration of video content moderation. ensure the user ID is not set as 0. + Configuration of video screenshot and upload. Configuration of video content moderation. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita index 6258ab385fe..f3345ffa04a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita @@ -55,7 +55,7 @@ sourceType -

                                    The type of the video source. ensure the user ID is not set as 0.

                                    +

                                    The type of the video source. See .

                                                                         diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita index 18e4e67f8fe..bd4ec1f8ddc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita @@ -48,7 +48,7 @@ int EnableDualStreamMode(bool enabled, const FSimulcastStreamConfig& streamC streamConfig -

                                    The configuration of the low-quality video stream. ensure the user ID is not set as 0.

                                    +

                                    The configuration of the low-quality video stream. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita index 58d14eba5b3..6b09ee1de71 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita @@ -42,7 +42,7 @@                                     config - Built-in encryption configurations. ensure the user ID is not set as 0. + Built-in encryption configurations. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita index 3b09e882eb3..061039b22f7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita @@ -50,7 +50,7 @@ includeAudioFilters - The audio filter of in-ear monitoring: ensure the user ID is not set as 0. + The audio filter of in-ear monitoring: See . The audio filter of in-ear monitoring:
                                    • (1 << 0): Do not add an audio filter to the in-ear monitor.
                                    • (1 << 1): Add an audio filter to the in-ear monitor. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.
                                      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita index 6e24156200c..67b7fc9a5f9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita @@ -76,7 +76,7 @@ config - Capture configuration for the second camera. ensure the user ID is not set as 0. + Capture configuration for the second camera. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita index 17ae9c3e78b..706abe2ee11 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita @@ -80,12 +80,12 @@ backgroundSource backData - The custom background. ensure the user ID is not set as 0. To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted. + The custom background. See . To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted. segproperty segData - Processing properties for background images. ensure the user ID is not set as 0. + Processing properties for background images. See . type diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita index deeb4892323..80417fdbd1f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita @@ -79,7 +79,7 @@ int GetExtensionProperty(FString provider, FString extension, FString key, FStri sourceType type - Source type of the extension. ensure the user ID is not set as 0. + Source type of the extension. See . buf_len diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita index 907b5d89e10..8bcc148b04e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita @@ -44,11 +44,11 @@ thumbSize - The target size of the screen or window thumbnail (the width and height are in pixels). ensure the user ID is not set as 0. The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and thumbSize is 100 × 100, the actual size of the thumbnail is 100 × 75. If the target size is larger than the original size, the thumbnail is the original image and the SDK does not scale it. + The target size of the screen or window thumbnail (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and thumbSize is 100 × 100, the actual size of the thumbnail is 100 × 75. If the target size is larger than the original size, the thumbnail is the original image and the SDK does not scale it. iconSize - The target size of the icon corresponding to the application program (the width and height are in pixels). ensure the user ID is not set as 0. The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and iconSize is 100 × 100, the actual size of the icon is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it. + The target size of the icon corresponding to the application program (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and iconSize is 100 × 100, the actual size of the icon is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it. includeScreen diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita b/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita index 5d00c225d3c..e59ede728a5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita @@ -43,7 +43,7 @@ int Initialize(const FRtcEngineContext& context); context config -

                                    Configurations for the instance. ensure the user ID is not set as 0.

                                    +

                                    Configurations for the instance. See .

                                                                         diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita index dd42a7ccdab..32784eff09f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita @@ -85,7 +85,7 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia options mediaOptions - The channel media options. ensure the user ID is not set as 0. + The channel media options. See . joinSuccessBlock diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita index 86ac4fdb4b5..45c2da87a3a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita @@ -53,7 +53,7 @@ token The token generated on your server for authentication. See .

                                    When the token for preloading channels expires, you can update the token based on the number of channels you preload.

                                    • When preloading one channel, calling this method to pass in the new token.
                                      • -
                                    • When preloading more than one channels:
                                      • If you use a wildcard token for all preloaded channels, call to update the token.When generating a wildcard token, ensure the user ID is not set as 0.
                                        • +
                                      • When preloading more than one channels:
                                        • If you use a wildcard token for all preloaded channels, call to update the token.When generating a wildcard token, ensure the user ID is not set as 0. See .
                                        • If you use different tokens to preload different channels, call this method to pass in your user ID, channel name and the new token.

                                      diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita index 1c0b37506cf..ecf5948faa7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita @@ -32,7 +32,7 @@ frame audioFrame - The external audio frame. ensure the user ID is not set as 0. + The external audio frame. See . data diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita index 6c0af3550b1..49795b6e1ef 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita @@ -32,7 +32,7 @@ frame - Video frame to be pushed. ensure the user ID is not set as 0. + Video frame to be pushed. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita b/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita index 08373156818..6f73c320d3b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita @@ -38,7 +38,7 @@ codecInfo -

                                    Input and output parameter. An array representing the video codec capabilities of the device. ensure the user ID is not set as 0.

                                    +

                                    Input and output parameter. An array representing the video codec capabilities of the device. See .

                                    • Input value: One defined by the user when executing this method, representing the video codec capability to be queried.
                                    • Output value: The after the method is executed, representing the actual video codec capabilities supported by the device.
                                      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita b/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita index ba1fcea0601..c08e8357f73 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita @@ -40,7 +40,7 @@
                                    <ph keyref="return-section-title"/> -
                                    • The highest frame rate supported by the device, if the method is called successfully. ensure the user ID is not set as 0.
                                      • +
                                      • The highest frame rate supported by the device, if the method is called successfully. See .
                                      • If the call fails, returns .
                                      • The highest frame rate supported by the device, if the method is called successfully. See .
                                          diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita index d75184bb278..a673b4ca224 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita @@ -46,14 +46,14 @@ config - Observer settings for the encoded audio. ensure the user ID is not set as 0. + Observer settings for the encoded audio. See . observer delegate - The encoded audio observer. ensure the user ID is not set as 0. + The encoded audio observer. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita index e0452ab4046..690705aacc0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita @@ -39,7 +39,7 @@ observer delegate -

                                    The audio spectrum observer. ensure the user ID is not set as 0.

                                    +

                                    The audio spectrum observer. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita index 287497497c8..597a5977265 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita @@ -41,12 +41,12 @@ observer - The metadata observer. ensure the user ID is not set as 0. + The metadata observer. See . type -

                                    The metadata type. The SDK currently only supports . ensure the user ID is not set as 0.

                                    +

                                    The metadata type. The SDK currently only supports . See .

                                                                         diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita b/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita index 665207ae06f..afca01f5f2c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita @@ -36,7 +36,7 @@ handler eventHandler - The callback handler to be deleted. ensure the user ID is not set as 0. + The callback handler to be deleted. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita b/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita index 16b1dadd04b..7e8150a04f5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita @@ -33,7 +33,7 @@ metadata - Media metadata ensure the user ID is not set as 0. + Media metadata See . sourceType diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita index b0bc89fdfcc..4c5cd2d10ff 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita @@ -31,7 +31,7 @@ options - The advanced options for audio. ensure the user ID is not set as 0. + The advanced options for audio. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita index 5445e189db4..0e855cf80c7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita @@ -35,7 +35,7 @@ mode - The channel mode. ensure the user ID is not set as 0. + The channel mode. See .
                                    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 6ff0aff1de1..6fd6de76b7d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita @@ -38,7 +38,7 @@ profile -

                                    The channel profile. ensure the user ID is not set as 0.

                                    +

                                    The channel profile. See .

                                    The channel profile.

                                    • (0): Communication. Use this profile when there are only two users in the channel.
                                    • (1): Live streaming. Use this profile when there are more than two users in the channel.
                                      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita index 580186577ff..6026262180e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita @@ -42,7 +42,7 @@ role -

                                      The user role. ensure the user ID is not set as 0.

                                      +

                                      The user role. See .

                                      The user role:

                                      • (1): Host.
                                      • (2): Audience.
                                        • 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 cc7587fa136..65507fb2d97 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita @@ -59,7 +59,7 @@ int SetClientRole(ECLIENT_ROLE_TYPE clientroletype, const FClientRoleOptions& options - The detailed options of a user, including the user level. ensure the user ID is not set as 0. + The detailed options of a user, including the user level. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita index 34a942f6dbb..40f25a29d3b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita @@ -63,7 +63,7 @@ options - The color enhancement options. ensure the user ID is not set as 0. + The color enhancement options. See . diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita index bd0ea2ab444..8aa7c1146ef 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita @@ -43,7 +43,7 @@ mode - The mode in which the video stream is sent. ensure the user ID is not set as 0. + The mode in which the video stream is sent. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita index 967c4a972ac..e242501a5e7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita @@ -55,12 +55,12 @@ int SetDualStreamMode(ESIMULCAST_STREAM_MODE mode, const FSimulcastStreamConfig& mode - The mode in which the video stream is sent. ensure the user ID is not set as 0. + The mode in which the video stream is sent. See . streamConfig -

                                    The configuration of the low-quality video stream. ensure the user ID is not set as 0.

                                    +

                                    The configuration of the low-quality video stream. See .

                                    When setting mode to , setting streamConfig will not take effect.                                     diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita index 69ff33a5a3e..33cf462e4fc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita @@ -31,7 +31,7 @@ sourcePos - The push position of the external audio frame. ensure the user ID is not set as 0. + The push position of the external audio frame. See . The push position of the external audio frame.
                                    • 0: The position before local playback. If you need to play the external audio frame on the local client, set this position.
                                    • 1: The position after audio capture and before audio pre-processing. If you need the audio module of the SDK to process the external audio frame, set this position.
                                      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita index bd4919ab4fe..81a39d1bae4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita @@ -37,7 +37,7 @@ preset - The preset headphone equalization effect. ensure the user ID is not set as 0. + The preset headphone equalization effect. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita index 594b10c4da4..c3647fd7002 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita @@ -44,7 +44,7 @@ transcoding -

                                    The transcoding configurations for the media push. ensure the user ID is not set as 0.

                                    +

                                    The transcoding configurations for the media push. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita index 17d4f14447d..f4e7909d760 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita @@ -35,7 +35,7 @@ config - The configurations of the Local Access Point. ensure the user ID is not set as 0. + The configurations of the Local Access Point. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita index 9882ea0a715..f2cdb722684 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita @@ -35,7 +35,7 @@ option - The stream fallback option. ensure the user ID is not set as 0. + The stream fallback option. See . The stream fallback option.
                                    • (0): (Default) No fallback behavior for the published video stream when the uplink network condition is poor. The stream quality is not guaranteed.
                                    • (2): The published video stream falls back to audio only when the uplink network condition is poor.
                                      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita index 3e132741702..248548892ff 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita @@ -46,7 +46,7 @@ renderMode mode -

                                      The local video display mode. ensure the user ID is not set as 0.

                                      +

                                      The local video display mode. See .

                                      The local video display mode.

                                      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 c9ab5c0f65e..2062436bccc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita @@ -49,7 +49,7 @@ int SetLocalRenderMode(ERENDER_MODE_TYPE renderMode, EVIDEO_MIRROR_MODE_TYPE mir renderMode mode -

                                      The local video display mode. ensure the user ID is not set as 0.

                                      +

                                      The local video display mode. See .

                                      The local video display mode.

                                      • (1): Hidden mode. Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents.
                                      • (2): Fit mode. Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio are filled with black.
                                        • 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 6d742803566..3c279e1b973 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita @@ -40,7 +40,7 @@ mode mirrorMode -

                                        The local video mirror mode. ensure the user ID is not set as 0.

                                        +

                                        The local video mirror mode. See .

                                        • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita index 494c5af1039..7eb991a0bf8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita @@ -63,7 +63,7 @@ options - The low-light enhancement options. ensure the user ID is not set as 0. + The low-light enhancement options. See . type diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita index 08da1afe9b8..7d9e0aedc70 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita @@ -44,7 +44,7 @@ params param - The spatial audio parameters. ensure the user ID is not set as 0. + The spatial audio parameters. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita index 7ce617e704b..0f9610c40a5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita @@ -32,7 +32,7 @@ contentHint - The content hint for screen sharing. ensure the user ID is not set as 0. + The content hint for screen sharing. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita index 152b70938a8..35111ec27c5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita @@ -38,7 +38,7 @@ canvas local - The local video view and settings. ensure the user ID is not set as 0. + The local video view and settings. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita index 6b0a16a0d23..614a5323a70 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita @@ -41,7 +41,7 @@ canvas remote -

                                    The remote video view and settings. ensure the user ID is not set as 0.

                                    +

                                    The remote video view and settings. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita index a334855ee15..680cde7ba6f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita @@ -63,7 +63,7 @@ options - The video noise reduction options. ensure the user ID is not set as 0. + The video noise reduction options. See . diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita index 26a3e2b0c8e..45dc2e0a7e8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita @@ -41,7 +41,7 @@ config - Video profile. ensure the user ID is not set as 0. + Video profile. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita index 5302309424d..3d64a2daecf 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita @@ -39,7 +39,7 @@ profile -

                                    Video profile. ensure the user ID is not set as 0.

                                    +

                                    Video profile. See .

                                                                         diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita index 13a742944ac..5d427d9ae9b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita @@ -37,7 +37,7 @@ int StartAudioRecording(const FAudioRecordingConfiguration& config); config - Recording configurations. ensure the user ID is not set as 0. + Recording configurations. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita index 3738cb5b449..4cf0f6b37a6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita @@ -48,7 +48,7 @@ sourceType -

                                    The type of the video source. ensure the user ID is not set as 0.

                                    +

                                    The type of the video source. See .

                                    • On the mobile platforms, you can capture video from up to 2 cameras, provided the device has dual cameras or supports an external camera.
                                    • On the desktop platforms, you can capture video from up to 4 cameras.
                                                                         @@ -57,7 +57,7 @@ config -

                                    The configuration of the video capture. ensure the user ID is not set as 0.

                                    +

                                    The configuration of the video capture. See .

                                    On the iOS platform, this parameter has no practical function. Use the config parameter in instead to set the video capture configuration.
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita index 8a6082eb100..88981a21ddf 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita @@ -55,7 +55,7 @@ channelMediaRelayConfiguration config configuration - The configuration of the media stream relay. ensure the user ID is not set as 0. + The configuration of the media stream relay. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita index 65f3f47ea03..7b7e026828d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita @@ -61,7 +61,7 @@ options - The media setting options for the host. ensure the user ID is not set as 0. + The media setting options for the host. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita index 111664270df..8cfe53b8c44 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita @@ -39,7 +39,7 @@ int StartEchoTest(const FEchoTestConfiguration& config); config - The configuration of the audio and video call loop test. ensure the user ID is not set as 0. + The configuration of the audio and video call loop test. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita index 5b0aebe42b1..6a6571943ee 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita @@ -54,7 +54,7 @@ channelMediaRelayConfiguration config configuration - The configuration of the media stream relay. ensure the user ID is not set as 0. + The configuration of the media stream relay. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita index b7276cb754a..db48adca5f8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita @@ -58,7 +58,7 @@ config - The metronome configuration. ensure the user ID is not set as 0. + The metronome configuration. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita index 62b612604b4..85b5460b25e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita @@ -58,7 +58,7 @@ int StartScreenCapture(const FScreenCaptureParameters2& captureParams);parameters screenCaptureParameters captureParams - The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. ensure the user ID is not set as 0. + The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita index 1a2576f1fa7..310a3bf7fa3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita @@ -62,7 +62,7 @@ int StartScreenCaptureBySourceType(EVIDEO_SOURCE_TYPE sourceType, const FScreenC config - The configuration of the captured screen. ensure the user ID is not set as 0. + The configuration of the captured screen. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita index a5ddf9b5854..233033bfefe 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita @@ -57,7 +57,7 @@ regionRect - (Optional) Sets the relative location of the region to the screen. Pass in nil to share the entire screen. ensure the user ID is not set as 0. It consists of the following parameters:
                                      + (Optional) Sets the relative location of the region to the screen. Pass in nil to share the entire screen. See . It consists of the following parameters:
                                      • x: The horizontal offset from the top-left corner.
                                      • y: The vertical offset from the top-left corner.
                                      • width: The width of the region.
                                        • @@ -67,7 +67,7 @@ captureParams - Screen sharing configurations. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. ensure the user ID is not set as 0. + Screen sharing configurations. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita index 3c7dc31f43f..a53e4052867 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita @@ -56,11 +56,11 @@ regionRect - (Optional) Sets the relative location of the region to the screen. If you do not set this parameter, the SDK shares the whole screen. ensure the user ID is not set as 0. If the specified region overruns the screen, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen. + (Optional) Sets the relative location of the region to the screen. If you do not set this parameter, the SDK shares the whole screen. See . If the specified region overruns the screen, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen. captureParams - The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. ensure the user ID is not set as 0. + The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See .
                                    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita index 40d88c530ca..5d8b6cf3c0e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita @@ -43,7 +43,7 @@

                                    • This method applies to the macOS and Windows only.
                                      • -
                                    • The window sharing feature of the Agora SDK relies on WGC (Windows Graphics Capture) or GDI (Graphics Device Interface) capture, and WGC cannot be set to disable mouse capture on systems earlier than Windows 10 2004. Therefore, captureMouseCursor(false) might not work when you start window sharing on a device with a system earlier than Windows 10 2004. ensure the user ID is not set as 0.
                                    +
                                  • The window sharing feature of the Agora SDK relies on WGC (Windows Graphics Capture) or GDI (Graphics Device Interface) capture, and WGC cannot be set to disable mouse capture on systems earlier than Windows 10 2004. Therefore, captureMouseCursor(false) might not work when you start window sharing on a device with a system earlier than Windows 10 2004. See .

                                  This method supports window sharing of UWP (Universal Windows Platform) applications. Agora tests the mainstream UWP applications by using the lastest SDK, see details as follows:

    @@ -176,7 +176,7 @@ regionRect - (Optional) Sets the relative location of the region to the screen. If you do not set this parameter, the SDK shares the whole screen. ensure the user ID is not set as 0. If the specified region overruns the window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole window. + (Optional) Sets the relative location of the region to the screen. If you do not set this parameter, the SDK shares the whole screen. See . If the specified region overruns the window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole window. regionRect @@ -192,7 +192,7 @@ captureParams - Screen sharing configurations. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. ensure the user ID is not set as 0. + Screen sharing configurations. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See .
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita index 07f4a604081..2f1b1156f88 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita @@ -58,7 +58,7 @@ options - The channel media options. ensure the user ID is not set as 0. + The channel media options. See .
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita index 29ee12d91aa..193ea38fe83 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita @@ -33,7 +33,7 @@ observer - The encoded audio observer. ensure the user ID is not set as 0. + The encoded audio observer. See .
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita index c6ce1e0096d..5c846cf4d5e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita @@ -42,7 +42,7 @@ parameters captureParams - The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. ensure the user ID is not set as 0. + The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See .
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita index 5afd5276798..ce51a43eeda 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita @@ -42,7 +42,7 @@ screenCaptureParameters captureParams - The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. ensure the user ID is not set as 0. + The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See .
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita index be6fb1e1325..095bb121f26 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita @@ -31,7 +31,7 @@ regionRect - The relative location of the screen-share area to the screen or window. If you do not set this parameter, the SDK shares the whole screen or window. ensure the user ID is not set as 0. If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window. + The relative location of the screen-share area to the screen or window. If you do not set this parameter, the SDK shares the whole screen or window. See . If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window. rect diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita index 868067624e5..9fcaccee823 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita @@ -28,7 +28,7 @@ rect regionRect - The relative location of the region to the screen or window. If you do not set this parameter, the SDK shares the whole screen. ensure the user ID is not set as 0. If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window. + The relative location of the region to the screen or window. If you do not set this parameter, the SDK shares the whole screen. See . If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window.
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita index e678621939a..423f2b1edc1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita @@ -48,7 +48,7 @@ config - The configurations for the data stream. ensure the user ID is not set as 0. + The configurations for the data stream. See . diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita index c4b565b46a7..a66de42b538 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita @@ -59,7 +59,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita index 916b7a8705a..71f15960aa4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita @@ -57,7 +57,7 @@ mode - The mode in which the video stream is sent. ensure the user ID is not set as 0. + The mode in which the video stream is sent. See . diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita index d53a435d755..59dbed31a9b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita @@ -47,7 +47,7 @@ remote canvas -

    The remote video view settings. ensure the user ID is not set as 0.

    +

    The remote video view settings. See .

         diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita index d0b04a7e2f1..4cf4760b640 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita @@ -42,7 +42,7 @@ config - Video profile. ensure the user ID is not set as 0. + Video profile. See . diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita index df55e372b73..74d8622145b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita @@ -58,7 +58,7 @@ channelMediaRelayConfiguration config configuration - The configuration of the media stream relay. ensure the user ID is not set as 0. + The configuration of the media stream relay. See . diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita index fe7eae6b3a5..8a2a086cc7a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita @@ -57,7 +57,7 @@ channelMediaRelayConfiguration config configuration - The configuration of the media stream relay. ensure the user ID is not set as 0. + The configuration of the media stream relay. See . diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita index 3c5f87b9e0a..fcddba1bfbd 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita @@ -48,7 +48,7 @@ capability - An output parameter. Indicates the specific information of the specified video format, including width (px), height (px), and frame rate (fps). ensure the user ID is not set as 0. + An output parameter. Indicates the specific information of the specified video format, including width (px), height (px), and frame rate (fps). See .
    @@ -56,6 +56,6 @@
    • 0: Success.
    • < 0: Failure.
    -

    The specific information of the specified video format, including width (px), height (px), and frame rate (fps). ensure the user ID is not set as 0.

    +

    The specific information of the specified video format, including width (px), height (px), and frame rate (fps). See .

    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/callback_iaudioencodedframeobserver_onrecordaudioencodedframe.dita b/en-US/dita/RTC-NG/API/callback_iaudioencodedframeobserver_onrecordaudioencodedframe.dita index 0edd3f8f979..7847d083b6d 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioencodedframeobserver_onrecordaudioencodedframe.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioencodedframeobserver_onrecordaudioencodedframe.dita @@ -58,7 +58,7 @@ audioEncodedFrameInfo info - Audio information after encoding. ensure the user ID is not set as 0. + Audio information after encoding. See . diff --git a/en-US/dita/RTC-NG/API/callback_iaudioframeobserver_onplaybackaudioframebeforemixing.dita b/en-US/dita/RTC-NG/API/callback_iaudioframeobserver_onplaybackaudioframebeforemixing.dita index 47695662542..01c273e37e2 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioframeobserver_onplaybackaudioframebeforemixing.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioframeobserver_onplaybackaudioframebeforemixing.dita @@ -57,7 +57,7 @@ audioFrame frame audio_Frame - The raw audio data. ensure the user ID is not set as 0. + The raw audio data. See . diff --git a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onearmonitoringaudioframe.dita b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onearmonitoringaudioframe.dita index c1fcb037dd6..bef8a6554c9 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onearmonitoringaudioframe.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onearmonitoringaudioframe.dita @@ -46,7 +46,7 @@ audioFrame frame - The raw audio data. ensure the user ID is not set as 0. + The raw audio data. See . diff --git a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onmixedaudioframe.dita b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onmixedaudioframe.dita index 05ef2981c28..224b49792a2 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onmixedaudioframe.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onmixedaudioframe.dita @@ -47,7 +47,7 @@ audioFrame audio_Frame frame - The raw audio data. ensure the user ID is not set as 0. + The raw audio data. See . channelId diff --git a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onrecordaudioframe.dita b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onrecordaudioframe.dita index e05fa303536..a2627b7bb19 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onrecordaudioframe.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onrecordaudioframe.dita @@ -46,7 +46,7 @@ audioFrame frame - The raw audio data. ensure the user ID is not set as 0. + The raw audio data. See . channelId diff --git a/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita b/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita index d50232a9b37..2e01a2f7618 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita @@ -35,11 +35,11 @@ frame audioFrame - The audio frame information. ensure the user ID is not set as 0. ensure the user ID is not set as 0. + The audio frame information. See . See . playerKit - ensure the user ID is not set as 0. + See .
    diff --git a/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onlocalaudiospectrum.dita b/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onlocalaudiospectrum.dita index 49c3ceb0724..4943cd6dfcf 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onlocalaudiospectrum.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onlocalaudiospectrum.dita @@ -35,7 +35,7 @@ data audioSpectrumData - The audio spectrum data of the local user. ensure the user ID is not set as 0. + The audio spectrum data of the local user. See . The audio spectrum data of the local user. Agora divides the audio frequency into 256 frequency domains, and reports the energy value of each frequency domain through this parameter. The value range of each energy type is [-300, 1] and the unit is dBFS.
    diff --git a/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstatechanged.dita b/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstatechanged.dita index 9c06eac1154..d5c7f93ae23 100644 --- a/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstatechanged.dita @@ -48,11 +48,11 @@ state - The current CDN streaming state. ensure the user ID is not set as 0. + The current CDN streaming state. See . error - The CDN streaming error. ensure the user ID is not set as 0. + The CDN streaming error. See . message diff --git a/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstats.dita b/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstats.dita index ed6aa55f381..ad2d83e4d15 100644 --- a/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstats.dita +++ b/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstats.dita @@ -32,7 +32,7 @@ stats - The statistics of the current CDN streaming. ensure the user ID is not set as 0. + The statistics of the current CDN streaming. See . diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onreaddata.dita b/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onreaddata.dita index e28c36231fc..52da69a5023 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onreaddata.dita +++ b/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onreaddata.dita @@ -35,7 +35,7 @@ playerKit - Media player protocol. ensure the user ID is not set as 0. + Media player protocol. See . buffer diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onseek.dita b/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onseek.dita index f73023c8bd6..01d21289c88 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onseek.dita +++ b/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onseek.dita @@ -36,7 +36,7 @@ playerKit - Media player protocol. ensure the user ID is not set as 0. + Media player protocol. See . offset diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita index ca007cd2353..52079db70f0 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita +++ b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita @@ -48,7 +48,7 @@ playerKit - ensure the user ID is not set as 0. + See . eventCode diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpreloadevent.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpreloadevent.dita index 82cc3ddd79e..e5d0215a647 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpreloadevent.dita +++ b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpreloadevent.dita @@ -40,7 +40,7 @@ event @event - Events that occur when media resources are preloaded. ensure the user ID is not set as 0. + Events that occur when media resources are preloaded. See . diff --git a/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderinfoupdated.dita b/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderinfoupdated.dita index 83c4ca22e81..59c1f12d8af 100644 --- a/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderinfoupdated.dita +++ b/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderinfoupdated.dita @@ -47,7 +47,7 @@ info - The information about the file that is recorded. ensure the user ID is not set as 0. + The information about the file that is recorded. See . recorder diff --git a/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderstatechanged.dita b/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderstatechanged.dita index 5a7c96bba2f..ed9bfe084fa 100644 --- a/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderstatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderstatechanged.dita @@ -53,7 +53,7 @@ state - The current recording state. ensure the user ID is not set as 0. + The current recording state. See . The current recording state:
    • (-1): An error occurs during the recording.
    • (2): The audio and video recording starts.
      • @@ -62,7 +62,7 @@ error - The reason for the state change. ensure the user ID is not set as 0. + The reason for the state change. See . The reason for the state change.
      • (0): No error.
      • (1): The SDK fails to write the recorded data to a file.
        • diff --git a/en-US/dita/RTC-NG/API/callback_imetadataobserver_onreadytosendmetadata.dita b/en-US/dita/RTC-NG/API/callback_imetadataobserver_onreadytosendmetadata.dita index aef33037f2f..44f8988aa08 100644 --- a/en-US/dita/RTC-NG/API/callback_imetadataobserver_onreadytosendmetadata.dita +++ b/en-US/dita/RTC-NG/API/callback_imetadataobserver_onreadytosendmetadata.dita @@ -41,11 +41,11 @@ sourceType source_type - Video data type. ensure the user ID is not set as 0. + Video data type. See . metadata - The metadata that the user wants to send. ensure the user ID is not set as 0. + The metadata that the user wants to send. See .
        diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicestatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicestatechanged.dita index 5c15d144231..4a225e8bbed 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicestatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicestatechanged.dita @@ -49,7 +49,7 @@ deviceType - The device type. ensure the user ID is not set as 0. + The device type. See . diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicevolumechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicevolumechanged.dita index 436c045792a..28444bc5abd 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicevolumechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicevolumechanged.dita @@ -44,7 +44,7 @@ deviceType - The device type. ensure the user ID is not set as 0. + The device type. See . volume diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioquality.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioquality.dita index b13308ec54c..7964dca2de5 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioquality.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioquality.dita @@ -60,7 +60,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . uid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioroutingchanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioroutingchanged.dita index 9c203ace9c7..65a9d06420e 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioroutingchanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioroutingchanged.dita @@ -40,7 +40,7 @@ routing -

        The current audio routing. ensure the user ID is not set as 0.

        +

        The current audio routing. See .

        The current audio routing.

        • (-1): The default audio route.
        • (0): The audio route is a headset with a microphone.
          • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiovolumeindication.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiovolumeindication.dita index a9ef31ec6ad..26a0cedda89 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiovolumeindication.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiovolumeindication.dita @@ -52,7 +52,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . speakers diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncameraexposureareachanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncameraexposureareachanged.dita index d0b45d95dfa..33b53dc608f 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncameraexposureareachanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncameraexposureareachanged.dita @@ -60,7 +60,7 @@ rect - The focus rectangle in the local preview. ensure the user ID is not set as 0. + The focus rectangle in the local preview. See .
        diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita index bcf7bb0d462..f61c9323c96 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita @@ -59,7 +59,7 @@ rect - The focus rectangle in the local preview. ensure the user ID is not set as 0. + The focus rectangle in the local preview. See . diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelayevent.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelayevent.dita index be7019ad41e..c4973cb74da 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelayevent.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelayevent.dita @@ -44,7 +44,7 @@ didReceiveChannelMediaRelayEvent:(AgoraChannelMediaRelayEvent)event; code event -

        The event code of channel media relay. ensure the user ID is not set as 0.

        +

        The event code of channel media relay. See .

        The event code of channel media relay:

        • (0): The user disconnects from the server due to a poor network connection.
        • (1): The user is connected to the server.
          • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita index 19a7ad9e785..e27cc185ed1 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita @@ -46,7 +46,7 @@ channelMediaRelayStateDidChange:(AgoraChannelMediaRelayState)state state -

          The state code. ensure the user ID is not set as 0.

          +

          The state code. See .

          The state code:

          • (0): The SDK is initializing.
          • (1): The SDK tries to relay the media stream to the destination channel.
            • @@ -58,7 +58,7 @@ channelMediaRelayStateDidChange:(AgoraChannelMediaRelayState)state code -

            The error code of the channel media relay. ensure the user ID is not set as 0.

            +

            The error code of the channel media relay. See .

            The error code of the channel media relay.

            • (0): Everything is normal.
            • (1): An error occurs in the server response.
              • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita index 598ba9ac5ed..0427bba625c 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita @@ -48,7 +48,7 @@ NS_SWIFT_NAME(rtcEngine(_:didClientRoleChanged:newRole:newRoleOptions:)); connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . oldRole @@ -71,7 +71,7 @@ NS_SWIFT_NAME(rtcEngine(_:didClientRoleChanged:newRole:newRoleOptions:));v4.1.0 -

              Properties of the role that the user switches to. ensure the user ID is not set as 0.

              +

              Properties of the role that the user switches to. See .

               diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita index 14ebecaca52..6ed744c8753 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita @@ -44,7 +44,7 @@ reason - The reason for a user role switch failure. ensure the user ID is not set as 0. + The reason for a user role switch failure. See . The possible reasons for the switch failure include the following:
              • (1): The number of hosts in the channel is already at the upper limit.This enumerator is reported only when the support for 128 users is enabled. The maximum number of hosts is based on the actual number of hosts configured when you enable the 128-user feature.
              • (2): The request is rejected by the Agora server. Agora recommends you prompt the user to try to switch their user role again.
                • @@ -54,7 +54,7 @@ currentRole - Current user role. ensure the user ID is not set as 0. + Current user role. See . Current user role.
                • (1): Host. A host can both send and receive streams.
                • (2): Audience. An audience member can only receive streams.
                  • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionbanned.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionbanned.dita index d55a7a1bb4b..c8930125ec0 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionbanned.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionbanned.dita @@ -39,7 +39,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectioninterrupted.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectioninterrupted.dita index 82ef7d58bff..021c02dbdf9 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectioninterrupted.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectioninterrupted.dita @@ -43,7 +43,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionlost.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionlost.dita index 68f4f897e86..95c2d0fbc69 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionlost.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionlost.dita @@ -34,7 +34,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita index 7ba9cb95571..3cd04c57c2b 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita @@ -48,12 +48,12 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . state -

                  The current connection state. ensure the user ID is not set as 0.

                  +

                  The current connection state. See .

                  • (1): The SDK is disconnected from Agora's edge server.
                  • (2): The SDK is connecting to Agora's edge server.
                    • @@ -65,7 +65,7 @@ reason -

                    The reason for a connection state change. ensure the user ID is not set as 0.

                    +

                    The reason for a connection state change. See .

                    • (0): The SDK is connecting to Agora's edge server.
                      • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncontentinspectresult.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncontentinspectresult.dita index 8ecc92000bd..376ee662939 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncontentinspectresult.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncontentinspectresult.dita @@ -32,7 +32,7 @@ result - Content moderation results. ensure the user ID is not set as 0. + Content moderation results. See .

                      The results of video content moderation:

                      • (1): The image does not contain inappropriate elements.
                        • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onencryptionerror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onencryptionerror.dita index 77d43786752..6d3bf12aa07 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onencryptionerror.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onencryptionerror.dita @@ -45,7 +45,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . errorType diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita index 4840261b5d6..934682d3331 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita @@ -41,7 +41,7 @@ errorCode err - Error code. ensure the user ID is not set as 0. + Error code. See . msg diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfacepositionchanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfacepositionchanged.dita index db19e001afc..f58072076ab 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfacepositionchanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfacepositionchanged.dita @@ -90,7 +90,7 @@
                      • height: The height (px) of the human face in the captured view.

                       - The information of the detected human face. ensure the user ID is not set as 0. + The information of the detected human face. See .                       vecDistance diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalaudioframepublished.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalaudioframepublished.dita index 126b122276c..23ba12aa0b0 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalaudioframepublished.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalaudioframepublished.dita @@ -49,7 +49,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . elapsed diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframepublished.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframepublished.dita index d27575ed217..93da417f32c 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframepublished.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframepublished.dita @@ -53,7 +53,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideodecoded.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideodecoded.dita index b2612aa3092..1dbcde8771f 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideodecoded.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideodecoded.dita @@ -72,7 +72,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . remoteUid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita index 975726dbd43..e5f206babb2 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita @@ -60,7 +60,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . width diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita index 6e4fed9d070..573d24fec8d 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita @@ -50,7 +50,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . elapsed diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita index 3e99864f370..2e16b972394 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita @@ -37,7 +37,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . stats diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita index 68cc3daf466..0969832c94c 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita @@ -48,11 +48,11 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . state - The state of the local audio. ensure the user ID is not set as 0. + The state of the local audio. See . The state of the local audio.
                      • (0): The local video is in the initial state.
                      • (1): The local video capturing device starts successfully.
                        • @@ -62,7 +62,7 @@ error - Local audio state error codes. ensure the user ID is not set as 0. + Local audio state error codes. See . Local audio state error codes.
                        • 0: The local audio is normal.
                        • 1: No specified reason for the local audio failure. Remind your users to try to rejoin the channel.
                          • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostats.dita index 4483c20c52d..b9ce15c7ab4 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostats.dita @@ -38,11 +38,11 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . stats - Local audio statistics. ensure the user ID is not set as 0. + Local audio statistics. See . diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita index da19270bafc..59d3c140a40 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita @@ -63,7 +63,7 @@ sourceType source - The type of the video source. ensure the user ID is not set as 0. + The type of the video source. See . state diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostats.dita index 3b79ebcf4e5..425e6d47bad 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostats.dita @@ -42,7 +42,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . @@ -50,7 +50,7 @@ stats - The statistics of the local video stream. ensure the user ID is not set as 0. + The statistics of the local video stream. See . diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita index be0f54049db..211867aa8c9 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita @@ -49,12 +49,12 @@ stream - The video streams that cannot be mixed during video mixing. ensure the user ID is not set as 0. + The video streams that cannot be mixed during video mixing. See . error errorCode - The reason for local video mixing error. ensure the user ID is not set as 0. + The reason for local video mixing error. See . The reason for local video mixing error:
                          • 1: The selected video source has not started video capture. You need to create a video track for it and start video capture.
                          • 2: The video source type is invalid. You need to re-specify the supported video source type.
                            • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita index 3df265c1a54..27f7ff28e3b 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita @@ -53,7 +53,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . uid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworktypechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworktypechanged.dita index 6e99b233b7a..77f57f45e8f 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworktypechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworktypechanged.dita @@ -37,12 +37,12 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . type -

                            The type of the local network connection. ensure the user ID is not set as 0.

                            +

                            The type of the local network connection. See .

                            Network types:

                            • (-1): The network type is unknown.
                            • (0): The SDK disconnects from the network.
                              • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onpermissionerror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onpermissionerror.dita index f9ef693dfab..2e20b88e329 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onpermissionerror.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onpermissionerror.dita @@ -38,7 +38,7 @@ permission type permissionType - The type of the device permission. ensure the user ID is not set as 0. + The type of the device permission. See . The type of the device permission.
                              • (0): Permission for the audio capture device.
                              • (1): Permission for the camera.
                                • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onproxyconnected.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onproxyconnected.dita index eb77ba1fd08..fe7d799511b 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onproxyconnected.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onproxyconnected.dita @@ -58,7 +58,7 @@ proxyType - The proxy type connected. ensure the user ID is not set as 0. + The proxy type connected. See . The proxy type connected.
                                • (0): Reserved for future use.
                                • (1): The cloud proxy for the UDP protocol, that is, the Force UDP cloud proxy mode. In this mode, the SDK always transmits data over UDP.
                                  • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita index 9af94a21667..4e67cb5d06e 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita @@ -48,7 +48,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . elapsed diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita index 8580ca5137e..15664166f08 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita @@ -60,7 +60,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . uid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostats.dita index 4532abf69fd..ee85ed09753 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostats.dita @@ -38,7 +38,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . stats diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiotransportstats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiotransportstats.dita index 424e6632c83..9d7ef0ea635 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiotransportstats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiotransportstats.dita @@ -67,7 +67,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . uid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostatechanged.dita index 05c4754116e..c6abb27bcef 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostatechanged.dita @@ -59,7 +59,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . uid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostats.dita index 097a732efef..4f4333a8f30 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostats.dita @@ -36,11 +36,11 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . stats - Statistics of the remote video stream. ensure the user ID is not set as 0. + Statistics of the remote video stream. See . diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideotransportstats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideotransportstats.dita index 04c7a266d43..e6c8a8af98a 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideotransportstats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideotransportstats.dita @@ -66,7 +66,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . uid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtcstats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtcstats.dita index 757a7d598f8..789bb6fa173 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtcstats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtcstats.dita @@ -37,7 +37,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . stats diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita index 9833509c0e6..ca176be64c3 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita @@ -36,7 +36,7 @@ eventCode event - The event code of Media Push. ensure the user ID is not set as 0. + The event code of Media Push. See . The event code of Media Push.
                                  • (1): An error occurs when you add a background image or a watermark image in the Media Push.
                                  • (2): The streaming URL is already being used for Media Push. If you want to start new streaming, use a new streaming URL.
                                    • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablevideo.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablevideo.dita index 296dcc2ecb0..7bab9eb5b50 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablevideo.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablevideo.dita @@ -58,7 +58,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . uid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserjoined.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserjoined.dita index 912cab687e7..394bd25300b 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserjoined.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserjoined.dita @@ -48,7 +48,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . uid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermutevideo.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermutevideo.dita index e009f571fd6..472c8918f5a 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermutevideo.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermutevideo.dita @@ -55,7 +55,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . uid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuseroffline.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuseroffline.dita index 8a2b5448a67..ef5d105f7a9 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuseroffline.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuseroffline.dita @@ -51,7 +51,7 @@ connection - The connection information. ensure the user ID is not set as 0. + The connection information. See . uid diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideodevicestatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideodevicestatechanged.dita index d5a7d7429d4..2003a6a9c98 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideodevicestatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideodevicestatechanged.dita @@ -47,7 +47,7 @@ deviceType - Media device types. ensure the user ID is not set as 0. + Media device types. See . deviceState diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideopublishstatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideopublishstatechanged.dita index f1069e3d30b..b3e8848e421 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideopublishstatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideopublishstatechanged.dita @@ -70,7 +70,7 @@ elapseSinceLastState:(int)elapseSinceLastState; sourceType source - The type of the video source. ensure the user ID is not set as 0. + The type of the video source. See . oldState diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideorenderingtracingresult.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideorenderingtracingresult.dita index 83fd45a06b0..848ecba2773 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideorenderingtracingresult.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideorenderingtracingresult.dita @@ -62,11 +62,11 @@ currentEvent - The current video frame rendering event. ensure the user ID is not set as 0. + The current video frame rendering event. See . tracingInfo - The indicators during the video frame rendering process. Developers need to reduce the value of indicators as much as possible in order to improve the efficiency of the first video frame rendering. ensure the user ID is not set as 0. + The indicators during the video frame rendering process. Developers need to reduce the value of indicators as much as possible in order to improve the efficiency of the first video frame rendering. See . diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getobservedframeposition.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getobservedframeposition.dita index 824db74276f..2eee26eda55 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getobservedframeposition.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getobservedframeposition.dita @@ -44,7 +44,7 @@
                                  Returns -

                                  A bit mask that controls the frame position of the video observer. ensure the user ID is not set as 0.

                                  +

                                  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.

                                  • (1 << 0): The position after capturing the video data, which corresponds to the callback.
                                  • (1 << 1): The position of the received remote video data before rendering, which corresponds to the callback.
                                    • diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getvideoformatpreference.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getvideoformatpreference.dita index 3365230a16a..dca74e0586b 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getvideoformatpreference.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getvideoformatpreference.dita @@ -32,7 +32,7 @@ If you want the video captured by the sender to be the original format, set the original video data format to in the return value. The original video pixel format varies based on different platforms. For the actual video pixel format, see .
                                  Returns -

                                  Sets the video format. ensure the user ID is not set as 0.

                                  +

                                  Sets the video format. See .

                                  According to different observation locations and collection scenarios, the actual video pixel format corresponding to this enumeration value is different. Agora recommends that you do not use this value. Some common situations are listed below.

                                  diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onframe.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onframe.dita index 01005ffc786..aa4eef52a77 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onframe.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onframe.dita @@ -40,15 +40,15 @@ audioFrame - Configurations of the video frame. ensure the user ID is not set as 0. + Configurations of the video frame. See . config - The type and source of the video frame. ensure the user ID is not set as 0. + The type and source of the video frame. See . playerKit - ensure the user ID is not set as 0. + See . pixelBuffer diff --git a/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita b/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita index 017a139bb66..42f47a31257 100644 --- a/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita @@ -201,7 +201,7 @@ mode

                                  The connection mode. ensure the user ID is not set as 0.

                                  + >The connection mode. See .

                                  Select one of the following connection modes:

                                  • (0): The SDK firstly tries to connect to the specified Agora private media server; if the connection attempt fails, it will connect to the Agora SD-RTN™ instead.
                                    • @@ -211,8 +211,8 @@ advancedConfig - The advanced options for the Local Access Point. ensure the user ID is not set as 0. + The advanced options for the Local Access Point. See .
                                  diff --git a/en-US/dita/RTC-NG/API/class_advanceoptions.dita b/en-US/dita/RTC-NG/API/class_advanceoptions.dita index 0704e891398..e9ab1ee61bf 100644 --- a/en-US/dita/RTC-NG/API/class_advanceoptions.dita +++ b/en-US/dita/RTC-NG/API/class_advanceoptions.dita @@ -96,11 +96,11 @@ encodingPreference - Video encoder preference. ensure the user ID is not set as 0. + Video encoder preference. See . compressionPreference - Compression preference for video encoding. ensure the user ID is not set as 0. + Compression preference for video encoding. See . diff --git a/en-US/dita/RTC-NG/API/class_audioencodedframeobserverconfig.dita b/en-US/dita/RTC-NG/API/class_audioencodedframeobserverconfig.dita index 36d849e4c09..40194641244 100644 --- a/en-US/dita/RTC-NG/API/class_audioencodedframeobserverconfig.dita +++ b/en-US/dita/RTC-NG/API/class_audioencodedframeobserverconfig.dita @@ -76,7 +76,7 @@ postionType -

                                  Audio profile. ensure the user ID is not set as 0.

                                  +

                                  Audio profile. See .

                                  Audio profile:

                                  • (1): Only encode the audio of the local user.
                                  • (2): Only encode the audio of all remote users.
                                    • @@ -87,7 +87,7 @@ encodingType -

                                    Audio encoding type. ensure the user ID is not set as 0.

                                    +

                                    Audio encoding type. See .

                                    Audio encoding type:

                                    • : AAC encoding format, 16000 Hz sampling rate, low quality. A file with an audio duration of 10 minutes is approximately 1.2 MB after encoding.
                                    • : AAC encoding format, 16000 Hz sampling rate, medium quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
                                      • diff --git a/en-US/dita/RTC-NG/API/class_audioparams.dita b/en-US/dita/RTC-NG/API/class_audioparams.dita index cb037b48704..c553ee129d3 100644 --- a/en-US/dita/RTC-NG/API/class_audioparams.dita +++ b/en-US/dita/RTC-NG/API/class_audioparams.dita @@ -147,7 +147,7 @@ mode - The use mode of the audio data. ensure the user ID is not set as 0. + The use mode of the audio data. See . The use mode of the audio data, which can be set as either of the following values:
                                      • (0): Read-only mode, where users only read the original data from without any modification. For example, when users acquire the data with the Agora SDK, then start the media push.
                                      • (2): Read and write mode, where users read the data from , modify it, and then play it. Users read the data returned by the SDK, modify it, and then play it. For example, when users have their own audio-effect processing module and perform some voice pre-processing, such as a voice change.
                                        • diff --git a/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita b/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita index 9957b429b48..1ab19da80e4 100644 --- a/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita @@ -204,7 +204,7 @@ fileRecordingType fileRecordOption -

                                        The recording content. ensure the user ID is not set as 0.

                                        +

                                        The recording content. See .

                                        Recording content:

                                        • (1): Only records the audio of the local user.
                                        • (2): Only records the audio of all remote users.
                                          • @@ -215,7 +215,7 @@ quality -

                                          Recording quality. ensure the user ID is not set as 0.

                                          +

                                          Recording quality. See .

                                          Recording quality:

                                          • (0): Low quality. For example, the size of an AAC file with a sample rate of 32,000 Hz and a recording duration of 10 minutes is around 1.2 MB.
                                          • (1): (Default) Medium quality. For example, the size of an AAC file with a sample rate of 32,000 Hz and a recording duration of 10 minutes is around 2 MB.
                                            • diff --git a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita index 9cfeb4b78c7..c8961b7b32b 100644 --- a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita @@ -213,12 +213,12 @@ cameraDirection - This parameter applies to Android and iOS only.The camera direction. ensure the user ID is not set as 0. + This parameter applies to Android and iOS only.The camera direction. See . format captureFormat - The format of the video frame. ensure the user ID is not set as 0. + The format of the video frame. See . deviceId diff --git a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita index 9ccfabe4d2a..2b1003f9a1e 100644 --- a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita +++ b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita @@ -656,7 +656,7 @@ class ChannelMediaOptions { clientRoleType - The user role. ensure the user ID is not set as 0. + The user role. See . diff --git a/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita b/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita index b843220f3de..1fbcf2850e8 100644 --- a/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita @@ -111,23 +111,23 @@ setSrcChannelInfo - Sets the information of the source channel. ensure the user ID is not set as 0. + Sets the information of the source channel. See . setDestChannelInfo - Sets the information of the target channel. ensure the user ID is not set as 0. + Sets the information of the target channel. See . removeDestChannelInfo - Deletes the information of target channel. ensure the user ID is not set as 0. + Deletes the information of target channel. See . getSrcChannelMediaInfo - Gets the information of the source channel. ensure the user ID is not set as 0. + Gets the information of the source channel. See . getDestChannelMediaInfos - Gets the information of the target channel. ensure the user ID is not set as 0. + Gets the information of the target channel. See . @@ -168,11 +168,11 @@ setDestinationInfo - Sets the information of the target channel. ensure the user ID is not set as 0. + Sets the information of the target channel. See . removeDestinationInfoForChannelName - Deletes the information of target channel. ensure the user ID is not set as 0. + Deletes the information of target channel. See . diff --git a/en-US/dita/RTC-NG/API/class_codeccapinfo.dita b/en-US/dita/RTC-NG/API/class_codeccapinfo.dita index b6356981e9a..0b92b456460 100644 --- a/en-US/dita/RTC-NG/API/class_codeccapinfo.dita +++ b/en-US/dita/RTC-NG/API/class_codeccapinfo.dita @@ -90,7 +90,7 @@ class CodecCapInfo { codecType - The video codec types. ensure the user ID is not set as 0. + The video codec types. See .

                                            The video codec types:

                                            • 1: VP8.
                                              • @@ -100,7 +100,7 @@ class CodecCapInfo { codecCapMask - The bit mask of the codec type. ensure the user ID is not set as 0. + The bit mask of the codec type. See .

                                              The bit mask of the codec type:

                                              • (0): The device does not support encoding or decoding.
                                                • @@ -113,7 +113,7 @@ class CodecCapInfo { codecLevels - The level of the codec capability. ensure the user ID is not set as 0. + The level of the codec capability. See . diff --git a/en-US/dita/RTC-NG/API/class_codeccaplevels.dita b/en-US/dita/RTC-NG/API/class_codeccaplevels.dita index b0dcf0143c8..29f19a46b6c 100644 --- a/en-US/dita/RTC-NG/API/class_codeccaplevels.dita +++ b/en-US/dita/RTC-NG/API/class_codeccaplevels.dita @@ -80,11 +80,11 @@ class CodecCapLevels { hwDecodingLevel - Hardware decoding capability level, which represents the device's ability to perform hardware decoding on videos of different quality. ensure the user ID is not set as 0. + Hardware decoding capability level, which represents the device's ability to perform hardware decoding on videos of different quality. See . swDecodingLevel - Software decoding capability level, which represents the device's ability to perform software decoding on videos of different quality. ensure the user ID is not set as 0. + Software decoding capability level, which represents the device's ability to perform software decoding on videos of different quality. See . diff --git a/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita b/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita index 7b68552d73e..443197715de 100644 --- a/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita +++ b/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita @@ -114,7 +114,7 @@ modules -

                                                Functional module. ensure the user ID is not set as 0.

                                                +

                                                Functional module. See .

                                                A maximum of 32 instances can be configured, and the value range of MAX_CONTENT_INSPECT_MODULE_COUNT is an integer in [1,32].

                                                A function module can only be configured with one instance at most. Currently only the video screenshot and upload function is supported.                                                 diff --git a/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita b/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita index 19995c6f982..85f7dbb2011 100644 --- a/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita +++ b/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita @@ -68,7 +68,7 @@ type - Types of functional module. ensure the user ID is not set as 0. + Types of functional module. See .

                                                Types of functional modules:

                                                • (0): (Default) This module has no actual function. Do not set to this value.
                                                  • diff --git a/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita b/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita index 1b4f569fadf..88df0d8fff4 100644 --- a/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita +++ b/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita @@ -373,7 +373,7 @@ streamType - The type of video streams. ensure the user ID is not set as 0. + The type of video streams. See .
                                                  • (0): High-quality stream, that is, a high-resolution and high-bitrate video stream.
                                                    • diff --git a/en-US/dita/RTC-NG/API/class_externalvideoframe.dita b/en-US/dita/RTC-NG/API/class_externalvideoframe.dita index 273de19112c..31adf2e2520 100644 --- a/en-US/dita/RTC-NG/API/class_externalvideoframe.dita +++ b/en-US/dita/RTC-NG/API/class_externalvideoframe.dita @@ -279,12 +279,12 @@ type -

                                                    The video type. ensure the user ID is not set as 0.

                                                    +

                                                    The video type. See .

                                                                                                         format - The pixel format. ensure the user ID is not set as 0. + The pixel format. See . The format of the incoming video frame. This parameter must be specified as one of the following values:
                                                    • 1: I420
                                                    • 2: BGRA
                                                      • diff --git a/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita b/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita index ddfb4696a23..fc70daee84d 100644 --- a/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita +++ b/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita @@ -180,7 +180,7 @@ audioSampleRate -

                                                      The sampling rate (Hz) of injecting the external audio stream. The default value is 48000 Hz. ensure the user ID is not set as 0.

                                                      +

                                                      The sampling rate (Hz) of injecting the external audio stream. The default value is 48000 Hz. See .

                                                      Agora recommends using the default value.                                                       diff --git a/en-US/dita/RTC-NG/API/class_lastmileproberesult.dita b/en-US/dita/RTC-NG/API/class_lastmileproberesult.dita index ea7a88f436a..af6147f1f1e 100644 --- a/en-US/dita/RTC-NG/API/class_lastmileproberesult.dita +++ b/en-US/dita/RTC-NG/API/class_lastmileproberesult.dita @@ -111,11 +111,11 @@ uplinkReport - Results of the uplink last-mile network test. ensure the user ID is not set as 0. + Results of the uplink last-mile network test. See . downlinkReport - Results of the downlink last-mile network test. ensure the user ID is not set as 0. + Results of the downlink last-mile network test. See . rtt diff --git a/en-US/dita/RTC-NG/API/class_livetranscoding.dita b/en-US/dita/RTC-NG/API/class_livetranscoding.dita index 6b69bdc4252..93da02453da 100644 --- a/en-US/dita/RTC-NG/API/class_livetranscoding.dita +++ b/en-US/dita/RTC-NG/API/class_livetranscoding.dita @@ -631,12 +631,12 @@ videoCodecType - Video codec profile types for Media Push. ensure the user ID is not set as 0. + 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. ensure the user ID is not set as 0.

                                                      +

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

                                                                                                             @@ -698,20 +698,20 @@ watermark -

                                                      The watermark on the live video. The image format needs to be PNG. ensure the user ID is not set as 0.

                                                      +

                                                      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. ensure the user ID is not set as 0.

                                                      +

                                                      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. ensure the user ID is not set as 0. 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 @@ -739,11 +739,11 @@ audioCodecProfile - Audio codec profile type for Media Push. ensure the user ID is not set as 0. + Audio codec profile type for Media Push. See . watermarkArray - The array of watermarks on the live video. ensure the user ID is not set as 0. 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. ensure the user ID is not set as 0. + Advanced features of the Media Push with transcoding. See . advancedFeatureCount @@ -767,27 +767,27 @@ addBackgroundImage - Adds a background image. ensure the user ID is not set as 0. + Adds a background image. See . addUser - Adds a user for video mixing during the CDN live streaming. ensure the user ID is not set as 0. + Adds a user for video mixing during the CDN live streaming. See . addWatermark - Adds a watermark. ensure the user ID is not set as 0. + Adds a watermark. See . getAdvancedFeatures - Gets the status of the advanced features of streaming with transcoding. ensure the user ID is not set as 0. + Gets the status of the advanced features of streaming with transcoding. See . getBackgroundColor - Gets the background color in hex. ensure the user ID is not set as 0. + Gets the background color in hex. See . getBackgroundImageList - Gets the list of background images. ensure the user ID is not set as 0. + 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. ensure the user ID is not set as 0.

                                                      +

                                                      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. ensure the user ID is not set as 0.

                                                      +

                                                      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. ensure the user ID is not set as 0.

                                                      +

                                                      Gets the background color's red component. See .

                                                       getUserCount - Gets the number of users transcoded in the CDN live streaming. ensure the user ID is not set as 0. + Gets the number of users transcoded in the CDN live streaming. See . getUsers - Gets the user list in the CDN live streaming. ensure the user ID is not set as 0. + Gets the user list in the CDN live streaming. See . getWatermarkList - Gets the watermark list. ensure the user ID is not set as 0. + Gets the watermark list. See . removeBackgroundImage - Removes a background image from the background image list. ensure the user ID is not set as 0. + Removes a background image from the background image list. See . removeUser - Removes a user from video mixing during the CDN live streaming. ensure the user ID is not set as 0. + Removes a user from video mixing during the CDN live streaming. See . removeWatermark - Removes a watermark from the watermark list. ensure the user ID is not set as 0. + Removes a watermark from the watermark list. See . setAdvancedFeatures - Sets whether to enable the advanced features of streaming with transcoding. ensure the user ID is not set as 0. + 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. ensure the user ID is not set as 0. + 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. ensure the user ID is not set as 0. + 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. ensure the user ID is not set as 0.

                                                      +

                                                      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. ensure the user ID is not set as 0.

                                                      +

                                                      Sets the background color's green component. See .

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

                                                      Sets the background color's red component. ensure the user ID is not set as 0.

                                                      +

                                                      Sets the background color's red component. See .

                                                       setUsers [1/2] - Sets the users in batches in the CDN live streaming. ensure the user ID is not set as 0. + Sets the users in batches in the CDN live streaming. See . setUsers [2/2] - Sets the users in batches in the CDN live streaming. ensure the user ID is not set as 0. + Sets the users in batches in the CDN live streaming. See . defaultTranscoding diff --git a/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita b/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita index 91ae5b3c215..8b715da6ff4 100644 --- a/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita @@ -89,11 +89,11 @@ class LocalTranscoderConfiguration { videoInputStreams transcodingVideoStreams - The video streams for local video mixing. ensure the user ID is not set as 0. + The video streams for local video mixing. See . videoOutputConfiguration - The encoding configuration of the mixed video stream after the local video mixing. ensure the user ID is not set as 0. + The encoding configuration of the mixed video stream after the local video mixing. See .                                                       diff --git a/en-US/dita/RTC-NG/API/class_localvideostats.dita b/en-US/dita/RTC-NG/API/class_localvideostats.dita index 436d017577e..d12919e56c3 100644 --- a/en-US/dita/RTC-NG/API/class_localvideostats.dita +++ b/en-US/dita/RTC-NG/API/class_localvideostats.dita @@ -408,7 +408,7 @@                                                       captureBrightnessLevel - The brightness level of the video image captured by the local camera. ensure the user ID is not set as 0. + The brightness level of the video image captured by the local camera. See . captureBrightnessLevel diff --git a/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita b/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita index 489b85f1efc..fc624f4f4f9 100644 --- a/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita @@ -118,12 +118,12 @@ containerFormat - The format of the recording file. ensure the user ID is not set as 0. + The format of the recording file. See . The format of the recording file. Only is supported. streamType - The recording content. ensure the user ID is not set as 0. + The recording content. See . The recording content:
                                                      • : Only audio.
                                                      • : Only video.
                                                        • diff --git a/en-US/dita/RTC-NG/API/class_mediasource.dita b/en-US/dita/RTC-NG/API/class_mediasource.dita index e4cec788d5b..263f15fd6fb 100644 --- a/en-US/dita/RTC-NG/API/class_mediasource.dita +++ b/en-US/dita/RTC-NG/API/class_mediasource.dita @@ -207,7 +207,7 @@ provider -

                                                        The callback for custom media resource files. ensure the user ID is not set as 0.

                                                        +

                                                        The callback for custom media resource files. See .

                                                        If you open a custom media resource, pass in the value to provider. If you open a common media resource, pass in the value to url. Agora recommends that you do not pass in values to both url and provider in one call; otherwise, this call may fail.

                                                         @@ -216,7 +216,7 @@ playerOnReadCallback -

                                                        Occurs when the SDK reads the media resource data. ensure the user ID is not set as 0.

                                                        +

                                                        Occurs when the SDK reads the media resource data. See .

                                                        @@ -224,7 +224,7 @@ playerOnSeekCallback -

                                                        Occurs when the SDK seeks the media resource data. ensure the user ID is not set as 0.

                                                        +

                                                        Occurs when the SDK seeks the media resource data. See .

                                                        diff --git a/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita b/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita index 47b15c46c83..ca7884ea02e 100644 --- a/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita +++ b/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita @@ -278,7 +278,7 @@ quality -

                                                        The quality of the audio stream sent by the user. ensure the user ID is not set as 0.

                                                        +

                                                        The quality of the audio stream sent by the user. See .

                                                        • (0): The quality is unknown.
                                                          • diff --git a/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita b/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita index f02de4f50f3..b9a6b03d108 100644 --- a/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita +++ b/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita @@ -279,7 +279,7 @@ class RtcEngineContext { logConfig mLogConfig -

                                                          Sets the log file size. ensure the user ID is not set as 0.

                                                          +

                                                          Sets the log file size. See .

                                                          By default, the SDK generates five SDK log files and five API call log files with the following rules:

                                                          • @@ -324,7 +324,7 @@ class RtcEngineContext { addExtension - Adds the extension. ensure the user ID is not set as 0. + Adds the extension. See . diff --git a/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita b/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita index 54b1435105f..377095e2002 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita @@ -129,11 +129,11 @@ __attribute__((visibility("default"))) @interface AgoraScreenCaptureConfiguratio params parameters - (For Windows and macOS only) The screen capture configuration. ensure the user ID is not set as 0. + (For Windows and macOS only) The screen capture configuration. See . regionRect - (For Windows and macOS only) The relative position of the shared region to the whole screen. ensure the user ID is not set as 0. If you do not set this parameter, the SDK shares the whole screen. If the region you set exceeds the boundary of the screen, only the region within in the screen is shared. If you set width or height in as 0, the whole screen is shared. + (For Windows and macOS only) The relative position of the shared region to the whole screen. See . If you do not set this parameter, the SDK shares the whole screen. If the region you set exceeds the boundary of the screen, only the region within in the screen is shared. If you set width or height in as 0, the whole screen is shared. The relative position of the shared region to the whole screen. The data type is CGRect. diff --git a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita index 21747080b85..c2679fdef21 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita @@ -234,7 +234,7 @@ dimensions -

                                                            The video encoding resolution of the shared screen stream. ensure the user ID is not set as 0. The default value is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges.

                                                            +

                                                            The video encoding resolution of the shared screen stream. See . The default value is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges.

                                                            If the screen dimensions are different from the value of this parameter, Agora applies the following strategies for encoding. Suppose dimensions is set to 1920 × 1080:

                                                            • If the value of the screen dimensions is lower than that of dimensions, for example, 1000 × 1000 pixels, the SDK uses the screen dimensions, that is, 1000 × 1000 pixels, for encoding.
                                                            • If the value of the screen dimensions is higher than that of dimensions, for example, 2000 × 1500, the SDK uses the maximum value under dimensions with the aspect ratio of the screen dimension (4:3) for encoding, that is, 1440 × 1080.
                                                              • diff --git a/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita index 4877680c47f..4a86e5cbd24 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita @@ -214,11 +214,11 @@ - The video configuration for the shared screen stream. ensure the user ID is not set as 0. + The video configuration for the shared screen stream. See . - The audio configuration for the shared screen stream. ensure the user ID is not set as 0. + The audio configuration for the shared screen stream. See . diff --git a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita index c780a1078ba..25dee9d51ac 100644 --- a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita +++ b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita @@ -136,7 +136,7 @@ type - The type of the shared target. ensure the user ID is not set as 0. + The type of the shared target. See . sourceId @@ -148,11 +148,11 @@ thumbImage - The image content of the thumbnail. ensure the user ID is not set as 0. + The image content of the thumbnail. See . iconImage - The image content of the icon. ensure the user ID is not set as 0. + The image content of the icon. See . processPath @@ -171,7 +171,7 @@ position - The position of a window relative to the entire screen space (including all shareable screens). ensure the user ID is not set as 0. ensure the user ID is not set as 0. + The position of a window relative to the entire screen space (including all shareable screens). See . See . minimizeWindow diff --git a/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita b/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita index 06117fbe090..4cc9bbcfb2a 100644 --- a/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita +++ b/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita @@ -77,7 +77,7 @@ dimensions - The video dimension. ensure the user ID is not set as 0. The default value is 160 × 120. + The video dimension. See . The default value is 160 × 120. bitrate diff --git a/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita b/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita index 5047b7f471f..d1aef3abb2a 100644 --- a/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita +++ b/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita @@ -187,7 +187,7 @@ class TranscodingVideoStream { sourceType - The video source type for local video mixing. ensure the user ID is not set as 0. + The video source type for local video mixing. See . remoteUserUid diff --git a/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita b/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita index 134b32bac70..c6f70b2f032 100644 --- a/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita +++ b/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita @@ -67,7 +67,7 @@ audioSpectrumData spectrumData -

                                                              Audio spectrum information of the remote user. ensure the user ID is not set as 0.

                                                              +

                                                              Audio spectrum information of the remote user. See .

                                                                                                                             diff --git a/en-US/dita/RTC-NG/API/class_videocanvas.dita b/en-US/dita/RTC-NG/API/class_videocanvas.dita index b404dd8e529..2b0fe9185f2 100644 --- a/en-US/dita/RTC-NG/API/class_videocanvas.dita +++ b/en-US/dita/RTC-NG/API/class_videocanvas.dita @@ -224,7 +224,7 @@ class VideoCanvas {                                                               setupMode - Setting mode of the view. ensure the user ID is not set as 0. + Setting mode of the view. See . Setting mode of the view.
                                                              • (0): (Default) Replaces a view.
                                                              • (1): Adds a view.
                                                                • @@ -238,7 +238,7 @@ class VideoCanvas { rect - (Optional) Display area for the video frame. ensure the user ID is not set as 0. width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. + (Optional) Display area for the video frame. See . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. cropArea diff --git a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita index a0829e50e3a..330a2a8a997 100644 --- a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita @@ -471,14 +471,14 @@ frameRate - The frame rate (fps) of the encoding video frame. The default value is 15. ensure the user ID is not set as 0. + The frame rate (fps) of the encoding video frame. The default value is 15. See . bitrate -

                                                                The encoding bitrate (Kbps) of the video. ensure the user ID is not set as 0.

                                                                +

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

                                                                  -
                                                                  • +
                                                                @@ -500,7 +500,7 @@ mirrorMode -

                                                                Sets the mirror mode of the published local video stream. It only affects the video that the remote user sees. ensure the user ID is not set as 0.

                                                                +

                                                                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.
                                                                  • @@ -510,7 +510,7 @@ advanceOptions - Advanced options for video encoding. ensure the user ID is not set as 0. + Advanced options for video encoding. See .
                                                                  @@ -518,11 +518,11 @@ initWithSize - Specifies the video resolution and initializes the object. ensure the user ID is not set as 0. + Specifies the video resolution and initializes the object. See . initWithWidth - Specifies the video width and height, and initializes the object. ensure the user ID is not set as 0. + Specifies the video width and height, and initializes the object. See .
                                                                  diff --git a/en-US/dita/RTC-NG/API/class_videoframe.dita b/en-US/dita/RTC-NG/API/class_videoframe.dita index 63d084f4764..bf7432a5660 100644 --- a/en-US/dita/RTC-NG/API/class_videoframe.dita +++ b/en-US/dita/RTC-NG/API/class_videoframe.dita @@ -496,7 +496,7 @@ class VideoFrame { type - The pixel format. ensure the user ID is not set as 0. + The pixel format. See . @@ -602,7 +602,7 @@ class VideoFrame { colorSpace - The color space of a video frame. ensure the user ID is not set as 0. + The color space of a video frame. See . sourceType diff --git a/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita b/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita index 63f0911b00f..a0243b3aebd 100644 --- a/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita +++ b/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita @@ -93,7 +93,7 @@ streamType type - The video stream type that you want to subscribe to. The default value is , indicating that the high-quality video streams are subscribed. ensure the user ID is not set as 0. + The video stream type that you want to subscribe to. The default value is , indicating that the high-quality video streams are subscribed. See . The video stream type that you want to subscribe to:
                                                                  • (0): (Default) High-quality video stream, that is, a high-resolution, high-bit-rate video stream.
                                                                  • (1): Low-quality stream, that is, a low-resolution, low-bitrate video stream.
                                                                    • diff --git a/en-US/dita/RTC-NG/API/class_watermarkoptions.dita b/en-US/dita/RTC-NG/API/class_watermarkoptions.dita index 20e4c476b4b..7cbc3b7b40b 100644 --- a/en-US/dita/RTC-NG/API/class_watermarkoptions.dita +++ b/en-US/dita/RTC-NG/API/class_watermarkoptions.dita @@ -135,8 +135,8 @@ positionInLandscapeMode - The area to display the watermark image in landscape mode. ensure the user ID is not set as 0. - When the adaptation mode of the watermark is , it is used to set the area of the watermark image in landscape mode. ensure the user ID is not set as 0. + The area to display the watermark image in landscape mode. See . + When the adaptation mode of the watermark is , it is used to set the area of the watermark image in landscape mode. See . The area to display the watermark image in landscape mode. This parameter contains the following members:
                                                                    • x: The horizontal position of the watermark relative to the upper left corner.
                                                                    • y: The vertical position of the watermark relative to the upper left corner.
                                                                      • @@ -146,8 +146,8 @@ positionInPortraitMode - The area to display the watermark image in portrait mode. ensure the user ID is not set as 0. - When the adaptation mode of the watermark is , it is used to set the area of the watermark image in portrait mode. ensure the user ID is not set as 0. + The area to display the watermark image in portrait mode. See . + When the adaptation mode of the watermark is , it is used to set the area of the watermark image in portrait mode. See . The area to display the watermark image in portrait mode. This parameter contains the following members:
                                                                      • x: The horizontal position of the watermark relative to the upper left corner.
                                                                      • y: The vertical position of the watermark relative to the upper left corner.
                                                                        • @@ -157,11 +157,11 @@ watermarkRatio - When the watermark adaptation mode is , this parameter is used to set the watermark coordinates. ensure the user ID is not set as 0. + When the watermark adaptation mode is , this parameter is used to set the watermark coordinates. See . mode - The adaptation mode of the watermark. ensure the user ID is not set as 0. + The adaptation mode of the watermark. See . diff --git a/en-US/dita/RTC-NG/API/enum_bitrate.dita b/en-US/dita/RTC-NG/API/enum_bitrate.dita index f61d996d715..a4cab5bf243 100644 --- a/en-US/dita/RTC-NG/API/enum_bitrate.dita +++ b/en-US/dita/RTC-NG/API/enum_bitrate.dita @@ -9,7 +9,7 @@ - 0: (Recommended) Standard bitrate mode. In this mode, the bitrates of the live broadcasting profile is higher than that of the communication profile. ensure the user ID is not set as 0. + 0: (Recommended) Standard bitrate mode. In this mode, the bitrates of the live broadcasting profile is higher than that of the communication profile. See . From 581ca47a45d8ff86e9786da0d0c059d0c79feb7c Mon Sep 17 00:00:00 2001 From: Suri539 Date: Fri, 8 Sep 2023 10:36:31 +0000 Subject: [PATCH 08/13] Sync cn prototype to en prototype --- ...onfiguration_getdestchannelmediainfos.dita | 24 +- ...evicemanager_getplaybackdefaultdevice.dita | 20 +- ...vicemanager_getrecordingdefaultdevice.dita | 20 +- ...laudioengine_updateplayerpositioninfo.dita | 12 +- ...i_ilocalspatialaudioengine_initialize.dita | 26 +-- ...atialaudioengine_updateremoteposition.dita | 10 +- .../API/api_imediaengine_addlistener.dita | 30 +-- ...i_imediaengine_createcustomaudiotrack.dita | 18 +- .../API/api_imediaengine_pushaudioframe.dita | 24 +- .../API/api_imediaengine_pushaudioframe0.dita | 8 +- ...pi_imediaengine_pushencodedvideoimage.dita | 24 +- .../API/api_imediaengine_pushvideoframe.dita | 22 +- ...ine_registervideoencodedframeobserver.dita | 36 +-- .../API/api_imediaplayer_addlistener.dita | 28 +-- ...ediaplayer_registervideoframeobserver.dita | 20 +- .../API/api_imediaplayer_setrendermode.dita | 6 +- ...pi_imediaplayer_setspatialaudioparams.dita | 6 +- .../API/api_imediarecorder_addlistener.dita | 28 +-- .../api_imediarecorder_startrecording.dita | 26 +-- .../API/api_irtcengine_addlistener.dita | 28 +-- .../api_irtcengine_configrhythmplayer.dita | 22 +- .../API/api_irtcengine_createdatastream2.dita | 4 +- .../api_irtcengine_enabledualstreammode2.dita | 6 +- .../api_irtcengine_enabledualstreammode3.dita | 22 +- .../API/api_irtcengine_enableencryption.dita | 6 +- ...api_irtcengine_enableinearmonitoring2.dita | 26 +-- .../API/api_irtcengine_enablemulticamera.dita | 38 ++-- ...pi_irtcengine_enablevirtualbackground.dita | 36 +-- .../api_irtcengine_getextensionproperty2.dita | 14 +- ...pi_irtcengine_getscreencapturesources.dita | 8 +- .../RTC-NG/API/api_irtcengine_initialize.dita | 32 +-- .../API/api_irtcengine_joinchannel2.dita | 14 +- .../API/api_irtcengine_preloadchannel.dita | 26 +-- .../API/api_irtcengine_preloadchannel2.dita | 34 +-- .../api_irtcengine_pushreverseaudioframe.dita | 6 +- .../API/api_irtcengine_pushvideoframe2.dita | 30 +-- .../api_irtcengine_querycodeccapability.dita | 32 +-- ...tcengine_queryscreencapturecapability.dita | 20 +- ...ine_registeraudioencodedframeobserver.dita | 10 +- ...cengine_registeraudiospectrumobserver.dita | 10 +- ...cengine_registermediametadataobserver.dita | 10 +- .../API/api_irtcengine_removehandler.dita | 6 +- .../API/api_irtcengine_sendmetadata.dita | 12 +- ...pi_irtcengine_setadvancedaudiooptions.dita | 8 +- ...irtcengine_setaudiomixingdualmonomode.dita | 8 +- .../API/api_irtcengine_setclientrole.dita | 4 +- ...api_irtcengine_setcolorenhanceoptions.dita | 16 +- .../API/api_irtcengine_setdualstreammode.dita | 28 +-- .../api_irtcengine_setdualstreammode2.dita | 30 +-- ...tcengine_setexternalaudiosourcevolume.dita | 22 +- .../api_irtcengine_setheadphoneeqpreset.dita | 16 +- .../api_irtcengine_setlivetranscoding.dita | 6 +- .../api_irtcengine_setlocalaccesspoint.dita | 8 +- ...cengine_setlocalpublishfallbackoption.dita | 6 +- .../api_irtcengine_setlocalrendermode.dita | 6 +- ..._irtcengine_setlowlightenhanceoptions.dita | 14 +- ...ngine_setremoteuserspatialaudioparams.dita | 6 +- ...rtcengine_setscreencapturecontenthint.dita | 6 +- .../API/api_irtcengine_setuplocalvideo.dita | 12 +- .../API/api_irtcengine_setupremotevideo.dita | 22 +- ...pi_irtcengine_setvideodenoiseroptions.dita | 32 +-- ...tcengine_setvideoencoderconfiguration.dita | 22 +- .../API/api_irtcengine_setvideoprofile.dita | 24 +- .../api_irtcengine_startaudiorecording3.dita | 6 +- .../api_irtcengine_startcameracapture.dita | 22 +- ...api_irtcengine_startchannelmediarelay.dita | 24 +- ...pi_irtcengine_startdirectcdnstreaming.dita | 12 +- .../API/api_irtcengine_startechotest3.dita | 14 +- ...engine_startorupdatechannelmediarelay.dita | 24 +- .../API/api_irtcengine_startrhythmplayer.dita | 26 +-- .../api_irtcengine_startscreencapture.dita | 30 +-- .../api_irtcengine_startscreencapture2.dita | 26 +-- ...cengine_startscreencapturebydisplayid.dita | 8 +- ...engine_startscreencapturebyscreenrect.dita | 6 +- ...tcengine_startscreencapturebywindowid.dita | 6 +- .../API/api_irtcengine_switchchannel2.dita | 28 +-- ...e_unregisteraudioencodedframeobserver.dita | 18 +- .../api_irtcengine_updatescreencapture.dita | 14 +- ...cengine_updatescreencaptureparameters.dita | 6 +- ..._irtcengine_updatescreencaptureregion.dita | 6 +- ...irtcengine_updatescreencaptureregion2.dita | 18 +- .../api_irtcengineex_createdatastreamex2.dita | 2 +- .../API/api_irtcengineex_joinchannelex.dita | 30 +-- .../api_irtcengineex_setdualstreammodeex.dita | 32 +-- .../api_irtcengineex_setupremotevideoex.dita | 6 +- ...gineex_setvideoencoderconfigurationex.dita | 6 +- ...irtcengineex_startchannelmediarelayex.dita | 30 +-- ...neex_startorupdatechannelmediarelayex.dita | 28 +-- ...api_ivideodevicemanager_getcapability.dita | 4 +- .../class_Localaccesspointconfiguration.dita | 34 ++- .../dita/RTC-NG/API/class_advanceoptions.dita | 18 +- en-US/dita/RTC-NG/API/class_audioparams.dita | 38 ++-- .../class_audiorecordingconfiguration.dita | 6 +- .../class_cameracapturerconfiguration.dita | 24 +- .../RTC-NG/API/class_channelmediaoptions.dita | 214 +++++++++--------- .../class_channelmediarelayconfiguration.dita | 40 ++-- en-US/dita/RTC-NG/API/class_codeccapinfo.dita | 18 +- .../dita/RTC-NG/API/class_codeccaplevels.dita | 16 +- .../API/class_contentinspectconfig.dita | 20 +- .../API/class_contentinspectmodule.dita | 22 +- .../API/class_encodedvideoframeinfo.dita | 16 +- .../RTC-NG/API/class_externalvideoframe.dita | 8 +- .../RTC-NG/API/class_injectstreamconfig.dita | 2 +- .../class_localtranscoderconfiguration.dita | 22 +- .../RTC-NG/API/class_localvideostats.dita | 40 ++-- .../API/class_mediarecorderconfiguration.dita | 14 +- en-US/dita/RTC-NG/API/class_mediasource.dita | 18 +- .../RTC-NG/API/class_remoteaudiostats.dita | 4 +- .../RTC-NG/API/class_rtcengineconfig.dita | 46 ++-- .../API/class_screencaptureparameters.dita | 40 ++-- .../API/class_screencaptureparameters2.dita | 36 +-- .../API/class_screencapturesourceinfo.dita | 34 +-- .../API/class_simulcaststreamconfig.dita | 2 +- .../API/class_transcodingvideostream.dita | 14 +- .../API/class_useraudiospectruminfo.dita | 2 +- en-US/dita/RTC-NG/API/class_videocanvas.dita | 46 ++-- .../API/class_videoencoderconfiguration.dita | 34 +-- en-US/dita/RTC-NG/API/class_videoframe.dita | 22 +- .../API/class_videosubscriptionoptions.dita | 30 +-- .../RTC-NG/API/class_watermarkoptions.dita | 22 +- 120 files changed, 1233 insertions(+), 1237 deletions(-) diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita index 63360b78f69..fa098bec720 100644 --- a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita +++ b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita @@ -1,32 +1,32 @@ - <ph keyref="getDestChannelMediaInfos"/> + <ph keyref="getDestChannelMediaInfos" /> Gets the information of the target channel. - +

                                                                        - public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { + public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { return destInfos; } - - - - - - -

                                                                        + + + + + + +

                                                                        Returns -

                                                                        The information of the target channel. See .

                                                                        +

                                                                        The information of the target channel. See .

                                                                         -                                                                         + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita index ad66080d805..3eb35a2cb64 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita @@ -1,26 +1,26 @@ - <ph keyref="getPlaybackDefaultDevice"/> + <ph keyref="getPlaybackDefaultDevice" /> Gets the default audio playback device. - +

                                                                        - - - + + + abstract getPlaybackDefaultDevice(): AudioDeviceInfo; public abstract int GetPlaybackDefaultDevice(ref string deviceId, ref string deviceName); - - Future<AudioDeviceInfo> getPlaybackDefaultDevice(); -

                                                                        + + Future<AudioDeviceInfo> getPlaybackDefaultDevice(); +

                                                                        Details @@ -40,11 +40,11 @@
                                                                        Returns -

                                                                        The details about the default audio playback device. See .

                                                                        +

                                                                        The details about the default audio playback device. See .

                                                                        • 0: Success.
                                                                        • < 0: Failure.
                                                                         -                                                                         + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita index cdd5bc4b4e0..feb6543aa4f 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita @@ -1,26 +1,26 @@ - <ph keyref="getRecordingDefaultDevice"/> + <ph keyref="getRecordingDefaultDevice" /> Gets the default audio capture device. - +

                                                                        - - - + + + abstract getRecordingDefaultDevice(): AudioDeviceInfo; public abstract int GetRecordingDefaultDevice(ref string deviceId, ref string deviceName); - - Future<AudioDeviceInfo> getRecordingDefaultDevice(); -

                                                                        + + Future<AudioDeviceInfo> getRecordingDefaultDevice(); +

                                                                        Details @@ -40,11 +40,11 @@
                                                                        Returns -

                                                                        The details about the default audio capture device. See .

                                                                        +

                                                                        The details about the default audio capture device. See .

                                                                        • 0: Success.
                                                                        • < 0: Failure.
                                                                         -                                                                         + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita index 50f58fee7e2..e6f5b56a852 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita @@ -25,9 +25,9 @@ playerId: number, positionInfo: RemoteVoicePositionInfo ): number; - Future<void> updatePlayerPositionInfo( + Future<void> updatePlayerPositionInfo( {required int playerId, required RemoteVoicePositionInfo positionInfo}); -

                                                                        +

                                                                        Details @@ -42,15 +42,15 @@ positionInfo - The spatial position of the media player. See . + The spatial position of the media player. 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.
                                                                        - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita index c16560e5d12..2c1e60dd5d5 100644 --- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita +++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita @@ -1,12 +1,12 @@ - <ph keyref="initialize_ILocalSpatialAudioEngine"/> - Initializes . + <ph keyref="initialize_ILocalSpatialAudioEngine" /> + Initializes . - + @@ -19,32 +19,32 @@ abstract initialize(): number; public abstract int Initialize(); abstract initialize(): number; - Future<void> initialize(); -

                                                                        + Future<void> initialize(); +

                                                                        Details
                                                                          -
                                                                        • Call this method after calling ().
                                                                          • -
                                                                        • Call this method after calling .
                                                                          • -
                                                                        • Before calling other methods of the class, you need to call this method to initialize .
                                                                          • -
                                                                        • The SDK supports creating only one instance for an app.
                                                                          • +
                                                                        • Call this method after calling ().
                                                                          • +
                                                                        • Call this method after calling .
                                                                          • +
                                                                        • Before calling other methods of the class, you need to call this method to initialize .
                                                                          • +
                                                                        • The SDK supports creating only one instance for an app.
                                                                        Parameters config - The configuration of . See . + The configuration of . 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.
                                                                        -                                                                         + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita index cce77628f8c..15363e1ebe2 100644 --- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita +++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita @@ -25,9 +25,9 @@ uid: number, posInfo: RemoteVoicePositionInfo ): number;                                                                         - Future<void> updateRemotePosition( + Future<void> updateRemotePosition( {required int uid, required RemoteVoicePositionInfo posInfo}); -

                                                                        +

                                                                        Details @@ -46,11 +46,11 @@
                                                                        - <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_imediaengine_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita index 330082aef13..e59d5215833 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita @@ -1,49 +1,49 @@ - <ph keyref="addListener_IMediaEngine"/> - Adds one listener. + <ph keyref="addListener_IMediaEngine" /> + Adds one listener. - +

                                                                        - - - - addListener?<EventType extends keyof IMediaEngineEvent>( + + + + addListener?<EventType extends keyof IMediaEngineEvent>( eventType: EventType, listener: IMediaEngineEvent[EventType] ): void; - - addListener?<EventType extends keyof IMediaEngineEvent>( + + addListener?<EventType extends keyof IMediaEngineEvent>( eventType: EventType, listener: IMediaEngineEvent[EventType] ): void; - -

                                                                        + +

                                                                        Details -

                                                                        After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

                                                                        +

                                                                        After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

                                                                        Parameters eventType - The name of the target event to listen for. See . + The name of the target event to listen for. See . listener - The callback function for eventType. Take adding a listener for as an example:const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {}; + The callback function for eventType. Take adding a listener for as an example:const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {}; engine.addListener('onPlaybackAudioFrameBeforeMixing', onPlaybackAudioFrameBeforeMixing);
                                                                        -                                                                         + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita b/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita index b88531a5e03..3b13ff2d16b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita @@ -1,12 +1,12 @@ - <ph keyref="createCustomAudioTrack"/> + <ph keyref="createCustomAudioTrack" /> Creates a custom audio track. - + @@ -27,9 +27,9 @@ trackType: AudioTrackType, config: AudioTrackConfig ): number;                                                                         - Future<int> createCustomAudioTrack( + Future<int> createCustomAudioTrack( {required AudioTrackType trackType, required AudioTrackConfig config}); -

                                                                        +

                                                                        Details @@ -41,8 +41,8 @@

                                                                        To publish a custom audio source to multiple channels, see the following steps:

                                                                        1. Call this method to create a custom audio track and get the audio track ID.
                                                                          2. -
                                                                        2. In of each channel, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
                                                                          3. -
                                                                        3. If you call , and specify trackId as the audio track ID set in step 2, you can publish the corresponding custom audio source in multiple channels.
                                                                          4. +
                                                                        4. In of each channel, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
                                                                          5. +
                                                                        5. If you call , and specify trackId as the audio track ID set in step 2, you can publish the corresponding custom audio source in multiple channels.

                                                                        @@ -50,11 +50,11 @@ trackType - The type of the custom audio track. See .If is specified for this parameter, you must set publishMicrophoneTrack to in when calling to join the channel; otherwise, joining the channel fails and returns the error code -2. + The type of the custom audio track. See .If is specified for this parameter, you must set publishMicrophoneTrack to in when calling to join the channel; otherwise, joining the channel fails and returns the error code -2. config - The configuration of the custom audio track. See . + The configuration of the custom audio track. See .
                                                                        @@ -64,4 +64,4 @@
                                                                      • If the method call fails, a negative value is returned.
                                                                      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita index f806a5ae147..5469badee5b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita @@ -1,12 +1,12 @@ - <ph keyref="pushAudioFrame1"/> + <ph keyref="pushAudioFrame1" /> Pushes the external audio frame. - + @@ -18,19 +18,19 @@ samples:(NSInteger)samples sourceId:(NSInteger)sourceId timestamp:(NSTimeInterval)timestamp; - - - - - -

                                                                      + + + + + +

                                                                      Parameters frame - The external audio frame. See . + The external audio frame. See . @@ -49,8 +49,8 @@ - - + +
                                                                      @@ -62,4 +62,4 @@

                                                                    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita index 36f74c2f58f..0703133a029 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita @@ -19,8 +19,8 @@ abstract pushAudioFrame(frame: AudioFrame, trackId?: number): number; public abstract int PushAudioFrame(AudioFrame frame, uint trackId = 0); abstract pushAudioFrame(frame: AudioFrame, trackId?: number): number; - Future<void> pushAudioFrame({required AudioFrame frame, int trackId = 0}); -

                                                                    + Future<void> pushAudioFrame({required AudioFrame frame, int trackId = 0}); +

                                                                    Parameters @@ -35,8 +35,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_imediaengine_pushencodedvideoimage.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita index a6ef41473a6..b793186827a 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita @@ -1,12 +1,12 @@ - <ph keyref="pushEncodedVideoImage"/> + <ph keyref="pushEncodedVideoImage" /> Pushes the external encoded video frame to the SDK. - + @@ -16,7 +16,7 @@ public abstract int pushExternalEncodedVideoFrame( ByteBuffer data, EncodedVideoFrameInfo frameInfo); videoTrackId:(NSUInteger)videoTrackId; - + virtual int pushEncodedVideoImage(const uint8_t* imageBuffer, size_t length, const agora::rtc::EncodedVideoFrameInfo& videoEncodedFrameInfo) = 0; abstract pushEncodedVideoImage( @@ -32,16 +32,16 @@ videoEncodedFrameInfo: EncodedVideoFrameInfo, videoTrackId?: number ): number; - Future<void> pushEncodedVideoImage( + Future<void> pushEncodedVideoImage( {required Uint8List imageBuffer, required int length, required EncodedVideoFrameInfo videoEncodedFrameInfo, int videoTrackId = 0}); -

                                                                      +

                                                                    Details -

                                                                    After calling to enable external video source and set the sourceType parameter to , you can call this method to push the encoded external video frame to the SDK.

                                                                    +

                                                                    After calling to enable external video source and set the sourceType parameter to , you can call this method to push the encoded external video frame to the SDK.

                                                                    Parameters @@ -58,19 +58,19 @@ frameInfo videoEncodedFrameInfo - Information about externally encoded video frames. See . + Information about externally encoded video frames. 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: Pushes the external encoded video frame to the SDK successfully.
                                                                    • < 0: Fails to push external encoded video frames to the SDK.
                                                                    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita index e46fe5634be..53ca8040171 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita @@ -25,20 +25,20 @@ frame: ExternalVideoFrame, videoTrackId?: number ): number;                                                                     - Future<void> pushVideoFrame( + Future<void> pushVideoFrame( {required ExternalVideoFrame frame, int videoTrackId = 0}); -

                                                                    +

                                                                    Details
                                                                    Deprecated:
                                                                    -
                                                                    If you need to push video frames in I422 format, you need to use this method; otherwise, use instead.
                                                                    +
                                                                    If you need to push video frames in I422 format, you need to use this method; otherwise, use instead.
                                                                    -

                                                                    If you call and set the enabled parameter as and the encodedFrame parameter as , you can call this method to push the external raw video frame to the SDK. If you call method to get the video track ID, set the customVideoTrackId parameter to the video track ID you want to publish in the of each channel, and set the publishCustomVideoTrack parameter to , you can call this method to push the unencoded external video frame to the SDK.

                                                                    -

                                                                    You can push the video frame either by calling this method or by calling . The difference is that the method does not support video data in texture format.

                                                                    +

                                                                    If you call and set the enabled parameter as and the encodedFrame parameter as , you can call this method to push the external raw video frame to the SDK. If you call method to get the video track ID, set the customVideoTrackId parameter to the video track ID you want to publish in the of each channel, and set the publishCustomVideoTrack parameter to , you can call this method to push the unencoded external video frame to the SDK.

                                                                    +

                                                                    You can push the video frame either by calling this method or by calling . The difference is that the method does not support video data in texture format.

                                                                    Parameters @@ -51,19 +51,19 @@ videoTrackId - The video track ID returned by calling the method. The default value is 0. + The video track ID returned by calling the method. The default value is 0.
                                                                    - <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.
                                                                      -
                                                                    • : Pushes the external raw video frame to the SDK successfully.
                                                                      • -
                                                                    • : Fails to push external raw video frame to the SDK.
                                                                      • +
                                                                    • : Pushes the external raw video frame to the SDK successfully.
                                                                      • +
                                                                    • : Fails to push external raw video frame to the SDK.
                                                                    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita index 80225a0428e..b306be33e53 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="registerVideoEncodedFrameObserver"/> + <ph keyref="registerVideoEncodedFrameObserver" /> Registers a receiver object for the encoded video image. - + @@ -25,18 +25,18 @@ observer: IVideoEncodedFrameObserver ): number;                                                                     void registerVideoEncodedFrameObserver(VideoEncodedFrameObserver observer); -

                                                                    +

                                                                    Details -

                                                                    If you only want to observe encoded video frames (such as h.264 format) without decoding and rendering the video, Agora recommends that you implement one class through this method.

                                                                    +

                                                                    If you only want to observe encoded video frames (such as h.264 format) without decoding and rendering the video, Agora recommends that you implement one class through this method.

                                                                    If you want to obtain the original video data of some remote users (referred to as group A) and the encoded video data of other remote users (referred to as group B), you can refer to the following steps:

                                                                      -
                                                                    1. Call to register the raw video frame observer before joining the channel.
                                                                      2. -
                                                                    2. Call to register the encoded video frame observer before joining the channel.
                                                                      3. -
                                                                    3. After joining the channel, get the user IDs of group B users through , and then call to set the encodedFrameOnly of this group of users to .
                                                                      4. -
                                                                    4. Call () to start receiving the video streams of all remote users. Then:
                                                                        -
                                                                      • The raw video data of group A users can be obtained through the callback in , and the SDK renders the data by default.
                                                                        • -
                                                                      • The encoded video data of group B users can be obtained through the callback in .
                                                                        • +
                                                                      • Call to register the raw video frame observer before joining the channel.
                                                                        • +
                                                                      • Call to register the encoded video frame observer before joining the channel.
                                                                        • +
                                                                      • After joining the channel, get the user IDs of group B users through , and then call to set the encodedFrameOnly of this group of users to .
                                                                        • +
                                                                      • Call () to start receiving the video streams of all remote users. Then:
                                                                          +
                                                                        • The raw video data of group A users can be obtained through the callback in , and the SDK renders the data by default.
                                                                          • +
                                                                        • The encoded video data of group B users can be obtained through the callback in .

                                                                    @@ -51,24 +51,24 @@ receiver observer videoEncodedImageReceiver - The video frame observer object. See . - The observer instance. See . Set the value as to release the instance. + The video frame observer object. See . + The observer instance. See . Set the value as to release the instance. mode - The video data callback mode. See . + The video data callback mode. 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_imediaplayer_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita index b2d92853a33..95ef3414e73 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita @@ -1,48 +1,48 @@ - <ph keyref="addListener_IMediaPlayer"/> - Adds one listener. + <ph keyref="addListener_IMediaPlayer" /> + Adds one listener. - +

                                                                    - - - - addListener?<EventType extends keyof IMediaPlayerEvent>( + + + + addListener?<EventType extends keyof IMediaPlayerEvent>( eventType: EventType, listener: IMediaPlayerEvent[EventType] ): void; - - addListener?<EventType extends keyof IMediaPlayerEvent>( + + addListener?<EventType extends keyof IMediaPlayerEvent>( eventType: EventType, listener: IMediaPlayerEvent[EventType] ): void; -

                                                                    +

                                                                    Details -

                                                                    After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

                                                                    +

                                                                    After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

                                                                    Parameters eventType - The name of the target event to listen for. See . + The name of the target event to listen for. See . listener - The callback function for eventType. Take adding a listener for as an example:const onPlayerSourceStateChanged = (connection: RtcConnection, elapsed: number) => {}; + The callback function for eventType. Take adding a listener for as an example:const onPlayerSourceStateChanged = (connection: RtcConnection, elapsed: number) => {}; engine.addListener('onPlayerSourceStateChanged', onPlayerSourceStateChanged);
                                                                    -                                                                     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita index 1a33f837eb9..20c70a4db8b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="registerVideoFrameObserver_IMediaPlayer"/> + <ph keyref="registerVideoFrameObserver_IMediaPlayer" /> Registers a video frame observer object. - + @@ -14,7 +14,7 @@

                                                                    int registerVideoFrameObserver(IMediaPlayerVideoFrameObserver videoFrameObserver); - + virtual int registerVideoFrameObserver(media::base::IVideoFrameObserver* observer) = 0; abstract registerVideoFrameObserver( observer: IMediaPlayerVideoFrameObserver @@ -24,11 +24,11 @@ observer: IMediaPlayerVideoFrameObserver ): number; void registerVideoFrameObserver(MediaPlayerVideoFrameObserver observer); -

                                                                    +

                                                                    Details -

                                                                    You need to implement the class in this method and register callbacks according to your scenarios. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.

                                                                    +

                                                                    You need to implement the class in this method and register callbacks according to your scenarios. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.

                                                                    Parameters @@ -36,16 +36,16 @@ videoFrameObserver observer - The video observer, reporting the reception of each video frame. See . - The video observer, reporting the reception of each video frame. See . + The video observer, reporting the reception of each video frame. See . + The video observer, reporting the reception of each video frame. 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.
                                                                    -                                                                     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita index 0caf1834012..eb8402816d9 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita @@ -22,7 +22,7 @@ public abstract int SetRenderMode(RENDER_MODE_TYPE renderMode); abstract setRenderMode(renderMode: RenderModeType): number; Future<void> setRenderMode(RenderModeType renderMode); -

                                                                    +

                                                                    Parameters @@ -39,8 +39,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_imediaplayer_setspatialaudioparams.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita index 25f89891793..bf12669794b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita @@ -20,7 +20,7 @@ public abstract int SetSpatialAudioParams(SpatialAudioParams spatial_audio_params); abstract setSpatialAudioParams(params: SpatialAudioParams): number; Future<void> setSpatialAudioParams(SpatialAudioParams params); -

                                                                      +

                                                                    Details @@ -37,8 +37,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_imediarecorder_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita index 384d63cf763..2b1ac3a1891 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita @@ -1,48 +1,48 @@ - <ph keyref="addListener_IMediaRecorder"/> - Adds one listener. + <ph keyref="addListener_IMediaRecorder" /> + Adds one listener. - +

                                                                      - - - - addListener?<EventType extends keyof IMediaRecorderEvent>( + + + + addListener?<EventType extends keyof IMediaRecorderEvent>( eventType: EventType, listener: IMediaRecorderEvent[EventType] ): void; - - addListener?<EventType extends keyof IMediaRecorderEvent>( + + addListener?<EventType extends keyof IMediaRecorderEvent>( eventType: EventType, listener: IMediaRecorderEvent[EventType] ): void; -

                                                                      +

                                                                      Details -

                                                                      After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

                                                                      +

                                                                      After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

                                                                      Parameters eventType - The name of the target event to listen for. See . + The name of the target event to listen for. See . listener - The callback function for eventType. Take adding a listener for as an example:const onRecorderStateChanged = (state: RecorderState, error: RecorderErrorCode) => {}; + The callback function for eventType. Take adding a listener for as an example:const onRecorderStateChanged = (state: RecorderState, error: RecorderErrorCode) => {}; engine.addListener('onRecorderStateChanged', onRecorderStateChanged);
                                                                      -                                                                       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita index 7c2d5fbedc0..59082338f2b 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita @@ -1,12 +1,12 @@ - <ph keyref="startRecording"/> + <ph keyref="startRecording" /> Starts recording audio and video streams. - + @@ -19,15 +19,15 @@ abstract startRecording(config: MediaRecorderConfiguration): number; public abstract int StartRecording(MediaRecorderConfiguration config); abstract startRecording(config: MediaRecorderConfiguration): number; - Future<void> startRecording(MediaRecorderConfiguration config); -

                                                                      + Future<void> startRecording(MediaRecorderConfiguration config); +

                                                                    Details

                                                                    You can call this method to enable the recording function. Agora supports recording the media streams of local and remote users at the same time.

                                                                    Before you call this method, ensure the following:

                                                                      -
                                                                    • The recording object is created through .
                                                                      • -
                                                                    • The recording observer is registered through .
                                                                      • +
                                                                    • The recording object is created through .
                                                                      • +
                                                                    • The recording observer is registered through .
                                                                    • You have joined the channel which the remote user that you want to record is in.

                                                                    Supported formats of recording are listed as below:

                                                                      @@ -35,7 +35,7 @@
                                                                    • Video captured by a camera and encoded in H.264 or H.265.

                                                                    Once the recording is started, if the video resolution is changed, the SDK stops the recording; if the sampling rate and audio channel changes, the SDK continues recording and generates audio files respectively.

                                                                    -

                                                                    The SDK can generate a recording file only when it detects audio and video streams; when there are no audio and video streams to be recorded or the audio and video streams are interrupted for more than five seconds, the SDK stops the recording and triggers the (, ) callback.

                                                                    +

                                                                    The SDK can generate a recording file only when it detects audio and video streams; when there are no audio and video streams to be recorded or the audio and video streams are interrupted for more than five seconds, the SDK stops the recording and triggers the (, ) callback.

                                                                      @@ -47,12 +47,12 @@ config - The recording configuration. See . + The recording configuration. 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.
                                                                        @@ -61,9 +61,9 @@
                                                                      • The specified format of the recording file is supported.
                                                                      • The maximum recording duration is correctly set.
                                                                      • -
                                                                    • -4: does not support the request. The recording is ongoing or the recording stops because an error occurs.
                                                                      • -
                                                                    • -7: The method is called before is initialized. Ensure the object is created before calling this method.
                                                                      • +
                                                                    • -4: does not support the request. The recording is ongoing or the recording stops because an error occurs.
                                                                      • +
                                                                    • -7: The method is called before is initialized. Ensure the object is created before calling this method.
                                                                  - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita b/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita index 7dc0cf78c6c..814a1738ce8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita @@ -1,48 +1,48 @@ - <ph keyref="addListener"/> - Adds one listener. + <ph keyref="addListener" /> + Adds one listener. - +

                                                                  - - - - addListener?<EventType extends keyof IRtcEngineEvent>( + + + + addListener?<EventType extends keyof IRtcEngineEvent>( eventType: EventType, listener: IRtcEngineEvent[EventType] ): void; - - addListener?<EventType extends keyof IRtcEngineEvent>( + + addListener?<EventType extends keyof IRtcEngineEvent>( eventType: EventType, listener: IRtcEngineEvent[EventType] ): void; -

                                                                  +

                                                                  Details -

                                                                  After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

                                                                  +

                                                                  After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

                                                                  Parameters eventType - The name of the target event to listen for. See . + The name of the target event to listen for. See . listener - The callback function for eventType. Take adding a listener for as an example:const onJoinChannelSuccess = (connection: RtcConnection, elapsed: number) => {}; + The callback function for eventType. Take adding a listener for as an example:const onJoinChannelSuccess = (connection: RtcConnection, elapsed: number) => {}; engine.addListener('onJoinChannelSuccess', onJoinChannelSuccess);
                                                                  -                                                                   + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita index 4ce10a923db..103d2b8703f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita @@ -1,12 +1,12 @@ - <ph keyref="configRhythmPlayer"/> + <ph keyref="configRhythmPlayer" /> Configures the virtual metronome. - + @@ -19,28 +19,28 @@ abstract configRhythmPlayer(config: AgoraRhythmPlayerConfig): number; public abstract int ConfigRhythmPlayer(AgoraRhythmPlayerConfig config); abstract configRhythmPlayer(config: AgoraRhythmPlayerConfig): number; - Future<void> configRhythmPlayer(AgoraRhythmPlayerConfig config); -

                                                                  + Future<void> configRhythmPlayer(AgoraRhythmPlayerConfig config); +

                                                                  Details -

                                                                  After calling , you can call this method to reconfigure the virtual metronome.

                                                                  -

                                                                  After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.

                                                                  -
                                                                  +

                                                                  After calling , you can call this method to reconfigure the virtual metronome.

                                                                  +

                                                                  After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.

                                                                  +
                                                                  Parameters config - The metronome configuration. See . + The metronome configuration. 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.
                                                                  -                                                                   + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita index 40333241f21..557fe00caeb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita @@ -23,7 +23,7 @@ int CreateDataStream(int& streamId, const FDataStreamConfig& config);public abstract int CreateDataStream(ref int streamId, DataStreamConfig config); abstract createDataStream(config: DataStreamConfig): number; Future<int> createDataStream(DataStreamConfig config); -

                                                                  +

                                                                  Details @@ -50,4 +50,4 @@ int CreateDataStream(int& streamId, const FDataStreamConfig& config);< 0: Failure.
                                                                - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita index f3345ffa04a..6541686f050 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita @@ -28,14 +28,14 @@ streamConfig?: SimulcastStreamConfig ): number; Future<void> enableDualStreamMode(bool enabled); -

                                                                +

                                                                Details
                                                                Deprecated:
                                                                -
                                                                This method is deprecated as of v4.2.0. Use instead.
                                                                +
                                                                This method is deprecated as of v4.2.0. Use instead.

                                                                You can call this method to enable or disable the dual-stream mode on the publisher side. Dual streams are a pairing of a high-quality video stream and a low-quality video stream:

                                                                  @@ -46,7 +46,7 @@
                                                                  • This method is applicable to all types of streams from the sender, including but not limited to video streams collected from cameras, screen sharing streams, and custom-collected video streams.
                                                                    • -
                                                                  • If you need to enable dual video streams in a multi-channel scenario, you can call the method.
                                                                    • +
                                                                  • If you need to enable dual video streams in a multi-channel scenario, you can call the method.
                                                                  • You can call this method either before or after joining a channel.
                                                                diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita index bd4ec1f8ddc..3ec4f85ba92 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita @@ -1,12 +1,12 @@ - <ph keyref="enableDualStreamMode3"/> + <ph keyref="enableDualStreamMode3" /> Enables or disables the dual-stream mode on the sender and sets the low-quality video stream. - + @@ -28,11 +28,11 @@ int EnableDualStreamMode(bool enabled, const FSimulcastStreamConfig& streamC enabled: boolean, streamConfig?: SimulcastStreamConfig ): number; - Future<void> enableDualStreamMode( + Future<void> enableDualStreamMode( {required bool enabled, SimulcastStreamConfig? streamConfig}); -

                                                                +

                                                                -
                                                                +
                                                                Parameters @@ -40,24 +40,24 @@ int EnableDualStreamMode(bool enabled, const FSimulcastStreamConfig& streamC enabled

                                                                Whether to enable dual-stream mode:

                                                                  -
                                                                • : Enable dual-stream mode.
                                                                  • -
                                                                • : (Default) Disable dual-stream mode.
                                                                  • +
                                                                • : Enable dual-stream mode.
                                                                  • +
                                                                • : (Default) Disable dual-stream mode.

                                                                 streamConfig -

                                                                The configuration of the low-quality video stream. See .

                                                                +

                                                                The configuration of the low-quality video stream. 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.
                                                                - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita index 6b09ee1de71..dc49fd314a6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita @@ -21,7 +21,7 @@ abstract enableEncryption(enabled: boolean, config: EncryptionConfig): number; Future<void> enableEncryption( {required bool enabled, required EncryptionConfig config}); -

                                                                +

                                                                Details @@ -46,8 +46,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_enableinearmonitoring2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita index 061039b22f7..bdf340e976e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita @@ -1,12 +1,12 @@ - <ph keyref="enableInEarMonitoring2"/> + <ph keyref="enableInEarMonitoring2" /> Enables in-ear monitoring. - + @@ -25,10 +25,10 @@ enabled: boolean, includeAudioFilters: EarMonitoringFilterType ): number; - Future<void> enableInEarMonitoring( + Future<void> enableInEarMonitoring( {required bool enabled, required EarMonitoringFilterType includeAudioFilters}); -

                                                                    +

                                                                Details @@ -44,28 +44,28 @@ enabled Enables or disables in-ear monitoring.
                                                                  -
                                                                • : Enables in-ear monitoring.
                                                                  • -
                                                                • : (Default) Disables in-ear monitoring.
                                                                  • +
                                                                • : Enables in-ear monitoring.
                                                                  • +
                                                                • : (Default) Disables in-ear monitoring.
                                                                                                                                 includeAudioFilters - The audio filter of in-ear monitoring: See . + The audio filter of in-ear monitoring: See . The audio filter of in-ear monitoring:
                                                                  -
                                                                • (1 << 0): Do not add an audio filter to the in-ear monitor.
                                                                  • -
                                                                • (1 << 1): Add an audio filter to the in-ear monitor. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.
                                                                  • -
                                                                • (1 << 2): Enable noise suppression to the in-ear monitor.

                                                                  You can use the bitwise or operator (|) to specify multiple audio filters.If you set the enabled parameter to , you do not need to set the includeAudioFilters parameter.

                                                                  +
                                                                • (1 << 0): Do not add an audio filter to the in-ear monitor.
                                                                  • +
                                                                • (1 << 1): Add an audio filter to the in-ear monitor. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.
                                                                  • +
                                                                • (1 << 2): Enable noise suppression to the in-ear monitor.

                                                                  You can use the bitwise or operator (|) to specify multiple audio filters.If you set the enabled parameter to , you do not need to set the includeAudioFilters parameter.
                                                                - <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.
                                                                  • - 8: Make sure the current audio routing is Bluetooth or headset.
                                                                - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita index 67b7fc9a5f9..62e4d17f881 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita @@ -1,19 +1,19 @@ - <ph keyref="enableMultiCamera"/> + <ph keyref="enableMultiCamera" /> Enables or disables multi-camera capture. - +

                                                                - + - (int)enableMultiCamera:(BOOL)enabled config:(AgoraCameraCapturerConfiguration* _Nullable)config NS_SWIFT_NAME(enableMultiCamera(_:config:)); #if defined(__APPLE__) && TARGET_OS_IOS virtual int enableMultiCamera(bool enabled, const CameraCapturerConfiguration& config) = 0; @@ -27,9 +27,9 @@ enabled: boolean, config: CameraCapturerConfiguration ): number; - Future<void> enableMultiCamera( + Future<void> enableMultiCamera( {required bool enabled, required CameraCapturerConfiguration config}); -

                                                                +

                                                                Details @@ -41,18 +41,18 @@

                                                                In scenarios where there are existing cameras to capture video, Agora recommends that you use the following steps to capture and publish video with multiple cameras:

                                                                1. Call this method to enable multi-channel camera capture.
                                                                  2. -
                                                                2. Call to start the local video preview.
                                                                  3. -
                                                                3. Call , and set sourceType to start video capture with the second camera.
                                                                  4. -
                                                                4. Call , and set publishSecondaryCameraTrack to to publish the video stream captured by the second camera in the channel.
                                                                  5. +
                                                                5. Call to start the local video preview.
                                                                  6. +
                                                                6. Call , and set sourceType to start video capture with the second camera.
                                                                  7. +
                                                                7. Call , and set publishSecondaryCameraTrack to to publish the video stream captured by the second camera in the channel.

                                                                If you want to disable multi-channel camera capture, use the following steps:

                                                                  -
                                                                1. Call .
                                                                  2. -
                                                                2. Call this method with enabled set to .
                                                                  3. +
                                                                3. Call .
                                                                  4. +
                                                                4. Call this method with enabled set to .

                                                                -

                                                                You can call this method before and after to enable multi-camera capture:

                                                                  -
                                                                • If it is enabled before , the local video preview shows the image captured by the two cameras at the same time.
                                                                  • -
                                                                • If it is enabled after , the SDK stops the current camera capture first, and then enables the primary camera and the second camera. The local video preview appears black for a short time, and then automatically returns to normal.
                                                                  • +

                                                                  You can call this method before and after to enable multi-camera capture:

                                                                    +
                                                                  • If it is enabled before , the local video preview shows the image captured by the two cameras at the same time.
                                                                    • +
                                                                  • If it is enabled after , the SDK stops the current camera capture first, and then enables the primary camera and the second camera. The local video preview appears black for a short time, and then automatically returns to normal.

                                                                  This method applies to iOS only.

                                                                  @@ -70,22 +70,22 @@ enabled Whether to enable multi-camera video capture mode:
                                                                    -
                                                                  • : Enable multi-camera capture mode; the SDK uses multiple cameras to capture video.
                                                                    • -
                                                                  • : Disable multi-camera capture mode; the SDK uses a single camera to capture video.
                                                                    • +
                                                                  • : Enable multi-camera capture mode; the SDK uses multiple cameras to capture video.
                                                                    • +
                                                                  • : Disable multi-camera capture mode; the SDK uses a single camera to capture video.
                                                                                                                                     config - Capture configuration for the second camera. See . + Capture configuration for the second camera. 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.
                                                                 -                                                                 + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita index 706abe2ee11..4065b4eb383 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita @@ -1,12 +1,12 @@ - <ph keyref="enableVirtualBackground"/> + <ph keyref="enableVirtualBackground" /> Enables/Disables the virtual background. - + @@ -32,17 +32,17 @@ segproperty: SegmentationProperty, type?: MediaSourceType ): number; - Future<void> enableVirtualBackground( + Future<void> enableVirtualBackground( {required bool enabled, required VirtualBackgroundSource backgroundSource, required SegmentationProperty segproperty, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

                                                                +

                                                                Details

                                                                The virtual background feature enables the local user to replace their original background with a static image, dynamic video, blurred background, or portrait-background segmentation to achieve picture-in-picture effect. Once the virtual background feature is enabled, all users in the channel can see the custom background.

                                                                -

                                                                Call this method before calling or .

                                                                +

                                                                Call this method before calling or .

                                                                • This feature requires high performance devices. Agora recommends that you implement it on devices equipped with the following chips:
                                                                    @@ -64,7 +64,7 @@
                                                                  • A high-definition camera device is used, and the environment is uniformly lit.
                                                                  • There are few objects in the captured video. Portraits are half-length and unobstructed. Ensure that the background is a solid color that is different from the color of the user's clothing.
                                                                  • -
                                                                • This method relies on the virtual background dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
                                                                  • +
                                                                • This method relies on the virtual background dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
                                                                Parameters @@ -73,38 +73,38 @@ enabled enable Whether to enable virtual background:
                                                                  -
                                                                • : Enable virtual background.
                                                                  • -
                                                                • : Disable virtual background.
                                                                  • +
                                                                • : Enable virtual background.
                                                                  • +
                                                                • : Disable virtual background.
                                                                 backgroundSource backData - The custom background. See . To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted. + The custom background. See . To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted. segproperty segData - Processing properties for background images. See . + Processing properties for background images. See . type - The type of the video source. See .In this method, this parameter supports only the following two settings:
                                                                  -
                                                                • The default value is .
                                                                  • -
                                                                • If you want to use the second camera to capture video, set this parameter to .
                                                                  • + The type of the video source. See .In this method, this parameter supports only the following two settings:
                                                                    +
                                                                  • The default value is .
                                                                    • +
                                                                  • If you want to use the second camera to capture video, set this parameter to .
                                                                - <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.
                                                                    -
                                                                  • -1: The custom background image does not exist. Check the value of source in .
                                                                    • -
                                                                  • -2: The color format of the custom background image is invalid. Check the value of color in .
                                                                    • +
                                                                  • -1: The custom background image does not exist. Check the value of source in .
                                                                    • +
                                                                  • -2: The color format of the custom background image is invalid. Check the value of color in .
                                                                  • -3: The device does not support virtual background.
                                                                - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita index 80417fdbd1f..87e9999d393 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita @@ -1,12 +1,12 @@ - <ph keyref="getExtensionProperty2"/> + <ph keyref="getExtensionProperty2" /> Gets detailed information on the extensions. - + @@ -42,17 +42,17 @@ int GetExtensionProperty(FString provider, FString extension, FString key, FStri bufLen: number, type?: MediaSourceType ): string;                                                                 - Future<String> getExtensionProperty( + Future<String> getExtensionProperty( {required String provider, required String extension, required String key, required int bufLen, MediaSourceType type = MediaSourceType.unknownMediaSource}); -

                                                                +

                                                                Details -

                                                                +

                                                                Parameters @@ -79,7 +79,7 @@ int GetExtensionProperty(FString provider, FString extension, FString key, FStri sourceType type - Source type of the extension. See . + Source type of the extension. See . buf_len @@ -98,4 +98,4 @@ int GetExtensionProperty(FString provider, FString extension, FString key, FStri
                                                              • An empty string, if the method call fails.
                                                              - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita index 8bcc148b04e..b00f0aedf90 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita @@ -32,7 +32,7 @@ {required Size thumbSize, required Size iconSize, required bool includeScreen}); -

                                                              +

                                                              Details @@ -44,11 +44,11 @@ thumbSize - The target size of the screen or window thumbnail (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and thumbSize is 100 × 100, the actual size of the thumbnail is 100 × 75. If the target size is larger than the original size, the thumbnail is the original image and the SDK does not scale it. + The target size of the screen or window thumbnail (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and thumbSize is 100 × 100, the actual size of the thumbnail is 100 × 75. If the target size is larger than the original size, the thumbnail is the original image and the SDK does not scale it. iconSize - The target size of the icon corresponding to the application program (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and iconSize is 100 × 100, the actual size of the icon is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it. + The target size of the icon corresponding to the application program (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and iconSize is 100 × 100, the actual size of the icon is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it. includeScreen @@ -64,4 +64,4 @@

                                                              The array.

                                                              - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita b/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita index e59ede728a5..85588b693ac 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita @@ -1,12 +1,12 @@ - <ph keyref="initialize"/> - Creates and initializes . Initializes . + <ph keyref="initialize" /> + Creates and initializes . Initializes . - + @@ -24,17 +24,17 @@ int Initialize(const FRtcEngineContext& context);                                                               public abstract int Initialize(RtcEngineContext context); abstract initialize(context: RtcEngineContext): number; Future<void> initialize(RtcEngineContext context); -

                                                              +

                                                              Details -

                                                              All called methods provided by the class are executed asynchronously. Agora recommends calling these methods in the same thread.

                                                              +

                                                              All called methods provided by the class are executed asynchronously. Agora recommends calling these methods in the same thread.

                                                                -
                                                              • Before calling other APIs, you must call and to create and initialize the object.
                                                                • -
                                                              • Before calling other APIs, you must call this method to create the object.
                                                                • -
                                                              • You can create the instance either by calling this method or by calling . The difference between and this method is that this method supports more configurations when creating the instance, for example, specifying the region for connection and setting the log files.
                                                                • -
                                                              • The SDK supports creating only one instance for an app.
                                                                • +
                                                              • Before calling other APIs, you must call and to create and initialize the object.
                                                                • +
                                                              • Before calling other APIs, you must call this method to create the object.
                                                                • +
                                                              • You can create the instance either by calling this method or by calling . The difference between and this method is that this method supports more configurations when creating the instance, for example, specifying the region for connection and setting the log files.
                                                                • +
                                                              • The SDK supports creating only one instance for an app.
                                                              Parameters @@ -43,19 +43,19 @@ int Initialize(const FRtcEngineContext& context); context config -

                                                              Configurations for the instance. See .

                                                              +

                                                              Configurations for the instance. See .

                                                               delegate - +
                                                              - <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.

                                                                -
                                                              • The instance, if the method call succeeds.
                                                                • +
                                                              • The instance, if the method call succeeds.
                                                              • 0: Success.
                                                              • The method call fails and an exception is thrown, you need to catch the exception and handle it.
                                                              • < 0: Failure.
                                                                  @@ -66,6 +66,6 @@ int Initialize(const FRtcEngineContext& context);
                                                                • -101: The App ID is invalid.
                                                              -
                                                              +
                                                              - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita index 32784eff09f..fa0545d7148 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita @@ -38,12 +38,12 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia uid: number, options: ChannelMediaOptions ): number; - Future<void> joinChannel( + Future<void> joinChannel( {required String token, required String channelId, required int uid, required ChannelMediaOptions options}); -

                                                              +

                                                              Details @@ -64,7 +64,7 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia token - The token generated on your server for authentication. See .If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See . + The token generated on your server for authentication. See .If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See . channelId @@ -74,7 +74,7 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia
                                                            • All uppercase English letters: A to Z.
                                                            • All numeric characters: 0 to 9.
                                                            • Space
                                                              • -
                                                            • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
                                                              • +
                                                            • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

                                                                                                                         @@ -93,8 +93,8 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia
                                                            - <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.
                                                                @@ -108,4 +108,4 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia
                                                            - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita index 45c2da87a3a..ba7083f8c5d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita @@ -1,12 +1,12 @@ - <ph keyref="preloadChannel"/> + <ph keyref="preloadChannel" /> Preloads a channel with token, channelIdchannelName, and uidoptionalUid. - + @@ -29,7 +29,7 @@ channelId: string, uid: number ): number; - Future<void> preloadChannel( + Future<void> preloadChannel( {required String token, required String channelId, required int uid});

                                                            @@ -41,9 +41,9 @@

                                                            When audience members need to switch between different channels frequently, calling the method can help shortening the time of joining a channel, thus reducing the time it takes for audience members to hear and see the host. As it may take a while for the SDK to preload a channel, Agora recommends that you call this method as soon as possible after obtaining the channel name and user ID to join a channel.

                                                            -
                                                            • When calling this method, ensure you set the user role as audience and do not set the audio scenario as , otherwise, this method does not take effect.
                                                              • +
                                                              • When calling this method, ensure you set the user role as audience and do not set the audio scenario as , otherwise, this method does not take effect.
                                                              • You also need to make sure that the channel name, user ID and token passed in for preloading are the same as the values passed in when joinning the channel, otherwise, this method does not take effect.
                                                                • -
                                                              • One instance supports preloading 20 channels at most. When exceeding this limit, the latest 20 preloaded channels take effect.
                                                                • +
                                                              • One instance supports preloading 20 channels at most. When exceeding this limit, the latest 20 preloaded channels take effect.
                                                              • Failing to preload a channel does not mean that you can't join a channel, nor will it increase the time of joining a channel.

                                                              If you join a preloaded channel, leave it and want to rejoin the same channel, you do not need to call this method unless the token for preloading the channel expires.

                                                            @@ -52,8 +52,8 @@ token - The token generated on your server for authentication. See .

                                                            When the token for preloading channels expires, you can update the token based on the number of channels you preload.

                                                            • When preloading one channel, calling this method to pass in the new token.
                                                              • -
                                                            • When preloading more than one channels:
                                                              • If you use a wildcard token for all preloaded channels, call to update the token.When generating a wildcard token, ensure the user ID is not set as 0. See .
                                                                • + The token generated on your server for authentication. See .

                                                                When the token for preloading channels expires, you can update the token based on the number of channels you preload.

                                                                • When preloading one channel, calling this method to pass in the new token.
                                                                  • +
                                                                • When preloading more than one channels:
                                                                  • If you use a wildcard token for all preloaded channels, call to update the token.When generating a wildcard token, ensure the user ID is not set as 0. See .
                                                                  • If you use different tokens to preload different channels, call this method to pass in your user ID, channel name and the new token.

                                                                 @@ -65,17 +65,17 @@
                                                              • All uppercase English letters: A to Z.
                                                              • All numeric characters: 0 to 9.
                                                              • Space
                                                                • -
                                                              • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
                                                                • +
                                                              • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

                                                              - - + +
                                                              - <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.
                                                                  @@ -84,4 +84,4 @@
                                                              - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita index f7ea30f5080..12fa874d11a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita @@ -1,12 +1,12 @@ - <ph keyref="preloadChannel2"/> + <ph keyref="preloadChannel2" /> Preloads a channel with token, channelIdchannelName, and userAccount. - + @@ -29,7 +29,7 @@ channelId: string, userAccount: string ): number; - Future<void> preloadChannelWithUserAccount( + Future<void> preloadChannelWithUserAccount( {required String token, required String channelId, required String userAccount});

                                                              @@ -42,34 +42,34 @@
                                                              v4.2.2
                                                              -

                                                              +

                                                              -

                                                              • +
                                                                • You also need to make sure that the User Account, channel ID and token passed in for preloading are the same as the values passed in when joining the channel, otherwise, this method does not take effect.
                                                                  • -
                                                                • -
                                                                -

                                                                +
                                                              • +
                                                              +

                                                              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.
                                                                  @@ -79,4 +79,4 @@
                                                              -                                                               + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita index ecf5948faa7..824add4a204 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita @@ -20,7 +20,7 @@ abstract pushReverseAudioFrame(frame: AudioFrame): number; Future<void> pushReverseAudioFrame(AudioFrame frame); -

                                                              +

                                                              Details @@ -44,8 +44,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_pushvideoframe2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita index 49795b6e1ef..522511a99b2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita @@ -1,12 +1,12 @@ - <ph keyref="pushVideoFrame2"/> + <ph keyref="pushVideoFrame2" /> Pushes the external video frame. - + @@ -14,32 +14,32 @@

                                                                public abstract boolean pushExternalVideoFrame(VideoFrame frame); - - - - - - -

                                                                + + + + + + +

                                                                Details -

                                                                This method actively encapsulates the video frame data with the class and passes it to the SDK. Call the method and set enable as before calling this method; otherwise, a failure returns after calling this method.

                                                                -

                                                                You can push the video frame either by calling this method or by calling . The difference is that the method supports video data in texture format.

                                                                +

                                                                This method actively encapsulates the video frame data with the class and passes it to the SDK. Call the method and set enable as before calling this method; otherwise, a failure returns after calling this method.

                                                                +

                                                                You can push the video frame either by calling this method or by calling . The difference is that the method supports video data in texture format.

                                                                Parameters frame - Video frame to be pushed. See . + Video frame to be pushed. See .
                                                                Returns
                                                                  -
                                                                • : Pushes the external raw video frame to the SDK successfully.
                                                                  • -
                                                                • : Fails to push external raw video frame to the SDK.
                                                                  • +
                                                                • : Pushes the external raw video frame to the SDK successfully.
                                                                  • +
                                                                • : Fails to push external raw video frame to the SDK.
                                                                -                                                                 + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita b/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita index 6f73c320d3b..1f04f986931 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita @@ -1,12 +1,12 @@ - <ph keyref="queryCodecCapability"/> + <ph keyref="queryCodecCapability" /> Queries the current device's supported video codec capabilities. - + @@ -14,13 +14,13 @@

                                                                public abstract CodecCapInfo[] queryCodecCapability(); - - (NSArray <AgoraVideoCodecCapInfo *> *__nullable)queryCodecCapability; + - (NSArray <AgoraVideoCodecCapInfo *> *__nullable)queryCodecCapability; virtual int queryCodecCapability(CodecCapInfo* codecInfo, int& size) = 0; abstract queryCodecCapability(): { codecInfo: CodecCapInfo[]; size: number }; public abstract int QueryCodecCapability(ref CodecCapInfo[] codecInfo, ref int size); abstract queryCodecCapability(): { codecInfo: CodecCapInfo[]; size: number }; - Future<List<CodecCapInfo>> queryCodecCapability(int size);

                                                                + Future<List<CodecCapInfo>> queryCodecCapability(int size);

                                                                Details @@ -30,7 +30,7 @@
                                                                v4.2.0
                                                                -

                                                                +

                                                                Parameters @@ -38,28 +38,28 @@ codecInfo -

                                                                Input and output parameter. An array representing the video codec capabilities of the device. See .

                                                                +

                                                                Input and output parameter. An array representing the video codec capabilities of the device. See .

                                                                  -
                                                                • Input value: One defined by the user when executing this method, representing the video codec capability to be queried.
                                                                  • -
                                                                • Output value: The after the method is executed, representing the actual video codec capabilities supported by the device.
                                                                  • +
                                                                • Input value: One defined by the user when executing this method, representing the video codec capability to be queried.
                                                                  • +
                                                                • Output value: The after the method is executed, representing the actual video codec capabilities supported by the device.
                                                                                                                                 size - Input and output parameter, represent the size of the array.
                                                                  -
                                                                • Input value: Size of the defined by the user when executing the method.
                                                                  • -
                                                                • Output value: Size of the output after this method is executed.
                                                                  • + Input and output parameter, represent the size of the array.
                                                                    +
                                                                  • Input value: Size of the defined by the user when executing the method.
                                                                    • +
                                                                  • Output value: Size of the output after this method is executed.
                                                                   - The size of . + The size of .
                                                                Returns
                                                                • If the call is successful, an object containing the following attributes is returned:
                                                                    -
                                                                  • codecInfo: The array, indicating the video codec capabillity of the device.
                                                                    • -
                                                                  • size: The size of the array.
                                                                  • +
                                                                • codecInfo: The array, indicating the video codec capabillity of the device.
                                                                  • +
                                                                • size: The size of the array.
                                                              • If the call timeouts, please modify the call logic and do not invoke the method in the main thread.
                                                                @@ -67,8 +67,8 @@
                                                              • < 0: Failure.
                                                                -
                                                              • One array indicating the video encoding capability of the device, if the method call succeeds.
                                                                • +
                                                              • One array indicating the video encoding capability of the device, if the method call succeeds.
                                                              • If the call timeouts, please modify the call logic and do not invoke the method in the main thread.
                                                              - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita b/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita index c08e8357f73..d82275073b5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita @@ -1,12 +1,12 @@ - <ph keyref="queryScreenCaptureCapability"/> + <ph keyref="queryScreenCaptureCapability" /> Queries the highest frame rate supported by the device during screen sharing. - + @@ -18,10 +18,10 @@ #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) virtual int queryScreenCaptureCapability() = 0; #endif - + public abstract int QueryScreenCaptureCapability(); abstract queryScreenCaptureCapability(): number; - Future<int> queryScreenCaptureCapability();

                                                              + Future<int> queryScreenCaptureCapability();

                                                              Details @@ -31,7 +31,7 @@
                                                              v4.2.0
                                                              -

                                                              +

                                                              Applicable scenarios @@ -39,15 +39,15 @@

                                                              To ensure optimal screen sharing performance, particularly in enabling high frame rates like 60 fps, Agora recommends you to query the device's maximum supported frame rate using this method beforehand. This way, if the device cannot support such a high frame rate, you can adjust the screen sharing stream accordingly to avoid any negative impact on the sharing quality. If the device does not support high frame rate, you can reduce the frame rate of the screen sharing stream appropriately when sharing the screen to ensure that the sharing effect meets your expectation.

                                                              - <ph keyref="return-section-title"/> -
                                                              • The highest frame rate supported by the device, if the method is called successfully. See .
                                                                • -
                                                              • If the call fails, returns .
                                                              + <ph keyref="return-section-title" /> +
                                                              • The highest frame rate supported by the device, if the method is called successfully. See .
                                                                • +
                                                              • If the call fails, returns .
                                                                -
                                                              • The highest frame rate supported by the device, if the method is called successfully. See .
                                                                  +
                                                                • The highest frame rate supported by the device, if the method is called successfully. See .
                                                                  • 0: The device supports the frame rate of up to 15 fps.
                                                                  • 1: The device supports the frame rate of up to 30 fps.
                                                                  • 2: The device supports the frame rate of up to 60 fps.
                                                                • < 0: Failure.
                                                              -                                                               + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita index a673b4ca224..99c0d265deb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita @@ -30,7 +30,7 @@ void registerAudioEncodedFrameObserver( {required AudioEncodedFrameObserverConfig config, required AudioEncodedFrameObserver observer}); -

                                                              +

                                                              Details @@ -57,12 +57,12 @@
                                                              - <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.
                                                              -

                                                              One object.

                                                              +

                                                              One object.

                                                              - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita index 690705aacc0..4ae53df7967 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita @@ -25,7 +25,7 @@ observer: IAudioSpectrumObserver ): number;                                                               void registerAudioSpectrumObserver(AudioSpectrumObserver observer); -

                                                              +

                                                              Details @@ -44,13 +44,13 @@
                                                              - <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.
                                                              -

                                                              One object.

                                                              +

                                                              One object.

                                                              - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita index 597a5977265..ad1d2b8d012 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita @@ -28,7 +28,7 @@ ): number;                                                               void registerMediaMetadataObserver( {required MetadataObserver observer, required MetadataType type}); -

                                                              +

                                                              Details @@ -46,17 +46,17 @@ type -

                                                              The metadata type. The SDK currently only supports . See .

                                                              +

                                                              The metadata type. The SDK currently only supports . 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.
                                                              - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita b/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita index afca01f5f2c..153eb373a2d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita @@ -24,7 +24,7 @@ eventHandler: IRtcEngineEventHandler ): boolean;                                                               void unregisterEventHandler(RtcEngineEventHandler eventHandler); -

                                                              +

                                                              Details @@ -40,8 +40,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.

                                                              • : Success.
                                                              • : Failure.
                                                                • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita b/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita index 7e8150a04f5..3a7b760620e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita @@ -21,7 +21,7 @@ abstract sendMetaData(metadata: Metadata, sourceType: VideoSourceType): number; Future<void> sendMetaData( {required Metadata metadata, required VideoSourceType sourceType}); -

                                                                +

                                                              Details @@ -33,20 +33,20 @@ metadata - Media metadata See . + Media metadata See . sourceType source_type - The type of the video source. See . + The type of the video source. 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.
                                                              - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita index 4c5cd2d10ff..cbfbc0ade95 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita @@ -19,8 +19,8 @@ abstract setAdvancedAudioOptions(options: AdvancedAudioOptions): number; public abstract int SetAdvancedAudioOptions(AdvancedAudioOptions options); abstract setAdvancedAudioOptions(options: AdvancedAudioOptions): number; - Future<void> setAdvancedAudioOptions(AdvancedAudioOptions options); -

                                                              + Future<void> setAdvancedAudioOptions(AdvancedAudioOptions options); +

                                                              Details @@ -35,8 +35,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_setaudiomixingdualmonomode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita index 0e855cf80c7..8b48be63691 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita @@ -20,7 +20,7 @@ public abstract int SetAudioMixingDualMonoMode(AUDIO_MIXING_DUAL_MONO_MODE mode); abstract setAudioMixingDualMonoMode(mode: AudioMixingDualMonoMode): number; Future<void> setAudioMixingDualMonoMode(AudioMixingDualMonoMode mode); -

                                                                +

                                                              Details @@ -39,11 +39,11 @@
                                                              - <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_setclientrole.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita index 6026262180e..59ee4bf4bbd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita @@ -30,7 +30,7 @@
                                                              Details

                                                              You can call this method either before or after joining the channel to set the user role as audience or host.

                                                              -

                                                              +

                                                              If you call this method to switch the user role after joining the channel, the SDK triggers the following callbacks:

                                                              • The local client: .
                                                              • The remote client: or ().
                                                                • @@ -62,4 +62,4 @@
                                                            -                                                             + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita index 40f25a29d3b..d826cfe52e6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita @@ -30,11 +30,11 @@ options: ColorEnhanceOptions, type?: MediaSourceType ): number; - Future<void> setColorEnhanceOptions( + Future<void> setColorEnhanceOptions( {required bool enabled, required ColorEnhanceOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

                                                            +

                                                            Details @@ -48,7 +48,7 @@
                                                          • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
                                                          • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
                                                          -
                                                        • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
                                                          • +
                                                        • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
                                                        Parameters @@ -66,16 +66,16 @@ The color enhancement options. 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.
                                                        - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita index 8aa7c1146ef..524130cf3a5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita @@ -1,12 +1,12 @@ - <ph keyref="setDualStreamMode"/> + <ph keyref="setDualStreamMode" /> Sets the dual-stream mode on the sender side. - + @@ -16,11 +16,11 @@ public abstract int setDualStreamMode(Constants.SimulcastStreamMode mode); - (int)setDualStreamMode:(AgoraSimulcastStreamMode)mode; virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode) = 0; - + public abstract int SetDualStreamMode(SIMULCAST_STREAM_MODE mode); - - -

                                                        + + +

                                                        Details
                                                        @@ -29,12 +29,12 @@
                                                        v4.0.1
                                                        -

                                                        The SDK enables the low-quality video stream auto mode on the sender side by default (it does not actively sending low-quality video streams). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling . After receiving the application, the sending end automatically switches to the low-quality video stream mode.

                                                          -
                                                        • If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).
                                                          • -
                                                        • If you want to restore the default behavior after making changes, you can call this method again with mode set to .

                                                        - The difference and connection between this method and is as follows:
                                                          -
                                                        • When calling this method and setting mode to , it has the same effect as ().
                                                          • -
                                                        • When calling this method and setting mode to , it has the same effect as ().
                                                          • +

                                                          The SDK enables the low-quality video stream auto mode on the sender side by default (it does not actively sending low-quality video streams). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling . After receiving the application, the sending end automatically switches to the low-quality video stream mode.

                                                            +
                                                          • If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).
                                                            • +
                                                          • If you want to restore the default behavior after making changes, you can call this method again with mode set to .

                                                          + The difference and connection between this method and is as follows:
                                                            +
                                                          • When calling this method and setting mode to , it has the same effect as ().
                                                            • +
                                                          • When calling this method and setting mode to , it has the same effect as ().
                                                          • Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
                                                        @@ -43,7 +43,7 @@ mode - The mode in which the video stream is sent. See . + The mode in which the video stream is sent. See .
                                                        @@ -54,4 +54,4 @@
                                                      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita index e242501a5e7..52fa0d2692b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita @@ -1,12 +1,12 @@ - <ph keyref="setDualStreamMode2"/> + <ph keyref="setDualStreamMode2" /> Sets dual-stream mode configuration on the sender, and sets the low-quality video stream. - + @@ -30,9 +30,9 @@ int SetDualStreamMode(ESIMULCAST_STREAM_MODE mode, const FSimulcastStreamConfig& mode: SimulcastStreamMode, streamConfig?: SimulcastStreamConfig ): number; - Future<void> setDualStreamMode( + Future<void> setDualStreamMode( {required SimulcastStreamMode mode, SimulcastStreamConfig? streamConfig}); -

                                                      +

                                                      Details @@ -42,11 +42,11 @@ int SetDualStreamMode(ESIMULCAST_STREAM_MODE mode, const FSimulcastStreamConfig&
                                                      v4.0.1
                                                      -

                                                      -

                                                      The difference between this method and is that this method can also configure the low-quality video stream, and the SDK sends the stream according to the configuration in streamConfig.

                                                      - The difference and connection between this method and is as follows:
                                                        -
                                                      • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
                                                        • -
                                                      • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
                                                        • +

                                                        +

                                                        The difference between this method and is that this method can also configure the low-quality video stream, and the SDK sends the stream according to the configuration in streamConfig.

                                                        + The difference and connection between this method and is as follows:
                                                          +
                                                        • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
                                                          • +
                                                        • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
                                                        • Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
                                                      @@ -55,22 +55,22 @@ int SetDualStreamMode(ESIMULCAST_STREAM_MODE mode, const FSimulcastStreamConfig& mode - The mode in which the video stream is sent. See . + The mode in which the video stream is sent. See . streamConfig -

                                                      The configuration of the low-quality video stream. See .

                                                      - When setting mode to , setting streamConfig will not take effect. +

                                                      The configuration of the low-quality video stream. See .

                                                      + When setting mode to , setting streamConfig will not take effect.
                                                      - <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_setexternalaudiosourcevolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita index 33cf462e4fc..03cd3c98c8a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita @@ -1,26 +1,26 @@ - <ph keyref="setExternalAudioSourceVolume"/> + <ph keyref="setExternalAudioSourceVolume" /> Sets the volume of the external audio frame in the specified position. - +

                                                      - - - - + + + + public abstract int SetExternalAudioSourceVolume(int sourcePos, int volume); - - -

                                                      + + +

                                                      Details @@ -31,7 +31,7 @@ sourcePos - The push position of the external audio frame. See . + The push position of the external audio frame. See . The push position of the external audio frame.
                                                      • 0: The position before local playback. If you need to play the external audio frame on the local client, set this position.
                                                      • 1: The position after audio capture and before audio pre-processing. If you need the audio module of the SDK to process the external audio frame, set this position.
                                                        • @@ -50,4 +50,4 @@
                                                      • < 0: Failure.
                                                       -                                                       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita index 81a39d1bae4..3044e7e5387 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita @@ -1,12 +1,12 @@ - <ph keyref="setHeadphoneEQPreset"/> + <ph keyref="setHeadphoneEQPreset" /> Sets the preset headphone equalization effect. - + @@ -19,8 +19,8 @@ abstract setHeadphoneEQPreset(preset: HeadphoneEqualizerPreset): number; public abstract int SetHeadphoneEQPreset(HEADPHONE_EQUALIZER_PRESET preset); abstract setHeadphoneEQPreset(preset: HeadphoneEqualizerPreset): number; - Future<void> setHeadphoneEQPreset(HeadphoneEqualizerPreset preset); -

                                                      + Future<void> setHeadphoneEQPreset(HeadphoneEqualizerPreset preset); +

                                                      Details @@ -37,12 +37,12 @@ preset - The preset headphone equalization effect. See . + The preset headphone equalization effect. 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.
                                                          @@ -50,4 +50,4 @@
                                                      -                                                       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita index c3647fd7002..c3480cc62cb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita @@ -20,7 +20,7 @@ public abstract int SetLiveTranscoding(LiveTranscoding transcoding); abstract setLiveTranscoding(transcoding: LiveTranscoding): number; Future<void> setLiveTranscoding(LiveTranscoding transcoding); -

                                                      +

                                                      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_irtcengine_setlocalaccesspoint.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita index f4e7909d760..16099dadaa3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita @@ -20,7 +20,7 @@ public abstract int SetLocalAccessPoint(LocalAccessPointConfiguration config); abstract setLocalAccessPoint(config: LocalAccessPointConfiguration): number; Future<void> setLocalAccessPoint(LocalAccessPointConfiguration config); -

                                                        +

                                                      Details @@ -39,11 +39,11 @@
                                                      - <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_setlocalpublishfallbackoption.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita index f2cdb722684..00f11d92787 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita @@ -20,7 +20,7 @@ public abstract int SetLocalPublishFallbackOption(STREAM_FALLBACK_OPTIONS option); Future<void> setLocalPublishFallbackOption(StreamFallbackOptions option); -

                                                      +

                                                      Details @@ -43,8 +43,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_setlocalrendermode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita index 248548892ff..f63c0d5634d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita @@ -27,7 +27,7 @@ mirrorMode?: VideoMirrorModeType ): number; Future<void> setLocalRenderMode2(RenderModeType renderMode); -

                                                        +

                                                      Details @@ -58,8 +58,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_setlowlightenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita index 7eb991a0bf8..ca7fff34830 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita @@ -30,11 +30,11 @@ options: LowlightEnhanceOptions, type?: MediaSourceType ): number; - Future<void> setLowlightEnhanceOptions( + Future<void> setLowlightEnhanceOptions( {required bool enabled, required LowlightEnhanceOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

                                                        +

                                                      Details @@ -48,7 +48,7 @@
                                                    • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
                                                    • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
                                                    -
                                                  • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
                                                    • +
                                                  • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
                                                  Parameters @@ -67,15 +67,15 @@ type - The type of the video source. See . + The type of the video source. 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.
                                                  - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita index 7d9e0aedc70..333bdd5bf19 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita @@ -28,7 +28,7 @@ ): number; Future<void> setRemoteUserSpatialAudioParams( {required int uid, required SpatialAudioParams params}); -

                                                  +

                                                  Details @@ -48,8 +48,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_setscreencapturecontenthint.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita index 0f9610c40a5..fab2eda96c6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita @@ -21,7 +21,7 @@ public abstract int SetScreenCaptureContentHint(VIDEO_CONTENT_HINT contentHint); abstract setScreenCaptureContentHint(contentHint: VideoContentHint): number; Future<void> setScreenCaptureContentHint(VideoContentHint contentHint); -

                                                    +

                                                  Details @@ -37,8 +37,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_setuplocalvideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita index 35111ec27c5..01f5bd4fafc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita @@ -20,7 +20,7 @@ public abstract int SetupLocalVideo(VideoCanvas canvas); abstract setupLocalVideo(canvas: VideoCanvas): number; Future<void> setupLocalVideo(VideoCanvas canvas); -

                                                    +

                                                  Details @@ -28,7 +28,7 @@

                                                  After initialization, call this method to set the local video and then join the channel. The local video still binds to the view after you leave the channel. To unbind the local video from the view, set the view parameter as .

                                                    -
                                                  • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
                                                    • +
                                                  • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
                                                  • You can call this method either before or after joining a channel.
                                                  • To update the rendering or mirror mode of the local video view during a call, use the method.
                                                  @@ -38,15 +38,15 @@ canvas local - The local video view and settings. See . + The local video view and settings. 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.
                                                  - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita index 614a5323a70..f8de9b0a7ec 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita @@ -1,12 +1,12 @@ - <ph keyref="setupRemoteVideo"/> + <ph keyref="setupRemoteVideo" /> Initializes the video view of a remote user. - + @@ -20,19 +20,19 @@ public abstract int SetupRemoteVideo(VideoCanvas canvas); abstract setupRemoteVideo(canvas: VideoCanvas): number; Future<void> setupRemoteVideo(VideoCanvas canvas); -

                                                  +

                                                  Details

                                                  This method initializes the video view of a remote stream on the local device. It affects only the video view that the local user sees. Call this method to bind the remote video stream to a video view and to set the rendering and mirror modes of the video view.

                                                  -

                                                  You need to specify the ID of the remote user in this method. If the remote user ID is unknown to the application, set it after the app receives the callback.

                                                  +

                                                  You need to specify the ID of the remote user in this method. If the remote user ID is unknown to the application, set it after the app receives the callback.

                                                  To unbind the remote user from the view, set the view parameter to NULL.

                                                  Once the remote user leaves the channel, the SDK unbinds the remote user.

                                                    -
                                                  • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
                                                    • -
                                                  • To update the rendering or mirror mode of the remote video view during a call, use the method.
                                                    • -
                                                  • If you use the Agora recording function, the recording client joins the channel as a placeholder client, triggering the callback. Do not bind the placeholder client to the app view because the placeholder client does not send any video streams. If your app does not recognize the placeholder client, bind the remote user to the view when the SDK triggers the callback.
                                                    • +
                                                  • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
                                                    • +
                                                  • To update the rendering or mirror mode of the remote video view during a call, use the method.
                                                    • +
                                                  • If you use the Agora recording function, the recording client joins the channel as a placeholder client, triggering the callback. Do not bind the placeholder client to the app view because the placeholder client does not send any video streams. If your app does not recognize the placeholder client, bind the remote user to the view when the SDK triggers the callback.
                                                  Parameters @@ -41,16 +41,16 @@ canvas remote -

                                                  The remote video view and settings. See .

                                                  +

                                                  The remote video view and settings. 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.
                                                  -                                                   + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita index 680cde7ba6f..6e2f6c0cac2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita @@ -1,12 +1,12 @@ - <ph keyref="setVideoDenoiserOptions"/> + <ph keyref="setVideoDenoiserOptions" /> Sets video noise reduction. - + @@ -30,11 +30,11 @@ options: VideoDenoiserOptions, type?: MediaSourceType ): number;                                                   - Future<void> setVideoDenoiserOptions( + Future<void> setVideoDenoiserOptions( {required bool enabled, required VideoDenoiserOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

                                                  +

                                                  Details @@ -42,13 +42,13 @@

                                                  You can call this method to enable the video noise reduction feature and set the options of the video noise reduction effect.

                                                    -
                                                  • Call this method after calling .
                                                    • +
                                                  • Call this method after calling .
                                                  • Video noise reduction has certain requirements for equipment performance. If your device overheats after you enable video noise reduction, Agora recommends modifying the video noise reduction options to a less performance-consuming level or disabling video noise reduction entirely.
                                                    • -
                                                  • Both this method and can turn on video noise reduction function:
                                                      +
                                                    • Both this method and can turn on video noise reduction function:
                                                      • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
                                                        • -
                                                      • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
                                                        • +
                                                      • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
                                                      • -
                                                    • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
                                                      • +
                                                    • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
                                                  Parameters @@ -57,25 +57,25 @@ enabled enable Whether to enable video noise reduction:
                                                    -
                                                  • : Enable video noise reduction.
                                                    • -
                                                  • : (Default) Disable video noise reduction.
                                                    • +
                                                  • : Enable video noise reduction.
                                                    • +
                                                  • : (Default) Disable video noise reduction.
                                                   options - The video noise reduction options. See . + The video noise reduction options. 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.
                                                  - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita index 45dc2e0a7e8..a6c3a58017f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita @@ -1,12 +1,12 @@ - <ph keyref="setVideoEncoderConfiguration"/> + <ph keyref="setVideoEncoderConfiguration" /> Sets the video encoder configuration. - + @@ -24,32 +24,32 @@ config: VideoEncoderConfiguration ): number;                                                   Future<void> setVideoEncoderConfiguration(VideoEncoderConfiguration config); -

                                                  +

                                                  Details

                                                  Sets the encoder configuration for the local video.

                                                    -
                                                  • You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.
                                                    • -
                                                  • Both this method and the method support setting the mirroring effect. Agora recommends that you only choose one method to set it up. Using both methods at the same time causes the mirroring effect to overlap, which causes the mirroring settings to fail.
                                                    • +
                                                  • You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.
                                                    • +
                                                  • Both this method and the method support setting the mirroring effect. Agora recommends that you only choose one method to set it up. Using both methods at the same time causes the mirroring effect to overlap, which causes the mirroring settings to fail.
                                                   - You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame. - Call this method before joining a channel. Agora recommends calling this method before to reduce the time to render the first video frame.
                                                  + You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame. + Call this method before joining a channel. Agora recommends calling this method before to reduce the time to render the first video frame.
                                                  Parameters config - Video profile. See . + Video profile. 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.
                                                  - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita index 3d64a2daecf..754ae6046d9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita @@ -1,12 +1,12 @@ - <ph keyref="setVideoProfile"/> + <ph keyref="setVideoProfile" /> Sets the video encoder configuration. - + @@ -17,21 +17,21 @@ - (int)setVideoProfile:(AgoraVideoProfile)profile swapWidthAndHeight:(BOOL)swapWidthAndHeight virtual int setVideoProfile(VIDEO_PROFILE_TYPE profile, bool swapWidthAndHeight) = 0; - + public abstract int SetVideoProfile(VIDEO_PROFILE_TYPE profile, bool swapWidthAndHeight = false); - - -

                                                  + + +

                                                  Details
                                                  Deprecated:
                                                  -
                                                  This method is deprecated. Use instead.
                                                  +
                                                  This method is deprecated. Use instead.
                                                  -

                                                  This method sets the video encoder configuration. You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.

                                                  +

                                                  This method sets the video encoder configuration. You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.

                                                  Parameters @@ -39,7 +39,7 @@ profile -

                                                  Video profile. See .

                                                  +

                                                  Video profile. See .

                                                                                                     @@ -47,8 +47,8 @@

                                                  The SDK outputs video with a fixed width and height according to the video profile (profile) you selected. This parameter sets whether to swap width and height of the video:

                                                    -
                                                  • : Swap the width and height.
                                                    • -
                                                  • : (Default) Do not swap the width and height.
                                                    • +
                                                  • : Swap the width and height.
                                                    • +
                                                  • : (Default) Do not swap the width and height.
                                                  @@ -59,4 +59,4 @@
                                                • < 0: Failure.
                                                - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita index 5d427d9ae9b..deb45054d86 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita @@ -22,7 +22,7 @@ int StartAudioRecording(const FAudioRecordingConfiguration& config);public abstract int StartAudioRecording(AudioRecordingConfiguration config); abstract startAudioRecording(config: AudioRecordingConfiguration): number; Future<void> startAudioRecording(AudioRecordingConfiguration config); -

                                                +

                                                Details @@ -41,8 +41,8 @@ int StartAudioRecording(const FAudioRecordingConfiguration& config);
                                                - <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_startcameracapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita index 4cf0f6b37a6..3c66e3c082a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita @@ -1,12 +1,12 @@ - <ph keyref="startCameraCapture"/> + <ph keyref="startCameraCapture" /> Starts camera capture. - + @@ -26,10 +26,10 @@ sourceType: VideoSourceType, config: CameraCapturerConfiguration ): number; - Future<void> startCameraCapture( + Future<void> startCameraCapture( {required VideoSourceType sourceType, required CameraCapturerConfiguration config}); -

                                                  +

                                                Details @@ -40,7 +40,7 @@

                                                You can call this method to start capturing video from one or more cameras by specifying sourceType.

                                                - On the iOS platform, if you want to enable multi-camera capture, you need to call and set enabled to before calling this method. + On the iOS platform, if you want to enable multi-camera capture, you need to call and set enabled to before calling this method.
                                                Parameters @@ -48,7 +48,7 @@ sourceType -

                                                The type of the video source. See .

                                                +

                                                The type of the video source. See .

                                                • On the mobile platforms, you can capture video from up to 2 cameras, provided the device has dual cameras or supports an external camera.
                                                • On the desktop platforms, you can capture video from up to 4 cameras.
                                                                                                 @@ -57,13 +57,13 @@ config -

                                                The configuration of the video capture. See .

                                                - On the iOS platform, this parameter has no practical function. Use the config parameter in instead to set the video capture configuration.                                                 +

                                                The configuration of the video capture. See .

                                                + On the iOS platform, this parameter has no practical function. Use the config parameter in instead to set the video capture configuration.
                                                - <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.

                                                  @@ -71,4 +71,4 @@
                                                • < 0: Failure.
                                                - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita index 88981a21ddf..72f0129b966 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita @@ -1,12 +1,12 @@ - <ph keyref="startChannelMediaRelay"/> + <ph keyref="startChannelMediaRelay" /> Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels. - + @@ -26,7 +26,7 @@ ): number;                                                 Future<void> startChannelMediaRelay( ChannelMediaRelayConfiguration configuration); -

                                                +

                                                Details @@ -36,16 +36,16 @@
                                                This method is deprecated. Use instead.
                                                -

                                                After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.

                                                  -
                                                • If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
                                                  • -
                                                • If the callback returns (3), an exception occurs during the media stream relay.
                                                  • +

                                                  After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.

                                                    +
                                                  • If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
                                                    • +
                                                  • If the callback returns (3), an exception occurs during the media stream relay.

                                                  • Call this method after joining the channel.
                                                  • This method takes effect only when you are a host in a live streaming channel.
                                                    • -
                                                  • After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
                                                    • -
                                                  • The relaying media streams across channels function needs to be enabled by contacting .
                                                    • +
                                                  • After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
                                                    • +
                                                  • The relaying media streams across channels function needs to be enabled by contacting .
                                                  • Agora does not support string user accounts in this API.
                                                @@ -55,12 +55,12 @@ channelMediaRelayConfiguration config configuration - The configuration of the media stream relay. See . + The configuration of the media stream relay. 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.
                                                    @@ -71,4 +71,4 @@
                                                - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita index 7b7e026828d..972299535be 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita @@ -28,11 +28,11 @@ publishUrl: string, options: DirectCdnStreamingMediaOptions ): number;                                                 - Future<void> startDirectCdnStreaming( + Future<void> startDirectCdnStreaming( {required DirectCdnStreamingEventHandler eventHandler, required String publishUrl, required DirectCdnStreamingMediaOptions options}); -

                                                +

                                                Details

                                                Aogra does not support pushing media streams to one URL repeatedly.

                                                @@ -46,7 +46,7 @@
                                              • publishCameraTrack is set as (the default value)
                                              • publishMicrophoneTrack is set as (the default value)
                                              -

                                              As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call to push audio streams. As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call or to push audio streams.Agora only supports pushing one audio and video streams or one audio streams to CDN.

                                              +

                                              As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call to push audio streams. As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call or to push audio streams.Agora only supports pushing one audio and video streams or one audio streams to CDN.

                                              Parameters @@ -65,11 +65,11 @@
                                              - <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_startechotest3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita index 8cfe53b8c44..c59232d3c4e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita @@ -1,12 +1,12 @@ - <ph keyref="startEchoTest3"/> + <ph keyref="startEchoTest3" /> Starts an audio device loopback test. - + @@ -21,8 +21,8 @@ int StartEchoTest(const FEchoTestConfiguration& config); abstract startEchoTest(config: EchoTestConfiguration): number; public abstract int StartEchoTest(EchoTestConfiguration config); abstract startEchoTest(config: EchoTestConfiguration): number; - Future<void> startEchoTest(EchoTestConfiguration config); -

                                              + Future<void> startEchoTest(EchoTestConfiguration config); +

                                              Details @@ -30,7 +30,7 @@ int StartEchoTest(const FEchoTestConfiguration& config);

                                              After starting the test, the user needs to make a sound or face the camera. The audio or video is output after about two seconds. If the audio playback is normal, the audio device and the user's upstream and downstream networks are working properly; if the video playback is normal, the video device and the user's upstream and downstream networks are working properly.

                                              • You can call this method either before or after joining a channel. When calling in a channel, make sure that no audio or video stream is being published.
                                                • -
                                              • After calling this method, call to end the test; otherwise, the user cannot perform the next audio and video call loop test and cannot join the channel.
                                                • +
                                              • After calling this method, call to end the test; otherwise, the user cannot perform the next audio and video call loop test and cannot join the channel.
                                              • In live streaming scenarios, this method only applies to hosts.

                                              @@ -39,7 +39,7 @@ int StartEchoTest(const FEchoTestConfiguration& config);                                               config - The configuration of the audio and video call loop test. See . + The configuration of the audio and video call loop test. See .
                                              @@ -49,4 +49,4 @@ int StartEchoTest(const FEchoTestConfiguration& config);
                                            • < 0: Failure.
                                            - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita index 6a6571943ee..6ff8cff1f41 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita @@ -1,12 +1,12 @@ - <ph keyref="startOrUpdateChannelMediaRelay"/> + <ph keyref="startOrUpdateChannelMediaRelay" /> Starts relaying media streams across channels or updates channels for media relay. - + @@ -24,9 +24,9 @@ abstract startOrUpdateChannelMediaRelay( configuration: ChannelMediaRelayConfiguration ): number; - Future<void> startOrUpdateChannelMediaRelay( + Future<void> startOrUpdateChannelMediaRelay( ChannelMediaRelayConfiguration configuration); -

                                            +

                                            Details @@ -36,15 +36,15 @@
                                            v4.2.0

                                            The first successful call to this method starts relaying media streams from the source channel to the destination channels. To relay the media stream to other channels, or exit one of the current media relays, you can call this method again to update the destination channels. This feature supports relaying media streams to a maximum of six destination channels.

                                            -

                                            After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:

                                              -
                                            • If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
                                              • -
                                            • If the callback returns (3), an exception occurs during the media stream relay.
                                              • +

                                              After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:

                                                +
                                              • If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
                                                • +
                                              • If the callback returns (3), an exception occurs during the media stream relay.

                                              • Call this method after joining the channel.
                                              • This method takes effect only when you are a host in a live streaming channel.
                                                • -
                                              • The relaying media streams across channels function needs to be enabled by contacting .
                                                • +
                                              • The relaying media streams across channels function needs to be enabled by contacting .
                                              • Agora does not support string user accounts in this API.
                                            @@ -54,12 +54,12 @@ channelMediaRelayConfiguration config configuration - The configuration of the media stream relay. See . + The configuration of the media stream relay. 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.
                                                @@ -70,4 +70,4 @@
                                            -                                             + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita index db48adca5f8..2af22028816 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita @@ -1,12 +1,12 @@ - <ph keyref="startRhythmPlayer"/> + <ph keyref="startRhythmPlayer" /> Enables the virtual metronome. - + @@ -28,42 +28,42 @@ sound2: string, config: AgoraRhythmPlayerConfig ): number; - Future<void> startRhythmPlayer( + Future<void> startRhythmPlayer( {required String sound1, required String sound2, required AgoraRhythmPlayerConfig config}); -

                                            +

                                            Details

                                            In music education, physical education and other scenarios, teachers usually need to use a metronome so that students can practice with the correct beat. The meter is composed of a downbeat and upbeats. The first beat of each measure is called a downbeat, and the rest are called upbeats.

                                            In this method, you need to set the file path of the upbeat and downbeat, the number of beats per measure, the beat speed, and whether to send the sound of the metronome to remote users.

                                            -

                                            After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.

                                            +

                                            After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.

                                            • This method is for Android and iOS only.
                                              • -
                                            • After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning, and controls the playback duration of each file according to beatsPerMinute you set in . For example, if you set beatsPerMinute as 60, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration.
                                              • -
                                            • By default, the sound of the virtual metronome is published in the channel. If you do not want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in as .
                                              • +
                                            • After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning, and controls the playback duration of each file according to beatsPerMinute you set in . For example, if you set beatsPerMinute as 60, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration.
                                              • +
                                            • By default, the sound of the virtual metronome is published in the channel. If you do not want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in as .
                                            Parameters sound1 - The absolute path or URL address (including the filename extensions) of the file for the downbeat. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. + The absolute path or URL address (including the filename extensions) of the file for the downbeat. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. sound2 - The absolute path or URL address (including the filename extensions) of the file for the upbeats. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. + The absolute path or URL address (including the filename extensions) of the file for the upbeats. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. config - The metronome configuration. See . + The metronome configuration. 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.
                                                @@ -71,4 +71,4 @@
                                            -                                             + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita index 85b5460b25e..1573e53c5e8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita @@ -1,12 +1,12 @@ - <ph keyref="startScreenCapture"/> + <ph keyref="startScreenCapture" /> Starts screen capture. - + @@ -24,32 +24,32 @@ int StartScreenCapture(const FScreenCaptureParameters2& captureParams);abstract startScreenCapture(captureParams: ScreenCaptureParameters2): number; public abstract int StartScreenCapture(ScreenCaptureParameters2 captureParams); abstract startScreenCapture(captureParams: ScreenCaptureParameters2): number; - Future<void> startScreenCapture(ScreenCaptureParameters2 captureParams); -

                                            + Future<void> startScreenCapture(ScreenCaptureParameters2 captureParams); +

                                            Details

                                            There are two ways to start screen sharing, you can choose one according to your needs:

                                              -
                                            • Call this method before joining a channel, then call to join channel and set publishScreenCaptureVideo to to start screen sharing.
                                              • -
                                            • Call this method after joining a channel, then call and set publishScreenCaptureVideo to to start screen sharing.
                                              • +
                                            • Call this method before joining a channel, then call to join channel and set publishScreenCaptureVideo to to start screen sharing.
                                              • +
                                            • Call this method after joining a channel, then call and set publishScreenCaptureVideo to to start screen sharing.

                                            -

                                            When the state of the screen sharing extension process changes, the SDK triggers the callback accordingly. When the type of sourceType is , the state parameter indicates the state of the screen sharing.

                                            +

                                            When the state of the screen sharing extension process changes, the SDK triggers the callback accordingly. When the type of sourceType is , the state parameter indicates the state of the screen sharing.

                                            • This method applies to Android and iOS only.
                                            • On the iOS platform, screen sharing is only available on iOS 12.0 and later.
                                              • -
                                            • The billing for the screen sharing stream is based on the dimensions in . When you do not pass in a value, Agora bills you at 1280 × 720; when you pass a value in, Agora bills you at that value. See .
                                              • +
                                            • The billing for the screen sharing stream is based on the dimensions in . When you do not pass in a value, Agora bills you at 1280 × 720; when you pass a value in, Agora bills you at that value. See .
                                            • If you are using the custom audio source instead of the SDK to capture audio, Agora recommends you add the keep-alive processing logic to your application to avoid screen sharing stopping when the application goes to the background.
                                            • This feature requires high-performance device, and Agora recommends that you use it on iPhone X and later models.
                                            • This method relies on the iOS screen sharing dynamic library AgoraReplayKitExtension.xcframework. If the dynamic library is deleted, screen sharing cannot be enabled normally.
                                            • On the Android platform, make sure the user has granted the app screen capture permission.
                                              • -
                                            • Make sure that the Android API level is not earlier than 21, otherwise, the SDK reports error codes (16) and (2).
                                              • -
                                            • To capture system audio during screen sharing, ensure that the Android API level is not earlier than 29 as well; otherwise, the SDK reports the error code (3).
                                              • +
                                            • Make sure that the Android API level is not earlier than 21, otherwise, the SDK reports error codes (16) and (2).
                                              • +
                                            • To capture system audio during screen sharing, ensure that the Android API level is not earlier than 29 as well; otherwise, the SDK reports the error code (3).
                                            • On Android 9 and later, to avoid the application being killed by the system after going to the background, Agora recommends you add the foreground service android.permission.FOREGROUND_SERVICE to the /app/Manifests/AndroidManifest.xml file.
                                            • Due to performance limitations, screen sharing is not supported on Android TV.
                                            • Due to system limitations, if you are using Huawei phones, do not adjust the video encoding resolution of the screen sharing stream during the screen sharing, or you could experience crashes.
                                            • Due to system limitations, some Xiaomi devices do not support capturing system audio during screen sharing.
                                              • -
                                            • To avoid system audio capture failure when screen sharing, Agora recommends that you set the audio application scenario to by using the method before joining the channel.
                                              • +
                                            • To avoid system audio capture failure when screen sharing, Agora recommends that you set the audio application scenario to by using the method before joining the channel.
                                            Parameters @@ -58,12 +58,12 @@ int StartScreenCapture(const FScreenCaptureParameters2& captureParams);parameters screenCaptureParameters captureParams - The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See . + The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. 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.
                                                @@ -71,4 +71,4 @@ int StartScreenCapture(const FScreenCaptureParameters2& captureParams);
                                            -                                             + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita index 310a3bf7fa3..def219254a0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita @@ -24,11 +24,11 @@ int StartScreenCaptureBySourceType(EVIDEO_SOURCE_TYPE sourceType, const FScreenC config: ScreenCaptureConfiguration ): number; public abstract int StartScreenCapture(VIDEO_SOURCE_TYPE sourceType, ScreenCaptureConfiguration config); - - Future<void> startScreenCaptureBySourceType( + + Future<void> startScreenCaptureBySourceType( {required VideoSourceType sourceType, required ScreenCaptureConfiguration config}); -

                                            +

                                            Details @@ -38,15 +38,15 @@ int StartScreenCaptureBySourceType(EVIDEO_SOURCE_TYPE sourceType, const FScreenC
                                            v4.2.0
                                            -

                                            This method, as well as and , all have the capability to start screen capture, with the following differences: -This method, as well as , , and , all have the capability to start screen capture, with the following differences:

                                              -
                                            • only applies to Android and iOS, whereas this method only applies to Windows and iOS.
                                              • -
                                            • and only support capturing video from a single screen or window. By calling this method and specifying the sourceType parameter, you can capture multiple video streams used for local video mixing or multi-channel publishing.
                                              • +

                                              This method, as well as and , all have the capability to start screen capture, with the following differences: +This method, as well as , , and , all have the capability to start screen capture, with the following differences:

                                                +
                                              • only applies to Android and iOS, whereas this method only applies to Windows and iOS.
                                                • +
                                              • and only support capturing video from a single screen or window. By calling this method and specifying the sourceType parameter, you can capture multiple video streams used for local video mixing or multi-channel publishing.

                                              • This method applies to the macOS and Windows only.
                                                • -
                                              • If you call this method to start screen capture, Agora recommends that you call to stop the capture and avoid using .
                                               +
                                            • If you call this method to start screen capture, Agora recommends that you call to stop the capture and avoid using .
                                            Parameters @@ -54,10 +54,10 @@ int StartScreenCaptureBySourceType(EVIDEO_SOURCE_TYPE sourceType, const FScreenC sourceType -

                                            The type of the video source. See .

                                            +

                                            The type of the video source. See .

                                            • Windows supports up to four screen capture video streams.
                                              • -
                                            • macOS supports only one screen capture video stream. You can only set this parameter to (2).
                                             +
                                          • macOS supports only one screen capture video stream. You can only set this parameter to (2).
                                                                                     @@ -66,8 +66,8 @@ int StartScreenCaptureBySourceType(EVIDEO_SOURCE_TYPE sourceType, const FScreenC
                                          - <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.

                                            @@ -75,4 +75,4 @@ int StartScreenCaptureBySourceType(EVIDEO_SOURCE_TYPE sourceType, const FScreenC
                                          • < 0: Failure.
                                          - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita index 233033bfefe..cbfdaf3ecb1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita @@ -36,7 +36,7 @@ {required int displayId, required Rectangle regionRect, required ScreenCaptureParameters captureParams}); -

                                          +

                                          Details @@ -57,7 +57,7 @@ regionRect - (Optional) Sets the relative location of the region to the screen. Pass in nil to share the entire screen. See . It consists of the following parameters:
                                            + (Optional) Sets the relative location of the region to the screen. Pass in nil to share the entire screen. See . It consists of the following parameters:
                                            • x: The horizontal offset from the top-left corner.
                                            • y: The vertical offset from the top-left corner.
                                            • width: The width of the region.
                                              • @@ -71,8 +71,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_startscreencapturebyscreenrect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita index a53e4052867..248c1b6d1c2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita @@ -34,7 +34,7 @@ {required Rectangle screenRect, required Rectangle regionRect, required ScreenCaptureParameters captureParams}); -

                                              +

                                          Details @@ -65,8 +65,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_startscreencapturebywindowid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita index 5d8b6cf3c0e..7addffe1ce7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita @@ -35,7 +35,7 @@ {required int windowId, required Rectangle regionRect, required ScreenCaptureParameters captureParams}); -

                                            +

                                          Details @@ -196,8 +196,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_switchchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita index 2f1b1156f88..63360150c93 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita @@ -1,33 +1,33 @@ - <ph keyref="switchChannel2"/> + <ph keyref="switchChannel2" /> Switches to a different channel, and configures whether to automatically subscribe to audio or video streams in the target channel. - +

                                            - - + + virtual int switchChannel(const char* token, const char* channelId, const ChannelMediaOptions& options) = 0; - + public abstract int SwitchChannel(string token, string channelId, ChannelMediaOptions options); - - -

                                            + + +

                                            Details

                                            This method allows the audience of an interactive live streaming channel to switch to a different channel.

                                            -

                                            After the user successfully switches to another channel, the and callbacks are triggered to indicate that the user has left the original channel and joined a new one.

                                            +

                                            After the user successfully switches to another channel, the and callbacks are triggered to indicate that the user has left the original channel and joined a new one.

                                            Once the user switches to another channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.

                                            @@ -37,10 +37,10 @@ token

                                            The token generated at your server.

                                              -
                                            • In scenarios with low security requirements, token is optional and can be set as .
                                              • +
                                            • In scenarios with low security requirements, token is optional and can be set as .
                                            • In scenarios with high security requirements, set the value to the token generated from your server. If you enable the App Certificate, you must use a token to join the channel.
                                            - Ensure that the App ID, channel name, and user name used for creating the token are the same ones as those used by the method for initializing the RTC engine.

                                            + Ensure that the App ID, channel name, and user name used for creating the token are the same ones as those used by the method for initializing the RTC engine.

                                            @@ -52,13 +52,13 @@
                                          • All uppercase English letters: A to Z.
                                          • All numeric characters: 0 to 9.
                                          • Space
                                            • -
                                          • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
                                            • +
                                          • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

                                          options - The channel media options. See . + The channel media options. See .
                                          @@ -75,4 +75,4 @@
                                      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita index 193ea38fe83..ac2992d4b08 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita @@ -1,21 +1,21 @@ - <ph keyref="unregisterAudioEncodedFrameObserver"/> + <ph keyref="unregisterAudioEncodedFrameObserver" /> Unregisters the encoded audio frame observer. - +

                                      - - - + + + abstract unregisterAudioEncodedFrameObserver( observer: IAudioEncodedFrameObserver ): number; @@ -26,7 +26,7 @@ ): number; void unregisterAudioEncodedFrameObserver(AudioEncodedFrameObserver observer); -

                                      +

                                      Parameters @@ -38,12 +38,12 @@
                                      - <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_updatescreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita index 5c846cf4d5e..a50469bfaf2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita @@ -21,13 +21,13 @@ public abstract int UpdateScreenCapture(ScreenCaptureParameters2 captureParams); abstract updateScreenCapture(captureParams: ScreenCaptureParameters2): number; Future<void> updateScreenCapture(ScreenCaptureParameters2 captureParams); -

                                      +

                                      Details

                                      If the system audio is not captured when screen sharing is enabled, and then you want to update the parameter configuration and publish the system audio, you can refer to the following steps:

                                        -
                                      1. Call this method, and set captureAudio to .
                                        2. -
                                      2. Call , and set publishScreenCaptureAudio to to publish the audio captured by the screen.
                                        3. +
                                      3. Call this method, and set captureAudio to .
                                        4. +
                                      4. Call , and set publishScreenCaptureAudio to to publish the audio captured by the screen.

                                        @@ -46,13 +46,13 @@
                                      - <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_updatescreencaptureparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita index ce51a43eeda..c2a69e760c3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita @@ -27,7 +27,7 @@ ): number;                                       Future<void> updateScreenCaptureParameters( ScreenCaptureParameters captureParams); -

                                      +

                                      Details @@ -46,8 +46,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_updatescreencaptureregion.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita index 095bb121f26..b2f88a63804 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita @@ -20,7 +20,7 @@ public abstract int UpdateScreenCaptureRegion(Rectangle regionRect); abstract updateScreenCaptureRegion(regionRect: Rectangle): number; Future<void> updateScreenCaptureRegion(Rectangle regionRect); -

                                          +

                                      Details @@ -47,8 +47,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_updatescreencaptureregion2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita index 9fcaccee823..4e7b848dbd4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita @@ -1,26 +1,26 @@ - <ph keyref="updateScreenCaptureRegion2"/> + <ph keyref="updateScreenCaptureRegion2" /> Updates the screen capturing region. - +

                                        - + - (int)updateScreenCaptureRegion:(CGRect)rect; virtual int updateScreenCaptureRegion(const Rect* rect) = 0; abstract updateScreenCaptureRegion(regionRect: Rectangle): number; public abstract int UpdateScreenCaptureRegion(Rectangle regionRect); - + Future<void> updateScreenCaptureRegion(Rectangle regionRect); -

                                        +

                                        Parameters @@ -28,15 +28,15 @@ rect regionRect - The relative location of the region to the screen or window. If you do not set this parameter, the SDK shares the whole screen. See . If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window. + The relative location of the region to the screen or window. If you do not set this parameter, the SDK shares the whole screen. See . If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window.
                                        - <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_createdatastreamex2.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita index 423f2b1edc1..c63a62d4eea 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita @@ -32,7 +32,7 @@ ): number; Future<int> createDataStreamEx( {required DataStreamConfig config, required RtcConnection connection}); -

                                        +

                                      Details diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita index a66de42b538..4d296e36cdb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita @@ -1,12 +1,12 @@ - <ph keyref="joinChannelEx"/> + <ph keyref="joinChannelEx" /> Joins a channel with the connection ID. - + @@ -38,7 +38,7 @@ {required String token, required RtcConnection connection, required ChannelMediaOptions options}); -

                                      +

                                      Details @@ -47,34 +47,34 @@
                                      • If you are already in a channel, you cannot rejoin it with the same user ID.
                                      • If you want to join the same channel from different devices, ensure that the user IDs are different for all devices.
                                        • -
                                      • Ensure that the app ID you use to generate the token is the same as the app ID used when creating the instance.
                                        • -
                                      • In a multi-camera capture scenario, you need to call the method after calling this method to set the sourceType to , to ensure that the second camera captures normally.
                                        • +
                                      • Ensure that the app ID you use to generate the token is the same as the app ID used when creating the instance.
                                        • +
                                      • In a multi-camera capture scenario, you need to call the method after calling this method to set the sourceType to , to ensure that the second camera captures normally.
                                      Parameters - - + + connection - The connection information. See . + The connection information. See . - - + + eventHandler delegate - The callback class of .See . + The callback class of .See . - - + +
                                      -
                                      +
                                      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita index 71f15960aa4..bdf7b470be0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita @@ -1,12 +1,12 @@ - <ph keyref="setDualStreamModeEx"/> + <ph keyref="setDualStreamModeEx" /> Sets the dual-stream mode on the sender side. - + @@ -32,11 +32,11 @@ streamConfig: SimulcastStreamConfig, connection: RtcConnection ): number; - Future<void> setDualStreamModeEx( + Future<void> setDualStreamModeEx( {required SimulcastStreamMode mode, required SimulcastStreamConfig streamConfig, required RtcConnection connection}); -

                                      +

                                      Details @@ -46,10 +46,10 @@
                                      v4.0.1
                                      -

                                      The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to . If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).

                                      - The difference and connection between this method and is as follows:
                                        -
                                      • When calling this method and setting mode to , it has the same effect as ().
                                        • -
                                      • When calling this method and setting mode to , it has the same effect as ().
                                        • +

                                        The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to . If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).

                                        + The difference and connection between this method and is as follows:
                                          +
                                        • When calling this method and setting mode to , it has the same effect as ().
                                          • +
                                        • When calling this method and setting mode to , it has the same effect as ().
                                        • Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
                                      @@ -57,23 +57,23 @@ mode - The mode in which the video stream is sent. See . + The mode in which the video stream is sent. 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.
                                      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita index 59dbed31a9b..b9026e3fde4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita @@ -28,7 +28,7 @@ ): number; Future<void> setupRemoteVideoEx( {required VideoCanvas canvas, required RtcConnection connection}); -

                                      +

                                      Details @@ -56,8 +56,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_setvideoencoderconfigurationex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita index 4cf4760b640..31d2394ac99 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita @@ -30,7 +30,7 @@ Future<void> setVideoEncoderConfigurationEx( {required VideoEncoderConfiguration config, required RtcConnection connection}); -

                                        +

                                      Details @@ -50,8 +50,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_startchannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita index 74d8622145b..c77da9dd34e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita @@ -1,12 +1,12 @@ - <ph keyref="startChannelMediaRelayEx"/> + <ph keyref="startChannelMediaRelayEx" /> Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels. - + @@ -26,10 +26,10 @@ configuration: ChannelMediaRelayConfiguration, connection: RtcConnection ): number; - Future<void> startChannelMediaRelayEx( + Future<void> startChannelMediaRelayEx( {required ChannelMediaRelayConfiguration configuration, required RtcConnection connection}); -

                                        +

                                      Details @@ -39,16 +39,16 @@
                                      This method is deprecated. Use instead.
                                      -

                                      After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.

                                        -
                                      • If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
                                        • -
                                      • If the callback returns (3), an exception occurs during the media stream relay.
                                        • +

                                        After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.

                                          +
                                        • If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
                                          • +
                                        • If the callback returns (3), an exception occurs during the media stream relay.

                                        • Call this method after joining the channel.
                                        • This method takes effect only when you are a host in a live streaming channel.
                                          • -
                                        • After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
                                          • -
                                        • The relaying media streams across channels function needs to be enabled by contacting .
                                          • +
                                        • After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
                                          • +
                                        • The relaying media streams across channels function needs to be enabled by contacting .
                                        • Agora does not support string user accounts in this API.
                                      @@ -58,16 +58,16 @@ channelMediaRelayConfiguration config configuration - The configuration of the media stream relay. See . + The configuration of the media stream relay. 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.
                                          @@ -78,4 +78,4 @@
                                      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita index 8a2a086cc7a..2819845594f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita @@ -1,12 +1,12 @@ - <ph keyref="startOrUpdateChannelMediaRelayEx"/> + <ph keyref="startOrUpdateChannelMediaRelayEx" /> Starts relaying media streams across channels or updates channels for media relay. - + @@ -26,10 +26,10 @@ configuration: ChannelMediaRelayConfiguration, connection: RtcConnection ): number;                                       - Future<void> startOrUpdateChannelMediaRelayEx( + Future<void> startOrUpdateChannelMediaRelayEx( {required ChannelMediaRelayConfiguration configuration, required RtcConnection connection}); -

                                      +

                                      Details @@ -39,15 +39,15 @@
                                      v4.2.0

                                      The first successful call to this method starts relaying media streams from the source channel to the destination channels. To relay the media stream to other channels, or exit one of the current media relays, you can call this method again to update the destination channels. This feature supports relaying media streams to a maximum of six destination channels.

                                      -

                                      After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:

                                        -
                                      • If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
                                        • -
                                      • If the callback returns (3), an exception occurs during the media stream relay.
                                        • +

                                        After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:

                                          +
                                        • If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
                                          • +
                                        • If the callback returns (3), an exception occurs during the media stream relay.

                                        • Call this method after joining the channel.
                                        • This method takes effect only when you are a host in a live streaming channel.
                                          • -
                                        • The relaying media streams across channels function needs to be enabled by contacting .
                                          • +
                                        • The relaying media streams across channels function needs to be enabled by contacting .
                                        • Agora does not support string user accounts in this API.
                                      @@ -57,16 +57,16 @@ channelMediaRelayConfiguration config configuration - The configuration of the media stream relay. See . + The configuration of the media stream relay. 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.
                                          @@ -77,4 +77,4 @@
                                      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita index fcddba1bfbd..2859072794b 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita @@ -26,9 +26,9 @@ deviceIdUTF8: string, deviceCapabilityNumber: number ): VideoFormat;                                       - Future<VideoFormat> getCapability( + Future<VideoFormat> getCapability( {required String deviceIdUTF8, required int deviceCapabilityNumber}); -

                                      +

                                      Details diff --git a/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita b/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita index 42f47a31257..f30f5800980 100644 --- a/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita @@ -1,9 +1,8 @@ - <ph keyref="LocalAccessPointConfiguration"/> - The configurations of the Local Access Point. + <ph keyref="LocalAccessPointConfiguration" /> + The configurations of the Local Access Point.

                                      @@ -60,8 +59,8 @@ return logUploadServer; } }; - public ArrayList<String> ipList = null; - public ArrayList<String> domainList = null; + public ArrayList<String> ipList = null; + public ArrayList<String> domainList = null; public String verifyDomainName = null; public int mode = Constants.LOCAL_RPOXY_CONNECTIVITY_FIRST; public AdvancedConfigInfo advancedConfig = null; @@ -147,13 +146,13 @@ this.advancedConfig}); @JsonKey(name: 'ipList') - final List<String>? ipList; + final List<String>? ipList; @JsonKey(name: 'ipListSize') final int? ipListSize; @JsonKey(name: 'domainList') - final List<String>? domainList; + final List<String>? domainList; @JsonKey(name: 'domainListSize') final int? domainListSize; @@ -167,15 +166,15 @@ @JsonKey(name: 'advancedConfig') final AdvancedConfigInfo? advancedConfig; - factory LocalAccessPointConfiguration.fromJson(Map<String, dynamic> json) => + factory LocalAccessPointConfiguration.fromJson(Map<String, dynamic> json) => _$LocalAccessPointConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$LocalAccessPointConfigurationToJson(this); + Map<String, dynamic> toJson() => _$LocalAccessPointConfigurationToJson(this); } -

                                      +

                                      - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> ipList @@ -200,20 +199,17 @@ mode -

                                      The connection mode. See .

                                      +

                                      The connection mode. See .

                                      Select one of the following connection modes:

                                        -
                                      • (0): The SDK firstly tries to connect to the specified Agora private media server; if the connection attempt fails, it will connect to the Agora SD-RTN™ instead.
                                        • -
                                      • (1) The SDK only tries to connect to the specified Agora private media server.
                                        • +
                                      • (0): The SDK firstly tries to connect to the specified Agora private media server; if the connection attempt fails, it will connect to the Agora SD-RTN™ instead.
                                        • +
                                      • (1) The SDK only tries to connect to the specified Agora private media server.

                                                                             advancedConfig - The advanced options for the Local Access Point. See . + The advanced options for the Local Access Point. See .
                                      -                                       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_advanceoptions.dita b/en-US/dita/RTC-NG/API/class_advanceoptions.dita index e9ab1ee61bf..ec0bc49e668 100644 --- a/en-US/dita/RTC-NG/API/class_advanceoptions.dita +++ b/en-US/dita/RTC-NG/API/class_advanceoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="AdvanceOptions"/> + <ph keyref="AdvanceOptions" /> Advanced options for video encoding.
                                      @@ -75,12 +75,12 @@ @JsonKey(name: 'compressionPreference') final CompressionPreference? compressionPreference; - factory AdvanceOptions.fromJson(Map<String, dynamic> json) => + factory AdvanceOptions.fromJson(Map<String, dynamic> json) => _$AdvanceOptionsFromJson(json); - Map<String, dynamic> toJson() => _$AdvanceOptionsToJson(this); + Map<String, dynamic> toJson() => _$AdvanceOptionsToJson(this); } -

                                      +

                                      @@ -89,19 +89,19 @@
                                      v4.1.0
                                      -

                                      +

                                      - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> encodingPreference - Video encoder preference. See . + Video encoder preference. See . compressionPreference - Compression preference for video encoding. See . + Compression preference for video encoding. See .
                                      -                                       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_audioparams.dita b/en-US/dita/RTC-NG/API/class_audioparams.dita index c553ee129d3..6e8e8f04f3c 100644 --- a/en-US/dita/RTC-NG/API/class_audioparams.dita +++ b/en-US/dita/RTC-NG/API/class_audioparams.dita @@ -1,7 +1,7 @@ - <ph keyref="AudioParams"/> + <ph keyref="AudioParams" /> Audio data format.
                                      @@ -98,33 +98,33 @@ @JsonKey(name: 'samples_per_call') final int? samplesPerCall; - factory AudioParams.fromJson(Map<String, dynamic> json) => + factory AudioParams.fromJson(Map<String, dynamic> json) => _$AudioParamsFromJson(json); - Map<String, dynamic> toJson() => _$AudioParamsToJson(this); + Map<String, dynamic> toJson() => _$AudioParamsToJson(this); } -

                                      +

                                      -

                                      You can pass the object in the following APIs to set the audio data format for the corresponding callback:

                                        -
                                      • : Sets the audio data format for the callback.
                                        • -
                                      • : Sets the audio data format for the callback.
                                        • -
                                      • : Sets the audio data format for the callback.
                                        • -
                                      • : Sets the audio data format for the callback.
                                        • +

                                        You can pass the object in the following APIs to set the audio data format for the corresponding callback:

                                          +
                                        • : Sets the audio data format for the callback.
                                          • +
                                        • : Sets the audio data format for the callback.
                                          • +
                                        • : Sets the audio data format for the callback.
                                          • +
                                        • : Sets the audio data format for the callback.

                                        -

                                        The SDK sets the audio data format in the following callbacks according to .

                                          -
                                          • -
                                          • -
                                          • +

                                          The SDK sets the audio data format in the following callbacks according to .

                                            +
                                            • +
                                            • +

                                            -
                                          • The SDK calculates the sampling interval through the samplesPerCall, sampleRate, and channel parameters in , and triggers the , , , and callbacks according to the sampling interval.
                                            • +
                                          • The SDK calculates the sampling interval through the samplesPerCall, sampleRate, and channel parameters in , and triggers the , , , and callbacks according to the sampling interval.
                                          • Sample interval (sec) = samplePerCall/(sampleRate × channel).
                                          • Ensure that the sample interval ≥ 0.01 (s).
                                      - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> sampleRate @@ -147,10 +147,10 @@ mode - The use mode of the audio data. See . + The use mode of the audio data. See . The use mode of the audio data, which can be set as either of the following values:
                                        -
                                      • (0): Read-only mode, where users only read the original data from without any modification. For example, when users acquire the data with the Agora SDK, then start the media push.
                                        • -
                                      • (2): Read and write mode, where users read the data from , modify it, and then play it. Users read the data returned by the SDK, modify it, and then play it. For example, when users have their own audio-effect processing module and perform some voice pre-processing, such as a voice change.
                                        • +
                                      • (0): Read-only mode, where users only read the original data from without any modification. For example, when users acquire the data with the Agora SDK, then start the media push.
                                        • +
                                      • (2): Read and write mode, where users read the data from , modify it, and then play it. Users read the data returned by the SDK, modify it, and then play it. For example, when users have their own audio-effect processing module and perform some voice pre-processing, such as a voice change.
                                                                             @@ -160,4 +160,4 @@
                                      -                                       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita b/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita index 1ab19da80e4..d709cc85a1c 100644 --- a/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita @@ -164,12 +164,12 @@ @JsonKey(name: 'recordingChannel') final int? recordingChannel; - factory AudioRecordingConfiguration.fromJson(Map<String, dynamic> json) => + factory AudioRecordingConfiguration.fromJson(Map<String, dynamic> json) => _$AudioRecordingConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$AudioRecordingConfigurationToJson(this); + Map<String, dynamic> toJson() => _$AudioRecordingConfigurationToJson(this); } -

                                      +

                                      <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> diff --git a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita index c8961b7b32b..599b705feb0 100644 --- a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita @@ -1,7 +1,7 @@ - <ph keyref="CameraCapturerConfiguration"/> + <ph keyref="CameraCapturerConfiguration" /> The camera capturer preference.
                                      @@ -199,40 +199,40 @@ @JsonKey(name: 'followEncodeDimensionRatio') final bool? followEncodeDimensionRatio; - factory CameraCapturerConfiguration.fromJson(Map<String, dynamic> json) => + factory CameraCapturerConfiguration.fromJson(Map<String, dynamic> json) => _$CameraCapturerConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$CameraCapturerConfigurationToJson(this); + Map<String, dynamic> toJson() => _$CameraCapturerConfigurationToJson(this); } -

                                      +

                                      - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <title> <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> cameraDirection - This parameter applies to Android and iOS only.The camera direction. See . + This parameter applies to Android and iOS only.The camera direction. See . format captureFormat - The format of the video frame. See . + The format of the video frame. See . deviceId This method applies to Windows only. - This method applies to macOS only.The ID of the camera. The maximum length is . + This method applies to macOS only.The ID of the camera. The maximum length is . followEncodeDimensionRatio - Whether to follow the video aspect ratio set in :
                                        -
                                      • : (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in and .
                                        • -
                                      • : Do not follow the system default audio playback device. The SDK does not change the aspect ratio of the captured video frame.
                                        • + Whether to follow the video aspect ratio set in :
                                          +
                                        • : (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in and .
                                          • +
                                        • : Do not follow the system default audio playback device. The SDK does not change the aspect ratio of the captured video frame.
                                      -                                       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita index 2b1003f9a1e..d2e73d40f4a 100644 --- a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita +++ b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="ChannelMediaOptions"/> + <ph keyref="ChannelMediaOptions" /> The channel media options.
                                      @@ -80,8 +80,8 @@ struct ChannelMediaOptions { Optional<bool> publishCameraTrack; Optional<bool> publishSecondaryCameraTrack; - Optional<bool> publishThirdCameraTrack; - Optional<bool> publishFourthCameraTrack; + Optional<bool> publishThirdCameraTrack; + Optional<bool> publishFourthCameraTrack; Optional<bool> publishMicrophoneTrack; #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) @@ -90,8 +90,8 @@ #else Optional<bool> publishScreenTrack; Optional<bool> publishSecondaryScreenTrack; - Optional<bool> publishThirdScreenTrack; - Optional<bool> publishFourthScreenTrack; + Optional<bool> publishThirdScreenTrack; + Optional<bool> publishFourthScreenTrack; #endif Optional<bool> publishCustomAudioTrack; @@ -223,37 +223,37 @@ } public class ChannelMediaOptions : OptionalJsonParse { - public Optional<bool> publishCameraTrack = new Optional<bool>(); - public Optional<bool> publishSecondaryCameraTrack = new Optional<bool>(); - public Optional<bool> publishThirdCameraTrack = new Optional<bool>(); - public Optional<bool> publishFourthCameraTrack = new Optional<bool>(); - public Optional<bool> publishMicrophoneTrack = new Optional<bool>(); - public Optional<bool> publishScreenCaptureVideo = new Optional<bool>(); - public Optional<bool> publishScreenCaptureAudio = new Optional<bool>(); - public Optional<bool> publishScreenTrack = new Optional<bool>(); - public Optional<bool> publishSecondaryScreenTrack = new Optional<bool>(); - public Optional<bool> publishThirdScreenTrack = new Optional<bool>(); - public Optional<bool> publishFourthScreenTrack = new Optional<bool>(); - public Optional<bool> publishCustomAudioTrack = new Optional<bool>(); - public Optional<int> publishCustomAudioTrackId = new Optional<int>(); - public Optional<bool> publishCustomVideoTrack = new Optional<bool>(); - public Optional<bool> publishEncodedVideoTrack = new Optional<bool>(); - public Optional<bool> publishMediaPlayerAudioTrack = new Optional<bool>(); - public Optional<bool> publishMediaPlayerVideoTrack = new Optional<bool>(); - public Optional<bool> publishTranscodedVideoTrack = new Optional<bool>(); - public Optional<bool> autoSubscribeAudio = new Optional<bool>(); - public Optional<bool> autoSubscribeVideo = new Optional<bool>(); - public Optional<bool> enableAudioRecordingOrPlayout = new Optional<bool>(); - public Optional<int> publishMediaPlayerId = new Optional<int>(); - public Optional<CLIENT_ROLE_TYPE> clientRoleType = new Optional<CLIENT_ROLE_TYPE>(); - public Optional<AUDIENCE_LATENCY_LEVEL_TYPE> audienceLatencyLevel = new Optional<AUDIENCE_LATENCY_LEVEL_TYPE>(); - public Optional<VIDEO_STREAM_TYPE> defaultVideoStreamType = new Optional<VIDEO_STREAM_TYPE>(); - public Optional<CHANNEL_PROFILE_TYPE> channelProfile = new Optional<CHANNEL_PROFILE_TYPE>(); - public Optional<string> token = new Optional<string>(); - public Optional<bool> publishRhythmPlayerTrack = new Optional<bool>(); - public Optional<bool> isInteractiveAudience = new Optional<bool>(); - public Optional<video_track_id_t> customVideoTrackId = new Optional<video_track_id_t>(); - public Optional<bool> isAudioFilterable = new Optional<bool>(); + public Optional<bool> publishCameraTrack = new Optional<bool>(); + public Optional<bool> publishSecondaryCameraTrack = new Optional<bool>(); + public Optional<bool> publishThirdCameraTrack = new Optional<bool>(); + public Optional<bool> publishFourthCameraTrack = new Optional<bool>(); + public Optional<bool> publishMicrophoneTrack = new Optional<bool>(); + public Optional<bool> publishScreenCaptureVideo = new Optional<bool>(); + public Optional<bool> publishScreenCaptureAudio = new Optional<bool>(); + public Optional<bool> publishScreenTrack = new Optional<bool>(); + public Optional<bool> publishSecondaryScreenTrack = new Optional<bool>(); + public Optional<bool> publishThirdScreenTrack = new Optional<bool>(); + public Optional<bool> publishFourthScreenTrack = new Optional<bool>(); + public Optional<bool> publishCustomAudioTrack = new Optional<bool>(); + public Optional<int> publishCustomAudioTrackId = new Optional<int>(); + public Optional<bool> publishCustomVideoTrack = new Optional<bool>(); + public Optional<bool> publishEncodedVideoTrack = new Optional<bool>(); + public Optional<bool> publishMediaPlayerAudioTrack = new Optional<bool>(); + public Optional<bool> publishMediaPlayerVideoTrack = new Optional<bool>(); + public Optional<bool> publishTranscodedVideoTrack = new Optional<bool>(); + public Optional<bool> autoSubscribeAudio = new Optional<bool>(); + public Optional<bool> autoSubscribeVideo = new Optional<bool>(); + public Optional<bool> enableAudioRecordingOrPlayout = new Optional<bool>(); + public Optional<int> publishMediaPlayerId = new Optional<int>(); + public Optional<CLIENT_ROLE_TYPE> clientRoleType = new Optional<CLIENT_ROLE_TYPE>(); + public Optional<AUDIENCE_LATENCY_LEVEL_TYPE> audienceLatencyLevel = new Optional<AUDIENCE_LATENCY_LEVEL_TYPE>(); + public Optional<VIDEO_STREAM_TYPE> defaultVideoStreamType = new Optional<VIDEO_STREAM_TYPE>(); + public Optional<CHANNEL_PROFILE_TYPE> channelProfile = new Optional<CHANNEL_PROFILE_TYPE>(); + public Optional<string> token = new Optional<string>(); + public Optional<bool> publishRhythmPlayerTrack = new Optional<bool>(); + public Optional<bool> isInteractiveAudience = new Optional<bool>(); + public Optional<video_track_id_t> customVideoTrackId = new Optional<video_track_id_t>(); + public Optional<bool> isAudioFilterable = new Optional<bool>(); } export class ChannelMediaOptions { @@ -462,66 +462,66 @@ class ChannelMediaOptions { @JsonKey(name: 'isAudioFilterable') final bool? isAudioFilterable; - factory ChannelMediaOptions.fromJson(Map<String, dynamic> json) => + factory ChannelMediaOptions.fromJson(Map<String, dynamic> json) => _$ChannelMediaOptionsFromJson(json); - Map<String, dynamic> toJson() => _$ChannelMediaOptionsToJson(this); + Map<String, dynamic> toJson() => _$ChannelMediaOptionsToJson(this); } -

                                      +

                                      -
                                      Agora supports publishing multiple audio streams and one video stream at the same time and in the same . For example, publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as at the same time, but only one of publishCameraTrack, publishScreenCaptureVideopublishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as .Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters. +
                                      Agora supports publishing multiple audio streams and one video stream at the same time and in the same . For example, publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as at the same time, but only one of publishCameraTrack, publishScreenCaptureVideopublishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as .Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters.
                                      - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> publishCameraTrack Whether to publish the video captured by the camera:
                                        -
                                      • : Publish the video captured by the camera.
                                        • -
                                      • : Do not publish the video captured by the camera.
                                        • +
                                      • : Publish the video captured by the camera.
                                        • +
                                      • : Do not publish the video captured by the camera.
                                                                             publishSecondaryCameraTrack Whether to publish the video captured by the second camera:
                                        -
                                      • : Publish the video captured by the second camera.
                                        • -
                                      • : Do not publish the video captured by the second camera.
                                        • +
                                      • : Publish the video captured by the second camera.
                                        • +
                                      • : Do not publish the video captured by the second camera.
                                                                             publishMicrophoneTrack Whether to publish the audio captured by the microphone:
                                        -
                                      • : Publish the audio captured by the microphone.
                                        • -
                                      • : Do not publish the audio captured by the microphone.
                                        • +
                                      • : Publish the audio captured by the microphone.
                                        • +
                                      • : Do not publish the audio captured by the microphone.
                                      • As of v4.0.0, the parameter name is changed from publishAudioTrack to publishMicrophoneTrack.
                                      • As of v6.0.0, the parameter name is changed from publishAudioTrack to publishMicrophoneTrack.
                                        • -
                                      • If you want to publish the audio streams captured by your microphone, ensure enableAudioRecordingOrPlayout is set as .
                                       +
                                    • If you want to publish the audio streams captured by your microphone, ensure enableAudioRecordingOrPlayout is set as .
                                                                         publishThirdCameraTrack Whether to publish the video captured by the third camera:
                                      -
                                    • : Publish the video captured by the third camera.
                                      • -
                                    • : Do not publish the video captured by the third camera.
                                      • +
                                    • : Publish the video captured by the third camera.
                                      • +
                                    • : Do not publish the video captured by the third camera.

                                    This method is for Windows and macOS only.

                                                                         publishFourthCameraTrack Whether to publish the video captured by the fourth camera:
                                      -
                                    • : Publish the video captured by the fourth camera.
                                      • -
                                    • : Do not publish the video captured by the fourth camera.
                                      • +
                                    • : Publish the video captured by the fourth camera.
                                      • +
                                    • : Do not publish the video captured by the fourth camera.

                                    This method is for Windows and macOS only.

                                                                         publishScreenTrack

                                    Whether to publish the video captured from the screen:

                                      -
                                    • : Publish the video captured from the screen.
                                      • -
                                    • : Do not publish the video captured from the screen.
                                      • +
                                    • : Publish the video captured from the screen.
                                      • +
                                    • : Do not publish the video captured from the screen.

                                    This method is for Windows and macOS only.

                                     @@ -530,8 +530,8 @@ class ChannelMediaOptions { publishScreenCaptureVideo

                                    Whether to publish the video captured from the screen:

                                      -
                                    • : Publish the video captured from the screen.
                                      • -
                                    • : Do not publish the video captured from the screen.
                                      • +
                                    • : Publish the video captured from the screen.
                                      • +
                                    • : Do not publish the video captured from the screen.

                                    This parameter applies to Android and iOS only.

                                    As of v4.0.0, the parameter name is changed from publishScreenTrack to publishScreenCaptureVideo.

                                     @@ -540,8 +540,8 @@ class ChannelMediaOptions { publishScreenCaptureAudio

                                    Whether to publish the audio captured from the screen:

                                      -
                                    • : Publish the audio captured from the screen.
                                      • -
                                    • : Publish the audio captured from the screen.
                                      • +
                                    • : Publish the audio captured from the screen.
                                      • +
                                    • : Publish the audio captured from the screen.

                                    This parameter applies to Android and iOS only.

                                    @@ -550,16 +550,16 @@ class ChannelMediaOptions { publishSecondaryScreenTrack Whether to publish the video captured from the second screen:
                                      -
                                    • : Publish the video captured from the second screen.
                                      • -
                                    • : Do not publish the video captured from the second screen.
                                      • +
                                    • : Publish the video captured from the second screen.
                                      • +
                                    • : Do not publish the video captured from the second screen.
                                                                         publishThirdScreenTrack Whether to publish the video captured from the third screen:
                                      -
                                    • : Publish the captured video from the third screen.
                                      • -
                                    • : Do not publish the video captured from the third screen.
                                      • +
                                    • : Publish the captured video from the third screen.
                                      • +
                                    • : Do not publish the video captured from the third screen.

                                    This method is for Windows and macOS only.

                                    @@ -568,8 +568,8 @@ class ChannelMediaOptions { publishFourthScreenTrack Whether to publish the video captured from the fourth screen:
                                      -
                                    • : Publish the captured video from the fourth screen.
                                      • -
                                    • : Do not publish the video captured from the fourth screen.
                                      • +
                                    • : Publish the captured video from the fourth screen.
                                      • +
                                    • : Do not publish the video captured from the fourth screen.

                                    This method is for Windows and macOS only.

                                    @@ -578,8 +578,8 @@ class ChannelMediaOptions { publishTranscodedVideoTrack Whether to publish the local transcoded video:
                                      -
                                    • : Publish the local transcoded video.
                                      • -
                                    • : Do not publish the local transcoded video.
                                      • +
                                    • : Publish the local transcoded video.
                                      • +
                                    • : Do not publish the local transcoded video.

                                    As of v4.2.0, the parameter name is corrected from publishTrancodedVideoTrack to publishTranscodedVideoTrack.

                                     @@ -587,64 +587,64 @@ class ChannelMediaOptions { publishCustomAudioTrack Whether to publish the audio captured from a custom source:
                                      -
                                    • : Publish the audio captured from the custom source.
                                      • -
                                    • : Do not publish the captured audio from a custom source.
                                      • +
                                    • : Publish the audio captured from the custom source.
                                      • +
                                    • : Do not publish the captured audio from a custom source.
                                                                         publishCustomAudioTrackId - The ID of the custom audio source to publish. The default value is 0.

                                    If you have set sourceNumber in to a value greater than 1, the SDK creates the corresponding number of custom audio tracks and assigns an ID to each audio track, starting from 0.

                                    + The ID of the custom audio source to publish. The default value is 0.

                                    If you have set sourceNumber in to a value greater than 1, the SDK creates the corresponding number of custom audio tracks and assigns an ID to each audio track, starting from 0.

                                                                         publishCustomVideoTrack Whether to publish the video captured from a custom source:
                                      -
                                    • : Publish the video captured from the custom source.
                                      • -
                                    • : Do not publish the captured video from a custom source.
                                      • +
                                    • : Publish the video captured from the custom source.
                                      • +
                                    • : Do not publish the captured video from a custom source.
                                                                         publishEncodedVideoTrack Whether to publish the encoded video:
                                      -
                                    • : Publish the encoded video.
                                      • -
                                    • : Do not publish the encoded video.
                                      • +
                                    • : Publish the encoded video.
                                      • +
                                    • : Do not publish the encoded video.
                                                                         publishMediaPlayerAudioTrack Whether to publish the audio from the media player:
                                      -
                                    • : Publish the audio from the media player.
                                      • -
                                    • : Do not publish the audio from the media player.
                                      • +
                                    • : Publish the audio from the media player.
                                      • +
                                    • : Do not publish the audio from the media player.
                                                                         publishMediaPlayerVideoTrack Whether to publish the video from the media player:
                                      -
                                    • : Publish the video from the media player.
                                      • -
                                    • : Do not publish the video from the media player.
                                      • +
                                    • : Publish the video from the media player.
                                      • +
                                    • : Do not publish the video from the media player.
                                                                         autoSubscribeAudio Whether to automatically subscribe to all remote audio streams when the user joins a channel:
                                      -
                                    • : Subscribe to all remote audio streams.
                                      • -
                                    • : Do not automatically subscribe to any remote audio streams.
                                      • +
                                    • : Subscribe to all remote audio streams.
                                      • +
                                    • : Do not automatically subscribe to any remote audio streams.
                                                                         autoSubscribeVideo Whether to automatically subscribe to all remote video streams when the user joins the channel:
                                      -
                                    • : Subscribe to all remote video streams.
                                      • -
                                    • : Do not automatically subscribe to any remote video streams.
                                      • +
                                    • : Subscribe to all remote video streams.
                                      • +
                                    • : Do not automatically subscribe to any remote video streams.
                                                                         enableAudioRecordingOrPlayout Whether to enable audio capturing or playback:
                                      -
                                    • : Enable audio capturing or playback.
                                      • -
                                    • : Do not enable audio capturing or playback.
                                      • +
                                    • : Enable audio capturing or playback.
                                      • +
                                    • : Do not enable audio capturing or playback.
                                    - If you need to publish the audio streams captured by your microphone, ensure this parameter is set as .                                     + If you need to publish the audio streams captured by your microphone, ensure this parameter is set as .                                                                         publishMediaPlayerId @@ -652,23 +652,23 @@ class ChannelMediaOptions { clientRoleType - + clientRoleType - The user role. See . + The user role. See . - - + + defaultVideoStreamType - + channelProfile - + audioDelayMs @@ -680,8 +680,8 @@ class ChannelMediaOptions { publishCustomAudioTrackAec Whether to publish audio frames processed by an external echo cancellation module.
                                      -
                                    • : Publish audio frames processed by the external echo cancellation module.
                                      • -
                                    • : Do not publish to publish audio frames processed by the external echo cancellation module.
                                      • +
                                    • : Publish audio frames processed by the external echo cancellation module.
                                      • +
                                    • : Do not publish to publish audio frames processed by the external echo cancellation module.
                                                                         @@ -690,48 +690,48 @@ class ChannelMediaOptions {

                                    (Optional) The token generated on your server for authentication. See Authenticate Your Users with Token.

                                      -
                                    • This parameter takes effect only when calling or .
                                      • -
                                    • Ensure that the App ID, channel name, and user name used for creating the token are the same as those used by the method for initializing the RTC engine, and those used by the and methods for joining the channel.
                                      • +
                                    • This parameter takes effect only when calling or .
                                      • +
                                    • Ensure that the App ID, channel name, and user name used for creating the token are the same as those used by the method for initializing the RTC engine, and those used by the and methods for joining the channel.
                                                                         startPreview Whether to automatically start the preview when joining a channel:
                                      -
                                    • : Do not automatically start the preview. Ensure that you have called the method to set the local video property; otherwise, the preview is not enabled.
                                      • -
                                    • : Do not automatically start the preview.
                                      • +
                                    • : Do not automatically start the preview. Ensure that you have called the method to set the local video property; otherwise, the preview is not enabled.
                                      • +
                                    • : Do not automatically start the preview.
                                                                         publishRhythmPlayerTrack Whether to publish the sound of a metronome to remote users:
                                      -
                                    • : Publish processed audio frames. Both the local user and remote users can hear the metronome.
                                      • -
                                    • : Do not publish the sound of the metronome. Only the local user can hear the metronome.
                                      • +
                                    • : Publish processed audio frames. Both the local user and remote users can hear the metronome.
                                      • +
                                    • : Do not publish the sound of the metronome. Only the local user can hear the metronome.
                                                                         isInteractiveAudience Whether to enable interactive mode:
                                      -
                                    • : Enable interactive mode. Once this mode is enabled and the user role is set as audience, the user can receive remote video streams with low latency.
                                      • -
                                    • :Do not enable interactive mode. If this mode is disabled, the user receives the remote video streams in default settings.
                                      • +
                                    • : Enable interactive mode. Once this mode is enabled and the user role is set as audience, the user can receive remote video streams with low latency.
                                      • +
                                    • :Do not enable interactive mode. If this mode is disabled, the user receives the remote video streams in default settings.
                                      -
                                    • This parameter only applies to scenarios involving cohosting across channels. The cohosts need to call the method to join the other host's channel as an audience member, and set isInteractiveAudience to .
                                      • -
                                    • This parameter takes effect only when the user role is .
                                      • +
                                    • This parameter only applies to scenarios involving cohosting across channels. The cohosts need to call the method to join the other host's channel as an audience member, and set isInteractiveAudience to .
                                      • +
                                    • This parameter takes effect only when the user role is .
                                                                         customVideoTrackId - The video track ID returned by calling the method. The default value is 0. + The video track ID returned by calling the method. The default value is 0. isAudioFilterable Whether the audio stream being published is filtered according to the volume algorithm:
                                      -
                                    • : The audio stream is filtered. If the audio stream filter is not enabled, this setting does not takes effect.
                                      • -
                                    • : The audio stream is not filtered.
                                      • +
                                    • : The audio stream is filtered. If the audio stream filter is not enabled, this setting does not takes effect.
                                      • +
                                    • : The audio stream is not filtered.
                                    - If you need to enable this function, contact .                                     + If you need to enable this function, contact .                                                                         - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita b/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita index 1fbcf2850e8..88e2a2d6cc8 100644 --- a/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita @@ -1,17 +1,17 @@ - <ph keyref="ChannelMediaRelayConfiguration"/> + <ph keyref="ChannelMediaRelayConfiguration" /> Configuration of cross channel media relay.

                                    public class ChannelMediaRelayConfiguration { private ChannelMediaInfo srcInfo = null; - private Map<String, ChannelMediaInfo> destInfos = null; + private Map<String, ChannelMediaInfo> destInfos = null; public ChannelMediaRelayConfiguration() { - destInfos = new HashMap<String, ChannelMediaInfo>(); + destInfos = new HashMap<String, ChannelMediaInfo>(); srcInfo = new ChannelMediaInfo(null, null, 0); } @@ -31,7 +31,7 @@ return srcInfo; } - public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { + public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { return destInfos; } } @@ -104,44 +104,44 @@ _$ChannelMediaRelayConfigurationFromJson(json); Map<String, dynamic> toJson() => _$ChannelMediaRelayConfigurationToJson(this); } -

                                    +

                                    Method setSrcChannelInfo - Sets the information of the source channel. See . + Sets the information of the source channel. See . setDestChannelInfo - Sets the information of the target channel. See . + Sets the information of the target channel. See . removeDestChannelInfo - Deletes the information of target channel. See . + Deletes the information of target channel. See . getSrcChannelMediaInfo - Gets the information of the source channel. See . + Gets the information of the source channel. See . getDestChannelMediaInfos - Gets the information of the target channel. See . + Gets the information of the target channel. See .
                                    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> srcInfo sourceInfo -

                                    The information of the source channel. See . It contains the following members:

                                      -
                                    • channelName: The name of the source channel. The default value is , which means the SDK applies the name of the current channel.
                                      • +

                                      The information of the source channel. See . It contains the following members:

                                        +
                                      • channelName: The name of the source channel. The default value is , which means the SDK applies the name of the current channel.
                                      • token: The token for joining the source channel. This token is generated with the channelName and uid you set in srcInfo.
                                          -
                                        • If you have not enabled the App Certificate, set this parameter as the default value , which means the SDK applies the App ID.
                                          • +
                                        • If you have not enabled the App Certificate, set this parameter as the default value , which means the SDK applies the App ID.
                                        • If you have enabled the App Certificate, you must use the token generated with the channelName and uid, and the uid must be set as 0.
                                      • uid: The unique user ID to identify the relay stream in the source channel. Agora recommends leaving the default value of 0 unchanged.
                                        • @@ -152,10 +152,10 @@ destInfos destinationInfos -

                                        The information of the target channel . It contains the following members:

                                          +

                                          The information of the target channel . It contains the following members:

                                          • channelName: The name of the target channel.
                                          • token: The token for joining the target channel. It is generated with the channelName and uid you set in destInfos.
                                              -
                                            • If you have not enabled the App Certificate, set this parameter as the default value , which means the SDK applies the App ID.
                                              • +
                                            • If you have not enabled the App Certificate, set this parameter as the default value , which means the SDK applies the App ID.
                                            • If you have enabled the App Certificate, you must use the token generated with the channelName and uid.

                                            If the token of any target channel expires, the whole media relay stops; hence Agora recommends that you specify the same expiration time for the tokens of all the target channels.

                                          • uid: The unique user ID to identify the relay stream in the target channel. The value ranges from 0 to (2 32-1). To avoid user ID conflicts, this user ID must be different from any other user ID in the target channel. The default value is 0, which means the SDK generates a random user ID.
                                            • @@ -164,16 +164,16 @@ destCount - The number of target channels. The default value is 0, and the value range is from 0 to 6. Ensure that the value of this parameter corresponds to the number of structs you define in destInfo. + The number of target channels. The default value is 0, and the value range is from 0 to 6. Ensure that the value of this parameter corresponds to the number of structs you define in destInfo. setDestinationInfo - Sets the information of the target channel. See . + Sets the information of the target channel. See . removeDestinationInfoForChannelName - Deletes the information of target channel. See . + Deletes the information of target channel. See .
                                    -                                     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_codeccapinfo.dita b/en-US/dita/RTC-NG/API/class_codeccapinfo.dita index 0b92b456460..71e0ebb7e66 100644 --- a/en-US/dita/RTC-NG/API/class_codeccapinfo.dita +++ b/en-US/dita/RTC-NG/API/class_codeccapinfo.dita @@ -1,7 +1,7 @@ - <ph keyref="CodecCapInfo"/> + <ph keyref="CodecCapInfo" /> The codec capability of the device.
                                    @@ -70,10 +70,10 @@ class CodecCapInfo { @JsonKey(name: 'codecLevels') final CodecCapLevels? codecLevels; - factory CodecCapInfo.fromJson(Map<String, dynamic> json) => + factory CodecCapInfo.fromJson(Map<String, dynamic> json) => _$CodecCapInfoFromJson(json); - Map<String, dynamic> toJson() => _$CodecCapInfoToJson(this); + Map<String, dynamic> toJson() => _$CodecCapInfoToJson(this); }

                                    @@ -83,14 +83,14 @@ class CodecCapInfo {
                                    v4.2.0
                                    -

                                    +

                                    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> codecType - The video codec types. See . + The video codec types. See .

                                    The video codec types:

                                    • 1: VP8.
                                      • @@ -100,7 +100,7 @@ class CodecCapInfo { codecCapMask - The bit mask of the codec type. See . + The bit mask of the codec type. See .

                                      The bit mask of the codec type:

                                      • (0): The device does not support encoding or decoding.
                                        • @@ -113,8 +113,8 @@ class CodecCapInfo { codecLevels - The level of the codec capability. See . + The level of the codec capability. See .
                                    -                                     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_codeccaplevels.dita b/en-US/dita/RTC-NG/API/class_codeccaplevels.dita index 29f19a46b6c..d06435fd763 100644 --- a/en-US/dita/RTC-NG/API/class_codeccaplevels.dita +++ b/en-US/dita/RTC-NG/API/class_codeccaplevels.dita @@ -1,7 +1,7 @@ - <ph keyref="CodecCapLevels"/> + <ph keyref="CodecCapLevels" /> The level of the codec capability.
                                    @@ -60,10 +60,10 @@ class CodecCapLevels { @JsonKey(name: 'swDecodingLevel') final VideoCodecCapabilityLevel? swDecodingLevel; - factory CodecCapLevels.fromJson(Map<String, dynamic> json) => + factory CodecCapLevels.fromJson(Map<String, dynamic> json) => _$CodecCapLevelsFromJson(json); - Map<String, dynamic> toJson() => _$CodecCapLevelsToJson(this); + Map<String, dynamic> toJson() => _$CodecCapLevelsToJson(this); }

                                    @@ -73,19 +73,19 @@ class CodecCapLevels {
                                    v4.2.2
                                    -

                                    +

                                    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> hwDecodingLevel - Hardware decoding capability level, which represents the device's ability to perform hardware decoding on videos of different quality. See . + Hardware decoding capability level, which represents the device's ability to perform hardware decoding on videos of different quality. See . swDecodingLevel - Software decoding capability level, which represents the device's ability to perform software decoding on videos of different quality. See . + Software decoding capability level, which represents the device's ability to perform software decoding on videos of different quality. See .
                                    -                                     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita b/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita index 443197715de..4ab52e56e18 100644 --- a/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita +++ b/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita @@ -1,7 +1,7 @@ - <ph keyref="ContentInspectConfig"/> + <ph keyref="ContentInspectConfig" /> Configuration of video screenshot and upload.
                                    @@ -22,7 +22,7 @@ type = CONTENT_INSPECT_TYPE_INVALID; interval = 0; } - }> + }> __attribute__((visibility("default"))) @interface AgoraContentInspectConfig: NSObject @property (nonatomic, copy) NSString* _Nullable extraInfo; @property(copy, nonatomic) NSArray<AgoraContentInspectModule*>* _Nullable modules; @@ -76,17 +76,17 @@ final String? extraInfo; @JsonKey(name: 'modules') - final List<ContentInspectModule>? modules; + final List<ContentInspectModule>? modules; @JsonKey(name: 'moduleCount') final int? moduleCount; - factory ContentInspectConfig.fromJson(Map<String, dynamic> json) => + factory ContentInspectConfig.fromJson(Map<String, dynamic> json) => _$ContentInspectConfigFromJson(json); - Map<String, dynamic> toJson() => _$ContentInspectConfigToJson(this); + Map<String, dynamic> toJson() => _$ContentInspectConfigToJson(this); } -

                                    +

                                    Parameters @@ -114,15 +114,15 @@ modules -

                                    Functional module. See .

                                    -

                                    A maximum of 32 instances can be configured, and the value range of MAX_CONTENT_INSPECT_MODULE_COUNT is an integer in [1,32].

                                    +

                                    Functional module. See .

                                    +

                                    A maximum of 32 instances can be configured, and the value range of MAX_CONTENT_INSPECT_MODULE_COUNT is an integer in [1,32].

                                    A function module can only be configured with one instance at most. Currently only the video screenshot and upload function is supported.                                     moduleCount - The number of functional modules, that is,the number of configured instances, must be the same as the number of instances configured in modules. The maximum number is 32. + The number of functional modules, that is,the number of configured instances, must be the same as the number of instances configured in modules. The maximum number is 32.
                                    -                                     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita b/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita index 85f7dbb2011..904bf6cd0bc 100644 --- a/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita +++ b/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita @@ -1,8 +1,8 @@ - <ph keyref="ContentInspectModule"/> - A structure used to configure the frequency of video screenshot and upload. + <ph keyref="ContentInspectModule" /> + A structure used to configure the frequency of video screenshot and upload.

                                    @@ -56,24 +56,24 @@ final ContentInspectType? type; @JsonKey(name: 'interval') final int? interval; - factory ContentInspectModule.fromJson(Map<String, dynamic> json) => + factory ContentInspectModule.fromJson(Map<String, dynamic> json) => _$ContentInspectModuleFromJson(json); - Map<String, dynamic> toJson() => _$ContentInspectModuleToJson(this); + Map<String, dynamic> toJson() => _$ContentInspectModuleToJson(this); } -

                                    +

                                    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> type - Types of functional module. See . + Types of functional module. See .

                                    Types of functional modules:

                                      -
                                    • (0): (Default) This module has no actual function. Do not set to this value.
                                      • -
                                    • (1): Video content moderation. SDK takes screenshots, inspects video content of the video stream in the channel, and uploads the screenshots and moderation results.
                                      • -
                                    • (2): Video screenshot and upload. SDK takes screenshots of the video stream in the channel and uploads them.
                                      • +
                                    • (0): (Default) This module has no actual function. Do not set to this value.
                                      • +
                                    • (1): Video content moderation. SDK takes screenshots, inspects video content of the video stream in the channel, and uploads the screenshots and moderation results.
                                      • +
                                    • (2): Video screenshot and upload. SDK takes screenshots of the video stream in the channel and uploads them.

                                                                         @@ -83,4 +83,4 @@
                                    -                                     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita b/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita index 88df0d8fff4..27a2da09949 100644 --- a/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita +++ b/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita @@ -299,12 +299,12 @@ @JsonKey(name: 'streamType') final VideoStreamType? streamType; - factory EncodedVideoFrameInfo.fromJson(Map<String, dynamic> json) => + factory EncodedVideoFrameInfo.fromJson(Map<String, dynamic> json) => _$EncodedVideoFrameInfoFromJson(json); - Map<String, dynamic> toJson() => _$EncodedVideoFrameInfoToJson(this); + Map<String, dynamic> toJson() => _$EncodedVideoFrameInfoToJson(this); } -

                                    +

                                    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -313,9 +313,9 @@ codecType The codec type of the local video stream. See . The default value is (2).

                                    The codec type of the video:

                                      -
                                    • (1): VP8.
                                      • -
                                    • (2): (Default) H.264.
                                      • -
                                    • (3): H.265.
                                      • +
                                    • (1): VP8.
                                      • +
                                    • (2): (Default) H.264.
                                      • +
                                    • (3): H.265.

                                     @@ -373,7 +373,7 @@ streamType - The type of video streams. See . + The type of video streams. See .
                                    • (0): High-quality stream, that is, a high-resolution and high-bitrate video stream.
                                      • @@ -382,4 +382,4 @@
                                    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_externalvideoframe.dita b/en-US/dita/RTC-NG/API/class_externalvideoframe.dita index 31adf2e2520..2ff2563eb68 100644 --- a/en-US/dita/RTC-NG/API/class_externalvideoframe.dita +++ b/en-US/dita/RTC-NG/API/class_externalvideoframe.dita @@ -250,7 +250,7 @@ final int? textureId; @JsonKey(name: 'matrix') - final List<double>? matrix; + final List<double>? matrix; @JsonKey(name: 'metadata_buffer', ignore: true) final Uint8List? metadataBuffer; @@ -258,12 +258,12 @@ @JsonKey(name: 'metadata_size') final int? metadataSize; - factory ExternalVideoFrame.fromJson(Map<String, dynamic> json) => + factory ExternalVideoFrame.fromJson(Map<String, dynamic> json) => _$ExternalVideoFrameFromJson(json); - Map<String, dynamic> toJson() => _$ExternalVideoFrameToJson(this); + Map<String, dynamic> toJson() => _$ExternalVideoFrameToJson(this); }                                     -

                                    +

                                    diff --git a/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita b/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita index fc70daee84d..3155ea39a73 100644 --- a/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita +++ b/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita @@ -143,7 +143,7 @@ _$InjectStreamConfigFromJson(json); Map<String, dynamic> toJson() => _$InjectStreamConfigToJson(this); } -

                                    +

                                    diff --git a/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita b/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita index 8b715da6ff4..08dea2cba91 100644 --- a/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita @@ -1,24 +1,24 @@ - <ph keyref="LocalTranscoderConfiguration"/> + <ph keyref="LocalTranscoderConfiguration" /> The configuration of the video mixing on the local client.

                                    public class LocalTranscoderConfiguration { - public ArrayList<TranscodingVideoStream> transcodingVideoStreams; + public ArrayList<TranscodingVideoStream> transcodingVideoStreams; public VideoEncoderConfiguration videoOutputConfiguration; public LocalTranscoderConfiguration() { - transcodingVideoStreams = new ArrayList<TranscodingVideoStream>(); + transcodingVideoStreams = new ArrayList<TranscodingVideoStream>(); videoOutputConfiguration = new VideoEncoderConfiguration(); } } __attribute__((visibility("default"))) @interface AgoraLocalTranscoderConfiguration: NSObject -@property(copy, nonatomic) NSArray<AgoraTranscodingVideoStream *> *_Nullable videoInputStreams; +@property(copy, nonatomic) NSArray<AgoraTranscodingVideoStream *> *_Nullable videoInputStreams; @property (strong, nonatomic) AgoraVideoEncoderConfiguration *_Nonnull videoOutputConfiguration; @@ -68,19 +68,19 @@ class LocalTranscoderConfiguration { final int? streamCount; @JsonKey(name: 'videoInputStreams') - final List<TranscodingVideoStream>? videoInputStreams; + final List<TranscodingVideoStream>? videoInputStreams; @JsonKey(name: 'videoOutputConfiguration') final VideoEncoderConfiguration? videoOutputConfiguration; - factory LocalTranscoderConfiguration.fromJson(Map<String, dynamic> json) => + factory LocalTranscoderConfiguration.fromJson(Map<String, dynamic> json) => _$LocalTranscoderConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$LocalTranscoderConfigurationToJson(this); + Map<String, dynamic> toJson() => _$LocalTranscoderConfigurationToJson(this); }

                                    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> streamCount @@ -89,12 +89,12 @@ class LocalTranscoderConfiguration { videoInputStreams transcodingVideoStreams - The video streams for local video mixing. See . + The video streams for local video mixing. See . videoOutputConfiguration - The encoding configuration of the mixed video stream after the local video mixing. See . + The encoding configuration of the mixed video stream after the local video mixing. See .
                                    -                                     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_localvideostats.dita b/en-US/dita/RTC-NG/API/class_localvideostats.dita index d12919e56c3..eb327156492 100644 --- a/en-US/dita/RTC-NG/API/class_localvideostats.dita +++ b/en-US/dita/RTC-NG/API/class_localvideostats.dita @@ -1,7 +1,7 @@ - <ph keyref="LocalVideoStats"/> + <ph keyref="LocalVideoStats" /> The statistics of the local video stream.
                                    @@ -296,15 +296,15 @@ @JsonKey(name: 'hwEncoderAccelerating') final int? hwEncoderAccelerating; - factory LocalVideoStats.fromJson(Map<String, dynamic> json) => + factory LocalVideoStats.fromJson(Map<String, dynamic> json) => _$LocalVideoStatsFromJson(json); - Map<String, dynamic> toJson() => _$LocalVideoStatsToJson(this); + Map<String, dynamic> toJson() => _$LocalVideoStatsToJson(this); } -

                                    +

                                    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> uid @@ -362,11 +362,11 @@ qualityAdaptIndication - The quality adaptation of the local video stream in the reported interval (based on the target frame rate and target bitrate). See .

                                    + The quality adaptation of the local video stream in the reported interval (based on the target frame rate and target bitrate). See .

                                      -
                                    • (0): The local video quality stays the same.
                                      • -
                                    • (1): The local video quality improves because the network bandwidth increases.
                                      • -
                                    • (2): The local video quality deteriorates because the network bandwidth decreases.
                                      • +
                                    • (0): The local video quality stays the same.
                                      • +
                                    • (1): The local video quality improves because the network bandwidth increases.
                                      • +
                                    • (2): The local video quality deteriorates because the network bandwidth decreases.

                                                                         @@ -390,11 +390,11 @@ codecType - The codec type of the local video. See .

                                    + The codec type of the local video. See .

                                      -
                                    • (1): VP8.
                                      • -
                                    • (2): (Default) H.264.
                                      • -
                                    • (3): H.265.
                                      • +
                                    • (1): VP8.
                                      • +
                                    • (2): (Default) H.264.
                                      • +
                                    • (3): H.265.

                                                                         @@ -408,24 +408,24 @@ captureBrightnessLevel - The brightness level of the video image captured by the local camera. See . + The brightness level of the video image captured by the local camera. See . captureBrightnessLevel The brightness level of the video image captured by the local camera.
                                      -
                                    • (-1): The SDK does not detect the brightness level of the video image. Wait a few seconds to get the brightness level from captureBrightnessLevel in the next callback.
                                      • -
                                    • (0): The brightness level of the video image is normal.
                                      • -
                                    • (1): The brightness level of the video image is too bright.
                                      • -
                                    • (2): The brightness level of the video image is too dark.
                                      • +
                                    • (-1): The SDK does not detect the brightness level of the video image. Wait a few seconds to get the brightness level from captureBrightnessLevel in the next callback.
                                      • +
                                    • (0): The brightness level of the video image is normal.
                                      • +
                                    • (1): The brightness level of the video image is too bright.
                                      • +
                                    • (2): The brightness level of the video image is too dark.
                                                                         hwEncoderAccelerating - The local video encoding acceleration type. See .
                                      + The local video encoding acceleration type. See .
                                      • 0: Software encoding is applied without acceleration.
                                      • 1: Hardware encoding is applied for acceleration.
                                    -                                     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita b/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita index fc624f4f4f9..2c97d0962a9 100644 --- a/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita @@ -93,12 +93,12 @@ @JsonKey(name: 'recorderInfoUpdateInterval') final int? recorderInfoUpdateInterval; - factory MediaRecorderConfiguration.fromJson(Map<String, dynamic> json) => + factory MediaRecorderConfiguration.fromJson(Map<String, dynamic> json) => _$MediaRecorderConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$MediaRecorderConfigurationToJson(this); + Map<String, dynamic> toJson() => _$MediaRecorderConfigurationToJson(this); }                                     -

                                    +

                                    @@ -109,10 +109,10 @@ storagePath The absolute path (including the filename extensions) of the recording file. For example:

                                      -
                                    • Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.mp4
                                      • +
                                    • Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.mp4
                                    • iOS: /App Sandbox/Library/Caches/example.mp4
                                    • macOS: ～/Library/Logs/example.mp4
                                      • -
                                    • Android: /storage/emulated/0/Android/data/<package name>/files/agorasdk.mp4
                                      • +
                                    • Android: /storage/emulated/0/Android/data/<package name>/files/agorasdk.mp4
                                    Ensure that the directory for the log files exists and is writable. @@ -123,7 +123,7 @@ streamType - The recording content. See . + The recording content. See . The recording content:
                                    • : Only audio.
                                    • : Only video.
                                      • @@ -140,4 +140,4 @@
                                    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_mediasource.dita b/en-US/dita/RTC-NG/API/class_mediasource.dita index 263f15fd6fb..4ec014d350d 100644 --- a/en-US/dita/RTC-NG/API/class_mediasource.dita +++ b/en-US/dita/RTC-NG/API/class_mediasource.dita @@ -1,7 +1,7 @@ - <ph keyref="MediaSource"/> + <ph keyref="MediaSource" /> Information related to the media file to be played and the playback scenario configurations.
                                    @@ -134,12 +134,12 @@ @JsonKey(name: 'isLiveSource') final bool? isLiveSource; - factory MediaSource.fromJson(Map<String, dynamic> json) => + factory MediaSource.fromJson(Map<String, dynamic> json) => _$MediaSourceFromJson(json); - Map<String, dynamic> toJson() => _$MediaSourceToJson(this); + Map<String, dynamic> toJson() => _$MediaSourceToJson(this); } -

                                    +

                                    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -207,7 +207,7 @@ provider -

                                    The callback for custom media resource files. See .

                                    +

                                    The callback for custom media resource files. See .

                                    If you open a custom media resource, pass in the value to provider. If you open a common media resource, pass in the value to url. Agora recommends that you do not pass in values to both url and provider in one call; otherwise, this call may fail.

                                     @@ -216,19 +216,19 @@ playerOnReadCallback -

                                    Occurs when the SDK reads the media resource data. See .

                                    +

                                    Occurs when the SDK reads the media resource data. See .

                                    -

                                    +

                                    playerOnSeekCallback -

                                    Occurs when the SDK seeks the media resource data. See .

                                    +

                                    Occurs when the SDK seeks the media resource data. See .

                                     -                                     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita b/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita index ca7884ea02e..9ba243c3685 100644 --- a/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita +++ b/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita @@ -260,10 +260,10 @@ @JsonKey(name: 'qualityChangedReason') final int? qualityChangedReason; - factory RemoteAudioStats.fromJson(Map<String, dynamic> json) => + factory RemoteAudioStats.fromJson(Map<String, dynamic> json) => _$RemoteAudioStatsFromJson(json); - Map<String, dynamic> toJson() => _$RemoteAudioStatsToJson(this); + Map<String, dynamic> toJson() => _$RemoteAudioStatsToJson(this); }

                                    diff --git a/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita b/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita index b9a6b03d108..ab51e60901e 100644 --- a/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita +++ b/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita @@ -1,8 +1,8 @@ - <ph keyref="RtcEngineConfig"/> - Configurations for the instance. + <ph keyref="RtcEngineConfig" /> + Configurations for the instance.

                                    @@ -214,25 +214,25 @@ class RtcEngineContext { @JsonKey(name: 'autoRegisterAgoraExtensions') final bool? autoRegisterAgoraExtensions; - factory RtcEngineContext.fromJson(Map<String, dynamic> json) => + factory RtcEngineContext.fromJson(Map<String, dynamic> json) => _$RtcEngineContextFromJson(json); - Map<String, dynamic> toJson() => _$RtcEngineContextToJson(this); + Map<String, dynamic> toJson() => _$RtcEngineContextToJson(this); } -

                                    +

                                    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> eventHandler mEventHandler - The event handler for . See . + The event handler for . See . appId mAppId - The App ID issued by Agora for your project. Only users in apps with the same App ID can join the same channel and communicate with each other. An App ID can only be used to create one instance. To change your App ID, call to destroy the current instance, and then create a new one. + The App ID issued by Agora for your project. Only users in apps with the same App ID can join the same channel and communicate with each other. An App ID can only be used to create one instance. To change your App ID, call to destroy the current instance, and then create a new one. context @@ -256,33 +256,33 @@ class RtcEngineContext {
                                    • This method is applicable when you integrate the SDK manually but not when you integrate the SDK with Maven Central or JitPack.
                                      • -
                                    • Ensure the specified directory exists; otherwise, the initialization fails.
                                      • +
                                    • Ensure the specified directory exists; otherwise, the initialization fails.
                                                                         channelProfile mChannelProfile - + audioScenario mAudioScenario - + areaCode mAreaCode - The region for connection. This is an advanced feature and applies to scenarios that have regional restrictions. For details on supported regions, see . The area codes support bitwise operation. + The region for connection. This is an advanced feature and applies to scenarios that have regional restrictions. For details on supported regions, see . The area codes support bitwise operation. After specifying the region, the app integrated with the Agora SDK connects to the Agora servers within that region. logConfig mLogConfig -

                                    Sets the log file size. See .

                                    +

                                    Sets the log file size. See .

                                    By default, the SDK generates five SDK log files and five API call log files with the following rules:

                                      -
                                    • +
                                    @@ -292,19 +292,19 @@ class RtcEngineContext { mExtensionObserver eventDelegate - The instance. + The instance. mediaFilterExtensions - The instance. + The instance. mDomainLimit domainLimit

                                    Whether to enable domain name restriction:

                                      -
                                    • : Enables the domain name restriction. This value is suitable for scenarios where IoT devices use IoT cards for network access. The SDK will only connect to servers in the domain name or IP whitelist that has been reported to the operator.
                                      • -
                                    • : (Default) Disables the domain name restriction. This value is suitable for most common scenarios.
                                      • +
                                    • : Enables the domain name restriction. This value is suitable for scenarios where IoT devices use IoT cards for network access. The SDK will only connect to servers in the domain name or IP whitelist that has been reported to the operator.
                                      • +
                                    • : (Default) Disables the domain name restriction. This value is suitable for most common scenarios.

                                                                         @@ -312,9 +312,9 @@ class RtcEngineContext { mAutoRegisterAgoraExtensions autoRegisterAgoraExtensions -

                                    Whether to automatically register the Agora extensions when initializing :

                                      -
                                    • : (Default) Automatically register the Agora extensions when initializing .
                                      • -
                                    • : Do not register the Agora extensions when initializing . You need to call to register the Agora extensions.
                                      • +

                                      Whether to automatically register the Agora extensions when initializing :

                                        +
                                      • : (Default) Automatically register the Agora extensions when initializing .
                                        • +
                                      • : Do not register the Agora extensions when initializing . You need to call to register the Agora extensions.

                                      @@ -324,9 +324,9 @@ class RtcEngineContext { addExtension - Adds the extension. See . + Adds the extension. See .
                                    -                                     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita index c2679fdef21..69b59fa2f61 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita @@ -1,12 +1,12 @@ - <ph keyref="ScreenCaptureParameters"/> + <ph keyref="ScreenCaptureParameters" /> Screen sharing configurations.

                                    - + __attribute__((visibility("default"))) @interface AgoraScreenCaptureParameters: NSObject @property (assign, nonatomic) CGSize dimensions; @property (assign, nonatomic) NSInteger frameRate; @@ -206,7 +206,7 @@ final bool? windowFocus; @JsonKey(name: 'excludeWindowList') - final List<int>? excludeWindowList; + final List<int>? excludeWindowList; @JsonKey(name: 'excludeWindowCount') final int? excludeWindowCount; @@ -220,21 +220,21 @@ @JsonKey(name: 'enableHighLight') final bool? enableHighLight; - factory ScreenCaptureParameters.fromJson(Map<String, dynamic> json) => + factory ScreenCaptureParameters.fromJson(Map<String, dynamic> json) => _$ScreenCaptureParametersFromJson(json); - Map<String, dynamic> toJson() => _$ScreenCaptureParametersToJson(this); + Map<String, dynamic> toJson() => _$ScreenCaptureParametersToJson(this); } -

                                    +

                                    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> - The video profiles of the shared screen stream are only set by , independent of . + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + The video profiles of the shared screen stream are only set by , independent of . dimensions -

                                    The video encoding resolution of the shared screen stream. See . The default value is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges.

                                    +

                                    The video encoding resolution of the shared screen stream. See . The default value is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges.

                                    If the screen dimensions are different from the value of this parameter, Agora applies the following strategies for encoding. Suppose dimensions is set to 1920 × 1080:

                                    • If the value of the screen dimensions is lower than that of dimensions, for example, 1000 × 1000 pixels, the SDK uses the screen dimensions, that is, 1000 × 1000 pixels, for encoding.
                                    • If the value of the screen dimensions is higher than that of dimensions, for example, 2000 × 1500, the SDK uses the maximum value under dimensions with the aspect ratio of the screen dimension (4:3) for encoding, that is, 1440 × 1080.
                                      • @@ -253,32 +253,32 @@ captureMouseCursor

                                      Whether to capture the mouse in screen sharing:

                                        -
                                      • : (Default) Capture the mouse.
                                        • -
                                      • : Do not capture the mouse.
                                        • +
                                      • : (Default) Capture the mouse.
                                        • +
                                      • : Do not capture the mouse.

                                       windowFocus -

                                      Whether to bring the window to the front when calling the method to share it:

                                        -
                                      • : Bring the window to the front.
                                        • -
                                      • : (Default) Do not bring the window to the front.
                                        • +

                                        Whether to bring the window to the front when calling the method to share it:

                                          +
                                        • : Bring the window to the front.
                                          • +
                                        • : (Default) Do not bring the window to the front.

                                        excludeWindowList - The ID list of the windows to be blocked. When calling to start screen sharing, you can use this parameter to block a specified window. When calling to update screen sharing configurations, you can use this parameter to dynamically block a specified window. + The ID list of the windows to be blocked. When calling to start screen sharing, you can use this parameter to block a specified window. When calling to update screen sharing configurations, you can use this parameter to dynamically block a specified window. highLighted enableHighLight (For macOS and Windows only) Whether to place a border around the shared window or screen:
                                          -
                                        • : Place a border.
                                          • -
                                        • : (Default) Do not place a border.
                                          • +
                                        • : Place a border.
                                          • +
                                        • : (Default) Do not place a border.
                                        - When you share a part of a window or screen, the SDK places a border around the entire window or screen if you set this parameter to .                                         + When you share a part of a window or screen, the SDK places a border around the entire window or screen if you set this parameter to .                                         highLightColor @@ -288,7 +288,7 @@ highLightWidth - (For macOS and Windows only) The width (px) of the border. The default value is 5, and the value range is (0, 50].This parameter only takes effect when highLighted is set to . + (For macOS and Windows only) The width (px) of the border. The default value is 5, and the value range is (0, 50].This parameter only takes effect when highLighted is set to . excludeWindowCount @@ -297,4 +297,4 @@
                                    -                                     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita index 4a86e5cbd24..a18bcc92859 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita @@ -1,7 +1,7 @@ - <ph keyref="ScreenCaptureParameters2"/> + <ph keyref="ScreenCaptureParameters2" /> Screen sharing configurations.
                                    @@ -169,58 +169,58 @@ @JsonKey(name: 'videoParams') final ScreenVideoParameters? videoParams; - factory ScreenCaptureParameters2.fromJson(Map<String, dynamic> json) => + factory ScreenCaptureParameters2.fromJson(Map<String, dynamic> json) => _$ScreenCaptureParameters2FromJson(json); - Map<String, dynamic> toJson() => _$ScreenCaptureParameters2ToJson(this); + Map<String, dynamic> toJson() => _$ScreenCaptureParameters2ToJson(this); } -

                                    +

                                    -

                                    +

                                    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> captureAudio Determines whether to capture system audio during screen sharing:
                                      -
                                    • : Capture system audio.
                                      • -
                                    • : (Default) Do not capture system audio.
                                      • +
                                    • : Capture system audio.
                                      • +
                                    • : (Default) Do not capture system audio.
                                    • Due to system limitations, capturing system audio is only applicable to Android API level 29 and later (that is, Android 10 and later).
                                      • -
                                    • To improve the success rate of capturing system audio during screen sharing, ensure that you have called the method and set the audio scenario to .
                                     +
                                  • To improve the success rate of capturing system audio during screen sharing, ensure that you have called the method and set the audio scenario to .
                                                                     audioParams - The audio configuration for the shared screen stream. See .This parameter only takes effect when captureAudio is . + The audio configuration for the shared screen stream. See .This parameter only takes effect when captureAudio is . captureVideo Whether to capture the screen when screen sharing:
                                    -
                                  • : (Default) Capture the screen.
                                    • -
                                  • : Do not capture the screen.
                                    • +
                                  • : (Default) Capture the screen.
                                    • +
                                  • : Do not capture the screen.
                                  Due to system limitations, the capture screen is only applicable to Android API level 21 and above, that is, Android 5 and above.                                                                     videoParams - The video configuration for the shared screen stream. See .This parameter only takes effect when captureVideo is . + The video configuration for the shared screen stream. See .This parameter only takes effect when captureVideo is .
                                  Subclass - - The video configuration for the shared screen stream. See . + + The video configuration for the shared screen stream. See . - - The audio configuration for the shared screen stream. See . + + The audio configuration for the shared screen stream. See .
                                  - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita index 25dee9d51ac..3a61c206403 100644 --- a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita +++ b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita @@ -1,12 +1,12 @@ - <ph keyref="ScreenCaptureSourceInfo"/> - The information about the specified shareable window or screen. The information is returned in . + <ph keyref="ScreenCaptureSourceInfo" /> + The information about the specified shareable window or screen. The information is returned in .

                                  - + __attribute__((visibility("default"))) @interface AgoraScreenCaptureSourceInfo : NSObject @property(assign, nonatomic) AgoraScreenCaptureSourceType type; @property(assign, nonatomic) CGWindowID sourceId; @@ -76,7 +76,7 @@ public Rectangle position; public view_t sourceDisplayId; }; - + class ScreenCaptureSourceInfo { const ScreenCaptureSourceInfo( {this.type, @@ -124,19 +124,19 @@ @JsonKey(name: 'sourceDisplayId') final int? sourceDisplayId; - factory ScreenCaptureSourceInfo.fromJson(Map<String, dynamic> json) => + factory ScreenCaptureSourceInfo.fromJson(Map<String, dynamic> json) => _$ScreenCaptureSourceInfoFromJson(json); - Map<String, dynamic> toJson() => _$ScreenCaptureSourceInfoToJson(this); + Map<String, dynamic> toJson() => _$ScreenCaptureSourceInfoToJson(this); } -

                                  +

                                  - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> type - The type of the shared target. See . + The type of the shared target. See . sourceId @@ -148,11 +148,11 @@ thumbImage - The image content of the thumbnail. See . + The image content of the thumbnail. See . iconImage - The image content of the icon. See . + The image content of the icon. See . processPath @@ -165,19 +165,19 @@ primaryMonitor Determines whether the screen is the primary display:
                                    -
                                  • : The screen is the primary display.
                                    • -
                                  • : The screen is not the primary display.
                                    • +
                                  • : The screen is the primary display.
                                    • +
                                  • : The screen is not the primary display.
                                                                     position - The position of a window relative to the entire screen space (including all shareable screens). See . See . + The position of a window relative to the entire screen space (including all shareable screens). See . See . minimizeWindow (For Windows only) Whether the window is minimized:
                                    -
                                  • : The window is minimized.
                                    • -
                                  • : The window is not minimized.
                                    • +
                                  • : The window is minimized.
                                    • +
                                  • : The window is not minimized.
                                                                     @@ -186,4 +186,4 @@
                                  -                                   + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita b/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita index 4cc9bbcfb2a..2600281b31e 100644 --- a/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita +++ b/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita @@ -77,7 +77,7 @@ dimensions - The video dimension. See . The default value is 160 × 120. + The video dimension. See . The default value is 160 × 120. bitrate diff --git a/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita b/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita index d1aef3abb2a..365d0624ba1 100644 --- a/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita +++ b/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita @@ -1,7 +1,7 @@ - <ph keyref="TranscodingVideoStream"/> + <ph keyref="TranscodingVideoStream" /> The video streams for local video mixing.
                                  @@ -176,18 +176,18 @@ class TranscodingVideoStream { @JsonKey(name: 'mirror') final bool? mirror; - factory TranscodingVideoStream.fromJson(Map<String, dynamic> json) => + factory TranscodingVideoStream.fromJson(Map<String, dynamic> json) => _$TranscodingVideoStreamFromJson(json); - Map<String, dynamic> toJson() => _$TranscodingVideoStreamToJson(this); + Map<String, dynamic> toJson() => _$TranscodingVideoStreamToJson(this); }

                                  - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> sourceType - The video source type for local video mixing. See . + The video source type for local video mixing. See . remoteUserUid @@ -203,7 +203,7 @@ class TranscodingVideoStream { mediaPlayerId - (Optional) Media player ID. Use the parameter only when you set sourceType to . + (Optional) Media player ID. Use the parameter only when you set sourceType to . x @@ -246,4 +246,4 @@ class TranscodingVideoStream {
                                  -                                   + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita b/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita index c6f70b2f032..833ab49b07a 100644 --- a/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita +++ b/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita @@ -53,7 +53,7 @@ _$UserAudioSpectrumInfoFromJson(json); Map<String, dynamic> toJson() => _$UserAudioSpectrumInfoToJson(this); } -

                                  +

                                  <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> diff --git a/en-US/dita/RTC-NG/API/class_videocanvas.dita b/en-US/dita/RTC-NG/API/class_videocanvas.dita index 2b0fe9185f2..2c4c0b2f244 100644 --- a/en-US/dita/RTC-NG/API/class_videocanvas.dita +++ b/en-US/dita/RTC-NG/API/class_videocanvas.dita @@ -1,7 +1,7 @@ - <ph keyref="VideoCanvas"/> + <ph keyref="VideoCanvas" /> Attributes of the video canvas object.
                                  @@ -173,16 +173,16 @@ class VideoCanvas { @JsonKey(name: 'enableAlphaMask') final bool? enableAlphaMask; - factory VideoCanvas.fromJson(Map<String, dynamic> json) => + factory VideoCanvas.fromJson(Map<String, dynamic> json) => _$VideoCanvasFromJson(json); - Map<String, dynamic> toJson() => _$VideoCanvasToJson(this); + Map<String, dynamic> toJson() => _$VideoCanvasToJson(this); } -

                                  +

                                  - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> view @@ -193,16 +193,16 @@ class VideoCanvas { renderMode - The rendering mode of the video. See . -
                                  + The rendering mode of the video. See . +
                                  mirrorMode -

                                  The mirror mode of the view. See .

                                  +

                                  The mirror mode of the view. See .

                                    -
                                  • +

                                    @@ -216,7 +216,7 @@ class VideoCanvas { sourceType - The type of the video source. See . + The type of the video source. See . sourceId @@ -224,29 +224,29 @@ class VideoCanvas { setupMode - Setting mode of the view. See . + Setting mode of the view. See . Setting mode of the view.
                                      -
                                    • (0): (Default) Replaces a view.
                                      • -
                                    • (1): Adds a view.
                                      • -
                                    • (2): Deletes a view.
                                      • +
                                    • (0): (Default) Replaces a view.
                                      • +
                                    • (1): Adds a view.
                                      • +
                                    • (2): Deletes a view.
                                                                         mediaPlayerId - The ID of the media player. You can get the Device ID by calling . - This parameter is required when sourceType is . + The ID of the media player. You can get the Device ID by calling . + This parameter is required when sourceType is . rect - (Optional) Display area for the video frame. See . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. + (Optional) Display area for the video frame. See . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. cropArea - (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. + (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. cropArea - (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. + (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. backgroundColor @@ -256,15 +256,15 @@ class VideoCanvas { enableAlphaMask

                                    (Optional) Whether the receiver enables alpha mask rendering:

                                      -
                                    • : The receiver enables alpha mask rendering.
                                      • -
                                    • : (default) The receiver disables alpha mask rendering.
                                      • +
                                    • : The receiver enables alpha mask rendering.
                                      • +
                                    • : (default) The receiver disables alpha mask rendering.

                                    Alpha mask rendering can create images with transparent effects and extract portraits from videos. When used in combination with other methods, you can implement effects such as picture-in-picture and watermarking.

                                    -
                                    • This property applies to macOS only.
                                    • The receiver can render alpha channel information only when the sender enables alpha transmission.
                                    • To enable alpha transmission, .
                                     +
                                    • This property applies to macOS only.
                                    • The receiver can render alpha channel information only when the sender enables alpha transmission.
                                    • To enable alpha transmission, .
                                                                         Reserved.
                                  -                                   + \ 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 38f171073ff..27e4258ec93 100644 --- a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita @@ -278,21 +278,21 @@ advanceOptions(PREFER_AUTO) {} }; export class VideoEncoderConfiguration { - + codecType?: VideoCodecType; - + dimensions?: VideoDimensions; - + frameRate?: number; - + bitrate?: number; - + minBitrate?: number; - + orientationMode?: OrientationMode; - + degradationPreference?: DegradationPreference; - + mirrorMode?: VideoMirrorModeType; advanceOptions?: AdvanceOptions; @@ -362,21 +362,21 @@ } }; export class VideoEncoderConfiguration { - + codecType?: VideoCodecType; - + dimensions?: VideoDimensions; - + frameRate?: number; - + bitrate?: number; - + minBitrate?: number; - + orientationMode?: OrientationMode; - + degradationPreference?: DegradationPreference; - + mirrorMode?: VideoMirrorModeType; advanceOptions?: AdvanceOptions; @@ -424,7 +424,7 @@ _$VideoEncoderConfigurationFromJson(json); Map<String, dynamic> toJson() => _$VideoEncoderConfigurationToJson(this); -} +}

                                  diff --git a/en-US/dita/RTC-NG/API/class_videoframe.dita b/en-US/dita/RTC-NG/API/class_videoframe.dita index bf7432a5660..57f7c9cb49c 100644 --- a/en-US/dita/RTC-NG/API/class_videoframe.dita +++ b/en-US/dita/RTC-NG/API/class_videoframe.dita @@ -1,7 +1,7 @@ - <ph keyref="VideoFrame"/> + <ph keyref="VideoFrame" /> Configurations of the video frame.
                                  @@ -476,28 +476,28 @@ class VideoFrame { final int? textureId; @JsonKey(name: 'matrix') - final List<double>? matrix; + final List<double>? matrix; @JsonKey(name: 'pixelBuffer', ignore: true) final Uint8List? pixelBuffer; - factory VideoFrame.fromJson(Map<String, dynamic> json) => + factory VideoFrame.fromJson(Map<String, dynamic> json) => _$VideoFrameFromJson(json); - Map<String, dynamic> toJson() => _$VideoFrameToJson(this); + Map<String, dynamic> toJson() => _$VideoFrameToJson(this); } -

                                  +

                                  Note that the buffer provides a pointer to a pointer. This interface cannot modify the pointer of the buffer, but it can modify the content of the buffer.

                                  - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> type - The pixel format. See . - + The pixel format. See . + width @@ -602,7 +602,7 @@ class VideoFrame { colorSpace - The color space of a video frame. See . + The color space of a video frame. See . sourceType @@ -620,9 +620,9 @@ class VideoFrame { alphaBuffer

                                  Indicates the alpha channel data output by the portrait segmentation algorithm, which is consistent with the size of the video frame. The value range of each pixel is [0,255], where 0 represents the background; 255 represents the foreground (portrait).

                                  -

                                  In the costom video renderer scenario, you can use this parameter to render the video background into various effects, such as: transparent, solid color, picture, video and so on.To use this parameter, contact .

                                  +

                                  In the costom video renderer scenario, you can use this parameter to render the video background into various effects, such as: transparent, solid color, picture, video and so on.To use this parameter, contact .
                                  -                                   + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita b/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita index a0243b3aebd..7f737d56534 100644 --- a/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita +++ b/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="VideoSubscriptionOptions"/> + <ph keyref="VideoSubscriptionOptions" /> Video subscription options.
                                  @@ -48,8 +48,8 @@ @end struct VideoSubscriptionOptions { - Optional<VIDEO_STREAM_TYPE> type; - Optional<bool> encodedFrameOnly; + Optional<VIDEO_STREAM_TYPE> type; + Optional<bool> encodedFrameOnly; VideoSubscriptionOptions() {} }; @@ -61,9 +61,9 @@ } public class VideoSubscriptionOptions:OptionalJsonParse { - public Optional<VIDEO_STREAM_TYPE> type = new Optional<VIDEO_STREAM_TYPE>(); + public Optional<VIDEO_STREAM_TYPE> type = new Optional<VIDEO_STREAM_TYPE>(); - public Optional<bool> encodedFrameOnly = new Optional<bool>(); + public Optional<bool> encodedFrameOnly = new Optional<bool>(); } export class VideoSubscriptionOptions { @@ -80,33 +80,33 @@ @JsonKey(name: 'encodedFrameOnly') final bool? encodedFrameOnly; - factory VideoSubscriptionOptions.fromJson(Map<String, dynamic> json) => + factory VideoSubscriptionOptions.fromJson(Map<String, dynamic> json) => _$VideoSubscriptionOptionsFromJson(json); - Map<String, dynamic> toJson() => _$VideoSubscriptionOptionsToJson(this); + Map<String, dynamic> toJson() => _$VideoSubscriptionOptionsToJson(this); } -

                                  +

                                  - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> streamType type - The video stream type that you want to subscribe to. The default value is , indicating that the high-quality video streams are subscribed. See . + The video stream type that you want to subscribe to. The default value is , indicating that the high-quality video streams are subscribed. See . The video stream type that you want to subscribe to:
                                    -
                                  • (0): (Default) High-quality video stream, that is, a high-resolution, high-bit-rate video stream.
                                    • -
                                  • (1): Low-quality stream, that is, a low-resolution, low-bitrate video stream.
                                    • +
                                  • (0): (Default) High-quality video stream, that is, a high-resolution, high-bit-rate video stream.
                                    • +
                                  • (1): Low-quality stream, that is, a low-resolution, low-bitrate video stream.
                                                                     encodedFrameOnly Whether to subscribe to encoded video frames only:
                                    -
                                  • : Subscribe to the encoded video data (structured data) only; the SDK does not decode or render raw video data.
                                    • -
                                  • : (Default) Subscribe to both raw video data and encoded video data.
                                    • +
                                  • : Subscribe to the encoded video data (structured data) only; the SDK does not decode or render raw video data.
                                    • +
                                  • : (Default) Subscribe to both raw video data and encoded video data.
                                  -                                   + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_watermarkoptions.dita b/en-US/dita/RTC-NG/API/class_watermarkoptions.dita index 7cbc3b7b40b..266d766b6b0 100644 --- a/en-US/dita/RTC-NG/API/class_watermarkoptions.dita +++ b/en-US/dita/RTC-NG/API/class_watermarkoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="WatermarkOptions"/> + <ph keyref="WatermarkOptions" /> Configurations of the watermark image.
                                  @@ -121,13 +121,13 @@ _$WatermarkOptionsFromJson(json); Map<String, dynamic> toJson() => _$WatermarkOptionsToJson(this); } -

                                  +

                                  -

                                  +

                                  - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> visibleInPreview @@ -135,8 +135,8 @@ positionInLandscapeMode - The area to display the watermark image in landscape mode. See . - When the adaptation mode of the watermark is , it is used to set the area of the watermark image in landscape mode. See . + The area to display the watermark image in landscape mode. See . + When the adaptation mode of the watermark is , it is used to set the area of the watermark image in landscape mode. See . The area to display the watermark image in landscape mode. This parameter contains the following members:
                                  • x: The horizontal position of the watermark relative to the upper left corner.
                                  • y: The vertical position of the watermark relative to the upper left corner.
                                    • @@ -146,8 +146,8 @@ positionInPortraitMode - The area to display the watermark image in portrait mode. See . - When the adaptation mode of the watermark is , it is used to set the area of the watermark image in portrait mode. See . + The area to display the watermark image in portrait mode. See . + When the adaptation mode of the watermark is , it is used to set the area of the watermark image in portrait mode. See . The area to display the watermark image in portrait mode. This parameter contains the following members:
                                    • x: The horizontal position of the watermark relative to the upper left corner.
                                    • y: The vertical position of the watermark relative to the upper left corner.
                                      • @@ -157,12 +157,12 @@ watermarkRatio - When the watermark adaptation mode is , this parameter is used to set the watermark coordinates. See . + When the watermark adaptation mode is , this parameter is used to set the watermark coordinates. See . mode - The adaptation mode of the watermark. See . + The adaptation mode of the watermark. See .
                                  -                                   + \ No newline at end of file From 9569deaa413b74cbf64c8b503973a86b32d82b88 Mon Sep 17 00:00:00 2001 From: Suri539 Date: Mon, 11 Sep 2023 10:22:48 +0800 Subject: [PATCH 09/13] Revert "Merge branch 'translation/4.x-api-ref'" This reverts commit 9835645b2ecf12cb59cdb31efff3266479240052, reversing changes made to a0f592cca1d5f3505fdb85cc054782ba0a547115. --- ...onfiguration_getdestchannelmediainfos.dita | 24 +- ...evicemanager_getplaybackdefaultdevice.dita | 20 +- ...vicemanager_getrecordingdefaultdevice.dita | 20 +- ...laudioengine_updateplayerpositioninfo.dita | 12 +- ...i_ilocalspatialaudioengine_initialize.dita | 26 +-- ...atialaudioengine_updateremoteposition.dita | 10 +- .../API/api_imediaengine_addlistener.dita | 30 +-- ...i_imediaengine_createcustomaudiotrack.dita | 18 +- .../API/api_imediaengine_pushaudioframe.dita | 24 +- .../API/api_imediaengine_pushaudioframe0.dita | 8 +- ...pi_imediaengine_pushencodedvideoimage.dita | 24 +- .../API/api_imediaengine_pushvideoframe.dita | 22 +- ...ediaengine_registeraudioframeobserver.dita | 32 +-- ...ine_registervideoencodedframeobserver.dita | 36 +-- .../API/api_imediaplayer_addlistener.dita | 28 +-- ...ediaplayer_registervideoframeobserver.dita | 20 +- .../API/api_imediaplayer_setrendermode.dita | 6 +- ...pi_imediaplayer_setspatialaudioparams.dita | 6 +- .../API/api_imediarecorder_addlistener.dita | 28 +-- .../api_imediarecorder_startrecording.dita | 26 +-- .../API/api_irtcengine_addlistener.dita | 28 +-- .../api_irtcengine_configrhythmplayer.dita | 22 +- .../API/api_irtcengine_createdatastream2.dita | 4 +- .../api_irtcengine_enablecontentinspect.dita | 28 +-- .../api_irtcengine_enabledualstreammode2.dita | 6 +- .../api_irtcengine_enabledualstreammode3.dita | 22 +- .../API/api_irtcengine_enableencryption.dita | 6 +- ...api_irtcengine_enableinearmonitoring2.dita | 26 +-- .../API/api_irtcengine_enablemulticamera.dita | 38 ++-- ...pi_irtcengine_enablevirtualbackground.dita | 36 +-- .../api_irtcengine_getextensionproperty2.dita | 14 +- ...pi_irtcengine_getscreencapturesources.dita | 8 +- .../RTC-NG/API/api_irtcengine_initialize.dita | 32 +-- .../API/api_irtcengine_joinchannel2.dita | 14 +- .../API/api_irtcengine_preloadchannel.dita | 26 +-- .../API/api_irtcengine_preloadchannel2.dita | 34 +-- .../api_irtcengine_pushreverseaudioframe.dita | 6 +- .../API/api_irtcengine_pushvideoframe2.dita | 30 +-- .../api_irtcengine_querycodeccapability.dita | 32 +-- ...tcengine_queryscreencapturecapability.dita | 20 +- ...ine_registeraudioencodedframeobserver.dita | 10 +- ...cengine_registeraudiospectrumobserver.dita | 10 +- ...cengine_registermediametadataobserver.dita | 10 +- .../API/api_irtcengine_removehandler.dita | 6 +- .../API/api_irtcengine_sendmetadata.dita | 12 +- ...pi_irtcengine_setadvancedaudiooptions.dita | 8 +- ...irtcengine_setaudiomixingdualmonomode.dita | 8 +- .../API/api_irtcengine_setclientrole.dita | 4 +- ...api_irtcengine_setcolorenhanceoptions.dita | 16 +- .../API/api_irtcengine_setdualstreammode.dita | 28 +-- .../api_irtcengine_setdualstreammode2.dita | 30 +-- ...tcengine_setexternalaudiosourcevolume.dita | 22 +- .../api_irtcengine_setheadphoneeqpreset.dita | 16 +- .../api_irtcengine_setlivetranscoding.dita | 6 +- .../api_irtcengine_setlocalaccesspoint.dita | 8 +- ...cengine_setlocalpublishfallbackoption.dita | 6 +- .../api_irtcengine_setlocalrendermode.dita | 6 +- ..._irtcengine_setlowlightenhanceoptions.dita | 14 +- ...ngine_setremoteuserspatialaudioparams.dita | 6 +- ...rtcengine_setscreencapturecontenthint.dita | 6 +- .../API/api_irtcengine_setuplocalvideo.dita | 12 +- .../API/api_irtcengine_setupremotevideo.dita | 22 +- ...pi_irtcengine_setvideodenoiseroptions.dita | 32 +-- ...tcengine_setvideoencoderconfiguration.dita | 22 +- .../API/api_irtcengine_setvideoprofile.dita | 24 +- .../api_irtcengine_startaudiorecording3.dita | 6 +- .../api_irtcengine_startcameracapture.dita | 22 +- ...api_irtcengine_startchannelmediarelay.dita | 24 +- ...pi_irtcengine_startdirectcdnstreaming.dita | 12 +- .../API/api_irtcengine_startechotest3.dita | 14 +- ...engine_startorupdatechannelmediarelay.dita | 24 +- .../API/api_irtcengine_startrhythmplayer.dita | 26 +-- .../api_irtcengine_startscreencapture.dita | 30 +-- .../api_irtcengine_startscreencapture2.dita | 26 +-- ...cengine_startscreencapturebydisplayid.dita | 8 +- ...engine_startscreencapturebyscreenrect.dita | 6 +- ...tcengine_startscreencapturebywindowid.dita | 6 +- .../API/api_irtcengine_switchchannel2.dita | 28 +-- ...e_unregisteraudioencodedframeobserver.dita | 18 +- .../api_irtcengine_updatescreencapture.dita | 14 +- ...cengine_updatescreencaptureparameters.dita | 6 +- ..._irtcengine_updatescreencaptureregion.dita | 6 +- ...irtcengine_updatescreencaptureregion2.dita | 18 +- .../api_irtcengineex_createdatastreamex2.dita | 2 +- .../API/api_irtcengineex_joinchannelex.dita | 30 +-- .../api_irtcengineex_setdualstreammodeex.dita | 32 +-- .../api_irtcengineex_setupremotevideoex.dita | 6 +- ...gineex_setvideoencoderconfigurationex.dita | 6 +- ...irtcengineex_startchannelmediarelayex.dita | 30 +-- ...neex_startorupdatechannelmediarelayex.dita | 28 +-- ...api_ivideodevicemanager_getcapability.dita | 4 +- .../callback_iaudiopcmframesink_onframe.dita | 2 +- ...rameobserver_getvideoformatpreference.dita | 2 +- .../class_Localaccesspointconfiguration.dita | 34 ++- .../dita/RTC-NG/API/class_advanceoptions.dita | 18 +- en-US/dita/RTC-NG/API/class_audioparams.dita | 40 ++-- .../class_audiorecordingconfiguration.dita | 6 +- .../class_cameracapturerconfiguration.dita | 24 +- .../RTC-NG/API/class_channelmediaoptions.dita | 214 +++++++++--------- .../class_channelmediarelayconfiguration.dita | 40 ++-- en-US/dita/RTC-NG/API/class_codeccapinfo.dita | 18 +- .../dita/RTC-NG/API/class_codeccaplevels.dita | 16 +- .../API/class_contentinspectconfig.dita | 20 +- .../API/class_contentinspectmodule.dita | 22 +- .../API/class_encodedvideoframeinfo.dita | 16 +- .../RTC-NG/API/class_externalvideoframe.dita | 8 +- .../RTC-NG/API/class_injectstreamconfig.dita | 2 +- .../class_localtranscoderconfiguration.dita | 22 +- .../RTC-NG/API/class_localvideostats.dita | 40 ++-- .../API/class_mediarecorderconfiguration.dita | 14 +- en-US/dita/RTC-NG/API/class_mediasource.dita | 18 +- .../RTC-NG/API/class_remoteaudiostats.dita | 4 +- .../RTC-NG/API/class_rtcengineconfig.dita | 46 ++-- .../API/class_screencaptureconfiguration.dita | 4 +- .../API/class_screencaptureparameters.dita | 40 ++-- .../API/class_screencaptureparameters2.dita | 36 +-- .../API/class_screencapturesourceinfo.dita | 34 +-- .../API/class_simulcaststreamconfig.dita | 2 +- .../API/class_transcodingvideostream.dita | 14 +- .../API/class_useraudiospectruminfo.dita | 2 +- en-US/dita/RTC-NG/API/class_videocanvas.dita | 46 ++-- .../API/class_videoencoderconfiguration.dita | 38 ++-- en-US/dita/RTC-NG/API/class_videoframe.dita | 22 +- .../API/class_videosubscriptionoptions.dita | 30 +-- .../RTC-NG/API/class_watermarkoptions.dita | 22 +- en-US/dita/RTC-NG/API/enum_bitrate.dita | 2 +- .../dita/RTC-NG/API/rtc_api_overview_ng.dita | 4 +- 127 files changed, 1275 insertions(+), 1275 deletions(-) diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita index 63360b78f69..fa098bec720 100644 --- a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita +++ b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita @@ -1,32 +1,32 @@ - <ph keyref="getDestChannelMediaInfos"/> + <ph keyref="getDestChannelMediaInfos" /> Gets the information of the target channel. - +

                                  - public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { + public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { return destInfos; } - - - - - - -

                                  + + + + + + +

                                  Returns -

                                  The information of the target channel. See .

                                  +

                                  The information of the target channel. See .

                                   -                                   + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita index ad66080d805..3eb35a2cb64 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita @@ -1,26 +1,26 @@ - <ph keyref="getPlaybackDefaultDevice"/> + <ph keyref="getPlaybackDefaultDevice" /> Gets the default audio playback device. - +

                                  - - - + + + abstract getPlaybackDefaultDevice(): AudioDeviceInfo; public abstract int GetPlaybackDefaultDevice(ref string deviceId, ref string deviceName); - - Future<AudioDeviceInfo> getPlaybackDefaultDevice(); -

                                  + + Future<AudioDeviceInfo> getPlaybackDefaultDevice(); +

                                  Details @@ -40,11 +40,11 @@
                                  Returns -

                                  The details about the default audio playback device. See .

                                  +

                                  The details about the default audio playback device. See .

                                  • 0: Success.
                                  • < 0: Failure.
                                   -                                   + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita index cdd5bc4b4e0..feb6543aa4f 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita @@ -1,26 +1,26 @@ - <ph keyref="getRecordingDefaultDevice"/> + <ph keyref="getRecordingDefaultDevice" /> Gets the default audio capture device. - +

                                  - - - + + + abstract getRecordingDefaultDevice(): AudioDeviceInfo; public abstract int GetRecordingDefaultDevice(ref string deviceId, ref string deviceName); - - Future<AudioDeviceInfo> getRecordingDefaultDevice(); -

                                  + + Future<AudioDeviceInfo> getRecordingDefaultDevice(); +

                                  Details @@ -40,11 +40,11 @@
                                  Returns -

                                  The details about the default audio capture device. See .

                                  +

                                  The details about the default audio capture device. See .

                                  • 0: Success.
                                  • < 0: Failure.
                                   -                                   + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita index 50f58fee7e2..e6f5b56a852 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita @@ -25,9 +25,9 @@ playerId: number, positionInfo: RemoteVoicePositionInfo ): number; - Future<void> updatePlayerPositionInfo( + Future<void> updatePlayerPositionInfo( {required int playerId, required RemoteVoicePositionInfo positionInfo}); -

                                  +

                                  Details @@ -42,15 +42,15 @@ positionInfo - The spatial position of the media player. See . + The spatial position of the media player. 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.
                                  - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita index c16560e5d12..2c1e60dd5d5 100644 --- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita +++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita @@ -1,12 +1,12 @@ - <ph keyref="initialize_ILocalSpatialAudioEngine"/> - Initializes . + <ph keyref="initialize_ILocalSpatialAudioEngine" /> + Initializes . - + @@ -19,32 +19,32 @@ abstract initialize(): number; public abstract int Initialize(); abstract initialize(): number; - Future<void> initialize(); -

                                  + Future<void> initialize(); +

                                  Details
                                    -
                                  • Call this method after calling ().
                                    • -
                                  • Call this method after calling .
                                    • -
                                  • Before calling other methods of the class, you need to call this method to initialize .
                                    • -
                                  • The SDK supports creating only one instance for an app.
                                    • +
                                  • Call this method after calling ().
                                    • +
                                  • Call this method after calling .
                                    • +
                                  • Before calling other methods of the class, you need to call this method to initialize .
                                    • +
                                  • The SDK supports creating only one instance for an app.
                                  Parameters config - The configuration of . See . + The configuration of . 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.
                                  -                                   + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita index cce77628f8c..15363e1ebe2 100644 --- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita +++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita @@ -25,9 +25,9 @@ uid: number, posInfo: RemoteVoicePositionInfo ): number;                                   - Future<void> updateRemotePosition( + Future<void> updateRemotePosition( {required int uid, required RemoteVoicePositionInfo posInfo}); -

                                  +

                                  Details @@ -46,11 +46,11 @@
                                  - <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_imediaengine_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita index 330082aef13..e59d5215833 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita @@ -1,49 +1,49 @@ - <ph keyref="addListener_IMediaEngine"/> - Adds one listener. + <ph keyref="addListener_IMediaEngine" /> + Adds one listener. - +

                                  - - - - addListener?<EventType extends keyof IMediaEngineEvent>( + + + + addListener?<EventType extends keyof IMediaEngineEvent>( eventType: EventType, listener: IMediaEngineEvent[EventType] ): void; - - addListener?<EventType extends keyof IMediaEngineEvent>( + + addListener?<EventType extends keyof IMediaEngineEvent>( eventType: EventType, listener: IMediaEngineEvent[EventType] ): void; - -

                                  + +

                                  Details -

                                  After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

                                  +

                                  After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

                                  Parameters eventType - The name of the target event to listen for. See . + The name of the target event to listen for. See . listener - The callback function for eventType. Take adding a listener for as an example:const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {}; + The callback function for eventType. Take adding a listener for as an example:const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {}; engine.addListener('onPlaybackAudioFrameBeforeMixing', onPlaybackAudioFrameBeforeMixing);
                                  -                                   + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita b/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita index b88531a5e03..3b13ff2d16b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita @@ -1,12 +1,12 @@ - <ph keyref="createCustomAudioTrack"/> + <ph keyref="createCustomAudioTrack" /> Creates a custom audio track. - + @@ -27,9 +27,9 @@ trackType: AudioTrackType, config: AudioTrackConfig ): number;                                   - Future<int> createCustomAudioTrack( + Future<int> createCustomAudioTrack( {required AudioTrackType trackType, required AudioTrackConfig config}); -

                                  +

                                  Details @@ -41,8 +41,8 @@

                                  To publish a custom audio source to multiple channels, see the following steps:

                                  1. Call this method to create a custom audio track and get the audio track ID.
                                    2. -
                                  2. In of each channel, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
                                    3. -
                                  3. If you call , and specify trackId as the audio track ID set in step 2, you can publish the corresponding custom audio source in multiple channels.
                                    4. +
                                  4. In of each channel, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
                                    5. +
                                  5. If you call , and specify trackId as the audio track ID set in step 2, you can publish the corresponding custom audio source in multiple channels.

                                  @@ -50,11 +50,11 @@ trackType - The type of the custom audio track. See .If is specified for this parameter, you must set publishMicrophoneTrack to in when calling to join the channel; otherwise, joining the channel fails and returns the error code -2. + The type of the custom audio track. See .If is specified for this parameter, you must set publishMicrophoneTrack to in when calling to join the channel; otherwise, joining the channel fails and returns the error code -2. config - The configuration of the custom audio track. See . + The configuration of the custom audio track. See .
                                  @@ -64,4 +64,4 @@
                                • If the method call fails, a negative value is returned.
                                - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita index f806a5ae147..5469badee5b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita @@ -1,12 +1,12 @@ - <ph keyref="pushAudioFrame1"/> + <ph keyref="pushAudioFrame1" /> Pushes the external audio frame. - + @@ -18,19 +18,19 @@ samples:(NSInteger)samples sourceId:(NSInteger)sourceId timestamp:(NSTimeInterval)timestamp; - - - - - -

                                + + + + + +

                                Parameters frame - The external audio frame. See . + The external audio frame. See . @@ -49,8 +49,8 @@ - - + +
                                @@ -62,4 +62,4 @@

                              - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita index 36f74c2f58f..0703133a029 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita @@ -19,8 +19,8 @@ abstract pushAudioFrame(frame: AudioFrame, trackId?: number): number; public abstract int PushAudioFrame(AudioFrame frame, uint trackId = 0); abstract pushAudioFrame(frame: AudioFrame, trackId?: number): number; - Future<void> pushAudioFrame({required AudioFrame frame, int trackId = 0}); -

                              + Future<void> pushAudioFrame({required AudioFrame frame, int trackId = 0}); +

                              Parameters @@ -35,8 +35,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_imediaengine_pushencodedvideoimage.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita index a6ef41473a6..b793186827a 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita @@ -1,12 +1,12 @@ - <ph keyref="pushEncodedVideoImage"/> + <ph keyref="pushEncodedVideoImage" /> Pushes the external encoded video frame to the SDK. - + @@ -16,7 +16,7 @@ public abstract int pushExternalEncodedVideoFrame( ByteBuffer data, EncodedVideoFrameInfo frameInfo); videoTrackId:(NSUInteger)videoTrackId; - + virtual int pushEncodedVideoImage(const uint8_t* imageBuffer, size_t length, const agora::rtc::EncodedVideoFrameInfo& videoEncodedFrameInfo) = 0; abstract pushEncodedVideoImage( @@ -32,16 +32,16 @@ videoEncodedFrameInfo: EncodedVideoFrameInfo, videoTrackId?: number ): number; - Future<void> pushEncodedVideoImage( + Future<void> pushEncodedVideoImage( {required Uint8List imageBuffer, required int length, required EncodedVideoFrameInfo videoEncodedFrameInfo, int videoTrackId = 0}); -

                                +

                              Details -

                              After calling to enable external video source and set the sourceType parameter to , you can call this method to push the encoded external video frame to the SDK.

                              +

                              After calling to enable external video source and set the sourceType parameter to , you can call this method to push the encoded external video frame to the SDK.

                              Parameters @@ -58,19 +58,19 @@ frameInfo videoEncodedFrameInfo - Information about externally encoded video frames. See . + Information about externally encoded video frames. 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: Pushes the external encoded video frame to the SDK successfully.
                              • < 0: Fails to push external encoded video frames to the SDK.
                              - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita index e46fe5634be..53ca8040171 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita @@ -25,20 +25,20 @@ frame: ExternalVideoFrame, videoTrackId?: number ): number;                               - Future<void> pushVideoFrame( + Future<void> pushVideoFrame( {required ExternalVideoFrame frame, int videoTrackId = 0}); -

                              +

                              Details
                              Deprecated:
                              -
                              If you need to push video frames in I422 format, you need to use this method; otherwise, use instead.
                              +
                              If you need to push video frames in I422 format, you need to use this method; otherwise, use instead.
                              -

                              If you call and set the enabled parameter as and the encodedFrame parameter as , you can call this method to push the external raw video frame to the SDK. If you call method to get the video track ID, set the customVideoTrackId parameter to the video track ID you want to publish in the of each channel, and set the publishCustomVideoTrack parameter to , you can call this method to push the unencoded external video frame to the SDK.

                              -

                              You can push the video frame either by calling this method or by calling . The difference is that the method does not support video data in texture format.

                              +

                              If you call and set the enabled parameter as and the encodedFrame parameter as , you can call this method to push the external raw video frame to the SDK. If you call method to get the video track ID, set the customVideoTrackId parameter to the video track ID you want to publish in the of each channel, and set the publishCustomVideoTrack parameter to , you can call this method to push the unencoded external video frame to the SDK.

                              +

                              You can push the video frame either by calling this method or by calling . The difference is that the method does not support video data in texture format.

                              Parameters @@ -51,19 +51,19 @@ videoTrackId - The video track ID returned by calling the method. The default value is 0. + The video track ID returned by calling the method. The default value is 0.
                              - <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.
                                -
                              • : Pushes the external raw video frame to the SDK successfully.
                                • -
                              • : Fails to push external raw video frame to the SDK.
                                • +
                              • : Pushes the external raw video frame to the SDK successfully.
                                • +
                              • : Fails to push external raw video frame to the SDK.
                              - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita index 3b426e844a9..04054be0dcc 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="registerAudioFrameObserver"/> + <ph keyref="registerAudioFrameObserver" /> Registers an audio frame observer object. - + @@ -20,11 +20,11 @@ public abstract int RegisterAudioFrameObserver(IAudioFrameObserver audioFrameObserver, AUDIO_FRAME_POSITION position, OBSERVER_MODE mode = OBSERVER_MODE.INTPTR); abstract registerAudioFrameObserver(observer: IAudioFrameObserver): number; void registerAudioFrameObserver(AudioFrameObserver observer); -

                              +

                              Details -

                              Call this method to register an audio frame observer object (register a callback). When you need the SDK to trigger , , or callback, you need to use this method to register the callbacks.

                              +

                              Call this method to register an audio frame observer object (register a callback). When you need the SDK to trigger , , or callback, you need to use this method to register the callbacks.

                              Ensure that you call this method before joining a channel.
                              Parameters @@ -34,35 +34,35 @@ delegate audioFrameObserver -

                              The observer instance. See . Set the value as to release the instance. Agora recommends calling this method after receiving to release the audio observer object.

                              +

                              The observer instance. See . Set the value as to release the instance. Agora recommends calling this method after receiving to release the audio observer object.

                               mode - The audio data callback mode. See . + The audio data callback mode. See . position The frame position of the audio observer.
                                -
                              • (0x0001): This position can observe the playback audio mixed by all remote users, corresponding to the callback.
                                • -
                              • (0x0002): This position can observe the collected local user's audio, corresponding to the callback.
                                • -
                              • (0x0004): This position can observe the playback audio mixed by the loacl user and all remote users, corresponding to the callback.
                                • -
                              • (0x0008): This position can observe the audio of a single remote user before mixing, corresponding to the callback.
                                • -
                              • (0x0010): This position can observe the in-ear monitoring audio of the local user, corresponding to the callback.
                                • +
                              • (0x0001): This position can observe the playback audio mixed by all remote users, corresponding to the callback.
                                • +
                              • (0x0002): This position can observe the collected local user's audio, corresponding to the callback.
                                • +
                              • (0x0004): This position can observe the playback audio mixed by the loacl user and all remote users, corresponding to the callback.
                                • +
                              • (0x0008): This position can observe the audio of a single remote user before mixing, corresponding to the callback.
                                • +
                              • (0x0010): This position can observe the in-ear monitoring audio of the local user, corresponding to the callback.
                              - <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_imediaengine_registervideoencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita index 80225a0428e..b306be33e53 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="registerVideoEncodedFrameObserver"/> + <ph keyref="registerVideoEncodedFrameObserver" /> Registers a receiver object for the encoded video image. - + @@ -25,18 +25,18 @@ observer: IVideoEncodedFrameObserver ): number;                               void registerVideoEncodedFrameObserver(VideoEncodedFrameObserver observer); -

                              +

                              Details -

                              If you only want to observe encoded video frames (such as h.264 format) without decoding and rendering the video, Agora recommends that you implement one class through this method.

                              +

                              If you only want to observe encoded video frames (such as h.264 format) without decoding and rendering the video, Agora recommends that you implement one class through this method.

                              If you want to obtain the original video data of some remote users (referred to as group A) and the encoded video data of other remote users (referred to as group B), you can refer to the following steps:

                                -
                              1. Call to register the raw video frame observer before joining the channel.
                                2. -
                              2. Call to register the encoded video frame observer before joining the channel.
                                3. -
                              3. After joining the channel, get the user IDs of group B users through , and then call to set the encodedFrameOnly of this group of users to .
                                4. -
                              4. Call () to start receiving the video streams of all remote users. Then:
                                  -
                                • The raw video data of group A users can be obtained through the callback in , and the SDK renders the data by default.
                                  • -
                                • The encoded video data of group B users can be obtained through the callback in .
                                  • +
                                • Call to register the raw video frame observer before joining the channel.
                                  • +
                                • Call to register the encoded video frame observer before joining the channel.
                                  • +
                                • After joining the channel, get the user IDs of group B users through , and then call to set the encodedFrameOnly of this group of users to .
                                  • +
                                • Call () to start receiving the video streams of all remote users. Then:
                                    +
                                  • The raw video data of group A users can be obtained through the callback in , and the SDK renders the data by default.
                                    • +
                                  • The encoded video data of group B users can be obtained through the callback in .

                              @@ -51,24 +51,24 @@ receiver observer videoEncodedImageReceiver - The video frame observer object. See . - The observer instance. See . Set the value as to release the instance. + The video frame observer object. See . + The observer instance. See . Set the value as to release the instance. mode - The video data callback mode. See . + The video data callback mode. 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_imediaplayer_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita index b2d92853a33..95ef3414e73 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita @@ -1,48 +1,48 @@ - <ph keyref="addListener_IMediaPlayer"/> - Adds one listener. + <ph keyref="addListener_IMediaPlayer" /> + Adds one listener. - +

                              - - - - addListener?<EventType extends keyof IMediaPlayerEvent>( + + + + addListener?<EventType extends keyof IMediaPlayerEvent>( eventType: EventType, listener: IMediaPlayerEvent[EventType] ): void; - - addListener?<EventType extends keyof IMediaPlayerEvent>( + + addListener?<EventType extends keyof IMediaPlayerEvent>( eventType: EventType, listener: IMediaPlayerEvent[EventType] ): void; -

                              +

                              Details -

                              After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

                              +

                              After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

                              Parameters eventType - The name of the target event to listen for. See . + The name of the target event to listen for. See . listener - The callback function for eventType. Take adding a listener for as an example:const onPlayerSourceStateChanged = (connection: RtcConnection, elapsed: number) => {}; + The callback function for eventType. Take adding a listener for as an example:const onPlayerSourceStateChanged = (connection: RtcConnection, elapsed: number) => {}; engine.addListener('onPlayerSourceStateChanged', onPlayerSourceStateChanged);
                              -                               + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita index 1a33f837eb9..20c70a4db8b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="registerVideoFrameObserver_IMediaPlayer"/> + <ph keyref="registerVideoFrameObserver_IMediaPlayer" /> Registers a video frame observer object. - + @@ -14,7 +14,7 @@

                              int registerVideoFrameObserver(IMediaPlayerVideoFrameObserver videoFrameObserver); - + virtual int registerVideoFrameObserver(media::base::IVideoFrameObserver* observer) = 0; abstract registerVideoFrameObserver( observer: IMediaPlayerVideoFrameObserver @@ -24,11 +24,11 @@ observer: IMediaPlayerVideoFrameObserver ): number; void registerVideoFrameObserver(MediaPlayerVideoFrameObserver observer); -

                              +

                              Details -

                              You need to implement the class in this method and register callbacks according to your scenarios. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.

                              +

                              You need to implement the class in this method and register callbacks according to your scenarios. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.

                              Parameters @@ -36,16 +36,16 @@ videoFrameObserver observer - The video observer, reporting the reception of each video frame. See . - The video observer, reporting the reception of each video frame. See . + The video observer, reporting the reception of each video frame. See . + The video observer, reporting the reception of each video frame. 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.
                              -                               + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita index 0caf1834012..eb8402816d9 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita @@ -22,7 +22,7 @@ public abstract int SetRenderMode(RENDER_MODE_TYPE renderMode); abstract setRenderMode(renderMode: RenderModeType): number; Future<void> setRenderMode(RenderModeType renderMode); -

                              +

                              Parameters @@ -39,8 +39,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_imediaplayer_setspatialaudioparams.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita index 25f89891793..bf12669794b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita @@ -20,7 +20,7 @@ public abstract int SetSpatialAudioParams(SpatialAudioParams spatial_audio_params); abstract setSpatialAudioParams(params: SpatialAudioParams): number; Future<void> setSpatialAudioParams(SpatialAudioParams params); -

                                +

                              Details @@ -37,8 +37,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_imediarecorder_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita index 384d63cf763..2b1ac3a1891 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita @@ -1,48 +1,48 @@ - <ph keyref="addListener_IMediaRecorder"/> - Adds one listener. + <ph keyref="addListener_IMediaRecorder" /> + Adds one listener. - +

                                - - - - addListener?<EventType extends keyof IMediaRecorderEvent>( + + + + addListener?<EventType extends keyof IMediaRecorderEvent>( eventType: EventType, listener: IMediaRecorderEvent[EventType] ): void; - - addListener?<EventType extends keyof IMediaRecorderEvent>( + + addListener?<EventType extends keyof IMediaRecorderEvent>( eventType: EventType, listener: IMediaRecorderEvent[EventType] ): void; -

                                +

                                Details -

                                After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

                                +

                                After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

                                Parameters eventType - The name of the target event to listen for. See . + The name of the target event to listen for. See . listener - The callback function for eventType. Take adding a listener for as an example:const onRecorderStateChanged = (state: RecorderState, error: RecorderErrorCode) => {}; + The callback function for eventType. Take adding a listener for as an example:const onRecorderStateChanged = (state: RecorderState, error: RecorderErrorCode) => {}; engine.addListener('onRecorderStateChanged', onRecorderStateChanged);
                                -                                 + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita index 7c2d5fbedc0..59082338f2b 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita @@ -1,12 +1,12 @@ - <ph keyref="startRecording"/> + <ph keyref="startRecording" /> Starts recording audio and video streams. - + @@ -19,15 +19,15 @@ abstract startRecording(config: MediaRecorderConfiguration): number; public abstract int StartRecording(MediaRecorderConfiguration config); abstract startRecording(config: MediaRecorderConfiguration): number; - Future<void> startRecording(MediaRecorderConfiguration config); -

                                + Future<void> startRecording(MediaRecorderConfiguration config); +

                              Details

                              You can call this method to enable the recording function. Agora supports recording the media streams of local and remote users at the same time.

                              Before you call this method, ensure the following:

                                -
                              • The recording object is created through .
                                • -
                              • The recording observer is registered through .
                                • +
                              • The recording object is created through .
                                • +
                              • The recording observer is registered through .
                              • You have joined the channel which the remote user that you want to record is in.

                              Supported formats of recording are listed as below:

                                @@ -35,7 +35,7 @@
                              • Video captured by a camera and encoded in H.264 or H.265.

                              Once the recording is started, if the video resolution is changed, the SDK stops the recording; if the sampling rate and audio channel changes, the SDK continues recording and generates audio files respectively.

                              -

                              The SDK can generate a recording file only when it detects audio and video streams; when there are no audio and video streams to be recorded or the audio and video streams are interrupted for more than five seconds, the SDK stops the recording and triggers the (, ) callback.

                              +

                              The SDK can generate a recording file only when it detects audio and video streams; when there are no audio and video streams to be recorded or the audio and video streams are interrupted for more than five seconds, the SDK stops the recording and triggers the (, ) callback.

                                @@ -47,12 +47,12 @@ config - The recording configuration. See . + The recording configuration. 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.
                                  @@ -61,9 +61,9 @@
                                • The specified format of the recording file is supported.
                                • The maximum recording duration is correctly set.
                                • -
                              • -4: does not support the request. The recording is ongoing or the recording stops because an error occurs.
                                • -
                              • -7: The method is called before is initialized. Ensure the object is created before calling this method.
                                • +
                              • -4: does not support the request. The recording is ongoing or the recording stops because an error occurs.
                                • +
                              • -7: The method is called before is initialized. Ensure the object is created before calling this method.
                            - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita b/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita index 7dc0cf78c6c..814a1738ce8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita @@ -1,48 +1,48 @@ - <ph keyref="addListener"/> - Adds one listener. + <ph keyref="addListener" /> + Adds one listener. - +

                            - - - - addListener?<EventType extends keyof IRtcEngineEvent>( + + + + addListener?<EventType extends keyof IRtcEngineEvent>( eventType: EventType, listener: IRtcEngineEvent[EventType] ): void; - - addListener?<EventType extends keyof IRtcEngineEvent>( + + addListener?<EventType extends keyof IRtcEngineEvent>( eventType: EventType, listener: IRtcEngineEvent[EventType] ): void; -

                            +

                            Details -

                            After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

                            +

                            After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

                            Parameters eventType - The name of the target event to listen for. See . + The name of the target event to listen for. See . listener - The callback function for eventType. Take adding a listener for as an example:const onJoinChannelSuccess = (connection: RtcConnection, elapsed: number) => {}; + The callback function for eventType. Take adding a listener for as an example:const onJoinChannelSuccess = (connection: RtcConnection, elapsed: number) => {}; engine.addListener('onJoinChannelSuccess', onJoinChannelSuccess);
                            -                             + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita index 4ce10a923db..103d2b8703f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita @@ -1,12 +1,12 @@ - <ph keyref="configRhythmPlayer"/> + <ph keyref="configRhythmPlayer" /> Configures the virtual metronome. - + @@ -19,28 +19,28 @@ abstract configRhythmPlayer(config: AgoraRhythmPlayerConfig): number; public abstract int ConfigRhythmPlayer(AgoraRhythmPlayerConfig config); abstract configRhythmPlayer(config: AgoraRhythmPlayerConfig): number; - Future<void> configRhythmPlayer(AgoraRhythmPlayerConfig config); -

                            + Future<void> configRhythmPlayer(AgoraRhythmPlayerConfig config); +

                            Details -

                            After calling , you can call this method to reconfigure the virtual metronome.

                            -

                            After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.

                            -
                            +

                            After calling , you can call this method to reconfigure the virtual metronome.

                            +

                            After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.

                            +
                            Parameters config - The metronome configuration. See . + The metronome configuration. 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.
                            -                             + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita index 40333241f21..557fe00caeb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita @@ -23,7 +23,7 @@ int CreateDataStream(int& streamId, const FDataStreamConfig& config);public abstract int CreateDataStream(ref int streamId, DataStreamConfig config); abstract createDataStream(config: DataStreamConfig): number; Future<int> createDataStream(DataStreamConfig config); -

                            +

                            Details @@ -50,4 +50,4 @@ int CreateDataStream(int& streamId, const FDataStreamConfig& config);< 0: Failure.
                          - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita index 06d219bfbcd..2d78d204040 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita @@ -1,12 +1,12 @@ - <ph keyref="enableContentInspect"/> + <ph keyref="enableContentInspect" /> Enables or disables video screenshot and upload. Enables or disables video content moderation. - + @@ -25,18 +25,18 @@ enabled: boolean, config: ContentInspectConfig ): number; - Future<void> enableContentInspect( + Future<void> enableContentInspect( {required bool enabled, required ContentInspectConfig config}); -

                          +

                          Details -

                          When video screenshot and upload function is enabled, the SDK takes screenshots and upload videos sent by local users based on the type and frequency of the module you set in . After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.

                          -

                          When video content moderation is enabled, the SDK takes screenshots, reviews the content, and uploads videos sent by local users based on the type and frequency of the content moderation module you set in . After content moderation, the Agora content moderation server sends the results to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.

                          +

                          When video screenshot and upload function is enabled, the SDK takes screenshots and upload videos sent by local users based on the type and frequency of the module you set in . After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.

                          +

                          When video content moderation is enabled, the SDK takes screenshots, reviews the content, and uploads videos sent by local users based on the type and frequency of the content moderation module you set in . After content moderation, the Agora content moderation server sends the results to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.

                            -
                          • Before calling this method, ensure that the video screenshot upload service has been activated. Before calling this method, ensure that Video content moderation service has been activated. See .
                            • -
                          • This method relies on the video screenshot and upload dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
                            • +
                          • Before calling this method, ensure that the video screenshot upload service has been activated. Before calling this method, ensure that Video content moderation service has been activated. See .
                            • +
                          • This method relies on the video screenshot and upload dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
                          Parameters @@ -44,21 +44,21 @@ enabled Whether to enable video screenshot and uploadvideo content moderation:
                            -
                          • : Enables video screenshot and upload. Enables video content moderation.
                            • -
                          • : Disables video screenshot and upload. Disables video content moderation.
                            • +
                          • : Enables video screenshot and upload. Enables video content moderation.
                            • +
                          • : Disables video screenshot and upload. Disables video content moderation.
                                                     config - Configuration of video screenshot and upload. Configuration of video content moderation. See . + Configuration of video screenshot and upload. Configuration of video content moderation. 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.
                          -                           + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita index f3345ffa04a..6541686f050 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita @@ -28,14 +28,14 @@ streamConfig?: SimulcastStreamConfig ): number; Future<void> enableDualStreamMode(bool enabled); -

                          +

                          Details
                          Deprecated:
                          -
                          This method is deprecated as of v4.2.0. Use instead.
                          +
                          This method is deprecated as of v4.2.0. Use instead.

                          You can call this method to enable or disable the dual-stream mode on the publisher side. Dual streams are a pairing of a high-quality video stream and a low-quality video stream:

                            @@ -46,7 +46,7 @@
                            • This method is applicable to all types of streams from the sender, including but not limited to video streams collected from cameras, screen sharing streams, and custom-collected video streams.
                              • -
                            • If you need to enable dual video streams in a multi-channel scenario, you can call the method.
                              • +
                            • If you need to enable dual video streams in a multi-channel scenario, you can call the method.
                            • You can call this method either before or after joining a channel.
                          diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita index bd4ec1f8ddc..3ec4f85ba92 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita @@ -1,12 +1,12 @@ - <ph keyref="enableDualStreamMode3"/> + <ph keyref="enableDualStreamMode3" /> Enables or disables the dual-stream mode on the sender and sets the low-quality video stream. - + @@ -28,11 +28,11 @@ int EnableDualStreamMode(bool enabled, const FSimulcastStreamConfig& streamC enabled: boolean, streamConfig?: SimulcastStreamConfig ): number; - Future<void> enableDualStreamMode( + Future<void> enableDualStreamMode( {required bool enabled, SimulcastStreamConfig? streamConfig}); -

                          +

                          -
                          +
                          Parameters @@ -40,24 +40,24 @@ int EnableDualStreamMode(bool enabled, const FSimulcastStreamConfig& streamC enabled

                          Whether to enable dual-stream mode:

                            -
                          • : Enable dual-stream mode.
                            • -
                          • : (Default) Disable dual-stream mode.
                            • +
                          • : Enable dual-stream mode.
                            • +
                          • : (Default) Disable dual-stream mode.

                           streamConfig -

                          The configuration of the low-quality video stream. See .

                          +

                          The configuration of the low-quality video stream. 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.
                          - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita index 6b09ee1de71..dc49fd314a6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita @@ -21,7 +21,7 @@ abstract enableEncryption(enabled: boolean, config: EncryptionConfig): number; Future<void> enableEncryption( {required bool enabled, required EncryptionConfig config}); -

                          +

                          Details @@ -46,8 +46,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_enableinearmonitoring2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita index 061039b22f7..bdf340e976e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita @@ -1,12 +1,12 @@ - <ph keyref="enableInEarMonitoring2"/> + <ph keyref="enableInEarMonitoring2" /> Enables in-ear monitoring. - + @@ -25,10 +25,10 @@ enabled: boolean, includeAudioFilters: EarMonitoringFilterType ): number; - Future<void> enableInEarMonitoring( + Future<void> enableInEarMonitoring( {required bool enabled, required EarMonitoringFilterType includeAudioFilters}); -

                              +

                          Details @@ -44,28 +44,28 @@ enabled Enables or disables in-ear monitoring.
                            -
                          • : Enables in-ear monitoring.
                            • -
                          • : (Default) Disables in-ear monitoring.
                            • +
                          • : Enables in-ear monitoring.
                            • +
                          • : (Default) Disables in-ear monitoring.
                                                     includeAudioFilters - The audio filter of in-ear monitoring: See . + The audio filter of in-ear monitoring: See . The audio filter of in-ear monitoring:
                            -
                          • (1 << 0): Do not add an audio filter to the in-ear monitor.
                            • -
                          • (1 << 1): Add an audio filter to the in-ear monitor. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.
                            • -
                          • (1 << 2): Enable noise suppression to the in-ear monitor.

                            You can use the bitwise or operator (|) to specify multiple audio filters.If you set the enabled parameter to , you do not need to set the includeAudioFilters parameter.

                            +
                          • (1 << 0): Do not add an audio filter to the in-ear monitor.
                            • +
                          • (1 << 1): Add an audio filter to the in-ear monitor. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.
                            • +
                          • (1 << 2): Enable noise suppression to the in-ear monitor.

                            You can use the bitwise or operator (|) to specify multiple audio filters.If you set the enabled parameter to , you do not need to set the includeAudioFilters parameter.
                          - <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.
                            • - 8: Make sure the current audio routing is Bluetooth or headset.
                          - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita index 67b7fc9a5f9..62e4d17f881 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita @@ -1,19 +1,19 @@ - <ph keyref="enableMultiCamera"/> + <ph keyref="enableMultiCamera" /> Enables or disables multi-camera capture. - +

                          - + - (int)enableMultiCamera:(BOOL)enabled config:(AgoraCameraCapturerConfiguration* _Nullable)config NS_SWIFT_NAME(enableMultiCamera(_:config:)); #if defined(__APPLE__) && TARGET_OS_IOS virtual int enableMultiCamera(bool enabled, const CameraCapturerConfiguration& config) = 0; @@ -27,9 +27,9 @@ enabled: boolean, config: CameraCapturerConfiguration ): number; - Future<void> enableMultiCamera( + Future<void> enableMultiCamera( {required bool enabled, required CameraCapturerConfiguration config}); -

                          +

                          Details @@ -41,18 +41,18 @@

                          In scenarios where there are existing cameras to capture video, Agora recommends that you use the following steps to capture and publish video with multiple cameras:

                          1. Call this method to enable multi-channel camera capture.
                            2. -
                          2. Call to start the local video preview.
                            3. -
                          3. Call , and set sourceType to start video capture with the second camera.
                            4. -
                          4. Call , and set publishSecondaryCameraTrack to to publish the video stream captured by the second camera in the channel.
                            5. +
                          5. Call to start the local video preview.
                            6. +
                          6. Call , and set sourceType to start video capture with the second camera.
                            7. +
                          7. Call , and set publishSecondaryCameraTrack to to publish the video stream captured by the second camera in the channel.

                          If you want to disable multi-channel camera capture, use the following steps:

                            -
                          1. Call .
                            2. -
                          2. Call this method with enabled set to .
                            3. +
                          3. Call .
                            4. +
                          4. Call this method with enabled set to .

                          -

                          You can call this method before and after to enable multi-camera capture:

                            -
                          • If it is enabled before , the local video preview shows the image captured by the two cameras at the same time.
                            • -
                          • If it is enabled after , the SDK stops the current camera capture first, and then enables the primary camera and the second camera. The local video preview appears black for a short time, and then automatically returns to normal.
                            • +

                            You can call this method before and after to enable multi-camera capture:

                              +
                            • If it is enabled before , the local video preview shows the image captured by the two cameras at the same time.
                              • +
                            • If it is enabled after , the SDK stops the current camera capture first, and then enables the primary camera and the second camera. The local video preview appears black for a short time, and then automatically returns to normal.

                            This method applies to iOS only.

                            @@ -70,22 +70,22 @@ enabled Whether to enable multi-camera video capture mode:
                              -
                            • : Enable multi-camera capture mode; the SDK uses multiple cameras to capture video.
                              • -
                            • : Disable multi-camera capture mode; the SDK uses a single camera to capture video.
                              • +
                            • : Enable multi-camera capture mode; the SDK uses multiple cameras to capture video.
                              • +
                            • : Disable multi-camera capture mode; the SDK uses a single camera to capture video.
                                                         config - Capture configuration for the second camera. See . + Capture configuration for the second camera. 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.
                           -                           + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita index 706abe2ee11..4065b4eb383 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita @@ -1,12 +1,12 @@ - <ph keyref="enableVirtualBackground"/> + <ph keyref="enableVirtualBackground" /> Enables/Disables the virtual background. - + @@ -32,17 +32,17 @@ segproperty: SegmentationProperty, type?: MediaSourceType ): number; - Future<void> enableVirtualBackground( + Future<void> enableVirtualBackground( {required bool enabled, required VirtualBackgroundSource backgroundSource, required SegmentationProperty segproperty, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

                          +

                          Details

                          The virtual background feature enables the local user to replace their original background with a static image, dynamic video, blurred background, or portrait-background segmentation to achieve picture-in-picture effect. Once the virtual background feature is enabled, all users in the channel can see the custom background.

                          -

                          Call this method before calling or .

                          +

                          Call this method before calling or .

                          • This feature requires high performance devices. Agora recommends that you implement it on devices equipped with the following chips:
                              @@ -64,7 +64,7 @@
                            • A high-definition camera device is used, and the environment is uniformly lit.
                            • There are few objects in the captured video. Portraits are half-length and unobstructed. Ensure that the background is a solid color that is different from the color of the user's clothing.
                            • -
                          • This method relies on the virtual background dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
                            • +
                          • This method relies on the virtual background dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
                          Parameters @@ -73,38 +73,38 @@ enabled enable Whether to enable virtual background:
                            -
                          • : Enable virtual background.
                            • -
                          • : Disable virtual background.
                            • +
                          • : Enable virtual background.
                            • +
                          • : Disable virtual background.
                           backgroundSource backData - The custom background. See . To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted. + The custom background. See . To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted. segproperty segData - Processing properties for background images. See . + Processing properties for background images. See . type - The type of the video source. See .In this method, this parameter supports only the following two settings:
                            -
                          • The default value is .
                            • -
                          • If you want to use the second camera to capture video, set this parameter to .
                            • + The type of the video source. See .In this method, this parameter supports only the following two settings:
                              +
                            • The default value is .
                              • +
                            • If you want to use the second camera to capture video, set this parameter to .
                          - <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.
                              -
                            • -1: The custom background image does not exist. Check the value of source in .
                              • -
                            • -2: The color format of the custom background image is invalid. Check the value of color in .
                              • +
                            • -1: The custom background image does not exist. Check the value of source in .
                              • +
                            • -2: The color format of the custom background image is invalid. Check the value of color in .
                            • -3: The device does not support virtual background.
                          - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita index 80417fdbd1f..87e9999d393 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita @@ -1,12 +1,12 @@ - <ph keyref="getExtensionProperty2"/> + <ph keyref="getExtensionProperty2" /> Gets detailed information on the extensions. - + @@ -42,17 +42,17 @@ int GetExtensionProperty(FString provider, FString extension, FString key, FStri bufLen: number, type?: MediaSourceType ): string;                           - Future<String> getExtensionProperty( + Future<String> getExtensionProperty( {required String provider, required String extension, required String key, required int bufLen, MediaSourceType type = MediaSourceType.unknownMediaSource}); -

                          +

                          Details -

                          +

                          Parameters @@ -79,7 +79,7 @@ int GetExtensionProperty(FString provider, FString extension, FString key, FStri sourceType type - Source type of the extension. See . + Source type of the extension. See . buf_len @@ -98,4 +98,4 @@ int GetExtensionProperty(FString provider, FString extension, FString key, FStri
                        • An empty string, if the method call fails.
                        - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita index 8bcc148b04e..74fc1ddc9a0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita @@ -32,7 +32,7 @@ {required Size thumbSize, required Size iconSize, required bool includeScreen}); -

                        +

                        Details @@ -44,11 +44,11 @@ thumbSize - The target size of the screen or window thumbnail (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and thumbSize is 100 × 100, the actual size of the thumbnail is 100 × 75. If the target size is larger than the original size, the thumbnail is the original image and the SDK does not scale it. + The target size of the screen or window thumbnail (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and thumbSize is 100 × 100, the actual size of the thumbnail is 100 × 75. If the target size is larger than the original size, the thumbnail is the original image and the SDK does not scale it. iconSize - The target size of the icon corresponding to the application program (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and iconSize is 100 × 100, the actual size of the icon is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it. + The target size of the icon corresponding to the application program (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and iconSize is 100 × 100, the actual size of the icon is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it. includeScreen @@ -64,4 +64,4 @@

                        The array.

                        - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita b/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita index e59ede728a5..85588b693ac 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita @@ -1,12 +1,12 @@ - <ph keyref="initialize"/> - Creates and initializes . Initializes . + <ph keyref="initialize" /> + Creates and initializes . Initializes . - + @@ -24,17 +24,17 @@ int Initialize(const FRtcEngineContext& context);                         public abstract int Initialize(RtcEngineContext context); abstract initialize(context: RtcEngineContext): number; Future<void> initialize(RtcEngineContext context); -

                        +

                        Details -

                        All called methods provided by the class are executed asynchronously. Agora recommends calling these methods in the same thread.

                        +

                        All called methods provided by the class are executed asynchronously. Agora recommends calling these methods in the same thread.

                          -
                        • Before calling other APIs, you must call and to create and initialize the object.
                          • -
                        • Before calling other APIs, you must call this method to create the object.
                          • -
                        • You can create the instance either by calling this method or by calling . The difference between and this method is that this method supports more configurations when creating the instance, for example, specifying the region for connection and setting the log files.
                          • -
                        • The SDK supports creating only one instance for an app.
                          • +
                        • Before calling other APIs, you must call and to create and initialize the object.
                          • +
                        • Before calling other APIs, you must call this method to create the object.
                          • +
                        • You can create the instance either by calling this method or by calling . The difference between and this method is that this method supports more configurations when creating the instance, for example, specifying the region for connection and setting the log files.
                          • +
                        • The SDK supports creating only one instance for an app.
                        Parameters @@ -43,19 +43,19 @@ int Initialize(const FRtcEngineContext& context); context config -

                        Configurations for the instance. See .

                        +

                        Configurations for the instance. See .

                         delegate - +
                        - <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.

                          -
                        • The instance, if the method call succeeds.
                          • +
                        • The instance, if the method call succeeds.
                        • 0: Success.
                        • The method call fails and an exception is thrown, you need to catch the exception and handle it.
                        • < 0: Failure.
                            @@ -66,6 +66,6 @@ int Initialize(const FRtcEngineContext& context);
                          • -101: The App ID is invalid.
                        -
                        +
                        - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita index 32784eff09f..fa0545d7148 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita @@ -38,12 +38,12 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia uid: number, options: ChannelMediaOptions ): number; - Future<void> joinChannel( + Future<void> joinChannel( {required String token, required String channelId, required int uid, required ChannelMediaOptions options}); -

                        +

                        Details @@ -64,7 +64,7 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia token - The token generated on your server for authentication. See .If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See . + The token generated on your server for authentication. See .If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See . channelId @@ -74,7 +74,7 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia
                      • All uppercase English letters: A to Z.
                      • All numeric characters: 0 to 9.
                      • Space
                        • -
                      • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
                        • +
                      • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

                                             @@ -93,8 +93,8 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia
                      - <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.
                          @@ -108,4 +108,4 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia
                      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita index 45c2da87a3a..78c9cc34430 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita @@ -1,12 +1,12 @@ - <ph keyref="preloadChannel"/> + <ph keyref="preloadChannel" /> Preloads a channel with token, channelIdchannelName, and uidoptionalUid. - + @@ -29,7 +29,7 @@ channelId: string, uid: number ): number; - Future<void> preloadChannel( + Future<void> preloadChannel( {required String token, required String channelId, required int uid});

                      @@ -41,9 +41,9 @@

                      When audience members need to switch between different channels frequently, calling the method can help shortening the time of joining a channel, thus reducing the time it takes for audience members to hear and see the host. As it may take a while for the SDK to preload a channel, Agora recommends that you call this method as soon as possible after obtaining the channel name and user ID to join a channel.

                      -
                      • When calling this method, ensure you set the user role as audience and do not set the audio scenario as , otherwise, this method does not take effect.
                        • +
                        • When calling this method, ensure you set the user role as audience and do not set the audio scenario as , otherwise, this method does not take effect.
                        • You also need to make sure that the channel name, user ID and token passed in for preloading are the same as the values passed in when joinning the channel, otherwise, this method does not take effect.
                          • -
                        • One instance supports preloading 20 channels at most. When exceeding this limit, the latest 20 preloaded channels take effect.
                          • +
                        • One instance supports preloading 20 channels at most. When exceeding this limit, the latest 20 preloaded channels take effect.
                        • Failing to preload a channel does not mean that you can't join a channel, nor will it increase the time of joining a channel.

                        If you join a preloaded channel, leave it and want to rejoin the same channel, you do not need to call this method unless the token for preloading the channel expires.

                      @@ -52,8 +52,8 @@ token - The token generated on your server for authentication. See .

                      When the token for preloading channels expires, you can update the token based on the number of channels you preload.

                      • When preloading one channel, calling this method to pass in the new token.
                        • -
                      • When preloading more than one channels:
                        • If you use a wildcard token for all preloaded channels, call to update the token.When generating a wildcard token, ensure the user ID is not set as 0. See .
                          • + The token generated on your server for authentication. See .

                          When the token for preloading channels expires, you can update the token based on the number of channels you preload.

                          • When preloading one channel, calling this method to pass in the new token.
                            • +
                          • When preloading more than one channels:
                            • If you use a wildcard token for all preloaded channels, call to update the token.
                            • If you use different tokens to preload different channels, call this method to pass in your user ID, channel name and the new token.

                           @@ -65,17 +65,17 @@
                        • All uppercase English letters: A to Z.
                        • All numeric characters: 0 to 9.
                        • Space
                          • -
                        • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
                          • +
                        • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

                        - - + +
                        - <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.
                            @@ -84,4 +84,4 @@
                        - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita index f7ea30f5080..12fa874d11a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita @@ -1,12 +1,12 @@ - <ph keyref="preloadChannel2"/> + <ph keyref="preloadChannel2" /> Preloads a channel with token, channelIdchannelName, and userAccount. - + @@ -29,7 +29,7 @@ channelId: string, userAccount: string ): number; - Future<void> preloadChannelWithUserAccount( + Future<void> preloadChannelWithUserAccount( {required String token, required String channelId, required String userAccount});

                        @@ -42,34 +42,34 @@
                        v4.2.2
                        -

                        +

                        -

                        • +
                          • You also need to make sure that the User Account, channel ID and token passed in for preloading are the same as the values passed in when joining the channel, otherwise, this method does not take effect.
                            • -
                          • -
                          -

                          +
                        • +
                        +

                        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.
                            @@ -79,4 +79,4 @@
                        -                         + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita index ecf5948faa7..824add4a204 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita @@ -20,7 +20,7 @@ abstract pushReverseAudioFrame(frame: AudioFrame): number; Future<void> pushReverseAudioFrame(AudioFrame frame); -

                        +

                        Details @@ -44,8 +44,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_pushvideoframe2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita index 49795b6e1ef..522511a99b2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita @@ -1,12 +1,12 @@ - <ph keyref="pushVideoFrame2"/> + <ph keyref="pushVideoFrame2" /> Pushes the external video frame. - + @@ -14,32 +14,32 @@

                          public abstract boolean pushExternalVideoFrame(VideoFrame frame); - - - - - - -

                          + + + + + + +

                          Details -

                          This method actively encapsulates the video frame data with the class and passes it to the SDK. Call the method and set enable as before calling this method; otherwise, a failure returns after calling this method.

                          -

                          You can push the video frame either by calling this method or by calling . The difference is that the method supports video data in texture format.

                          +

                          This method actively encapsulates the video frame data with the class and passes it to the SDK. Call the method and set enable as before calling this method; otherwise, a failure returns after calling this method.

                          +

                          You can push the video frame either by calling this method or by calling . The difference is that the method supports video data in texture format.

                          Parameters frame - Video frame to be pushed. See . + Video frame to be pushed. See .
                          Returns
                            -
                          • : Pushes the external raw video frame to the SDK successfully.
                            • -
                          • : Fails to push external raw video frame to the SDK.
                            • +
                          • : Pushes the external raw video frame to the SDK successfully.
                            • +
                          • : Fails to push external raw video frame to the SDK.
                          -                           + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita b/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita index 6f73c320d3b..1f04f986931 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita @@ -1,12 +1,12 @@ - <ph keyref="queryCodecCapability"/> + <ph keyref="queryCodecCapability" /> Queries the current device's supported video codec capabilities. - + @@ -14,13 +14,13 @@

                          public abstract CodecCapInfo[] queryCodecCapability(); - - (NSArray <AgoraVideoCodecCapInfo *> *__nullable)queryCodecCapability; + - (NSArray <AgoraVideoCodecCapInfo *> *__nullable)queryCodecCapability; virtual int queryCodecCapability(CodecCapInfo* codecInfo, int& size) = 0; abstract queryCodecCapability(): { codecInfo: CodecCapInfo[]; size: number }; public abstract int QueryCodecCapability(ref CodecCapInfo[] codecInfo, ref int size); abstract queryCodecCapability(): { codecInfo: CodecCapInfo[]; size: number }; - Future<List<CodecCapInfo>> queryCodecCapability(int size);

                          + Future<List<CodecCapInfo>> queryCodecCapability(int size);

                          Details @@ -30,7 +30,7 @@
                          v4.2.0
                          -

                          +

                          Parameters @@ -38,28 +38,28 @@ codecInfo -

                          Input and output parameter. An array representing the video codec capabilities of the device. See .

                          +

                          Input and output parameter. An array representing the video codec capabilities of the device. See .

                            -
                          • Input value: One defined by the user when executing this method, representing the video codec capability to be queried.
                            • -
                          • Output value: The after the method is executed, representing the actual video codec capabilities supported by the device.
                            • +
                          • Input value: One defined by the user when executing this method, representing the video codec capability to be queried.
                            • +
                          • Output value: The after the method is executed, representing the actual video codec capabilities supported by the device.
                                                     size - Input and output parameter, represent the size of the array.
                            -
                          • Input value: Size of the defined by the user when executing the method.
                            • -
                          • Output value: Size of the output after this method is executed.
                            • + Input and output parameter, represent the size of the array.
                              +
                            • Input value: Size of the defined by the user when executing the method.
                              • +
                            • Output value: Size of the output after this method is executed.
                             - The size of . + The size of .
                          Returns
                          • If the call is successful, an object containing the following attributes is returned:
                              -
                            • codecInfo: The array, indicating the video codec capabillity of the device.
                              • -
                            • size: The size of the array.
                            • +
                          • codecInfo: The array, indicating the video codec capabillity of the device.
                            • +
                          • size: The size of the array.
                        • If the call timeouts, please modify the call logic and do not invoke the method in the main thread.
                          @@ -67,8 +67,8 @@
                        • < 0: Failure.
                          -
                        • One array indicating the video encoding capability of the device, if the method call succeeds.
                          • +
                        • One array indicating the video encoding capability of the device, if the method call succeeds.
                        • If the call timeouts, please modify the call logic and do not invoke the method in the main thread.
                        - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita b/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita index c08e8357f73..d82275073b5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita @@ -1,12 +1,12 @@ - <ph keyref="queryScreenCaptureCapability"/> + <ph keyref="queryScreenCaptureCapability" /> Queries the highest frame rate supported by the device during screen sharing. - + @@ -18,10 +18,10 @@ #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) virtual int queryScreenCaptureCapability() = 0; #endif - + public abstract int QueryScreenCaptureCapability(); abstract queryScreenCaptureCapability(): number; - Future<int> queryScreenCaptureCapability();

                        + Future<int> queryScreenCaptureCapability();

                        Details @@ -31,7 +31,7 @@
                        v4.2.0
                        -

                        +

                        Applicable scenarios @@ -39,15 +39,15 @@

                        To ensure optimal screen sharing performance, particularly in enabling high frame rates like 60 fps, Agora recommends you to query the device's maximum supported frame rate using this method beforehand. This way, if the device cannot support such a high frame rate, you can adjust the screen sharing stream accordingly to avoid any negative impact on the sharing quality. If the device does not support high frame rate, you can reduce the frame rate of the screen sharing stream appropriately when sharing the screen to ensure that the sharing effect meets your expectation.

                        - <ph keyref="return-section-title"/> -
                        • The highest frame rate supported by the device, if the method is called successfully. See .
                          • -
                        • If the call fails, returns .
                        + <ph keyref="return-section-title" /> +
                        • The highest frame rate supported by the device, if the method is called successfully. See .
                          • +
                        • If the call fails, returns .
                          -
                        • The highest frame rate supported by the device, if the method is called successfully. See .
                            +
                          • The highest frame rate supported by the device, if the method is called successfully. See .
                            • 0: The device supports the frame rate of up to 15 fps.
                            • 1: The device supports the frame rate of up to 30 fps.
                            • 2: The device supports the frame rate of up to 60 fps.
                          • < 0: Failure.
                        -                         + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita index a673b4ca224..99c0d265deb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita @@ -30,7 +30,7 @@ void registerAudioEncodedFrameObserver( {required AudioEncodedFrameObserverConfig config, required AudioEncodedFrameObserver observer}); -

                        +

                        Details @@ -57,12 +57,12 @@
                        - <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.
                        -

                        One object.

                        +

                        One object.

                        - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita index 690705aacc0..4ae53df7967 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita @@ -25,7 +25,7 @@ observer: IAudioSpectrumObserver ): number;                         void registerAudioSpectrumObserver(AudioSpectrumObserver observer); -

                        +

                        Details @@ -44,13 +44,13 @@
                        - <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.
                        -

                        One object.

                        +

                        One object.

                        - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita index 597a5977265..38e4f83a975 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita @@ -28,7 +28,7 @@ ): number;                         void registerMediaMetadataObserver( {required MetadataObserver observer, required MetadataType type}); -

                        +

                        Details @@ -46,17 +46,17 @@ type -

                        The metadata type. The SDK currently only supports . See .

                        +

                        The metadata type. The SDK currently only supports . 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.
                        - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita b/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita index afca01f5f2c..153eb373a2d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita @@ -24,7 +24,7 @@ eventHandler: IRtcEngineEventHandler ): boolean;                         void unregisterEventHandler(RtcEngineEventHandler eventHandler); -

                        +

                        Details @@ -40,8 +40,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.

                        • : Success.
                        • : Failure.
                          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita b/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita index 7e8150a04f5..3a7b760620e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita @@ -21,7 +21,7 @@ abstract sendMetaData(metadata: Metadata, sourceType: VideoSourceType): number; Future<void> sendMetaData( {required Metadata metadata, required VideoSourceType sourceType}); -

                          +

                        Details @@ -33,20 +33,20 @@ metadata - Media metadata See . + Media metadata See . sourceType source_type - The type of the video source. See . + The type of the video source. 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.
                        - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita index 4c5cd2d10ff..cbfbc0ade95 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita @@ -19,8 +19,8 @@ abstract setAdvancedAudioOptions(options: AdvancedAudioOptions): number; public abstract int SetAdvancedAudioOptions(AdvancedAudioOptions options); abstract setAdvancedAudioOptions(options: AdvancedAudioOptions): number; - Future<void> setAdvancedAudioOptions(AdvancedAudioOptions options); -

                        + Future<void> setAdvancedAudioOptions(AdvancedAudioOptions options); +

                        Details @@ -35,8 +35,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_setaudiomixingdualmonomode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita index 0e855cf80c7..8b48be63691 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita @@ -20,7 +20,7 @@ public abstract int SetAudioMixingDualMonoMode(AUDIO_MIXING_DUAL_MONO_MODE mode); abstract setAudioMixingDualMonoMode(mode: AudioMixingDualMonoMode): number; Future<void> setAudioMixingDualMonoMode(AudioMixingDualMonoMode mode); -

                          +

                        Details @@ -39,11 +39,11 @@
                        - <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_setclientrole.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita index 6026262180e..59ee4bf4bbd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita @@ -30,7 +30,7 @@
                        Details

                        You can call this method either before or after joining the channel to set the user role as audience or host.

                        -

                        +

                        If you call this method to switch the user role after joining the channel, the SDK triggers the following callbacks:

                        • The local client: .
                        • The remote client: or ().
                          • @@ -62,4 +62,4 @@
                      -                       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita index 40f25a29d3b..d826cfe52e6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita @@ -30,11 +30,11 @@ options: ColorEnhanceOptions, type?: MediaSourceType ): number; - Future<void> setColorEnhanceOptions( + Future<void> setColorEnhanceOptions( {required bool enabled, required ColorEnhanceOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

                      +

                      Details @@ -48,7 +48,7 @@
                    • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
                    • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
                    -
                  • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
                    • +
                  • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
                  Parameters @@ -66,16 +66,16 @@ The color enhancement options. 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.
                  - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita index 8aa7c1146ef..524130cf3a5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita @@ -1,12 +1,12 @@ - <ph keyref="setDualStreamMode"/> + <ph keyref="setDualStreamMode" /> Sets the dual-stream mode on the sender side. - + @@ -16,11 +16,11 @@ public abstract int setDualStreamMode(Constants.SimulcastStreamMode mode); - (int)setDualStreamMode:(AgoraSimulcastStreamMode)mode; virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode) = 0; - + public abstract int SetDualStreamMode(SIMULCAST_STREAM_MODE mode); - - -

                  + + +

                  Details
                  @@ -29,12 +29,12 @@
                  v4.0.1
                  -

                  The SDK enables the low-quality video stream auto mode on the sender side by default (it does not actively sending low-quality video streams). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling . After receiving the application, the sending end automatically switches to the low-quality video stream mode.

                    -
                  • If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).
                    • -
                  • If you want to restore the default behavior after making changes, you can call this method again with mode set to .

                  - The difference and connection between this method and is as follows:
                    -
                  • When calling this method and setting mode to , it has the same effect as ().
                    • -
                  • When calling this method and setting mode to , it has the same effect as ().
                    • +

                    The SDK enables the low-quality video stream auto mode on the sender side by default (it does not actively sending low-quality video streams). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling . After receiving the application, the sending end automatically switches to the low-quality video stream mode.

                      +
                    • If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).
                      • +
                    • If you want to restore the default behavior after making changes, you can call this method again with mode set to .

                    + The difference and connection between this method and is as follows:
                      +
                    • When calling this method and setting mode to , it has the same effect as ().
                      • +
                    • When calling this method and setting mode to , it has the same effect as ().
                    • Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
                  @@ -43,7 +43,7 @@ mode - The mode in which the video stream is sent. See . + The mode in which the video stream is sent. See .
                  @@ -54,4 +54,4 @@
                - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita index e242501a5e7..52fa0d2692b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita @@ -1,12 +1,12 @@ - <ph keyref="setDualStreamMode2"/> + <ph keyref="setDualStreamMode2" /> Sets dual-stream mode configuration on the sender, and sets the low-quality video stream. - + @@ -30,9 +30,9 @@ int SetDualStreamMode(ESIMULCAST_STREAM_MODE mode, const FSimulcastStreamConfig& mode: SimulcastStreamMode, streamConfig?: SimulcastStreamConfig ): number; - Future<void> setDualStreamMode( + Future<void> setDualStreamMode( {required SimulcastStreamMode mode, SimulcastStreamConfig? streamConfig}); -

                +

                Details @@ -42,11 +42,11 @@ int SetDualStreamMode(ESIMULCAST_STREAM_MODE mode, const FSimulcastStreamConfig&
                v4.0.1
                -

                -

                The difference between this method and is that this method can also configure the low-quality video stream, and the SDK sends the stream according to the configuration in streamConfig.

                - The difference and connection between this method and is as follows:
                  -
                • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
                  • -
                • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
                  • +

                  +

                  The difference between this method and is that this method can also configure the low-quality video stream, and the SDK sends the stream according to the configuration in streamConfig.

                  + The difference and connection between this method and is as follows:
                    +
                  • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
                    • +
                  • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
                  • Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
                @@ -55,22 +55,22 @@ int SetDualStreamMode(ESIMULCAST_STREAM_MODE mode, const FSimulcastStreamConfig& mode - The mode in which the video stream is sent. See . + The mode in which the video stream is sent. See . streamConfig -

                The configuration of the low-quality video stream. See .

                - When setting mode to , setting streamConfig will not take effect. +

                The configuration of the low-quality video stream. See .

                + When setting mode to , setting streamConfig will not take effect.
                - <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_setexternalaudiosourcevolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita index 33cf462e4fc..03cd3c98c8a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita @@ -1,26 +1,26 @@ - <ph keyref="setExternalAudioSourceVolume"/> + <ph keyref="setExternalAudioSourceVolume" /> Sets the volume of the external audio frame in the specified position. - +

                - - - - + + + + public abstract int SetExternalAudioSourceVolume(int sourcePos, int volume); - - -

                + + +

                Details @@ -31,7 +31,7 @@ sourcePos - The push position of the external audio frame. See . + The push position of the external audio frame. See . The push position of the external audio frame.
                • 0: The position before local playback. If you need to play the external audio frame on the local client, set this position.
                • 1: The position after audio capture and before audio pre-processing. If you need the audio module of the SDK to process the external audio frame, set this position.
                  • @@ -50,4 +50,4 @@
                • < 0: Failure.
                 -                 + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita index 81a39d1bae4..3044e7e5387 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita @@ -1,12 +1,12 @@ - <ph keyref="setHeadphoneEQPreset"/> + <ph keyref="setHeadphoneEQPreset" /> Sets the preset headphone equalization effect. - + @@ -19,8 +19,8 @@ abstract setHeadphoneEQPreset(preset: HeadphoneEqualizerPreset): number; public abstract int SetHeadphoneEQPreset(HEADPHONE_EQUALIZER_PRESET preset); abstract setHeadphoneEQPreset(preset: HeadphoneEqualizerPreset): number; - Future<void> setHeadphoneEQPreset(HeadphoneEqualizerPreset preset); -

                + Future<void> setHeadphoneEQPreset(HeadphoneEqualizerPreset preset); +

                Details @@ -37,12 +37,12 @@ preset - The preset headphone equalization effect. See . + The preset headphone equalization effect. 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.
                    @@ -50,4 +50,4 @@
                -                 + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita index c3647fd7002..c3480cc62cb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita @@ -20,7 +20,7 @@ public abstract int SetLiveTranscoding(LiveTranscoding transcoding); abstract setLiveTranscoding(transcoding: LiveTranscoding): number; Future<void> setLiveTranscoding(LiveTranscoding transcoding); -

                +

                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_irtcengine_setlocalaccesspoint.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita index f4e7909d760..16099dadaa3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita @@ -20,7 +20,7 @@ public abstract int SetLocalAccessPoint(LocalAccessPointConfiguration config); abstract setLocalAccessPoint(config: LocalAccessPointConfiguration): number; Future<void> setLocalAccessPoint(LocalAccessPointConfiguration config); -

                  +

                Details @@ -39,11 +39,11 @@
                - <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_setlocalpublishfallbackoption.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita index f2cdb722684..00f11d92787 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita @@ -20,7 +20,7 @@ public abstract int SetLocalPublishFallbackOption(STREAM_FALLBACK_OPTIONS option); Future<void> setLocalPublishFallbackOption(StreamFallbackOptions option); -

                +

                Details @@ -43,8 +43,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_setlocalrendermode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita index 248548892ff..f63c0d5634d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita @@ -27,7 +27,7 @@ mirrorMode?: VideoMirrorModeType ): number; Future<void> setLocalRenderMode2(RenderModeType renderMode); -

                  +

                Details @@ -58,8 +58,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_setlowlightenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita index 7eb991a0bf8..ca7fff34830 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita @@ -30,11 +30,11 @@ options: LowlightEnhanceOptions, type?: MediaSourceType ): number; - Future<void> setLowlightEnhanceOptions( + Future<void> setLowlightEnhanceOptions( {required bool enabled, required LowlightEnhanceOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

                  +

                Details @@ -48,7 +48,7 @@
              • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
              • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
              -
            • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
              • +
            • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
            Parameters @@ -67,15 +67,15 @@ type - The type of the video source. See . + The type of the video source. 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.
            - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita index 7d9e0aedc70..333bdd5bf19 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita @@ -28,7 +28,7 @@ ): number; Future<void> setRemoteUserSpatialAudioParams( {required int uid, required SpatialAudioParams params}); -

            +

            Details @@ -48,8 +48,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_setscreencapturecontenthint.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita index 0f9610c40a5..fab2eda96c6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita @@ -21,7 +21,7 @@ public abstract int SetScreenCaptureContentHint(VIDEO_CONTENT_HINT contentHint); abstract setScreenCaptureContentHint(contentHint: VideoContentHint): number; Future<void> setScreenCaptureContentHint(VideoContentHint contentHint); -

              +

            Details @@ -37,8 +37,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_setuplocalvideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita index 35111ec27c5..01f5bd4fafc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita @@ -20,7 +20,7 @@ public abstract int SetupLocalVideo(VideoCanvas canvas); abstract setupLocalVideo(canvas: VideoCanvas): number; Future<void> setupLocalVideo(VideoCanvas canvas); -

              +

            Details @@ -28,7 +28,7 @@

            After initialization, call this method to set the local video and then join the channel. The local video still binds to the view after you leave the channel. To unbind the local video from the view, set the view parameter as .

              -
            • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
              • +
            • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
            • You can call this method either before or after joining a channel.
            • To update the rendering or mirror mode of the local video view during a call, use the method.
            @@ -38,15 +38,15 @@ canvas local - The local video view and settings. See . + The local video view and settings. 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.
            - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita index 614a5323a70..f8de9b0a7ec 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita @@ -1,12 +1,12 @@ - <ph keyref="setupRemoteVideo"/> + <ph keyref="setupRemoteVideo" /> Initializes the video view of a remote user. - + @@ -20,19 +20,19 @@ public abstract int SetupRemoteVideo(VideoCanvas canvas); abstract setupRemoteVideo(canvas: VideoCanvas): number; Future<void> setupRemoteVideo(VideoCanvas canvas); -

            +

            Details

            This method initializes the video view of a remote stream on the local device. It affects only the video view that the local user sees. Call this method to bind the remote video stream to a video view and to set the rendering and mirror modes of the video view.

            -

            You need to specify the ID of the remote user in this method. If the remote user ID is unknown to the application, set it after the app receives the callback.

            +

            You need to specify the ID of the remote user in this method. If the remote user ID is unknown to the application, set it after the app receives the callback.

            To unbind the remote user from the view, set the view parameter to NULL.

            Once the remote user leaves the channel, the SDK unbinds the remote user.

              -
            • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
              • -
            • To update the rendering or mirror mode of the remote video view during a call, use the method.
              • -
            • If you use the Agora recording function, the recording client joins the channel as a placeholder client, triggering the callback. Do not bind the placeholder client to the app view because the placeholder client does not send any video streams. If your app does not recognize the placeholder client, bind the remote user to the view when the SDK triggers the callback.
              • +
            • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
              • +
            • To update the rendering or mirror mode of the remote video view during a call, use the method.
              • +
            • If you use the Agora recording function, the recording client joins the channel as a placeholder client, triggering the callback. Do not bind the placeholder client to the app view because the placeholder client does not send any video streams. If your app does not recognize the placeholder client, bind the remote user to the view when the SDK triggers the callback.
            Parameters @@ -41,16 +41,16 @@ canvas remote -

            The remote video view and settings. See .

            +

            The remote video view and settings. 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.
            -             + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita index 680cde7ba6f..6e2f6c0cac2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita @@ -1,12 +1,12 @@ - <ph keyref="setVideoDenoiserOptions"/> + <ph keyref="setVideoDenoiserOptions" /> Sets video noise reduction. - + @@ -30,11 +30,11 @@ options: VideoDenoiserOptions, type?: MediaSourceType ): number;             - Future<void> setVideoDenoiserOptions( + Future<void> setVideoDenoiserOptions( {required bool enabled, required VideoDenoiserOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

            +

            Details @@ -42,13 +42,13 @@

            You can call this method to enable the video noise reduction feature and set the options of the video noise reduction effect.

              -
            • Call this method after calling .
              • +
            • Call this method after calling .
            • Video noise reduction has certain requirements for equipment performance. If your device overheats after you enable video noise reduction, Agora recommends modifying the video noise reduction options to a less performance-consuming level or disabling video noise reduction entirely.
              • -
            • Both this method and can turn on video noise reduction function:
                +
              • Both this method and can turn on video noise reduction function:
                • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
                  • -
                • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
                  • +
                • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
                • -
              • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
                • +
              • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
            Parameters @@ -57,25 +57,25 @@ enabled enable Whether to enable video noise reduction:
              -
            • : Enable video noise reduction.
              • -
            • : (Default) Disable video noise reduction.
              • +
            • : Enable video noise reduction.
              • +
            • : (Default) Disable video noise reduction.
             options - The video noise reduction options. See . + The video noise reduction options. 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.
            - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita index 45dc2e0a7e8..a6c3a58017f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita @@ -1,12 +1,12 @@ - <ph keyref="setVideoEncoderConfiguration"/> + <ph keyref="setVideoEncoderConfiguration" /> Sets the video encoder configuration. - + @@ -24,32 +24,32 @@ config: VideoEncoderConfiguration ): number;             Future<void> setVideoEncoderConfiguration(VideoEncoderConfiguration config); -

            +

            Details

            Sets the encoder configuration for the local video.

              -
            • You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.
              • -
            • Both this method and the method support setting the mirroring effect. Agora recommends that you only choose one method to set it up. Using both methods at the same time causes the mirroring effect to overlap, which causes the mirroring settings to fail.
              • +
            • You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.
              • +
            • Both this method and the method support setting the mirroring effect. Agora recommends that you only choose one method to set it up. Using both methods at the same time causes the mirroring effect to overlap, which causes the mirroring settings to fail.
             - You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame. - Call this method before joining a channel. Agora recommends calling this method before to reduce the time to render the first video frame.
            + You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame. + Call this method before joining a channel. Agora recommends calling this method before to reduce the time to render the first video frame.
            Parameters config - Video profile. See . + Video profile. 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.
            - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita index 3d64a2daecf..754ae6046d9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita @@ -1,12 +1,12 @@ - <ph keyref="setVideoProfile"/> + <ph keyref="setVideoProfile" /> Sets the video encoder configuration. - + @@ -17,21 +17,21 @@ - (int)setVideoProfile:(AgoraVideoProfile)profile swapWidthAndHeight:(BOOL)swapWidthAndHeight virtual int setVideoProfile(VIDEO_PROFILE_TYPE profile, bool swapWidthAndHeight) = 0; - + public abstract int SetVideoProfile(VIDEO_PROFILE_TYPE profile, bool swapWidthAndHeight = false); - - -

            + + +

            Details
            Deprecated:
            -
            This method is deprecated. Use instead.
            +
            This method is deprecated. Use instead.
            -

            This method sets the video encoder configuration. You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.

            +

            This method sets the video encoder configuration. You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.

            Parameters @@ -39,7 +39,7 @@ profile -

            Video profile. See .

            +

            Video profile. See .

                         @@ -47,8 +47,8 @@

            The SDK outputs video with a fixed width and height according to the video profile (profile) you selected. This parameter sets whether to swap width and height of the video:

              -
            • : Swap the width and height.
              • -
            • : (Default) Do not swap the width and height.
              • +
            • : Swap the width and height.
              • +
            • : (Default) Do not swap the width and height.
            @@ -59,4 +59,4 @@
          • < 0: Failure.
          - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita index 5d427d9ae9b..deb45054d86 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita @@ -22,7 +22,7 @@ int StartAudioRecording(const FAudioRecordingConfiguration& config);public abstract int StartAudioRecording(AudioRecordingConfiguration config); abstract startAudioRecording(config: AudioRecordingConfiguration): number; Future<void> startAudioRecording(AudioRecordingConfiguration config); -

          +

          Details @@ -41,8 +41,8 @@ int StartAudioRecording(const FAudioRecordingConfiguration& config);
          - <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_startcameracapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita index 4cf0f6b37a6..3c66e3c082a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita @@ -1,12 +1,12 @@ - <ph keyref="startCameraCapture"/> + <ph keyref="startCameraCapture" /> Starts camera capture. - + @@ -26,10 +26,10 @@ sourceType: VideoSourceType, config: CameraCapturerConfiguration ): number; - Future<void> startCameraCapture( + Future<void> startCameraCapture( {required VideoSourceType sourceType, required CameraCapturerConfiguration config}); -

            +

          Details @@ -40,7 +40,7 @@

          You can call this method to start capturing video from one or more cameras by specifying sourceType.

          - On the iOS platform, if you want to enable multi-camera capture, you need to call and set enabled to before calling this method. + On the iOS platform, if you want to enable multi-camera capture, you need to call and set enabled to before calling this method.
          Parameters @@ -48,7 +48,7 @@ sourceType -

          The type of the video source. See .

          +

          The type of the video source. See .

          • On the mobile platforms, you can capture video from up to 2 cameras, provided the device has dual cameras or supports an external camera.
          • On the desktop platforms, you can capture video from up to 4 cameras.
                     @@ -57,13 +57,13 @@ config -

          The configuration of the video capture. See .

          - On the iOS platform, this parameter has no practical function. Use the config parameter in instead to set the video capture configuration.           +

          The configuration of the video capture. See .

          + On the iOS platform, this parameter has no practical function. Use the config parameter in instead to set the video capture configuration.
          - <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.

            @@ -71,4 +71,4 @@
          • < 0: Failure.
          - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita index 88981a21ddf..72f0129b966 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita @@ -1,12 +1,12 @@ - <ph keyref="startChannelMediaRelay"/> + <ph keyref="startChannelMediaRelay" /> Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels. - + @@ -26,7 +26,7 @@ ): number;           Future<void> startChannelMediaRelay( ChannelMediaRelayConfiguration configuration); -

          +

          Details @@ -36,16 +36,16 @@
          This method is deprecated. Use instead.
          -

          After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.

            -
          • If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
            • -
          • If the callback returns (3), an exception occurs during the media stream relay.
            • +

            After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.

              +
            • If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
              • +
            • If the callback returns (3), an exception occurs during the media stream relay.

            • Call this method after joining the channel.
            • This method takes effect only when you are a host in a live streaming channel.
              • -
            • After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
              • -
            • The relaying media streams across channels function needs to be enabled by contacting .
              • +
            • After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
              • +
            • The relaying media streams across channels function needs to be enabled by contacting .
            • Agora does not support string user accounts in this API.
          @@ -55,12 +55,12 @@ channelMediaRelayConfiguration config configuration - The configuration of the media stream relay. See . + The configuration of the media stream relay. 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.
              @@ -71,4 +71,4 @@
          - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita index 7b7e026828d..972299535be 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita @@ -28,11 +28,11 @@ publishUrl: string, options: DirectCdnStreamingMediaOptions ): number;           - Future<void> startDirectCdnStreaming( + Future<void> startDirectCdnStreaming( {required DirectCdnStreamingEventHandler eventHandler, required String publishUrl, required DirectCdnStreamingMediaOptions options}); -

          +

          Details

          Aogra does not support pushing media streams to one URL repeatedly.

          @@ -46,7 +46,7 @@
        • publishCameraTrack is set as (the default value)
        • publishMicrophoneTrack is set as (the default value)
        -

        As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call to push audio streams. As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call or to push audio streams.Agora only supports pushing one audio and video streams or one audio streams to CDN.

        +

        As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call to push audio streams. As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call or to push audio streams.Agora only supports pushing one audio and video streams or one audio streams to CDN.

        Parameters @@ -65,11 +65,11 @@
        - <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_startechotest3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita index 8cfe53b8c44..c59232d3c4e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita @@ -1,12 +1,12 @@ - <ph keyref="startEchoTest3"/> + <ph keyref="startEchoTest3" /> Starts an audio device loopback test. - + @@ -21,8 +21,8 @@ int StartEchoTest(const FEchoTestConfiguration& config); abstract startEchoTest(config: EchoTestConfiguration): number; public abstract int StartEchoTest(EchoTestConfiguration config); abstract startEchoTest(config: EchoTestConfiguration): number; - Future<void> startEchoTest(EchoTestConfiguration config); -

        + Future<void> startEchoTest(EchoTestConfiguration config); +

        Details @@ -30,7 +30,7 @@ int StartEchoTest(const FEchoTestConfiguration& config);

        After starting the test, the user needs to make a sound or face the camera. The audio or video is output after about two seconds. If the audio playback is normal, the audio device and the user's upstream and downstream networks are working properly; if the video playback is normal, the video device and the user's upstream and downstream networks are working properly.

        • You can call this method either before or after joining a channel. When calling in a channel, make sure that no audio or video stream is being published.
          • -
        • After calling this method, call to end the test; otherwise, the user cannot perform the next audio and video call loop test and cannot join the channel.
          • +
        • After calling this method, call to end the test; otherwise, the user cannot perform the next audio and video call loop test and cannot join the channel.
        • In live streaming scenarios, this method only applies to hosts.

        @@ -39,7 +39,7 @@ int StartEchoTest(const FEchoTestConfiguration& config);         config - The configuration of the audio and video call loop test. See . + The configuration of the audio and video call loop test. See .
        @@ -49,4 +49,4 @@ int StartEchoTest(const FEchoTestConfiguration& config);
      • < 0: Failure.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita index 6a6571943ee..6ff8cff1f41 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita @@ -1,12 +1,12 @@ - <ph keyref="startOrUpdateChannelMediaRelay"/> + <ph keyref="startOrUpdateChannelMediaRelay" /> Starts relaying media streams across channels or updates channels for media relay. - + @@ -24,9 +24,9 @@ abstract startOrUpdateChannelMediaRelay( configuration: ChannelMediaRelayConfiguration ): number; - Future<void> startOrUpdateChannelMediaRelay( + Future<void> startOrUpdateChannelMediaRelay( ChannelMediaRelayConfiguration configuration); -

      +

      Details @@ -36,15 +36,15 @@
      v4.2.0

      The first successful call to this method starts relaying media streams from the source channel to the destination channels. To relay the media stream to other channels, or exit one of the current media relays, you can call this method again to update the destination channels. This feature supports relaying media streams to a maximum of six destination channels.

      -

      After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:

        -
      • If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
        • -
      • If the callback returns (3), an exception occurs during the media stream relay.
        • +

        After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:

          +
        • If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
          • +
        • If the callback returns (3), an exception occurs during the media stream relay.

        • Call this method after joining the channel.
        • This method takes effect only when you are a host in a live streaming channel.
          • -
        • The relaying media streams across channels function needs to be enabled by contacting .
          • +
        • The relaying media streams across channels function needs to be enabled by contacting .
        • Agora does not support string user accounts in this API.
      @@ -54,12 +54,12 @@ channelMediaRelayConfiguration config configuration - The configuration of the media stream relay. See . + The configuration of the media stream relay. 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.
          @@ -70,4 +70,4 @@
      -       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita index db48adca5f8..2af22028816 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita @@ -1,12 +1,12 @@ - <ph keyref="startRhythmPlayer"/> + <ph keyref="startRhythmPlayer" /> Enables the virtual metronome. - + @@ -28,42 +28,42 @@ sound2: string, config: AgoraRhythmPlayerConfig ): number; - Future<void> startRhythmPlayer( + Future<void> startRhythmPlayer( {required String sound1, required String sound2, required AgoraRhythmPlayerConfig config}); -

      +

      Details

      In music education, physical education and other scenarios, teachers usually need to use a metronome so that students can practice with the correct beat. The meter is composed of a downbeat and upbeats. The first beat of each measure is called a downbeat, and the rest are called upbeats.

      In this method, you need to set the file path of the upbeat and downbeat, the number of beats per measure, the beat speed, and whether to send the sound of the metronome to remote users.

      -

      After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.

      +

      After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.

      • This method is for Android and iOS only.
        • -
      • After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning, and controls the playback duration of each file according to beatsPerMinute you set in . For example, if you set beatsPerMinute as 60, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration.
        • -
      • By default, the sound of the virtual metronome is published in the channel. If you do not want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in as .
        • +
      • After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning, and controls the playback duration of each file according to beatsPerMinute you set in . For example, if you set beatsPerMinute as 60, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration.
        • +
      • By default, the sound of the virtual metronome is published in the channel. If you do not want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in as .
      Parameters sound1 - The absolute path or URL address (including the filename extensions) of the file for the downbeat. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. + The absolute path or URL address (including the filename extensions) of the file for the downbeat. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. sound2 - The absolute path or URL address (including the filename extensions) of the file for the upbeats. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. + The absolute path or URL address (including the filename extensions) of the file for the upbeats. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. config - The metronome configuration. See . + The metronome configuration. 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.
          @@ -71,4 +71,4 @@
      -       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita index 85b5460b25e..1573e53c5e8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita @@ -1,12 +1,12 @@ - <ph keyref="startScreenCapture"/> + <ph keyref="startScreenCapture" /> Starts screen capture. - + @@ -24,32 +24,32 @@ int StartScreenCapture(const FScreenCaptureParameters2& captureParams);abstract startScreenCapture(captureParams: ScreenCaptureParameters2): number; public abstract int StartScreenCapture(ScreenCaptureParameters2 captureParams); abstract startScreenCapture(captureParams: ScreenCaptureParameters2): number; - Future<void> startScreenCapture(ScreenCaptureParameters2 captureParams); -

      + Future<void> startScreenCapture(ScreenCaptureParameters2 captureParams); +

      Details

      There are two ways to start screen sharing, you can choose one according to your needs:

        -
      • Call this method before joining a channel, then call to join channel and set publishScreenCaptureVideo to to start screen sharing.
        • -
      • Call this method after joining a channel, then call and set publishScreenCaptureVideo to to start screen sharing.
        • +
      • Call this method before joining a channel, then call to join channel and set publishScreenCaptureVideo to to start screen sharing.
        • +
      • Call this method after joining a channel, then call and set publishScreenCaptureVideo to to start screen sharing.

      -

      When the state of the screen sharing extension process changes, the SDK triggers the callback accordingly. When the type of sourceType is , the state parameter indicates the state of the screen sharing.

      +

      When the state of the screen sharing extension process changes, the SDK triggers the callback accordingly. When the type of sourceType is , the state parameter indicates the state of the screen sharing.

      • This method applies to Android and iOS only.
      • On the iOS platform, screen sharing is only available on iOS 12.0 and later.
        • -
      • The billing for the screen sharing stream is based on the dimensions in . When you do not pass in a value, Agora bills you at 1280 × 720; when you pass a value in, Agora bills you at that value. See .
        • +
      • The billing for the screen sharing stream is based on the dimensions in . When you do not pass in a value, Agora bills you at 1280 × 720; when you pass a value in, Agora bills you at that value. See .
      • If you are using the custom audio source instead of the SDK to capture audio, Agora recommends you add the keep-alive processing logic to your application to avoid screen sharing stopping when the application goes to the background.
      • This feature requires high-performance device, and Agora recommends that you use it on iPhone X and later models.
      • This method relies on the iOS screen sharing dynamic library AgoraReplayKitExtension.xcframework. If the dynamic library is deleted, screen sharing cannot be enabled normally.
      • On the Android platform, make sure the user has granted the app screen capture permission.
        • -
      • Make sure that the Android API level is not earlier than 21, otherwise, the SDK reports error codes (16) and (2).
        • -
      • To capture system audio during screen sharing, ensure that the Android API level is not earlier than 29 as well; otherwise, the SDK reports the error code (3).
        • +
      • Make sure that the Android API level is not earlier than 21, otherwise, the SDK reports error codes (16) and (2).
        • +
      • To capture system audio during screen sharing, ensure that the Android API level is not earlier than 29 as well; otherwise, the SDK reports the error code (3).
      • On Android 9 and later, to avoid the application being killed by the system after going to the background, Agora recommends you add the foreground service android.permission.FOREGROUND_SERVICE to the /app/Manifests/AndroidManifest.xml file.
      • Due to performance limitations, screen sharing is not supported on Android TV.
      • Due to system limitations, if you are using Huawei phones, do not adjust the video encoding resolution of the screen sharing stream during the screen sharing, or you could experience crashes.
      • Due to system limitations, some Xiaomi devices do not support capturing system audio during screen sharing.
        • -
      • To avoid system audio capture failure when screen sharing, Agora recommends that you set the audio application scenario to by using the method before joining the channel.
        • +
      • To avoid system audio capture failure when screen sharing, Agora recommends that you set the audio application scenario to by using the method before joining the channel.
      Parameters @@ -58,12 +58,12 @@ int StartScreenCapture(const FScreenCaptureParameters2& captureParams);parameters screenCaptureParameters captureParams - The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See . + The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. 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.
          @@ -71,4 +71,4 @@ int StartScreenCapture(const FScreenCaptureParameters2& captureParams);
      -       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita index 310a3bf7fa3..def219254a0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita @@ -24,11 +24,11 @@ int StartScreenCaptureBySourceType(EVIDEO_SOURCE_TYPE sourceType, const FScreenC config: ScreenCaptureConfiguration ): number; public abstract int StartScreenCapture(VIDEO_SOURCE_TYPE sourceType, ScreenCaptureConfiguration config); - - Future<void> startScreenCaptureBySourceType( + + Future<void> startScreenCaptureBySourceType( {required VideoSourceType sourceType, required ScreenCaptureConfiguration config}); -

      +

      Details @@ -38,15 +38,15 @@ int StartScreenCaptureBySourceType(EVIDEO_SOURCE_TYPE sourceType, const FScreenC
      v4.2.0
      -

      This method, as well as and , all have the capability to start screen capture, with the following differences: -This method, as well as , , and , all have the capability to start screen capture, with the following differences:

        -
      • only applies to Android and iOS, whereas this method only applies to Windows and iOS.
        • -
      • and only support capturing video from a single screen or window. By calling this method and specifying the sourceType parameter, you can capture multiple video streams used for local video mixing or multi-channel publishing.
        • +

        This method, as well as and , all have the capability to start screen capture, with the following differences: +This method, as well as , , and , all have the capability to start screen capture, with the following differences:

          +
        • only applies to Android and iOS, whereas this method only applies to Windows and iOS.
          • +
        • and only support capturing video from a single screen or window. By calling this method and specifying the sourceType parameter, you can capture multiple video streams used for local video mixing or multi-channel publishing.

        • This method applies to the macOS and Windows only.
          • -
        • If you call this method to start screen capture, Agora recommends that you call to stop the capture and avoid using .
         +
      • If you call this method to start screen capture, Agora recommends that you call to stop the capture and avoid using .
      Parameters @@ -54,10 +54,10 @@ int StartScreenCaptureBySourceType(EVIDEO_SOURCE_TYPE sourceType, const FScreenC sourceType -

      The type of the video source. See .

      +

      The type of the video source. See .

      • Windows supports up to four screen capture video streams.
        • -
      • macOS supports only one screen capture video stream. You can only set this parameter to (2).
       +
    • macOS supports only one screen capture video stream. You can only set this parameter to (2).
         @@ -66,8 +66,8 @@ int StartScreenCaptureBySourceType(EVIDEO_SOURCE_TYPE sourceType, const FScreenC
    - <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.

      @@ -75,4 +75,4 @@ int StartScreenCaptureBySourceType(EVIDEO_SOURCE_TYPE sourceType, const FScreenC
    • < 0: Failure.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita index 233033bfefe..6d9931600c9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita @@ -36,7 +36,7 @@ {required int displayId, required Rectangle regionRect, required ScreenCaptureParameters captureParams}); -

    +

    Details @@ -57,7 +57,7 @@ regionRect - (Optional) Sets the relative location of the region to the screen. Pass in nil to share the entire screen. See . It consists of the following parameters:
      + (Optional) Sets the relative location of the region to the screen. Pass in nil to share the entire screen. See . It consists of the following parameters:
      • x: The horizontal offset from the top-left corner.
      • y: The vertical offset from the top-left corner.
      • width: The width of the region.
        • @@ -71,8 +71,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_startscreencapturebyscreenrect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita index a53e4052867..248c1b6d1c2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita @@ -34,7 +34,7 @@ {required Rectangle screenRect, required Rectangle regionRect, required ScreenCaptureParameters captureParams}); -

        +

    Details @@ -65,8 +65,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_startscreencapturebywindowid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita index 5d8b6cf3c0e..7addffe1ce7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita @@ -35,7 +35,7 @@ {required int windowId, required Rectangle regionRect, required ScreenCaptureParameters captureParams}); -

      +

    Details @@ -196,8 +196,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_switchchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita index 2f1b1156f88..63360150c93 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita @@ -1,33 +1,33 @@ - <ph keyref="switchChannel2"/> + <ph keyref="switchChannel2" /> Switches to a different channel, and configures whether to automatically subscribe to audio or video streams in the target channel. - +

      - - + + virtual int switchChannel(const char* token, const char* channelId, const ChannelMediaOptions& options) = 0; - + public abstract int SwitchChannel(string token, string channelId, ChannelMediaOptions options); - - -

      + + +

      Details

      This method allows the audience of an interactive live streaming channel to switch to a different channel.

      -

      After the user successfully switches to another channel, the and callbacks are triggered to indicate that the user has left the original channel and joined a new one.

      +

      After the user successfully switches to another channel, the and callbacks are triggered to indicate that the user has left the original channel and joined a new one.

      Once the user switches to another channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.

      @@ -37,10 +37,10 @@ token

      The token generated at your server.

        -
      • In scenarios with low security requirements, token is optional and can be set as .
        • +
      • In scenarios with low security requirements, token is optional and can be set as .
      • In scenarios with high security requirements, set the value to the token generated from your server. If you enable the App Certificate, you must use a token to join the channel.
      - Ensure that the App ID, channel name, and user name used for creating the token are the same ones as those used by the method for initializing the RTC engine.

      + Ensure that the App ID, channel name, and user name used for creating the token are the same ones as those used by the method for initializing the RTC engine.

      @@ -52,13 +52,13 @@
    • All uppercase English letters: A to Z.
    • All numeric characters: 0 to 9.
    • Space
      • -
    • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
      • +
    • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

    options - The channel media options. See . + The channel media options. See .
    @@ -75,4 +75,4 @@
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita index 193ea38fe83..ac2992d4b08 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita @@ -1,21 +1,21 @@ - <ph keyref="unregisterAudioEncodedFrameObserver"/> + <ph keyref="unregisterAudioEncodedFrameObserver" /> Unregisters the encoded audio frame observer. - +

    - - - + + + abstract unregisterAudioEncodedFrameObserver( observer: IAudioEncodedFrameObserver ): number; @@ -26,7 +26,7 @@ ): number; void unregisterAudioEncodedFrameObserver(AudioEncodedFrameObserver observer); -

    +

    Parameters @@ -38,12 +38,12 @@
    - <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_updatescreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita index 5c846cf4d5e..a50469bfaf2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita @@ -21,13 +21,13 @@ public abstract int UpdateScreenCapture(ScreenCaptureParameters2 captureParams); abstract updateScreenCapture(captureParams: ScreenCaptureParameters2): number; Future<void> updateScreenCapture(ScreenCaptureParameters2 captureParams); -

    +

    Details

    If the system audio is not captured when screen sharing is enabled, and then you want to update the parameter configuration and publish the system audio, you can refer to the following steps:

      -
    1. Call this method, and set captureAudio to .
      2. -
    2. Call , and set publishScreenCaptureAudio to to publish the audio captured by the screen.
      3. +
    3. Call this method, and set captureAudio to .
      4. +
    4. Call , and set publishScreenCaptureAudio to to publish the audio captured by the screen.

      @@ -46,13 +46,13 @@
    - <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_updatescreencaptureparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita index ce51a43eeda..c2a69e760c3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita @@ -27,7 +27,7 @@ ): number;     Future<void> updateScreenCaptureParameters( ScreenCaptureParameters captureParams); -

    +

    Details @@ -46,8 +46,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_updatescreencaptureregion.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita index 095bb121f26..b2f88a63804 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita @@ -20,7 +20,7 @@ public abstract int UpdateScreenCaptureRegion(Rectangle regionRect); abstract updateScreenCaptureRegion(regionRect: Rectangle): number; Future<void> updateScreenCaptureRegion(Rectangle regionRect); -

        +

    Details @@ -47,8 +47,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_updatescreencaptureregion2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita index 9fcaccee823..4e7b848dbd4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita @@ -1,26 +1,26 @@ - <ph keyref="updateScreenCaptureRegion2"/> + <ph keyref="updateScreenCaptureRegion2" /> Updates the screen capturing region. - +

      - + - (int)updateScreenCaptureRegion:(CGRect)rect; virtual int updateScreenCaptureRegion(const Rect* rect) = 0; abstract updateScreenCaptureRegion(regionRect: Rectangle): number; public abstract int UpdateScreenCaptureRegion(Rectangle regionRect); - + Future<void> updateScreenCaptureRegion(Rectangle regionRect); -

      +

      Parameters @@ -28,15 +28,15 @@ rect regionRect - The relative location of the region to the screen or window. If you do not set this parameter, the SDK shares the whole screen. See . If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window. + The relative location of the region to the screen or window. If you do not set this parameter, the SDK shares the whole screen. See . If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window.
      - <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_createdatastreamex2.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita index 423f2b1edc1..c63a62d4eea 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita @@ -32,7 +32,7 @@ ): number; Future<int> createDataStreamEx( {required DataStreamConfig config, required RtcConnection connection}); -

      +

    Details diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita index a66de42b538..4d296e36cdb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita @@ -1,12 +1,12 @@ - <ph keyref="joinChannelEx"/> + <ph keyref="joinChannelEx" /> Joins a channel with the connection ID. - + @@ -38,7 +38,7 @@ {required String token, required RtcConnection connection, required ChannelMediaOptions options}); -

    +

    Details @@ -47,34 +47,34 @@
    • If you are already in a channel, you cannot rejoin it with the same user ID.
    • If you want to join the same channel from different devices, ensure that the user IDs are different for all devices.
      • -
    • Ensure that the app ID you use to generate the token is the same as the app ID used when creating the instance.
      • -
    • In a multi-camera capture scenario, you need to call the method after calling this method to set the sourceType to , to ensure that the second camera captures normally.
      • +
    • Ensure that the app ID you use to generate the token is the same as the app ID used when creating the instance.
      • +
    • In a multi-camera capture scenario, you need to call the method after calling this method to set the sourceType to , to ensure that the second camera captures normally.
    Parameters - - + + connection - The connection information. See . + The connection information. See . - - + + eventHandler delegate - The callback class of .See . + The callback class of .See . - - + +
    -
    +
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita index 71f15960aa4..bdf7b470be0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita @@ -1,12 +1,12 @@ - <ph keyref="setDualStreamModeEx"/> + <ph keyref="setDualStreamModeEx" /> Sets the dual-stream mode on the sender side. - + @@ -32,11 +32,11 @@ streamConfig: SimulcastStreamConfig, connection: RtcConnection ): number; - Future<void> setDualStreamModeEx( + Future<void> setDualStreamModeEx( {required SimulcastStreamMode mode, required SimulcastStreamConfig streamConfig, required RtcConnection connection}); -

    +

    Details @@ -46,10 +46,10 @@
    v4.0.1
    -

    The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to . If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).

    - The difference and connection between this method and is as follows:
      -
    • When calling this method and setting mode to , it has the same effect as ().
      • -
    • When calling this method and setting mode to , it has the same effect as ().
      • +

      The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to . If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).

      + The difference and connection between this method and is as follows:
        +
      • When calling this method and setting mode to , it has the same effect as ().
        • +
      • When calling this method and setting mode to , it has the same effect as ().
      • Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
    @@ -57,23 +57,23 @@ mode - The mode in which the video stream is sent. See . + The mode in which the video stream is sent. 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.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita index 59dbed31a9b..b9026e3fde4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita @@ -28,7 +28,7 @@ ): number; Future<void> setupRemoteVideoEx( {required VideoCanvas canvas, required RtcConnection connection}); -

    +

    Details @@ -56,8 +56,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_setvideoencoderconfigurationex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita index 4cf4760b640..31d2394ac99 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita @@ -30,7 +30,7 @@ Future<void> setVideoEncoderConfigurationEx( {required VideoEncoderConfiguration config, required RtcConnection connection}); -

      +

    Details @@ -50,8 +50,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_startchannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita index 74d8622145b..c77da9dd34e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita @@ -1,12 +1,12 @@ - <ph keyref="startChannelMediaRelayEx"/> + <ph keyref="startChannelMediaRelayEx" /> Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels. - + @@ -26,10 +26,10 @@ configuration: ChannelMediaRelayConfiguration, connection: RtcConnection ): number; - Future<void> startChannelMediaRelayEx( + Future<void> startChannelMediaRelayEx( {required ChannelMediaRelayConfiguration configuration, required RtcConnection connection}); -

      +

    Details @@ -39,16 +39,16 @@
    This method is deprecated. Use instead.
    -

    After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.

      -
    • If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
      • -
    • If the callback returns (3), an exception occurs during the media stream relay.
      • +

      After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.

        +
      • If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
        • +
      • If the callback returns (3), an exception occurs during the media stream relay.

      • Call this method after joining the channel.
      • This method takes effect only when you are a host in a live streaming channel.
        • -
      • After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
        • -
      • The relaying media streams across channels function needs to be enabled by contacting .
        • +
      • After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
        • +
      • The relaying media streams across channels function needs to be enabled by contacting .
      • Agora does not support string user accounts in this API.
    @@ -58,16 +58,16 @@ channelMediaRelayConfiguration config configuration - The configuration of the media stream relay. See . + The configuration of the media stream relay. 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.
        @@ -78,4 +78,4 @@
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita index 8a2a086cc7a..2819845594f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita @@ -1,12 +1,12 @@ - <ph keyref="startOrUpdateChannelMediaRelayEx"/> + <ph keyref="startOrUpdateChannelMediaRelayEx" /> Starts relaying media streams across channels or updates channels for media relay. - + @@ -26,10 +26,10 @@ configuration: ChannelMediaRelayConfiguration, connection: RtcConnection ): number;     - Future<void> startOrUpdateChannelMediaRelayEx( + Future<void> startOrUpdateChannelMediaRelayEx( {required ChannelMediaRelayConfiguration configuration, required RtcConnection connection}); -

    +

    Details @@ -39,15 +39,15 @@
    v4.2.0

    The first successful call to this method starts relaying media streams from the source channel to the destination channels. To relay the media stream to other channels, or exit one of the current media relays, you can call this method again to update the destination channels. This feature supports relaying media streams to a maximum of six destination channels.

    -

    After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:

      -
    • If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
      • -
    • If the callback returns (3), an exception occurs during the media stream relay.
      • +

      After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:

        +
      • If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
        • +
      • If the callback returns (3), an exception occurs during the media stream relay.

      • Call this method after joining the channel.
      • This method takes effect only when you are a host in a live streaming channel.
        • -
      • The relaying media streams across channels function needs to be enabled by contacting .
        • +
      • The relaying media streams across channels function needs to be enabled by contacting .
      • Agora does not support string user accounts in this API.
    @@ -57,16 +57,16 @@ channelMediaRelayConfiguration config configuration - The configuration of the media stream relay. See . + The configuration of the media stream relay. 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.
        @@ -77,4 +77,4 @@
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita index fcddba1bfbd..2859072794b 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita @@ -26,9 +26,9 @@ deviceIdUTF8: string, deviceCapabilityNumber: number ): VideoFormat;     - Future<VideoFormat> getCapability( + Future<VideoFormat> getCapability( {required String deviceIdUTF8, required int deviceCapabilityNumber}); -

    +

    Details diff --git a/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita b/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita index 2e01a2f7618..ba4e179a0bd 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita @@ -35,7 +35,7 @@ frame audioFrame - The audio frame information. See . See . + The audio frame information. See . See . playerKit diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getvideoformatpreference.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getvideoformatpreference.dita index dca74e0586b..a73c149badc 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getvideoformatpreference.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getvideoformatpreference.dita @@ -32,7 +32,7 @@ If you want the video captured by the sender to be the original format, set the original video data format to in the return value. The original video pixel format varies based on different platforms. For the actual video pixel format, see .
    Returns -

    Sets the video format. See .

    +

    Sets the video format. See .

    According to different observation locations and collection scenarios, the actual video pixel format corresponding to this enumeration value is different. Agora recommends that you do not use this value. Some common situations are listed below.

    diff --git a/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita b/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita index 42f47a31257..f30f5800980 100644 --- a/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita @@ -1,9 +1,8 @@ - <ph keyref="LocalAccessPointConfiguration"/> - The configurations of the Local Access Point. + <ph keyref="LocalAccessPointConfiguration" /> + The configurations of the Local Access Point.

    @@ -60,8 +59,8 @@ return logUploadServer; } }; - public ArrayList<String> ipList = null; - public ArrayList<String> domainList = null; + public ArrayList<String> ipList = null; + public ArrayList<String> domainList = null; public String verifyDomainName = null; public int mode = Constants.LOCAL_RPOXY_CONNECTIVITY_FIRST; public AdvancedConfigInfo advancedConfig = null; @@ -147,13 +146,13 @@ this.advancedConfig}); @JsonKey(name: 'ipList') - final List<String>? ipList; + final List<String>? ipList; @JsonKey(name: 'ipListSize') final int? ipListSize; @JsonKey(name: 'domainList') - final List<String>? domainList; + final List<String>? domainList; @JsonKey(name: 'domainListSize') final int? domainListSize; @@ -167,15 +166,15 @@ @JsonKey(name: 'advancedConfig') final AdvancedConfigInfo? advancedConfig; - factory LocalAccessPointConfiguration.fromJson(Map<String, dynamic> json) => + factory LocalAccessPointConfiguration.fromJson(Map<String, dynamic> json) => _$LocalAccessPointConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$LocalAccessPointConfigurationToJson(this); + Map<String, dynamic> toJson() => _$LocalAccessPointConfigurationToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> ipList @@ -200,20 +199,17 @@ mode -

    The connection mode. See .

    +

    The connection mode. See .

    Select one of the following connection modes:

      -
    • (0): The SDK firstly tries to connect to the specified Agora private media server; if the connection attempt fails, it will connect to the Agora SD-RTN™ instead.
      • -
    • (1) The SDK only tries to connect to the specified Agora private media server.
      • +
    • (0): The SDK firstly tries to connect to the specified Agora private media server; if the connection attempt fails, it will connect to the Agora SD-RTN™ instead.
      • +
    • (1) The SDK only tries to connect to the specified Agora private media server.

         advancedConfig - The advanced options for the Local Access Point. See . + The advanced options for the Local Access Point. See .
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_advanceoptions.dita b/en-US/dita/RTC-NG/API/class_advanceoptions.dita index e9ab1ee61bf..ec0bc49e668 100644 --- a/en-US/dita/RTC-NG/API/class_advanceoptions.dita +++ b/en-US/dita/RTC-NG/API/class_advanceoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="AdvanceOptions"/> + <ph keyref="AdvanceOptions" /> Advanced options for video encoding.
    @@ -75,12 +75,12 @@ @JsonKey(name: 'compressionPreference') final CompressionPreference? compressionPreference; - factory AdvanceOptions.fromJson(Map<String, dynamic> json) => + factory AdvanceOptions.fromJson(Map<String, dynamic> json) => _$AdvanceOptionsFromJson(json); - Map<String, dynamic> toJson() => _$AdvanceOptionsToJson(this); + Map<String, dynamic> toJson() => _$AdvanceOptionsToJson(this); } -

    +

    @@ -89,19 +89,19 @@
    v4.1.0
    -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> encodingPreference - Video encoder preference. See . + Video encoder preference. See . compressionPreference - Compression preference for video encoding. See . + Compression preference for video encoding. See .
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_audioparams.dita b/en-US/dita/RTC-NG/API/class_audioparams.dita index c553ee129d3..141dda8efba 100644 --- a/en-US/dita/RTC-NG/API/class_audioparams.dita +++ b/en-US/dita/RTC-NG/API/class_audioparams.dita @@ -1,7 +1,7 @@ - <ph keyref="AudioParams"/> + <ph keyref="AudioParams" /> Audio data format.
    @@ -98,33 +98,33 @@ @JsonKey(name: 'samples_per_call') final int? samplesPerCall; - factory AudioParams.fromJson(Map<String, dynamic> json) => + factory AudioParams.fromJson(Map<String, dynamic> json) => _$AudioParamsFromJson(json); - Map<String, dynamic> toJson() => _$AudioParamsToJson(this); + Map<String, dynamic> toJson() => _$AudioParamsToJson(this); } -

    +

    -

    You can pass the object in the following APIs to set the audio data format for the corresponding callback:

      -
    • : Sets the audio data format for the callback.
      • -
    • : Sets the audio data format for the callback.
      • -
    • : Sets the audio data format for the callback.
      • -
    • : Sets the audio data format for the callback.
      • +

      You can pass the object in the following APIs to set the audio data format for the corresponding callback:

        +
      • : Sets the audio data format for the callback.
        • +
      • : Sets the audio data format for the callback.
        • +
      • : Sets the audio data format for the callback.
        • +
      • : Sets the audio data format for the callback.
        • +

      +

      The SDK sets the audio data format in the following callbacks according to .

        +
        • +
        • +

      -

      The SDK sets the audio data format in the following callbacks according to .

        -
        • -
        • -
        • -

        -
      • The SDK calculates the sampling interval through the samplesPerCall, sampleRate, and channel parameters in , and triggers the , , , and callbacks according to the sampling interval.
        • +
      • The SDK calculates the sampling interval through the samplesPerCall, sampleRate, and channel parameters in , and triggers the , , , and callbacks according to the sampling interval.
      • Sample interval (sec) = samplePerCall/(sampleRate × channel).
      • Ensure that the sample interval ≥ 0.01 (s).
    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> sampleRate @@ -147,10 +147,10 @@ mode - The use mode of the audio data. See . + The use mode of the audio data. See . The use mode of the audio data, which can be set as either of the following values:
      -
    • (0): Read-only mode, where users only read the original data from without any modification. For example, when users acquire the data with the Agora SDK, then start the media push.
      • -
    • (2): Read and write mode, where users read the data from , modify it, and then play it. Users read the data returned by the SDK, modify it, and then play it. For example, when users have their own audio-effect processing module and perform some voice pre-processing, such as a voice change.
      • +
    • (0): Read-only mode, where users only read the original data from without any modification. For example, when users acquire the data with the Agora SDK, then start the media push.
      • +
    • (2): Read and write mode, where users read the data from , modify it, and then play it. Users read the data returned by the SDK, modify it, and then play it. For example, when users have their own audio-effect processing module and perform some voice pre-processing, such as a voice change.
         @@ -160,4 +160,4 @@
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita b/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita index 1ab19da80e4..d709cc85a1c 100644 --- a/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita @@ -164,12 +164,12 @@ @JsonKey(name: 'recordingChannel') final int? recordingChannel; - factory AudioRecordingConfiguration.fromJson(Map<String, dynamic> json) => + factory AudioRecordingConfiguration.fromJson(Map<String, dynamic> json) => _$AudioRecordingConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$AudioRecordingConfigurationToJson(this); + Map<String, dynamic> toJson() => _$AudioRecordingConfigurationToJson(this); } -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> diff --git a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita index c8961b7b32b..87fe88d06c2 100644 --- a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita @@ -1,7 +1,7 @@ - <ph keyref="CameraCapturerConfiguration"/> + <ph keyref="CameraCapturerConfiguration" /> The camera capturer preference.
    @@ -199,40 +199,40 @@ @JsonKey(name: 'followEncodeDimensionRatio') final bool? followEncodeDimensionRatio; - factory CameraCapturerConfiguration.fromJson(Map<String, dynamic> json) => + factory CameraCapturerConfiguration.fromJson(Map<String, dynamic> json) => _$CameraCapturerConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$CameraCapturerConfigurationToJson(this); + Map<String, dynamic> toJson() => _$CameraCapturerConfigurationToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <title> <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> cameraDirection - This parameter applies to Android and iOS only.The camera direction. See . + This parameter applies to Android and iOS only.The camera direction. See . format captureFormat - The format of the video frame. See . + The format of the video frame. See . deviceId This method applies to Windows only. - This method applies to macOS only.The ID of the camera. The maximum length is . + This method applies to macOS only.The ID of the camera. The maximum length is . followEncodeDimensionRatio - Whether to follow the video aspect ratio set in :
      -
    • : (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in and .
      • -
    • : Do not follow the system default audio playback device. The SDK does not change the aspect ratio of the captured video frame.
      • + Whether to follow the video aspect ratio set in :
        +
      • : (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in and .
        • +
      • : Do not follow the system default audio playback device. The SDK does not change the aspect ratio of the captured video frame.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita index 2b1003f9a1e..d2e73d40f4a 100644 --- a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita +++ b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="ChannelMediaOptions"/> + <ph keyref="ChannelMediaOptions" /> The channel media options.
    @@ -80,8 +80,8 @@ struct ChannelMediaOptions { Optional<bool> publishCameraTrack; Optional<bool> publishSecondaryCameraTrack; - Optional<bool> publishThirdCameraTrack; - Optional<bool> publishFourthCameraTrack; + Optional<bool> publishThirdCameraTrack; + Optional<bool> publishFourthCameraTrack; Optional<bool> publishMicrophoneTrack; #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) @@ -90,8 +90,8 @@ #else Optional<bool> publishScreenTrack; Optional<bool> publishSecondaryScreenTrack; - Optional<bool> publishThirdScreenTrack; - Optional<bool> publishFourthScreenTrack; + Optional<bool> publishThirdScreenTrack; + Optional<bool> publishFourthScreenTrack; #endif Optional<bool> publishCustomAudioTrack; @@ -223,37 +223,37 @@ } public class ChannelMediaOptions : OptionalJsonParse { - public Optional<bool> publishCameraTrack = new Optional<bool>(); - public Optional<bool> publishSecondaryCameraTrack = new Optional<bool>(); - public Optional<bool> publishThirdCameraTrack = new Optional<bool>(); - public Optional<bool> publishFourthCameraTrack = new Optional<bool>(); - public Optional<bool> publishMicrophoneTrack = new Optional<bool>(); - public Optional<bool> publishScreenCaptureVideo = new Optional<bool>(); - public Optional<bool> publishScreenCaptureAudio = new Optional<bool>(); - public Optional<bool> publishScreenTrack = new Optional<bool>(); - public Optional<bool> publishSecondaryScreenTrack = new Optional<bool>(); - public Optional<bool> publishThirdScreenTrack = new Optional<bool>(); - public Optional<bool> publishFourthScreenTrack = new Optional<bool>(); - public Optional<bool> publishCustomAudioTrack = new Optional<bool>(); - public Optional<int> publishCustomAudioTrackId = new Optional<int>(); - public Optional<bool> publishCustomVideoTrack = new Optional<bool>(); - public Optional<bool> publishEncodedVideoTrack = new Optional<bool>(); - public Optional<bool> publishMediaPlayerAudioTrack = new Optional<bool>(); - public Optional<bool> publishMediaPlayerVideoTrack = new Optional<bool>(); - public Optional<bool> publishTranscodedVideoTrack = new Optional<bool>(); - public Optional<bool> autoSubscribeAudio = new Optional<bool>(); - public Optional<bool> autoSubscribeVideo = new Optional<bool>(); - public Optional<bool> enableAudioRecordingOrPlayout = new Optional<bool>(); - public Optional<int> publishMediaPlayerId = new Optional<int>(); - public Optional<CLIENT_ROLE_TYPE> clientRoleType = new Optional<CLIENT_ROLE_TYPE>(); - public Optional<AUDIENCE_LATENCY_LEVEL_TYPE> audienceLatencyLevel = new Optional<AUDIENCE_LATENCY_LEVEL_TYPE>(); - public Optional<VIDEO_STREAM_TYPE> defaultVideoStreamType = new Optional<VIDEO_STREAM_TYPE>(); - public Optional<CHANNEL_PROFILE_TYPE> channelProfile = new Optional<CHANNEL_PROFILE_TYPE>(); - public Optional<string> token = new Optional<string>(); - public Optional<bool> publishRhythmPlayerTrack = new Optional<bool>(); - public Optional<bool> isInteractiveAudience = new Optional<bool>(); - public Optional<video_track_id_t> customVideoTrackId = new Optional<video_track_id_t>(); - public Optional<bool> isAudioFilterable = new Optional<bool>(); + public Optional<bool> publishCameraTrack = new Optional<bool>(); + public Optional<bool> publishSecondaryCameraTrack = new Optional<bool>(); + public Optional<bool> publishThirdCameraTrack = new Optional<bool>(); + public Optional<bool> publishFourthCameraTrack = new Optional<bool>(); + public Optional<bool> publishMicrophoneTrack = new Optional<bool>(); + public Optional<bool> publishScreenCaptureVideo = new Optional<bool>(); + public Optional<bool> publishScreenCaptureAudio = new Optional<bool>(); + public Optional<bool> publishScreenTrack = new Optional<bool>(); + public Optional<bool> publishSecondaryScreenTrack = new Optional<bool>(); + public Optional<bool> publishThirdScreenTrack = new Optional<bool>(); + public Optional<bool> publishFourthScreenTrack = new Optional<bool>(); + public Optional<bool> publishCustomAudioTrack = new Optional<bool>(); + public Optional<int> publishCustomAudioTrackId = new Optional<int>(); + public Optional<bool> publishCustomVideoTrack = new Optional<bool>(); + public Optional<bool> publishEncodedVideoTrack = new Optional<bool>(); + public Optional<bool> publishMediaPlayerAudioTrack = new Optional<bool>(); + public Optional<bool> publishMediaPlayerVideoTrack = new Optional<bool>(); + public Optional<bool> publishTranscodedVideoTrack = new Optional<bool>(); + public Optional<bool> autoSubscribeAudio = new Optional<bool>(); + public Optional<bool> autoSubscribeVideo = new Optional<bool>(); + public Optional<bool> enableAudioRecordingOrPlayout = new Optional<bool>(); + public Optional<int> publishMediaPlayerId = new Optional<int>(); + public Optional<CLIENT_ROLE_TYPE> clientRoleType = new Optional<CLIENT_ROLE_TYPE>(); + public Optional<AUDIENCE_LATENCY_LEVEL_TYPE> audienceLatencyLevel = new Optional<AUDIENCE_LATENCY_LEVEL_TYPE>(); + public Optional<VIDEO_STREAM_TYPE> defaultVideoStreamType = new Optional<VIDEO_STREAM_TYPE>(); + public Optional<CHANNEL_PROFILE_TYPE> channelProfile = new Optional<CHANNEL_PROFILE_TYPE>(); + public Optional<string> token = new Optional<string>(); + public Optional<bool> publishRhythmPlayerTrack = new Optional<bool>(); + public Optional<bool> isInteractiveAudience = new Optional<bool>(); + public Optional<video_track_id_t> customVideoTrackId = new Optional<video_track_id_t>(); + public Optional<bool> isAudioFilterable = new Optional<bool>(); } export class ChannelMediaOptions { @@ -462,66 +462,66 @@ class ChannelMediaOptions { @JsonKey(name: 'isAudioFilterable') final bool? isAudioFilterable; - factory ChannelMediaOptions.fromJson(Map<String, dynamic> json) => + factory ChannelMediaOptions.fromJson(Map<String, dynamic> json) => _$ChannelMediaOptionsFromJson(json); - Map<String, dynamic> toJson() => _$ChannelMediaOptionsToJson(this); + Map<String, dynamic> toJson() => _$ChannelMediaOptionsToJson(this); } -

    +

    -
    Agora supports publishing multiple audio streams and one video stream at the same time and in the same . For example, publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as at the same time, but only one of publishCameraTrack, publishScreenCaptureVideopublishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as .Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters. +
    Agora supports publishing multiple audio streams and one video stream at the same time and in the same . For example, publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as at the same time, but only one of publishCameraTrack, publishScreenCaptureVideopublishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as .Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters.
    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> publishCameraTrack Whether to publish the video captured by the camera:
      -
    • : Publish the video captured by the camera.
      • -
    • : Do not publish the video captured by the camera.
      • +
    • : Publish the video captured by the camera.
      • +
    • : Do not publish the video captured by the camera.
         publishSecondaryCameraTrack Whether to publish the video captured by the second camera:
      -
    • : Publish the video captured by the second camera.
      • -
    • : Do not publish the video captured by the second camera.
      • +
    • : Publish the video captured by the second camera.
      • +
    • : Do not publish the video captured by the second camera.
         publishMicrophoneTrack Whether to publish the audio captured by the microphone:
      -
    • : Publish the audio captured by the microphone.
      • -
    • : Do not publish the audio captured by the microphone.
      • +
    • : Publish the audio captured by the microphone.
      • +
    • : Do not publish the audio captured by the microphone.
    • As of v4.0.0, the parameter name is changed from publishAudioTrack to publishMicrophoneTrack.
    • As of v6.0.0, the parameter name is changed from publishAudioTrack to publishMicrophoneTrack.
      • -
    • If you want to publish the audio streams captured by your microphone, ensure enableAudioRecordingOrPlayout is set as .
     +
  • If you want to publish the audio streams captured by your microphone, ensure enableAudioRecordingOrPlayout is set as .
    •      publishThirdCameraTrack Whether to publish the video captured by the third camera:
      -
    • : Publish the video captured by the third camera.
      • -
    • : Do not publish the video captured by the third camera.
      • +
    • : Publish the video captured by the third camera.
      • +
    • : Do not publish the video captured by the third camera.

    This method is for Windows and macOS only.

         publishFourthCameraTrack Whether to publish the video captured by the fourth camera:
      -
    • : Publish the video captured by the fourth camera.
      • -
    • : Do not publish the video captured by the fourth camera.
      • +
    • : Publish the video captured by the fourth camera.
      • +
    • : Do not publish the video captured by the fourth camera.

    This method is for Windows and macOS only.

         publishScreenTrack

    Whether to publish the video captured from the screen:

      -
    • : Publish the video captured from the screen.
      • -
    • : Do not publish the video captured from the screen.
      • +
    • : Publish the video captured from the screen.
      • +
    • : Do not publish the video captured from the screen.

    This method is for Windows and macOS only.

     @@ -530,8 +530,8 @@ class ChannelMediaOptions { publishScreenCaptureVideo

    Whether to publish the video captured from the screen:

      -
    • : Publish the video captured from the screen.
      • -
    • : Do not publish the video captured from the screen.
      • +
    • : Publish the video captured from the screen.
      • +
    • : Do not publish the video captured from the screen.

    This parameter applies to Android and iOS only.

    As of v4.0.0, the parameter name is changed from publishScreenTrack to publishScreenCaptureVideo.

     @@ -540,8 +540,8 @@ class ChannelMediaOptions { publishScreenCaptureAudio

    Whether to publish the audio captured from the screen:

      -
    • : Publish the audio captured from the screen.
      • -
    • : Publish the audio captured from the screen.
      • +
    • : Publish the audio captured from the screen.
      • +
    • : Publish the audio captured from the screen.

    This parameter applies to Android and iOS only.

    @@ -550,16 +550,16 @@ class ChannelMediaOptions { publishSecondaryScreenTrack Whether to publish the video captured from the second screen:
      -
    • : Publish the video captured from the second screen.
      • -
    • : Do not publish the video captured from the second screen.
      • +
    • : Publish the video captured from the second screen.
      • +
    • : Do not publish the video captured from the second screen.
         publishThirdScreenTrack Whether to publish the video captured from the third screen:
      -
    • : Publish the captured video from the third screen.
      • -
    • : Do not publish the video captured from the third screen.
      • +
    • : Publish the captured video from the third screen.
      • +
    • : Do not publish the video captured from the third screen.

    This method is for Windows and macOS only.

    @@ -568,8 +568,8 @@ class ChannelMediaOptions { publishFourthScreenTrack Whether to publish the video captured from the fourth screen:
      -
    • : Publish the captured video from the fourth screen.
      • -
    • : Do not publish the video captured from the fourth screen.
      • +
    • : Publish the captured video from the fourth screen.
      • +
    • : Do not publish the video captured from the fourth screen.

    This method is for Windows and macOS only.

    @@ -578,8 +578,8 @@ class ChannelMediaOptions { publishTranscodedVideoTrack Whether to publish the local transcoded video:
      -
    • : Publish the local transcoded video.
      • -
    • : Do not publish the local transcoded video.
      • +
    • : Publish the local transcoded video.
      • +
    • : Do not publish the local transcoded video.

    As of v4.2.0, the parameter name is corrected from publishTrancodedVideoTrack to publishTranscodedVideoTrack.

     @@ -587,64 +587,64 @@ class ChannelMediaOptions { publishCustomAudioTrack Whether to publish the audio captured from a custom source:
      -
    • : Publish the audio captured from the custom source.
      • -
    • : Do not publish the captured audio from a custom source.
      • +
    • : Publish the audio captured from the custom source.
      • +
    • : Do not publish the captured audio from a custom source.
         publishCustomAudioTrackId - The ID of the custom audio source to publish. The default value is 0.

    If you have set sourceNumber in to a value greater than 1, the SDK creates the corresponding number of custom audio tracks and assigns an ID to each audio track, starting from 0.

    + The ID of the custom audio source to publish. The default value is 0.

    If you have set sourceNumber in to a value greater than 1, the SDK creates the corresponding number of custom audio tracks and assigns an ID to each audio track, starting from 0.

         publishCustomVideoTrack Whether to publish the video captured from a custom source:
      -
    • : Publish the video captured from the custom source.
      • -
    • : Do not publish the captured video from a custom source.
      • +
    • : Publish the video captured from the custom source.
      • +
    • : Do not publish the captured video from a custom source.
         publishEncodedVideoTrack Whether to publish the encoded video:
      -
    • : Publish the encoded video.
      • -
    • : Do not publish the encoded video.
      • +
    • : Publish the encoded video.
      • +
    • : Do not publish the encoded video.
         publishMediaPlayerAudioTrack Whether to publish the audio from the media player:
      -
    • : Publish the audio from the media player.
      • -
    • : Do not publish the audio from the media player.
      • +
    • : Publish the audio from the media player.
      • +
    • : Do not publish the audio from the media player.
         publishMediaPlayerVideoTrack Whether to publish the video from the media player:
      -
    • : Publish the video from the media player.
      • -
    • : Do not publish the video from the media player.
      • +
    • : Publish the video from the media player.
      • +
    • : Do not publish the video from the media player.
         autoSubscribeAudio Whether to automatically subscribe to all remote audio streams when the user joins a channel:
      -
    • : Subscribe to all remote audio streams.
      • -
    • : Do not automatically subscribe to any remote audio streams.
      • +
    • : Subscribe to all remote audio streams.
      • +
    • : Do not automatically subscribe to any remote audio streams.
         autoSubscribeVideo Whether to automatically subscribe to all remote video streams when the user joins the channel:
      -
    • : Subscribe to all remote video streams.
      • -
    • : Do not automatically subscribe to any remote video streams.
      • +
    • : Subscribe to all remote video streams.
      • +
    • : Do not automatically subscribe to any remote video streams.
         enableAudioRecordingOrPlayout Whether to enable audio capturing or playback:
      -
    • : Enable audio capturing or playback.
      • -
    • : Do not enable audio capturing or playback.
      • +
    • : Enable audio capturing or playback.
      • +
    • : Do not enable audio capturing or playback.
    - If you need to publish the audio streams captured by your microphone, ensure this parameter is set as .     + If you need to publish the audio streams captured by your microphone, ensure this parameter is set as .         publishMediaPlayerId @@ -652,23 +652,23 @@ class ChannelMediaOptions { clientRoleType - + clientRoleType - The user role. See . + The user role. See . - - + + defaultVideoStreamType - + channelProfile - + audioDelayMs @@ -680,8 +680,8 @@ class ChannelMediaOptions { publishCustomAudioTrackAec Whether to publish audio frames processed by an external echo cancellation module.
      -
    • : Publish audio frames processed by the external echo cancellation module.
      • -
    • : Do not publish to publish audio frames processed by the external echo cancellation module.
      • +
    • : Publish audio frames processed by the external echo cancellation module.
      • +
    • : Do not publish to publish audio frames processed by the external echo cancellation module.
         @@ -690,48 +690,48 @@ class ChannelMediaOptions {

    (Optional) The token generated on your server for authentication. See Authenticate Your Users with Token.

      -
    • This parameter takes effect only when calling or .
      • -
    • Ensure that the App ID, channel name, and user name used for creating the token are the same as those used by the method for initializing the RTC engine, and those used by the and methods for joining the channel.
      • +
    • This parameter takes effect only when calling or .
      • +
    • Ensure that the App ID, channel name, and user name used for creating the token are the same as those used by the method for initializing the RTC engine, and those used by the and methods for joining the channel.
         startPreview Whether to automatically start the preview when joining a channel:
      -
    • : Do not automatically start the preview. Ensure that you have called the method to set the local video property; otherwise, the preview is not enabled.
      • -
    • : Do not automatically start the preview.
      • +
    • : Do not automatically start the preview. Ensure that you have called the method to set the local video property; otherwise, the preview is not enabled.
      • +
    • : Do not automatically start the preview.
         publishRhythmPlayerTrack Whether to publish the sound of a metronome to remote users:
      -
    • : Publish processed audio frames. Both the local user and remote users can hear the metronome.
      • -
    • : Do not publish the sound of the metronome. Only the local user can hear the metronome.
      • +
    • : Publish processed audio frames. Both the local user and remote users can hear the metronome.
      • +
    • : Do not publish the sound of the metronome. Only the local user can hear the metronome.
         isInteractiveAudience Whether to enable interactive mode:
      -
    • : Enable interactive mode. Once this mode is enabled and the user role is set as audience, the user can receive remote video streams with low latency.
      • -
    • :Do not enable interactive mode. If this mode is disabled, the user receives the remote video streams in default settings.
      • +
    • : Enable interactive mode. Once this mode is enabled and the user role is set as audience, the user can receive remote video streams with low latency.
      • +
    • :Do not enable interactive mode. If this mode is disabled, the user receives the remote video streams in default settings.
      -
    • This parameter only applies to scenarios involving cohosting across channels. The cohosts need to call the method to join the other host's channel as an audience member, and set isInteractiveAudience to .
      • -
    • This parameter takes effect only when the user role is .
      • +
    • This parameter only applies to scenarios involving cohosting across channels. The cohosts need to call the method to join the other host's channel as an audience member, and set isInteractiveAudience to .
      • +
    • This parameter takes effect only when the user role is .
         customVideoTrackId - The video track ID returned by calling the method. The default value is 0. + The video track ID returned by calling the method. The default value is 0. isAudioFilterable Whether the audio stream being published is filtered according to the volume algorithm:
      -
    • : The audio stream is filtered. If the audio stream filter is not enabled, this setting does not takes effect.
      • -
    • : The audio stream is not filtered.
      • +
    • : The audio stream is filtered. If the audio stream filter is not enabled, this setting does not takes effect.
      • +
    • : The audio stream is not filtered.
    - If you need to enable this function, contact .     + If you need to enable this function, contact .
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita b/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita index 1fbcf2850e8..88e2a2d6cc8 100644 --- a/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita @@ -1,17 +1,17 @@ - <ph keyref="ChannelMediaRelayConfiguration"/> + <ph keyref="ChannelMediaRelayConfiguration" /> Configuration of cross channel media relay.

    public class ChannelMediaRelayConfiguration { private ChannelMediaInfo srcInfo = null; - private Map<String, ChannelMediaInfo> destInfos = null; + private Map<String, ChannelMediaInfo> destInfos = null; public ChannelMediaRelayConfiguration() { - destInfos = new HashMap<String, ChannelMediaInfo>(); + destInfos = new HashMap<String, ChannelMediaInfo>(); srcInfo = new ChannelMediaInfo(null, null, 0); } @@ -31,7 +31,7 @@ return srcInfo; } - public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { + public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { return destInfos; } } @@ -104,44 +104,44 @@ _$ChannelMediaRelayConfigurationFromJson(json); Map<String, dynamic> toJson() => _$ChannelMediaRelayConfigurationToJson(this); } -

    +

    Method setSrcChannelInfo - Sets the information of the source channel. See . + Sets the information of the source channel. See . setDestChannelInfo - Sets the information of the target channel. See . + Sets the information of the target channel. See . removeDestChannelInfo - Deletes the information of target channel. See . + Deletes the information of target channel. See . getSrcChannelMediaInfo - Gets the information of the source channel. See . + Gets the information of the source channel. See . getDestChannelMediaInfos - Gets the information of the target channel. See . + Gets the information of the target channel. See .
    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> srcInfo sourceInfo -

    The information of the source channel. See . It contains the following members:

      -
    • channelName: The name of the source channel. The default value is , which means the SDK applies the name of the current channel.
      • +

      The information of the source channel. See . It contains the following members:

        +
      • channelName: The name of the source channel. The default value is , which means the SDK applies the name of the current channel.
      • token: The token for joining the source channel. This token is generated with the channelName and uid you set in srcInfo.
          -
        • If you have not enabled the App Certificate, set this parameter as the default value , which means the SDK applies the App ID.
          • +
        • If you have not enabled the App Certificate, set this parameter as the default value , which means the SDK applies the App ID.
        • If you have enabled the App Certificate, you must use the token generated with the channelName and uid, and the uid must be set as 0.
      • uid: The unique user ID to identify the relay stream in the source channel. Agora recommends leaving the default value of 0 unchanged.
        • @@ -152,10 +152,10 @@ destInfos destinationInfos -

        The information of the target channel . It contains the following members:

          +

          The information of the target channel . It contains the following members:

          • channelName: The name of the target channel.
          • token: The token for joining the target channel. It is generated with the channelName and uid you set in destInfos.
              -
            • If you have not enabled the App Certificate, set this parameter as the default value , which means the SDK applies the App ID.
              • +
            • If you have not enabled the App Certificate, set this parameter as the default value , which means the SDK applies the App ID.
            • If you have enabled the App Certificate, you must use the token generated with the channelName and uid.

            If the token of any target channel expires, the whole media relay stops; hence Agora recommends that you specify the same expiration time for the tokens of all the target channels.

          • uid: The unique user ID to identify the relay stream in the target channel. The value ranges from 0 to (2 32-1). To avoid user ID conflicts, this user ID must be different from any other user ID in the target channel. The default value is 0, which means the SDK generates a random user ID.
            • @@ -164,16 +164,16 @@ destCount - The number of target channels. The default value is 0, and the value range is from 0 to 6. Ensure that the value of this parameter corresponds to the number of structs you define in destInfo. + The number of target channels. The default value is 0, and the value range is from 0 to 6. Ensure that the value of this parameter corresponds to the number of structs you define in destInfo. setDestinationInfo - Sets the information of the target channel. See . + Sets the information of the target channel. See . removeDestinationInfoForChannelName - Deletes the information of target channel. See . + Deletes the information of target channel. See .
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_codeccapinfo.dita b/en-US/dita/RTC-NG/API/class_codeccapinfo.dita index 0b92b456460..71e0ebb7e66 100644 --- a/en-US/dita/RTC-NG/API/class_codeccapinfo.dita +++ b/en-US/dita/RTC-NG/API/class_codeccapinfo.dita @@ -1,7 +1,7 @@ - <ph keyref="CodecCapInfo"/> + <ph keyref="CodecCapInfo" /> The codec capability of the device.
    @@ -70,10 +70,10 @@ class CodecCapInfo { @JsonKey(name: 'codecLevels') final CodecCapLevels? codecLevels; - factory CodecCapInfo.fromJson(Map<String, dynamic> json) => + factory CodecCapInfo.fromJson(Map<String, dynamic> json) => _$CodecCapInfoFromJson(json); - Map<String, dynamic> toJson() => _$CodecCapInfoToJson(this); + Map<String, dynamic> toJson() => _$CodecCapInfoToJson(this); }

    @@ -83,14 +83,14 @@ class CodecCapInfo {
    v4.2.0
    -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> codecType - The video codec types. See . + The video codec types. See .

    The video codec types:

    • 1: VP8.
      • @@ -100,7 +100,7 @@ class CodecCapInfo { codecCapMask - The bit mask of the codec type. See . + The bit mask of the codec type. See .

      The bit mask of the codec type:

      • (0): The device does not support encoding or decoding.
        • @@ -113,8 +113,8 @@ class CodecCapInfo { codecLevels - The level of the codec capability. See . + The level of the codec capability. See .
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_codeccaplevels.dita b/en-US/dita/RTC-NG/API/class_codeccaplevels.dita index 29f19a46b6c..d06435fd763 100644 --- a/en-US/dita/RTC-NG/API/class_codeccaplevels.dita +++ b/en-US/dita/RTC-NG/API/class_codeccaplevels.dita @@ -1,7 +1,7 @@ - <ph keyref="CodecCapLevels"/> + <ph keyref="CodecCapLevels" /> The level of the codec capability.
    @@ -60,10 +60,10 @@ class CodecCapLevels { @JsonKey(name: 'swDecodingLevel') final VideoCodecCapabilityLevel? swDecodingLevel; - factory CodecCapLevels.fromJson(Map<String, dynamic> json) => + factory CodecCapLevels.fromJson(Map<String, dynamic> json) => _$CodecCapLevelsFromJson(json); - Map<String, dynamic> toJson() => _$CodecCapLevelsToJson(this); + Map<String, dynamic> toJson() => _$CodecCapLevelsToJson(this); }

    @@ -73,19 +73,19 @@ class CodecCapLevels {
    v4.2.2
    -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> hwDecodingLevel - Hardware decoding capability level, which represents the device's ability to perform hardware decoding on videos of different quality. See . + Hardware decoding capability level, which represents the device's ability to perform hardware decoding on videos of different quality. See . swDecodingLevel - Software decoding capability level, which represents the device's ability to perform software decoding on videos of different quality. See . + Software decoding capability level, which represents the device's ability to perform software decoding on videos of different quality. See .
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita b/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita index 443197715de..4ab52e56e18 100644 --- a/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita +++ b/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita @@ -1,7 +1,7 @@ - <ph keyref="ContentInspectConfig"/> + <ph keyref="ContentInspectConfig" /> Configuration of video screenshot and upload.
    @@ -22,7 +22,7 @@ type = CONTENT_INSPECT_TYPE_INVALID; interval = 0; } - }> + }> __attribute__((visibility("default"))) @interface AgoraContentInspectConfig: NSObject @property (nonatomic, copy) NSString* _Nullable extraInfo; @property(copy, nonatomic) NSArray<AgoraContentInspectModule*>* _Nullable modules; @@ -76,17 +76,17 @@ final String? extraInfo; @JsonKey(name: 'modules') - final List<ContentInspectModule>? modules; + final List<ContentInspectModule>? modules; @JsonKey(name: 'moduleCount') final int? moduleCount; - factory ContentInspectConfig.fromJson(Map<String, dynamic> json) => + factory ContentInspectConfig.fromJson(Map<String, dynamic> json) => _$ContentInspectConfigFromJson(json); - Map<String, dynamic> toJson() => _$ContentInspectConfigToJson(this); + Map<String, dynamic> toJson() => _$ContentInspectConfigToJson(this); } -

    +

    Parameters @@ -114,15 +114,15 @@ modules -

    Functional module. See .

    -

    A maximum of 32 instances can be configured, and the value range of MAX_CONTENT_INSPECT_MODULE_COUNT is an integer in [1,32].

    +

    Functional module. See .

    +

    A maximum of 32 instances can be configured, and the value range of MAX_CONTENT_INSPECT_MODULE_COUNT is an integer in [1,32].

    A function module can only be configured with one instance at most. Currently only the video screenshot and upload function is supported.     moduleCount - The number of functional modules, that is,the number of configured instances, must be the same as the number of instances configured in modules. The maximum number is 32. + The number of functional modules, that is,the number of configured instances, must be the same as the number of instances configured in modules. The maximum number is 32.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita b/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita index 85f7dbb2011..904bf6cd0bc 100644 --- a/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita +++ b/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita @@ -1,8 +1,8 @@ - <ph keyref="ContentInspectModule"/> - A structure used to configure the frequency of video screenshot and upload. + <ph keyref="ContentInspectModule" /> + A structure used to configure the frequency of video screenshot and upload.

    @@ -56,24 +56,24 @@ final ContentInspectType? type; @JsonKey(name: 'interval') final int? interval; - factory ContentInspectModule.fromJson(Map<String, dynamic> json) => + factory ContentInspectModule.fromJson(Map<String, dynamic> json) => _$ContentInspectModuleFromJson(json); - Map<String, dynamic> toJson() => _$ContentInspectModuleToJson(this); + Map<String, dynamic> toJson() => _$ContentInspectModuleToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> type - Types of functional module. See . + Types of functional module. See .

    Types of functional modules:

      -
    • (0): (Default) This module has no actual function. Do not set to this value.
      • -
    • (1): Video content moderation. SDK takes screenshots, inspects video content of the video stream in the channel, and uploads the screenshots and moderation results.
      • -
    • (2): Video screenshot and upload. SDK takes screenshots of the video stream in the channel and uploads them.
      • +
    • (0): (Default) This module has no actual function. Do not set to this value.
      • +
    • (1): Video content moderation. SDK takes screenshots, inspects video content of the video stream in the channel, and uploads the screenshots and moderation results.
      • +
    • (2): Video screenshot and upload. SDK takes screenshots of the video stream in the channel and uploads them.

         @@ -83,4 +83,4 @@
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita b/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita index 88df0d8fff4..4f99a162c4e 100644 --- a/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita +++ b/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita @@ -299,12 +299,12 @@ @JsonKey(name: 'streamType') final VideoStreamType? streamType; - factory EncodedVideoFrameInfo.fromJson(Map<String, dynamic> json) => + factory EncodedVideoFrameInfo.fromJson(Map<String, dynamic> json) => _$EncodedVideoFrameInfoFromJson(json); - Map<String, dynamic> toJson() => _$EncodedVideoFrameInfoToJson(this); + Map<String, dynamic> toJson() => _$EncodedVideoFrameInfoToJson(this); } -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -313,9 +313,9 @@ codecType The codec type of the local video stream. See . The default value is (2).

    The codec type of the video:

      -
    • (1): VP8.
      • -
    • (2): (Default) H.264.
      • -
    • (3): H.265.
      • +
    • (1): VP8.
      • +
    • (2): (Default) H.264.
      • +
    • (3): H.265.

     @@ -373,7 +373,7 @@ streamType - The type of video streams. See . + The type of video streams. See .
    • (0): High-quality stream, that is, a high-resolution and high-bitrate video stream.
      • @@ -382,4 +382,4 @@
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_externalvideoframe.dita b/en-US/dita/RTC-NG/API/class_externalvideoframe.dita index 31adf2e2520..2ff2563eb68 100644 --- a/en-US/dita/RTC-NG/API/class_externalvideoframe.dita +++ b/en-US/dita/RTC-NG/API/class_externalvideoframe.dita @@ -250,7 +250,7 @@ final int? textureId; @JsonKey(name: 'matrix') - final List<double>? matrix; + final List<double>? matrix; @JsonKey(name: 'metadata_buffer', ignore: true) final Uint8List? metadataBuffer; @@ -258,12 +258,12 @@ @JsonKey(name: 'metadata_size') final int? metadataSize; - factory ExternalVideoFrame.fromJson(Map<String, dynamic> json) => + factory ExternalVideoFrame.fromJson(Map<String, dynamic> json) => _$ExternalVideoFrameFromJson(json); - Map<String, dynamic> toJson() => _$ExternalVideoFrameToJson(this); + Map<String, dynamic> toJson() => _$ExternalVideoFrameToJson(this); } -

    +

    diff --git a/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita b/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita index fc70daee84d..3155ea39a73 100644 --- a/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita +++ b/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita @@ -143,7 +143,7 @@ _$InjectStreamConfigFromJson(json); Map<String, dynamic> toJson() => _$InjectStreamConfigToJson(this); } -

    +

    diff --git a/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita b/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita index 8b715da6ff4..08dea2cba91 100644 --- a/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita @@ -1,24 +1,24 @@ - <ph keyref="LocalTranscoderConfiguration"/> + <ph keyref="LocalTranscoderConfiguration" /> The configuration of the video mixing on the local client.

    public class LocalTranscoderConfiguration { - public ArrayList<TranscodingVideoStream> transcodingVideoStreams; + public ArrayList<TranscodingVideoStream> transcodingVideoStreams; public VideoEncoderConfiguration videoOutputConfiguration; public LocalTranscoderConfiguration() { - transcodingVideoStreams = new ArrayList<TranscodingVideoStream>(); + transcodingVideoStreams = new ArrayList<TranscodingVideoStream>(); videoOutputConfiguration = new VideoEncoderConfiguration(); } } __attribute__((visibility("default"))) @interface AgoraLocalTranscoderConfiguration: NSObject -@property(copy, nonatomic) NSArray<AgoraTranscodingVideoStream *> *_Nullable videoInputStreams; +@property(copy, nonatomic) NSArray<AgoraTranscodingVideoStream *> *_Nullable videoInputStreams; @property (strong, nonatomic) AgoraVideoEncoderConfiguration *_Nonnull videoOutputConfiguration; @@ -68,19 +68,19 @@ class LocalTranscoderConfiguration { final int? streamCount; @JsonKey(name: 'videoInputStreams') - final List<TranscodingVideoStream>? videoInputStreams; + final List<TranscodingVideoStream>? videoInputStreams; @JsonKey(name: 'videoOutputConfiguration') final VideoEncoderConfiguration? videoOutputConfiguration; - factory LocalTranscoderConfiguration.fromJson(Map<String, dynamic> json) => + factory LocalTranscoderConfiguration.fromJson(Map<String, dynamic> json) => _$LocalTranscoderConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$LocalTranscoderConfigurationToJson(this); + Map<String, dynamic> toJson() => _$LocalTranscoderConfigurationToJson(this); }

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> streamCount @@ -89,12 +89,12 @@ class LocalTranscoderConfiguration { videoInputStreams transcodingVideoStreams - The video streams for local video mixing. See . + The video streams for local video mixing. See . videoOutputConfiguration - The encoding configuration of the mixed video stream after the local video mixing. See . + The encoding configuration of the mixed video stream after the local video mixing. See .
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_localvideostats.dita b/en-US/dita/RTC-NG/API/class_localvideostats.dita index d12919e56c3..eb327156492 100644 --- a/en-US/dita/RTC-NG/API/class_localvideostats.dita +++ b/en-US/dita/RTC-NG/API/class_localvideostats.dita @@ -1,7 +1,7 @@ - <ph keyref="LocalVideoStats"/> + <ph keyref="LocalVideoStats" /> The statistics of the local video stream.
    @@ -296,15 +296,15 @@ @JsonKey(name: 'hwEncoderAccelerating') final int? hwEncoderAccelerating; - factory LocalVideoStats.fromJson(Map<String, dynamic> json) => + factory LocalVideoStats.fromJson(Map<String, dynamic> json) => _$LocalVideoStatsFromJson(json); - Map<String, dynamic> toJson() => _$LocalVideoStatsToJson(this); + Map<String, dynamic> toJson() => _$LocalVideoStatsToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> uid @@ -362,11 +362,11 @@ qualityAdaptIndication - The quality adaptation of the local video stream in the reported interval (based on the target frame rate and target bitrate). See .

    + The quality adaptation of the local video stream in the reported interval (based on the target frame rate and target bitrate). See .

      -
    • (0): The local video quality stays the same.
      • -
    • (1): The local video quality improves because the network bandwidth increases.
      • -
    • (2): The local video quality deteriorates because the network bandwidth decreases.
      • +
    • (0): The local video quality stays the same.
      • +
    • (1): The local video quality improves because the network bandwidth increases.
      • +
    • (2): The local video quality deteriorates because the network bandwidth decreases.

         @@ -390,11 +390,11 @@ codecType - The codec type of the local video. See .

    + The codec type of the local video. See .

      -
    • (1): VP8.
      • -
    • (2): (Default) H.264.
      • -
    • (3): H.265.
      • +
    • (1): VP8.
      • +
    • (2): (Default) H.264.
      • +
    • (3): H.265.

         @@ -408,24 +408,24 @@ captureBrightnessLevel - The brightness level of the video image captured by the local camera. See . + The brightness level of the video image captured by the local camera. See . captureBrightnessLevel The brightness level of the video image captured by the local camera.
      -
    • (-1): The SDK does not detect the brightness level of the video image. Wait a few seconds to get the brightness level from captureBrightnessLevel in the next callback.
      • -
    • (0): The brightness level of the video image is normal.
      • -
    • (1): The brightness level of the video image is too bright.
      • -
    • (2): The brightness level of the video image is too dark.
      • +
    • (-1): The SDK does not detect the brightness level of the video image. Wait a few seconds to get the brightness level from captureBrightnessLevel in the next callback.
      • +
    • (0): The brightness level of the video image is normal.
      • +
    • (1): The brightness level of the video image is too bright.
      • +
    • (2): The brightness level of the video image is too dark.
         hwEncoderAccelerating - The local video encoding acceleration type. See .
      + The local video encoding acceleration type. See .
      • 0: Software encoding is applied without acceleration.
      • 1: Hardware encoding is applied for acceleration.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita b/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita index fc624f4f4f9..2c97d0962a9 100644 --- a/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita @@ -93,12 +93,12 @@ @JsonKey(name: 'recorderInfoUpdateInterval') final int? recorderInfoUpdateInterval; - factory MediaRecorderConfiguration.fromJson(Map<String, dynamic> json) => + factory MediaRecorderConfiguration.fromJson(Map<String, dynamic> json) => _$MediaRecorderConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$MediaRecorderConfigurationToJson(this); + Map<String, dynamic> toJson() => _$MediaRecorderConfigurationToJson(this); }     -

    +

    @@ -109,10 +109,10 @@ storagePath The absolute path (including the filename extensions) of the recording file. For example:

      -
    • Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.mp4
      • +
    • Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.mp4
    • iOS: /App Sandbox/Library/Caches/example.mp4
    • macOS: ～/Library/Logs/example.mp4
      • -
    • Android: /storage/emulated/0/Android/data/<package name>/files/agorasdk.mp4
      • +
    • Android: /storage/emulated/0/Android/data/<package name>/files/agorasdk.mp4
    Ensure that the directory for the log files exists and is writable. @@ -123,7 +123,7 @@ streamType - The recording content. See . + The recording content. See . The recording content:
    • : Only audio.
    • : Only video.
      • @@ -140,4 +140,4 @@
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_mediasource.dita b/en-US/dita/RTC-NG/API/class_mediasource.dita index 263f15fd6fb..4ec014d350d 100644 --- a/en-US/dita/RTC-NG/API/class_mediasource.dita +++ b/en-US/dita/RTC-NG/API/class_mediasource.dita @@ -1,7 +1,7 @@ - <ph keyref="MediaSource"/> + <ph keyref="MediaSource" /> Information related to the media file to be played and the playback scenario configurations.
    @@ -134,12 +134,12 @@ @JsonKey(name: 'isLiveSource') final bool? isLiveSource; - factory MediaSource.fromJson(Map<String, dynamic> json) => + factory MediaSource.fromJson(Map<String, dynamic> json) => _$MediaSourceFromJson(json); - Map<String, dynamic> toJson() => _$MediaSourceToJson(this); + Map<String, dynamic> toJson() => _$MediaSourceToJson(this); } -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -207,7 +207,7 @@ provider -

    The callback for custom media resource files. See .

    +

    The callback for custom media resource files. See .

    If you open a custom media resource, pass in the value to provider. If you open a common media resource, pass in the value to url. Agora recommends that you do not pass in values to both url and provider in one call; otherwise, this call may fail.

     @@ -216,19 +216,19 @@ playerOnReadCallback -

    Occurs when the SDK reads the media resource data. See .

    +

    Occurs when the SDK reads the media resource data. See .

    -

    +

    playerOnSeekCallback -

    Occurs when the SDK seeks the media resource data. See .

    +

    Occurs when the SDK seeks the media resource data. See .

     -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita b/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita index ca7884ea02e..9ba243c3685 100644 --- a/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita +++ b/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita @@ -260,10 +260,10 @@ @JsonKey(name: 'qualityChangedReason') final int? qualityChangedReason; - factory RemoteAudioStats.fromJson(Map<String, dynamic> json) => + factory RemoteAudioStats.fromJson(Map<String, dynamic> json) => _$RemoteAudioStatsFromJson(json); - Map<String, dynamic> toJson() => _$RemoteAudioStatsToJson(this); + Map<String, dynamic> toJson() => _$RemoteAudioStatsToJson(this); }

    diff --git a/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita b/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita index b9a6b03d108..ab51e60901e 100644 --- a/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita +++ b/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita @@ -1,8 +1,8 @@ - <ph keyref="RtcEngineConfig"/> - Configurations for the instance. + <ph keyref="RtcEngineConfig" /> + Configurations for the instance.

    @@ -214,25 +214,25 @@ class RtcEngineContext { @JsonKey(name: 'autoRegisterAgoraExtensions') final bool? autoRegisterAgoraExtensions; - factory RtcEngineContext.fromJson(Map<String, dynamic> json) => + factory RtcEngineContext.fromJson(Map<String, dynamic> json) => _$RtcEngineContextFromJson(json); - Map<String, dynamic> toJson() => _$RtcEngineContextToJson(this); + Map<String, dynamic> toJson() => _$RtcEngineContextToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> eventHandler mEventHandler - The event handler for . See . + The event handler for . See . appId mAppId - The App ID issued by Agora for your project. Only users in apps with the same App ID can join the same channel and communicate with each other. An App ID can only be used to create one instance. To change your App ID, call to destroy the current instance, and then create a new one. + The App ID issued by Agora for your project. Only users in apps with the same App ID can join the same channel and communicate with each other. An App ID can only be used to create one instance. To change your App ID, call to destroy the current instance, and then create a new one. context @@ -256,33 +256,33 @@ class RtcEngineContext {
    • This method is applicable when you integrate the SDK manually but not when you integrate the SDK with Maven Central or JitPack.
      • -
    • Ensure the specified directory exists; otherwise, the initialization fails.
      • +
    • Ensure the specified directory exists; otherwise, the initialization fails.
         channelProfile mChannelProfile - + audioScenario mAudioScenario - + areaCode mAreaCode - The region for connection. This is an advanced feature and applies to scenarios that have regional restrictions. For details on supported regions, see . The area codes support bitwise operation. + The region for connection. This is an advanced feature and applies to scenarios that have regional restrictions. For details on supported regions, see . The area codes support bitwise operation. After specifying the region, the app integrated with the Agora SDK connects to the Agora servers within that region. logConfig mLogConfig -

    Sets the log file size. See .

    +

    Sets the log file size. See .

    By default, the SDK generates five SDK log files and five API call log files with the following rules:

      -
    • +
    @@ -292,19 +292,19 @@ class RtcEngineContext { mExtensionObserver eventDelegate - The instance. + The instance. mediaFilterExtensions - The instance. + The instance. mDomainLimit domainLimit

    Whether to enable domain name restriction:

      -
    • : Enables the domain name restriction. This value is suitable for scenarios where IoT devices use IoT cards for network access. The SDK will only connect to servers in the domain name or IP whitelist that has been reported to the operator.
      • -
    • : (Default) Disables the domain name restriction. This value is suitable for most common scenarios.
      • +
    • : Enables the domain name restriction. This value is suitable for scenarios where IoT devices use IoT cards for network access. The SDK will only connect to servers in the domain name or IP whitelist that has been reported to the operator.
      • +
    • : (Default) Disables the domain name restriction. This value is suitable for most common scenarios.

         @@ -312,9 +312,9 @@ class RtcEngineContext { mAutoRegisterAgoraExtensions autoRegisterAgoraExtensions -

    Whether to automatically register the Agora extensions when initializing :

      -
    • : (Default) Automatically register the Agora extensions when initializing .
      • -
    • : Do not register the Agora extensions when initializing . You need to call to register the Agora extensions.
      • +

      Whether to automatically register the Agora extensions when initializing :

        +
      • : (Default) Automatically register the Agora extensions when initializing .
        • +
      • : Do not register the Agora extensions when initializing . You need to call to register the Agora extensions.

      @@ -324,9 +324,9 @@ class RtcEngineContext { addExtension - Adds the extension. See . + Adds the extension. See .
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita b/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita index 377095e2002..f01c7b2938c 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita @@ -101,7 +101,7 @@ __attribute__((visibility("default"))) @interface AgoraScreenCaptureConfiguratio _$ScreenCaptureConfigurationFromJson(json); Map<String, dynamic> toJson() => _$ScreenCaptureConfigurationToJson(this); }     -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -129,7 +129,7 @@ __attribute__((visibility("default"))) @interface AgoraScreenCaptureConfiguratio params parameters - (For Windows and macOS only) The screen capture configuration. See . + (For Windows and macOS only) The screen capture configuration. See . regionRect diff --git a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita index c2679fdef21..9af53a7837e 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita @@ -1,12 +1,12 @@ - <ph keyref="ScreenCaptureParameters"/> + <ph keyref="ScreenCaptureParameters" /> Screen sharing configurations.

    - + __attribute__((visibility("default"))) @interface AgoraScreenCaptureParameters: NSObject @property (assign, nonatomic) CGSize dimensions; @property (assign, nonatomic) NSInteger frameRate; @@ -206,7 +206,7 @@ final bool? windowFocus; @JsonKey(name: 'excludeWindowList') - final List<int>? excludeWindowList; + final List<int>? excludeWindowList; @JsonKey(name: 'excludeWindowCount') final int? excludeWindowCount; @@ -220,21 +220,21 @@ @JsonKey(name: 'enableHighLight') final bool? enableHighLight; - factory ScreenCaptureParameters.fromJson(Map<String, dynamic> json) => + factory ScreenCaptureParameters.fromJson(Map<String, dynamic> json) => _$ScreenCaptureParametersFromJson(json); - Map<String, dynamic> toJson() => _$ScreenCaptureParametersToJson(this); + Map<String, dynamic> toJson() => _$ScreenCaptureParametersToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> - The video profiles of the shared screen stream are only set by , independent of . + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + The video profiles of the shared screen stream are only set by , independent of . dimensions -

    The video encoding resolution of the shared screen stream. See . The default value is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges.

    +

    The video encoding resolution of the shared screen stream. See . The default value is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges.

    If the screen dimensions are different from the value of this parameter, Agora applies the following strategies for encoding. Suppose dimensions is set to 1920 × 1080:

    • If the value of the screen dimensions is lower than that of dimensions, for example, 1000 × 1000 pixels, the SDK uses the screen dimensions, that is, 1000 × 1000 pixels, for encoding.
    • If the value of the screen dimensions is higher than that of dimensions, for example, 2000 × 1500, the SDK uses the maximum value under dimensions with the aspect ratio of the screen dimension (4:3) for encoding, that is, 1440 × 1080.
      • @@ -253,32 +253,32 @@ captureMouseCursor

      Whether to capture the mouse in screen sharing:

        -
      • : (Default) Capture the mouse.
        • -
      • : Do not capture the mouse.
        • +
      • : (Default) Capture the mouse.
        • +
      • : Do not capture the mouse.

       windowFocus -

      Whether to bring the window to the front when calling the method to share it:

        -
      • : Bring the window to the front.
        • -
      • : (Default) Do not bring the window to the front.
        • +

        Whether to bring the window to the front when calling the method to share it:

          +
        • : Bring the window to the front.
          • +
        • : (Default) Do not bring the window to the front.

        excludeWindowList - The ID list of the windows to be blocked. When calling to start screen sharing, you can use this parameter to block a specified window. When calling to update screen sharing configurations, you can use this parameter to dynamically block a specified window. + The ID list of the windows to be blocked. When calling to start screen sharing, you can use this parameter to block a specified window. When calling to update screen sharing configurations, you can use this parameter to dynamically block a specified window. highLighted enableHighLight (For macOS and Windows only) Whether to place a border around the shared window or screen:
          -
        • : Place a border.
          • -
        • : (Default) Do not place a border.
          • +
        • : Place a border.
          • +
        • : (Default) Do not place a border.
        - When you share a part of a window or screen, the SDK places a border around the entire window or screen if you set this parameter to .         + When you share a part of a window or screen, the SDK places a border around the entire window or screen if you set this parameter to .         highLightColor @@ -288,7 +288,7 @@ highLightWidth - (For macOS and Windows only) The width (px) of the border. The default value is 5, and the value range is (0, 50].This parameter only takes effect when highLighted is set to . + (For macOS and Windows only) The width (px) of the border. The default value is 5, and the value range is (0, 50].This parameter only takes effect when highLighted is set to . excludeWindowCount @@ -297,4 +297,4 @@
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita index 4a86e5cbd24..a18bcc92859 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita @@ -1,7 +1,7 @@ - <ph keyref="ScreenCaptureParameters2"/> + <ph keyref="ScreenCaptureParameters2" /> Screen sharing configurations.
    @@ -169,58 +169,58 @@ @JsonKey(name: 'videoParams') final ScreenVideoParameters? videoParams; - factory ScreenCaptureParameters2.fromJson(Map<String, dynamic> json) => + factory ScreenCaptureParameters2.fromJson(Map<String, dynamic> json) => _$ScreenCaptureParameters2FromJson(json); - Map<String, dynamic> toJson() => _$ScreenCaptureParameters2ToJson(this); + Map<String, dynamic> toJson() => _$ScreenCaptureParameters2ToJson(this); } -

    +

    -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> captureAudio Determines whether to capture system audio during screen sharing:
      -
    • : Capture system audio.
      • -
    • : (Default) Do not capture system audio.
      • +
    • : Capture system audio.
      • +
    • : (Default) Do not capture system audio.
    • Due to system limitations, capturing system audio is only applicable to Android API level 29 and later (that is, Android 10 and later).
      • -
    • To improve the success rate of capturing system audio during screen sharing, ensure that you have called the method and set the audio scenario to .
     +
  • To improve the success rate of capturing system audio during screen sharing, ensure that you have called the method and set the audio scenario to .
    •  audioParams - The audio configuration for the shared screen stream. See .This parameter only takes effect when captureAudio is . + The audio configuration for the shared screen stream. See .This parameter only takes effect when captureAudio is . captureVideo Whether to capture the screen when screen sharing:
      -
    • : (Default) Capture the screen.
      • -
    • : Do not capture the screen.
      • +
    • : (Default) Capture the screen.
      • +
    • : Do not capture the screen.
    Due to system limitations, the capture screen is only applicable to Android API level 21 and above, that is, Android 5 and above.         videoParams - The video configuration for the shared screen stream. See .This parameter only takes effect when captureVideo is . + The video configuration for the shared screen stream. See .This parameter only takes effect when captureVideo is .
    Subclass - - The video configuration for the shared screen stream. See . + + The video configuration for the shared screen stream. See . - - The audio configuration for the shared screen stream. See . + + The audio configuration for the shared screen stream. See .
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita index 25dee9d51ac..b675d414180 100644 --- a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita +++ b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita @@ -1,12 +1,12 @@ - <ph keyref="ScreenCaptureSourceInfo"/> - The information about the specified shareable window or screen. The information is returned in . + <ph keyref="ScreenCaptureSourceInfo" /> + The information about the specified shareable window or screen. The information is returned in .

    - + __attribute__((visibility("default"))) @interface AgoraScreenCaptureSourceInfo : NSObject @property(assign, nonatomic) AgoraScreenCaptureSourceType type; @property(assign, nonatomic) CGWindowID sourceId; @@ -76,7 +76,7 @@ public Rectangle position; public view_t sourceDisplayId; }; - + class ScreenCaptureSourceInfo { const ScreenCaptureSourceInfo( {this.type, @@ -124,19 +124,19 @@ @JsonKey(name: 'sourceDisplayId') final int? sourceDisplayId; - factory ScreenCaptureSourceInfo.fromJson(Map<String, dynamic> json) => + factory ScreenCaptureSourceInfo.fromJson(Map<String, dynamic> json) => _$ScreenCaptureSourceInfoFromJson(json); - Map<String, dynamic> toJson() => _$ScreenCaptureSourceInfoToJson(this); + Map<String, dynamic> toJson() => _$ScreenCaptureSourceInfoToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> type - The type of the shared target. See . + The type of the shared target. See . sourceId @@ -148,11 +148,11 @@ thumbImage - The image content of the thumbnail. See . + The image content of the thumbnail. See . iconImage - The image content of the icon. See . + The image content of the icon. See . processPath @@ -165,19 +165,19 @@ primaryMonitor Determines whether the screen is the primary display:
      -
    • : The screen is the primary display.
      • -
    • : The screen is not the primary display.
      • +
    • : The screen is the primary display.
      • +
    • : The screen is not the primary display.
         position - The position of a window relative to the entire screen space (including all shareable screens). See . See . + The position of a window relative to the entire screen space (including all shareable screens). See . See . minimizeWindow (For Windows only) Whether the window is minimized:
      -
    • : The window is minimized.
      • -
    • : The window is not minimized.
      • +
    • : The window is minimized.
      • +
    • : The window is not minimized.
         @@ -186,4 +186,4 @@
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita b/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita index 4cc9bbcfb2a..402fa97289d 100644 --- a/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita +++ b/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita @@ -77,7 +77,7 @@ dimensions - The video dimension. See . The default value is 160 × 120. + The video dimension. See . The default value is 160 × 120. bitrate diff --git a/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita b/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita index d1aef3abb2a..365d0624ba1 100644 --- a/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita +++ b/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita @@ -1,7 +1,7 @@ - <ph keyref="TranscodingVideoStream"/> + <ph keyref="TranscodingVideoStream" /> The video streams for local video mixing.
    @@ -176,18 +176,18 @@ class TranscodingVideoStream { @JsonKey(name: 'mirror') final bool? mirror; - factory TranscodingVideoStream.fromJson(Map<String, dynamic> json) => + factory TranscodingVideoStream.fromJson(Map<String, dynamic> json) => _$TranscodingVideoStreamFromJson(json); - Map<String, dynamic> toJson() => _$TranscodingVideoStreamToJson(this); + Map<String, dynamic> toJson() => _$TranscodingVideoStreamToJson(this); }

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> sourceType - The video source type for local video mixing. See . + The video source type for local video mixing. See . remoteUserUid @@ -203,7 +203,7 @@ class TranscodingVideoStream { mediaPlayerId - (Optional) Media player ID. Use the parameter only when you set sourceType to . + (Optional) Media player ID. Use the parameter only when you set sourceType to . x @@ -246,4 +246,4 @@ class TranscodingVideoStream {
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita b/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita index c6f70b2f032..833ab49b07a 100644 --- a/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita +++ b/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita @@ -53,7 +53,7 @@ _$UserAudioSpectrumInfoFromJson(json); Map<String, dynamic> toJson() => _$UserAudioSpectrumInfoToJson(this); } -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> diff --git a/en-US/dita/RTC-NG/API/class_videocanvas.dita b/en-US/dita/RTC-NG/API/class_videocanvas.dita index 2b0fe9185f2..2c4c0b2f244 100644 --- a/en-US/dita/RTC-NG/API/class_videocanvas.dita +++ b/en-US/dita/RTC-NG/API/class_videocanvas.dita @@ -1,7 +1,7 @@ - <ph keyref="VideoCanvas"/> + <ph keyref="VideoCanvas" /> Attributes of the video canvas object.
    @@ -173,16 +173,16 @@ class VideoCanvas { @JsonKey(name: 'enableAlphaMask') final bool? enableAlphaMask; - factory VideoCanvas.fromJson(Map<String, dynamic> json) => + factory VideoCanvas.fromJson(Map<String, dynamic> json) => _$VideoCanvasFromJson(json); - Map<String, dynamic> toJson() => _$VideoCanvasToJson(this); + Map<String, dynamic> toJson() => _$VideoCanvasToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> view @@ -193,16 +193,16 @@ class VideoCanvas { renderMode - The rendering mode of the video. See . -
    + The rendering mode of the video. See . +
    mirrorMode -

    The mirror mode of the view. See .

    +

    The mirror mode of the view. See .

      -
    • +

      @@ -216,7 +216,7 @@ class VideoCanvas { sourceType - The type of the video source. See . + The type of the video source. See . sourceId @@ -224,29 +224,29 @@ class VideoCanvas { setupMode - Setting mode of the view. See . + Setting mode of the view. See . Setting mode of the view.
        -
      • (0): (Default) Replaces a view.
        • -
      • (1): Adds a view.
        • -
      • (2): Deletes a view.
        • +
      • (0): (Default) Replaces a view.
        • +
      • (1): Adds a view.
        • +
      • (2): Deletes a view.
             mediaPlayerId - The ID of the media player. You can get the Device ID by calling . - This parameter is required when sourceType is . + The ID of the media player. You can get the Device ID by calling . + This parameter is required when sourceType is . rect - (Optional) Display area for the video frame. See . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. + (Optional) Display area for the video frame. See . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. cropArea - (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. + (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. cropArea - (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. + (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. backgroundColor @@ -256,15 +256,15 @@ class VideoCanvas { enableAlphaMask

      (Optional) Whether the receiver enables alpha mask rendering:

        -
      • : The receiver enables alpha mask rendering.
        • -
      • : (default) The receiver disables alpha mask rendering.
        • +
      • : The receiver enables alpha mask rendering.
        • +
      • : (default) The receiver disables alpha mask rendering.

      Alpha mask rendering can create images with transparent effects and extract portraits from videos. When used in combination with other methods, you can implement effects such as picture-in-picture and watermarking.

      -
      • This property applies to macOS only.
      • The receiver can render alpha channel information only when the sender enables alpha transmission.
      • To enable alpha transmission, .
       +
      • This property applies to macOS only.
      • The receiver can render alpha channel information only when the sender enables alpha transmission.
      • To enable alpha transmission, .
             Reserved.
    -     + \ 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 38f171073ff..664cb776215 100644 --- a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita @@ -278,21 +278,21 @@ advanceOptions(PREFER_AUTO) {} }; export class VideoEncoderConfiguration { - + codecType?: VideoCodecType; - + dimensions?: VideoDimensions; - + frameRate?: number; - + bitrate?: number; - + minBitrate?: number; - + orientationMode?: OrientationMode; - + degradationPreference?: DegradationPreference; - + mirrorMode?: VideoMirrorModeType; advanceOptions?: AdvanceOptions; @@ -362,21 +362,21 @@ } }; export class VideoEncoderConfiguration { - + codecType?: VideoCodecType; - + dimensions?: VideoDimensions; - + frameRate?: number; - + bitrate?: number; - + minBitrate?: number; - + orientationMode?: OrientationMode; - + degradationPreference?: DegradationPreference; - + mirrorMode?: VideoMirrorModeType; advanceOptions?: AdvanceOptions; @@ -424,7 +424,7 @@ _$VideoEncoderConfigurationFromJson(json); Map<String, dynamic> toJson() => _$VideoEncoderConfigurationToJson(this); -} +}

    @@ -471,6 +471,10 @@ frameRate The frame rate (fps) of the encoding video frame. The default value is 15. See . + + minFramerate + The minimum encoding frame rate of the video. The default value is -1. + bitrate diff --git a/en-US/dita/RTC-NG/API/class_videoframe.dita b/en-US/dita/RTC-NG/API/class_videoframe.dita index bf7432a5660..57f7c9cb49c 100644 --- a/en-US/dita/RTC-NG/API/class_videoframe.dita +++ b/en-US/dita/RTC-NG/API/class_videoframe.dita @@ -1,7 +1,7 @@ - <ph keyref="VideoFrame"/> + <ph keyref="VideoFrame" /> Configurations of the video frame.
    @@ -476,28 +476,28 @@ class VideoFrame { final int? textureId; @JsonKey(name: 'matrix') - final List<double>? matrix; + final List<double>? matrix; @JsonKey(name: 'pixelBuffer', ignore: true) final Uint8List? pixelBuffer; - factory VideoFrame.fromJson(Map<String, dynamic> json) => + factory VideoFrame.fromJson(Map<String, dynamic> json) => _$VideoFrameFromJson(json); - Map<String, dynamic> toJson() => _$VideoFrameToJson(this); + Map<String, dynamic> toJson() => _$VideoFrameToJson(this); } -

    +

    Note that the buffer provides a pointer to a pointer. This interface cannot modify the pointer of the buffer, but it can modify the content of the buffer.

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> type - The pixel format. See . - + The pixel format. See . + width @@ -602,7 +602,7 @@ class VideoFrame { colorSpace - The color space of a video frame. See . + The color space of a video frame. See . sourceType @@ -620,9 +620,9 @@ class VideoFrame { alphaBuffer

    Indicates the alpha channel data output by the portrait segmentation algorithm, which is consistent with the size of the video frame. The value range of each pixel is [0,255], where 0 represents the background; 255 represents the foreground (portrait).

    -

    In the costom video renderer scenario, you can use this parameter to render the video background into various effects, such as: transparent, solid color, picture, video and so on.To use this parameter, contact .

    +

    In the costom video renderer scenario, you can use this parameter to render the video background into various effects, such as: transparent, solid color, picture, video and so on.To use this parameter, contact .
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita b/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita index a0243b3aebd..7f737d56534 100644 --- a/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita +++ b/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="VideoSubscriptionOptions"/> + <ph keyref="VideoSubscriptionOptions" /> Video subscription options.
    @@ -48,8 +48,8 @@ @end struct VideoSubscriptionOptions { - Optional<VIDEO_STREAM_TYPE> type; - Optional<bool> encodedFrameOnly; + Optional<VIDEO_STREAM_TYPE> type; + Optional<bool> encodedFrameOnly; VideoSubscriptionOptions() {} }; @@ -61,9 +61,9 @@ } public class VideoSubscriptionOptions:OptionalJsonParse { - public Optional<VIDEO_STREAM_TYPE> type = new Optional<VIDEO_STREAM_TYPE>(); + public Optional<VIDEO_STREAM_TYPE> type = new Optional<VIDEO_STREAM_TYPE>(); - public Optional<bool> encodedFrameOnly = new Optional<bool>(); + public Optional<bool> encodedFrameOnly = new Optional<bool>(); } export class VideoSubscriptionOptions { @@ -80,33 +80,33 @@ @JsonKey(name: 'encodedFrameOnly') final bool? encodedFrameOnly; - factory VideoSubscriptionOptions.fromJson(Map<String, dynamic> json) => + factory VideoSubscriptionOptions.fromJson(Map<String, dynamic> json) => _$VideoSubscriptionOptionsFromJson(json); - Map<String, dynamic> toJson() => _$VideoSubscriptionOptionsToJson(this); + Map<String, dynamic> toJson() => _$VideoSubscriptionOptionsToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> streamType type - The video stream type that you want to subscribe to. The default value is , indicating that the high-quality video streams are subscribed. See . + The video stream type that you want to subscribe to. The default value is , indicating that the high-quality video streams are subscribed. See . The video stream type that you want to subscribe to:
      -
    • (0): (Default) High-quality video stream, that is, a high-resolution, high-bit-rate video stream.
      • -
    • (1): Low-quality stream, that is, a low-resolution, low-bitrate video stream.
      • +
    • (0): (Default) High-quality video stream, that is, a high-resolution, high-bit-rate video stream.
      • +
    • (1): Low-quality stream, that is, a low-resolution, low-bitrate video stream.
         encodedFrameOnly Whether to subscribe to encoded video frames only:
      -
    • : Subscribe to the encoded video data (structured data) only; the SDK does not decode or render raw video data.
      • -
    • : (Default) Subscribe to both raw video data and encoded video data.
      • +
    • : Subscribe to the encoded video data (structured data) only; the SDK does not decode or render raw video data.
      • +
    • : (Default) Subscribe to both raw video data and encoded video data.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_watermarkoptions.dita b/en-US/dita/RTC-NG/API/class_watermarkoptions.dita index 7cbc3b7b40b..266d766b6b0 100644 --- a/en-US/dita/RTC-NG/API/class_watermarkoptions.dita +++ b/en-US/dita/RTC-NG/API/class_watermarkoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="WatermarkOptions"/> + <ph keyref="WatermarkOptions" /> Configurations of the watermark image.
    @@ -121,13 +121,13 @@ _$WatermarkOptionsFromJson(json); Map<String, dynamic> toJson() => _$WatermarkOptionsToJson(this); } -

    +

    -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> visibleInPreview @@ -135,8 +135,8 @@ positionInLandscapeMode - The area to display the watermark image in landscape mode. See . - When the adaptation mode of the watermark is , it is used to set the area of the watermark image in landscape mode. See . + The area to display the watermark image in landscape mode. See . + When the adaptation mode of the watermark is , it is used to set the area of the watermark image in landscape mode. See . The area to display the watermark image in landscape mode. This parameter contains the following members:
    • x: The horizontal position of the watermark relative to the upper left corner.
    • y: The vertical position of the watermark relative to the upper left corner.
      • @@ -146,8 +146,8 @@ positionInPortraitMode - The area to display the watermark image in portrait mode. See . - When the adaptation mode of the watermark is , it is used to set the area of the watermark image in portrait mode. See . + The area to display the watermark image in portrait mode. See . + When the adaptation mode of the watermark is , it is used to set the area of the watermark image in portrait mode. See . The area to display the watermark image in portrait mode. This parameter contains the following members:
      • x: The horizontal position of the watermark relative to the upper left corner.
      • y: The vertical position of the watermark relative to the upper left corner.
        • @@ -157,12 +157,12 @@ watermarkRatio - When the watermark adaptation mode is , this parameter is used to set the watermark coordinates. See . + When the watermark adaptation mode is , this parameter is used to set the watermark coordinates. See . mode - The adaptation mode of the watermark. See . + The adaptation mode of the watermark. See .
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/enum_bitrate.dita b/en-US/dita/RTC-NG/API/enum_bitrate.dita index a4cab5bf243..5ca1d506826 100644 --- a/en-US/dita/RTC-NG/API/enum_bitrate.dita +++ b/en-US/dita/RTC-NG/API/enum_bitrate.dita @@ -9,7 +9,7 @@ - 0: (Recommended) Standard bitrate mode. In this mode, the bitrates of the live broadcasting profile is higher than that of the communication profile. See . + 0: (Recommended) Standard bitrate mode. In this mode, the bitrates of the live broadcasting profile is higher than that of the communication profile. See . diff --git a/en-US/dita/RTC-NG/API/rtc_api_overview_ng.dita b/en-US/dita/RTC-NG/API/rtc_api_overview_ng.dita index 574e09f69d5..0e0b7b5af56 100644 --- a/en-US/dita/RTC-NG/API/rtc_api_overview_ng.dita +++ b/en-US/dita/RTC-NG/API/rtc_api_overview_ng.dita @@ -1937,7 +1937,7 @@ - + Event @@ -2562,7 +2562,7 @@ - + From 465b4296e3cb70e16d8bc94d7c192c5ea8d379e1 Mon Sep 17 00:00:00 2001 From: Suri539 Date: Mon, 11 Sep 2023 02:30:05 +0000 Subject: [PATCH 10/13] Sync cn prototype to en prototype --- en-US/dita/RTC-NG/API/class_audioparams.dita | 16 ++++++++-------- .../API/class_cameracapturerconfiguration.dita | 14 +++++++------- .../API/class_screencaptureparameters.dita | 2 +- .../API/class_screencapturesourceinfo.dita | 18 +++++++++--------- 4 files changed, 25 insertions(+), 25 deletions(-) diff --git a/en-US/dita/RTC-NG/API/class_audioparams.dita b/en-US/dita/RTC-NG/API/class_audioparams.dita index 7f261a560e3..141dda8efba 100644 --- a/en-US/dita/RTC-NG/API/class_audioparams.dita +++ b/en-US/dita/RTC-NG/API/class_audioparams.dita @@ -40,13 +40,13 @@ AudioParams(int samplerate, int channel, rtc::RAW_AUDIO_FRAME_OP_MODE_TYPE type, int samplesPerCall) : sample_rate(samplerate), channels(channel), mode(type), samples_per_call(samplesPerCall) {} }; export class AudioParams { - + sample_rate?: number; - + channels?: number; - + mode?: RawAudioFrameOpModeType; - + samples_per_call?: number; } public class AudioParams @@ -73,13 +73,13 @@ } }; export class AudioParams { - + sample_rate?: number; - + channels?: number; - + mode?: RawAudioFrameOpModeType; - + samples_per_call?: number; } class AudioParams { diff --git a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita index e2e37d5bcb0..87fe88d06c2 100644 --- a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita @@ -135,11 +135,11 @@ } }; export class CameraCapturerConfiguration { - + cameraDirection?: CameraDirection; - + deviceId?: string; - + format?: VideoFormat; followEncodeDimensionRatio?: boolean; @@ -170,11 +170,11 @@ public CAMERA_DIRECTION cameraDirection { set; get; } } export class CameraCapturerConfiguration { - + cameraDirection?: CameraDirection; - + deviceId?: string; - + format?: VideoFormat; followEncodeDimensionRatio?: boolean; @@ -203,7 +203,7 @@ _$CameraCapturerConfigurationFromJson(json); Map<String, dynamic> toJson() => _$CameraCapturerConfigurationToJson(this); -} +}

    diff --git a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita index 9136691bf95..9af53a7837e 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita @@ -224,7 +224,7 @@ _$ScreenCaptureParametersFromJson(json); Map<String, dynamic> toJson() => _$ScreenCaptureParametersToJson(this); -} +}

    diff --git a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita index a0d1c7fec7b..b675d414180 100644 --- a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita +++ b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita @@ -40,21 +40,21 @@ #endif }; export class ScreenCaptureSourceInfo { - + type?: ScreenCaptureSourceType; - + sourceId?: any; - + sourceName?: string; - + thumbImage?: ThumbImageBuffer; - + iconImage?: ThumbImageBuffer; - + processPath?: string; - + sourceTitle?: string; - + primaryMonitor?: boolean; position?: Rectangle; @@ -128,7 +128,7 @@ _$ScreenCaptureSourceInfoFromJson(json); Map<String, dynamic> toJson() => _$ScreenCaptureSourceInfoToJson(this); -} +}

    From 10dc96952657134b4742aceb3e56affd932b2799 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Mon, 11 Sep 2023 10:34:13 +0800 Subject: [PATCH 11/13] New translations --- .../dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita | 2 +- .../RTC-NG/API/api_irtcengine_getscreencapturesources.dita | 4 ++-- .../API/api_irtcengine_registermediametadataobserver.dita | 2 +- .../API/api_irtcengine_startscreencapturebydisplayid.dita | 2 +- .../dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita | 2 +- en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita | 2 +- en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita | 2 +- en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita | 2 +- en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita | 2 +- en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita | 2 +- en-US/dita/RTC-NG/API/enum_bitrate.dita | 2 +- 11 files changed, 12 insertions(+), 12 deletions(-) diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita index 06d219bfbcd..aa786199a30 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita @@ -50,7 +50,7 @@ config - Configuration of video screenshot and upload. Configuration of video content moderation. See . + Configuration of video screenshot and upload. Configuration of video content moderation. See .
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita index 8bcc148b04e..071d30c8813 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita @@ -44,11 +44,11 @@ thumbSize - The target size of the screen or window thumbnail (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and thumbSize is 100 × 100, the actual size of the thumbnail is 100 × 75. If the target size is larger than the original size, the thumbnail is the original image and the SDK does not scale it. + The target size of the screen or window thumbnail (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and thumbSize is 100 × 100, the actual size of the thumbnail is 100 × 75. If the target size is larger than the original size, the thumbnail is the original image and the SDK does not scale it. iconSize - The target size of the icon corresponding to the application program (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and iconSize is 100 × 100, the actual size of the icon is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it. + The target size of the icon corresponding to the application program (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and iconSize is 100 × 100, the actual size of the icon is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it. includeScreen diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita index 597a5977265..a53b73c283c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita @@ -46,7 +46,7 @@ type -

    The metadata type. The SDK currently only supports . See .

    +

    The metadata type. The SDK currently only supports . See .
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita index 233033bfefe..bd0d4d51b7f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita @@ -57,7 +57,7 @@     regionRect - (Optional) Sets the relative location of the region to the screen. Pass in nil to share the entire screen. See . It consists of the following parameters:
      + (Optional) Sets the relative location of the region to the screen. Pass in nil to share the entire screen. See . It consists of the following parameters:
      • x: The horizontal offset from the top-left corner.
      • y: The vertical offset from the top-left corner.
      • width: The width of the region.
        • diff --git a/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita b/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita index 2e01a2f7618..ba4e179a0bd 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita @@ -35,7 +35,7 @@ frame audioFrame - The audio frame information. See . See . + The audio frame information. See . See . playerKit diff --git a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita index c8961b7b32b..93ce8e5c5b7 100644 --- a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita @@ -213,7 +213,7 @@ cameraDirection - This parameter applies to Android and iOS only.The camera direction. See . + This parameter applies to Android and iOS only.The camera direction. See . format diff --git a/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita b/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita index 88df0d8fff4..4418ea7c172 100644 --- a/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita +++ b/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita @@ -373,7 +373,7 @@ streamType - The type of video streams. See . + The type of video streams. See .
        • (0): High-quality stream, that is, a high-resolution and high-bitrate video stream.
          • diff --git a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita index 25dee9d51ac..2fb1212206a 100644 --- a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita +++ b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita @@ -171,7 +171,7 @@ position - The position of a window relative to the entire screen space (including all shareable screens). See . See . + The position of a window relative to the entire screen space (including all shareable screens). See . See . minimizeWindow diff --git a/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita b/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita index 4cc9bbcfb2a..402fa97289d 100644 --- a/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita +++ b/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita @@ -77,7 +77,7 @@ dimensions - The video dimension. See . The default value is 160 × 120. + The video dimension. See . The default value is 160 × 120. bitrate diff --git a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita index 330a2a8a997..18cd6142db9 100644 --- a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita @@ -476,7 +476,7 @@ bitrate -

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

          +

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

            • diff --git a/en-US/dita/RTC-NG/API/enum_bitrate.dita b/en-US/dita/RTC-NG/API/enum_bitrate.dita index a4cab5bf243..5ca1d506826 100644 --- a/en-US/dita/RTC-NG/API/enum_bitrate.dita +++ b/en-US/dita/RTC-NG/API/enum_bitrate.dita @@ -9,7 +9,7 @@ - 0: (Recommended) Standard bitrate mode. In this mode, the bitrates of the live broadcasting profile is higher than that of the communication profile. See . + 0: (Recommended) Standard bitrate mode. In this mode, the bitrates of the live broadcasting profile is higher than that of the communication profile. See . From 8251339c1b2b0da5e42bc6b4e5732f7a3099d172 Mon Sep 17 00:00:00 2001 From: Suri539 Date: Mon, 11 Sep 2023 10:45:17 +0800 Subject: [PATCH 12/13] fix parse error --- dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap index d17b859d737..fded8f14972 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap @@ -3225,7 +3225,7 @@ - + isApplicationMute From 6b6e886a0da9da50d3d61b1f968a6f3f78404310 Mon Sep 17 00:00:00 2001 From: Cilla-luodan Date: Mon, 11 Sep 2023 02:48:21 +0000 Subject: [PATCH 13/13] Sync cn prototype to en prototype --- en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita | 2 +- en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita | 2 +- en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita | 2 +- en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita index a0af4011729..2d78d204040 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita @@ -50,7 +50,7 @@ config - Configuration of video screenshot and upload. Configuration of video content moderation. See . + Configuration of video screenshot and upload. Configuration of video content moderation. See .
            diff --git a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita index 6e020e7f816..87fe88d06c2 100644 --- a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita @@ -213,7 +213,7 @@ cameraDirection - This parameter applies to Android and iOS only.The camera direction. See . + This parameter applies to Android and iOS only.The camera direction. See . format diff --git a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita index cc3cda08141..b675d414180 100644 --- a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita +++ b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita @@ -171,7 +171,7 @@ position - The position of a window relative to the entire screen space (including all shareable screens). See . See . + The position of a window relative to the entire screen space (including all shareable screens). See . See . minimizeWindow diff --git a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita index 2152bff5ad9..664cb776215 100644 --- a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita @@ -478,7 +478,7 @@ bitrate -

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

            +

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