From 50abf060dd6073ab3e8f4ba7fde2619ee3c33efd Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Thu, 23 May 2024 12:20:44 +0800 Subject: [PATCH 01/10] New translations --- en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_switchchannel.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita | 2 +- en-US/dita/RTC-NG/API/enum_qualitytype.dita | 4 ++-- 5 files changed, 6 insertions(+), 6 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 595ca2ccead..dd724968254 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita @@ -74,7 +74,7 @@
  • All lowercase English letters: a to z.
  • All uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
    • -
  • Space
    • +
  • Space
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

    • 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 27dd5608903..f8ce3807f35 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita @@ -71,7 +71,7 @@
  • All lowercase English letters: a to z.
  • All uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
    • -
  • Space
    • +
  • Space
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel.dita index 780889e3a67..494c43aa60e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel.dita @@ -48,7 +48,7 @@
  • All lowercase English letters: a to z.
  • All uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
    • -
  • Space
    • +
  • Space
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

    • 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 627503f720e..f6f97920149 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita @@ -51,7 +51,7 @@
  • All lowercase English letters: a to z.
  • All uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
    • -
  • Space
    • +
  • Space
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

    • diff --git a/en-US/dita/RTC-NG/API/enum_qualitytype.dita b/en-US/dita/RTC-NG/API/enum_qualitytype.dita index 8e1abc6eb49..3a4bfc2cd95 100644 --- a/en-US/dita/RTC-NG/API/enum_qualitytype.dita +++ b/en-US/dita/RTC-NG/API/enum_qualitytype.dita @@ -35,11 +35,11 @@ 6: The network is down and users cannot communicate at all. - + 7: Users cannot detect the network quality (not in use). - + 8: Detecting the network quality. From 2f8788bb2fbaa3778ed87af41d49cf9177b5c73c Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Thu, 23 May 2024 15:21:55 +0800 Subject: [PATCH 02/10] New translations --- .../API/api_irtcengine_leavechannel.dita | 41 ++++++++-------- .../API/api_irtcengine_leavechannel2.dita | 35 ++++++++++---- .../API/api_irtcengine_setclientrole.dita | 25 ++++++---- .../API/api_irtcengine_setclientrole2.dita | 47 ++++++++++++------- .../API/api_irtcengineex_leavechannelex.dita | 40 ++++++++++------ .../API/api_irtcengineex_leavechannelex2.dita | 42 +++++++++++------ ...ngineeventhandler_onclientrolechanged.dita | 19 ++++++-- ...eventhandler_onclientrolechangefailed.dita | 23 +++++++-- ...irtcengineeventhandler_onleavechannel.dita | 21 +++++++-- ...irtcengineeventhandler_onrequesttoken.dita | 6 +-- 10 files changed, 200 insertions(+), 99 deletions(-) diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel.dita index db351fa957c..8f088148056 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel.dita @@ -22,25 +22,28 @@ Future<void> leaveChannel({LeaveChannelOptions? options});

    -
    - Details -

    This method releases all resources related to the session.

    -

    This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel.

    -

    Calling this method does not necessarily mean that the user has left the channel.

    -

    After joining the channel, you must call this method or to end the call, otherwise, the next call cannot be started.

    -

    If you successfully call this method and leave the channel, the following callbacks are triggered:

      -
    • The local client: .
      • -
    • The remote client: , if the user joining the channel is in the Communication profile, or is a host in the Live-broadcasting profile.
      • -

    - -
      -
    • If you call immediately after calling this method, the SDK does not trigger the callback.
      • -
    • If you have called to join multiple channels, calling this method will leave the channels when calling and at the same time.
      • -
    • If you call this method during a Media Push, the SDK automatically calls the method.
      • -
    -
    - Parameters - +
    +

    调用该方法后，SDK 会终止音视频互动、离开当前频道，并会释放会话相关的所有资源。

    +

    After joining the channel, you must call this method to end the call; otherwise, you cannot join the next call.

    + +
    • This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel.
      • +
    • If you have called to join multiple channels, calling this method will leave the channels when calling and at the same time.
     +
    +
    + Call timing +

    +

    +
    + Restrictions +

    +

    + +
    + <ph props="ios mac">Parameters</ph> + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita index 627800c0df9..0f7afdde696 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita @@ -25,14 +25,33 @@ Future<void> leaveChannel({LeaveChannelOptions? options});

    -
    - Details -

    This method will release all resources related to the session, leave the channel, that is, hang up or exit the call. This method can be called whether or not a call is currently in progress.

    -

    After joining the channel, you must call this method or to end the call, otherwise, the next call cannot be started.

    -

    This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After actually leaving the channel, the local user triggers the callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the callback.

    -

    Calling this method does not necessarily mean that the user has left the channel. After actually leaving the channel, the local user triggers the callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the callback.

    -
    -
    +
    +

    调用该方法后，SDK 会终止音视频互动、离开当前频道，并会释放会话相关的所有资源。

    +

    After joining the channel, you must call this method or to end the call, otherwise, the next call cannot be started. If you have called to join multiple channels, calling this method will leave the channels when calling and at the same time.

    +

    After joining the channel, you must call this method to end the call; otherwise, you cannot join the next call. If you have called to join multiple channels, calling this method will leave the channels when calling and at the same time.

    + This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. +
    +
    + Applicable scenarios +

    +

    +
    + Call timing +

    Call this method after joining a channel.

    +
    +
    + Restrictions +

    If you call immediately after calling this method, the SDK does not trigger the callback.

    +
    + +
    Parameters 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 634ef94e76f..82e971e5971 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita @@ -27,18 +27,23 @@ ): number;

    -
    - Details -

    In the interactive live streaming profile, the SDK sets the user role as audience by default. You can call this method to set the user role as host.

    +
    +

    In the interactive live streaming profile, the SDK sets the user role as audience by default. You can call this method to set the user role as host. 用户角色（role）确定用户在 SDK 层的权限，包含是否可以发送流等。

    +
    +
    + Call timing

    You can call this method either before or after joining a channel.

    -

    -

    If you call this method to switch the user role after joining a channel, the SDK automatically does the following:

      -
    • Calls and to change the publishing state.
      • -
    • Triggers on the local client.
      • -
    • Triggers or on the remote client.
      • -

    +

    +

    +

    +

    +
    + Restrictions +

    在频道外调用本方法并将用户角色设为 BROADCASTER（主播）时，本地不会触发 回调。

    +
    + -
    +
    Parameters 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 d108f97d63d..5f11dc8312f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita @@ -2,7 +2,7 @@ <ph keyref="setClientRole2" /> - Sets the user role and level in an interactive live streaming channel. + 设置直播场景下的用户角色和观众端延时级别。 @@ -31,31 +31,42 @@ {required ClientRoleType role, ClientRoleOptions? options});

    -
    - Details -

    In the interactive live streaming profile, the SDK sets the user role as audience by default. You can call this method to set the user role as host.

    +
    +

    In the interactive live streaming profile, the SDK sets the user role as audience by default. You can call this method to set the user role as host. 用户角色（role）确定用户在 SDK 层的权限，包含是否有发流权限等。

    +

    该方法与 的区别在于，该方法还支持设置观众端延时级别（audienceLatencyLevel）。 audienceLatencyLevel 需与 role 结合使用，确定用户在其权限范围内可以享受到的服务。 For example, an audience member can choose to receive remote streams with low latency or ultra-low latency. 不同的延时级别会影响计费，详见 。

    +
    +
    + Call timing

    You can call this method either before or after joining a channel.

    -

    If you call this method to set the user's role as the host before joining the channel and set the local video property through the method, the local video preview is automatically enabled when the user joins the channel.

    -

    If you call this method to switch the user role after joining a channel, the SDK automatically does the following:

      -
    • Calls and to change the publishing state.
      • -
    • Triggers on the local client.
      • -
    • Triggers or on the remote client.
      • -

    -

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

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

    - This method applies to the interactive live streaming profile (the profile parameter of is set as ) only.
    -
    +

    If you call this method to set the user's role as the host before joining the channel and set the local video property through the method, the local video preview is automatically enabled when the user joins the channel.

    +

    If you call this method to set the user's role as the host before joining the channel and set the local video property through the method, the local video preview is automatically enabled when the user joins the channel.

    +

    如果你在加入频道后调用该方法切换用户角色，调用成功后，SDK 会自动调用 和 修改发布音视频流的状态。

    +
    +
    + Restrictions +

    当用户角色设为主播时，观众端延时级别仅支持设置为 （超低延时）。

    +

    在加入频道前调用该方法并将 role 设为 BROADCASTER（主播）时，本地不会触发 回调。

    +
    + +
    Parameters role clientRoleType - The user role in the interactive live streaming. See .
      + The user role. See .
      • (1): Host. A host can both send and receive streams.
      • (2): (Default) Audience. An audience member can only receive streams.
        • -
      +
    + If you set the user role as an audience member, you cannot publish audio and video streams in the channel. If you want to publish media streams in a channel during live streaming, ensure you set the user role as broadcaster. +     options diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex.dita index e5b8860e02b..5cdab7ed7f8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex.dita @@ -26,20 +26,32 @@

    -
    - Details -

    This method lets the user leave the channel, for example, by hanging up or exiting the call.

    -

    After calling to join the channel, this method must be called to end the call before starting the next call.

    -

    This method can be called whether or not a call is currently in progress. This method releases all resources related to the session.

    -

    This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the callback.

    -

    Calling this method does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the callback.

    -

    After actually leaving the channel, the local user triggers the callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the callback.

    - -
      -
    • If you call immediately after calling this method, the SDK does not trigger the callback.
      • -
    • If you want to leave the channels that you joined by calling and , call the method.
      • -
    -
    +
    +

    调用该方法后，SDK 会终止音视频互动、离开当前频道，并会释放会话相关的所有资源。

    +

    After joining the channel, you must call this method or to end the call, otherwise, the next call cannot be started.

    + +
      +
    • This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel.
      • +
    • 如果你调用了 或 后，会同时离开 或 及 加入的频道。
      • +
    +
    +
    + Applicable scenarios +

    该方法适用于多频道场景。

    +
    +
    + Call timing +

    Call this method after .

    +
    +
    + Restrictions +

    +

    + +
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita index b2d2a6d9cc8..68e46b2c83c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita @@ -33,20 +33,34 @@ {required RtcConnection connection, LeaveChannelOptions? options});

    -
    - Details -

    This method lets the user leave the channel, for example, by hanging up or exiting the call.

    -

    After calling to join the channel, this method must be called to end the call before starting the next call.

    -

    This method can be called whether or not a call is currently in progress. This method releases all resources related to the session.

    -

    This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the callback.

    -

    Calling this method does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the callback.

    -

    After actually leaving the channel, the local user triggers the callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the callback.

    - -
      -
    • If you call immediately after calling this method, the SDK does not trigger the callback.
      • -
    • If you want to leave the channels that you joined by calling and , call the method.
      • -
    -
    +
    +

    调用该方法后，SDK 会终止音视频互动、离开当前频道，并会释放会话相关的所有资源。

    +

    After joining the channel, you must call this method or to end the call, otherwise, the next call cannot be started.

    +

    After joining the channel, you must call this method to end the call; otherwise, you cannot join the next call.

    + +
      +
    • This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel.
      • +
    • 如果你调用了 或 后，会同时离开 或 及 加入的频道。
      • +
    • 如果你调用了 后，会同时离开 及 加入的频道。
      • +
    +
    +
    + Applicable scenarios +

    +

    +
    + Call timing +

    Call this method after .

    +
    +
    + Restrictions +

    +

    + +
    Parameters 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 fbe084f2fe5..40e95fdc36a 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita @@ -2,7 +2,7 @@ <ph keyref="onClientRoleChanged"/> - Occurs when the user role switches during the interactive live streaming. + 用户角色、观众端延时级别已切换回调。

    @@ -37,10 +37,21 @@ NS_SWIFT_NAME(rtcEngine(_:didClientRoleChanged:newRole:newRoleOptions:));

    -
    -

    The SDK triggers this callback when the local user switches their user role by calling after joining the channel.

    +
    + Applicable scenarios +

    -
    +
    + Trigger timing +

    在以下任意一种情况时，会触发此回调：

      +
    • 在加入频道后调用 或 设置用户角色或观众端延时级别。
      • +
    • 在加入频道前调用 或 并将用户角色设为 AUDIENCE。

    +
    +
    + Restrictions +

    当你在加入频道前调用 或 并将用户角色设为 BROADCASTER 时，不会触发此回调。

    +
    +
    <ph keyref="callback-section-title"/> 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 b3708b56fb7..583573af720 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita @@ -2,7 +2,7 @@ <ph keyref="onClientRoleChangeFailed" /> - Occurs when the user role switching fails in the interactive live streaming. + 用户角色切换失败回调。 @@ -37,16 +37,29 @@ ClientRoleType currentRole)? onClientRoleChangeFailed;

    -
    -

    In the live broadcasting channel profile, when the local user calls to switch the user role after joining the channel but the switch fails, the SDK triggers this callback to report the reason for the failure and the current user role.

    +
    +

    当用户角色切换失败时，你可以通过此回调得知切换失败的原因和当前的用户角色。

    -
    +
    + Applicable scenarios +

    +

    +
    + Trigger timing +

    本地用户加入频道后调用 或 设置用户角色失败时，SDK 会触发该回调。

    +

    本地用户加入频道后调用 设置用户角色失败时，SDK 会触发该回调。

    +
    +
    + Restrictions +

    None.

    +
    +
    <ph keyref="callback-section-title" /> reason The reason for a user role switch failure. See . - The possible reasons for the switch failure include the following:
      + The reason for a user role switch failure.
      • (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.
      • (3): The request is timed out. Agora recommends you prompt the user to check the network connection and try to switch their user role again.
        • 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 34230006a5c..9a578e72d39 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita @@ -26,10 +26,23 @@ final void Function(RtcConnection connection, RtcStats stats)? onLeaveChannel;

    -
    -

    This callback notifies the app that the user leaves the channel by calling . From this callback, the app can get information such as the call duration and statistics.

    +
    +

    你可以通过该回调获取此次通话的总通话时长、SDK 收发数据的流量等信息。

    -
    +
    + Applicable scenarios +

    +

    +
    + Trigger timing +

    当你成功调用 、、 或 离开频道后，SDK 会触发该回调。

    +

    当你成功调用 或 离开频道后，SDK 会触发该回调。

    +
    +
    + Restrictions +

    None.

    +
    +
    <ph keyref="callback-section-title" /> @@ -42,7 +55,7 @@ stats - The statistics of the call. See . + 通话的统计数据，详见 。
    diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrequesttoken.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrequesttoken.dita index 2f0b965e61f..82913bf4f5a 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrequesttoken.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrequesttoken.dita @@ -37,9 +37,9 @@ Restrictions

    None.

    -
    - <ph keyref="callback-section-title" /> - +
    + <ph keyref="callback-section-title" props="apple unity electron rn flutter cs"/> + From 6eba0674f3119da97882df7e38461b710dd06f75 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Thu, 23 May 2024 16:22:22 +0800 Subject: [PATCH 03/10] New translations --- .../RTC-NG/API/api_irtcengine_startscreencapture2.dita | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) 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 14c4d981604..d1766bd0c3b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita @@ -46,8 +46,12 @@
  • //: Only supports capturing a single screen or window, suitable for scenarios where only a single screen is shared.
  • : Supports specifying multiple video sources to capture multiple screen sharing streams, used for local video mixing or multi-channel scenarios.

    • -
    - + <section id="timing" deliveryTarget="details"> + <title>Call timing +

    You can call this method either before or after joining the channel, with the following differences:

      +
    • 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 to join channel and set publishScreenCaptureVideo to to start screen sharing.
      • +

    Restrictions From adb299aaee637541469ffbbf7f5fcc5f8be16663 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Tue, 28 May 2024 17:53:51 +0800 Subject: [PATCH 04/10] New translations --- .../API/api_irtcengine_querycamerafocallengthcapability.dita | 1 - .../API/api_irtcengine_setremotesubscribefallbackoption.dita | 3 +-- en-US/dita/RTC-NG/API/class_focallengthinfo.dita | 4 ++-- 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_querycamerafocallengthcapability.dita b/en-US/dita/RTC-NG/API/api_irtcengine_querycamerafocallengthcapability.dita index c3cbcc7b369..0cd4cd612f6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_querycamerafocallengthcapability.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_querycamerafocallengthcapability.dita @@ -35,7 +35,6 @@

    If you want to enable the wide-angle or ultra-wide-angle mode for camera capture, it is recommended to start by calling this method to check whether the device supports the required focal length capability. Then, adjust the camera's focal length configuration based on the query result by calling , ensuring the best camera capture performance.

    - For the specific implementation of querying camera focal length capabilities through this method, refer to the provided . This method is for Android and iOS only.
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremotesubscribefallbackoption.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremotesubscribefallbackoption.dita index 2ceaa77651d..4506c73bd88 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotesubscribefallbackoption.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotesubscribefallbackoption.dita @@ -29,8 +29,7 @@
    Details

    An unstable network affects the audio and video quality in a video call or interactive live video streaming. If option is set as or , the SDK automatically switches the video from a high-quality stream to a low-quality stream or disables the video when the downlink network conditions cannot support both audio and video to guarantee the quality of the audio. Meanwhile, the SDK continuously monitors network quality and resumes subscribing to audio and video streams when the network quality improves.

    -

    When the subscribed video stream falls back to an audio-only stream, or recovers from an audio-only stream to an audio-video stream, the SDK triggers the callback.

    - Ensure that you call this method before joining a channel.
    +

    When the subscribed video stream falls back to an audio-only stream, or recovers from an audio-only stream to an audio-video stream, the SDK triggers the callback.

    Parameters diff --git a/en-US/dita/RTC-NG/API/class_focallengthinfo.dita b/en-US/dita/RTC-NG/API/class_focallengthinfo.dita index a0295f82610..f54ed22edf2 100644 --- a/en-US/dita/RTC-NG/API/class_focallengthinfo.dita +++ b/en-US/dita/RTC-NG/API/class_focallengthinfo.dita @@ -8,9 +8,9 @@

    public class AgoraFocalLengthInfo { - int cameraDirection; + public int cameraDirection; - int focalLengthType; + public int focalLengthType; @CalledByNative public AgoraFocalLengthInfo(int cameraDirection, int focalLengthType) { From ef71a4e9b07b61f1446a8c7caa39573cac68f7d5 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Fri, 14 Jun 2024 10:31:12 +0800 Subject: [PATCH 05/10] New translations --- ...i_imediaengine_createcustomaudiotrack.dita | 4 +- ...api_irtcengine_createcustomvideotrack.dita | 4 +- .../API/api_irtcengine_createdatastream.dita | 34 +++++------ .../API/api_irtcengine_createdatastream2.dita | 28 ++++++---- .../api_irtcengine_enableinearmonitoring.dita | 44 ++++++--------- ...api_irtcengine_enableinearmonitoring2.dita | 33 ++++++----- .../api_irtcengine_getconnectionstate.dita | 20 ++++--- .../API/api_irtcengine_getuserinfobyuid.dita | 25 ++++++--- ...i_irtcengine_getuserinfobyuseraccount.dita | 19 +++++-- .../RTC-NG/API/api_irtcengine_initialize.dita | 25 +++++---- ..._irtcengine_iscameraexposuresupported.dita | 2 +- ..._irtcengine_muteallremotevideostreams.dita | 4 +- .../api_irtcengine_muterecordingsignal.dita | 26 ++++++--- ...i_irtcengine_registerlocaluseraccount.dita | 38 ++++++++----- .../API/api_irtcengine_setchannelprofile.dita | 28 ++++++---- ...e_setdefaultmuteallremoteaudiostreams.dita | 2 +- ...e_setdefaultmuteallremotevideostreams.dita | 14 ++--- .../API/api_irtcengine_startaudiomixing.dita | 1 + ...cengine_startscreencapturebydisplayid.dita | 3 +- .../API/api_irtcengine_stopscreencapture.dita | 3 +- ...cengine_updatescreencaptureparameters.dita | 3 +- .../api_irtcengineex_createdatastreamex.dita | 56 ++++++------------- .../api_irtcengineex_createdatastreamex2.dita | 34 +++++------ ...api_irtcengineex_getconnectionstateex.dita | 20 +++---- .../API/api_irtcengineex_joinchannelex.dita | 2 +- ...spectrumobserver_onlocalaudiospectrum.dita | 2 +- ...eeventhandler_onfirstremotevideoframe.dita | 3 + ...tcengineeventhandler_onnetworkquality.dita | 1 + ...rameobserver_getvideoformatpreference.dita | 19 ++++--- .../callback_ivideoframeobserver_onframe.dita | 6 +- .../RTC-NG/API/class_channelmediaoptions.dita | 2 - .../API/class_screencaptureparameters.dita | 3 +- en-US/dita/RTC-NG/API/class_videocanvas.dita | 10 ++-- .../API/class_videoencoderconfiguration.dita | 2 +- 34 files changed, 276 insertions(+), 244 deletions(-) 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 8d2192a304c..c228498ef51 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita @@ -62,7 +62,7 @@ Returns

    • If the method call is successful, the audio track ID is returned as the unique identifier of the audio track.
      • -
    • If the method call fails, a negative value is returned.
      • +
    • 方法调用失败，返回 0xffffffff。 See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_createcustomvideotrack.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createcustomvideotrack.dita index 504d7da4b48..0dfd4787013 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createcustomvideotrack.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createcustomvideotrack.dita @@ -36,7 +36,7 @@ Returns
    • If the method call is successful, the video track ID is returned as the unique identifier of the video track.
      • -
    • If the method call fails, a negative value is returned. See for details and resolution suggestions.
      • +
    • 方法调用失败，返回 0xffffffff。 See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream.dita index c763e575e00..d0e6831d0cc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream.dita @@ -18,40 +18,42 @@ reliable:(BOOL)reliable ordered:(BOOL)ordered; virtual int createDataStream(int* streamId, bool reliable, bool ordered) = 0; - abstract createDataStream(config: DataStreamConfig): number; + public abstract int CreateDataStream(ref int streamId, bool reliable, bool ordered); - Future<int> createDataStream(DataStreamConfig config); +

    -
    - Details -

    Each user can create up to five data streams during the lifecycle of . The data stream will be destroyed when leaving the channel, and the data stream needs to be recreated if needed.

    - -
      -
    • Call this method after joining a channel.
      • -
    • Agora does not support setting reliable as and ordered as .
      • -
    -
    +
    +

    You can call this method to create a data stream and improve the reliability and ordering of data transmission.

    +
    +
    +
    + +
    Parameters - + - + reliable -

    Whether or not the data stream is reliable:

      -
    • : The recipients receive the data from the sender within five seconds. If the recipient does not receive the data within five seconds, the SDK triggers the callback and returns an error code.
      • +

      Sets whether the recipients are guaranteed to receive the data stream from the sender within five seconds:

        +
      • : The recipients receive the data from the sender within five seconds. If the recipient does not receive the data within five seconds, the SDK triggers the callback and returns an error code.
      • : There is no guarantee that the recipients receive the data stream within five seconds and no error message is reported for any delay or missing data stream.

      + 请确保将 reliable 和 ordered 同时设为 或同时设为 。 ordered -

      Whether or not the recipients receive the data stream in the sent order:

        +

        Sets whether the recipients receive the data stream in the sent order:

        • : The recipients receive the data in the sent order.
        • : The recipients do not receive the data in the sent order.

        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 921b71ce9f7..c05b5f930cc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita @@ -17,20 +17,26 @@ - (int)createDataStream:(NSInteger * _Nonnull)streamId config:(AgoraDataStreamConfig * _Nonnull)config; virtual int createDataStream(int* streamId, DataStreamConfig& config) = 0; - UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") - int CreateDataStream(int& streamId, const FDataStreamConfig& config); + UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") + int CreateDataStream(int& streamId, const FDataStreamConfig& config); abstract createDataStream(config: DataStreamConfig): number; public abstract int CreateDataStream(ref int streamId, DataStreamConfig config); abstract createDataStream(config: DataStreamConfig): number; Future<int> createDataStream(DataStreamConfig config);

    -
    - Details -

    Creates a data stream. Each user can create up to five data streams in a single channel.

    -

    Compared with , this method does not support data reliability. If a data packet is not received five seconds after it was sent, the SDK directly discards the data.

    +
    +

    相比 ，本方法不保证数据传输的可靠性。 If a data packet is not received five seconds after it was sent, the SDK directly discards the data.

    -
    +
    + Call timing +

    Call this method after joining a channel.

    +
    +
    + Restrictions +

    Each user can create up to five data streams during the lifecycle of . The data stream will be destroyed when leaving the channel, and the data stream needs to be recreated if needed.

    +
    +
    Parameters @@ -43,11 +49,11 @@
    - Returns + <ph keyref="return-section-title"/>
    • 0: The data stream is successfully created.
    • ID of the created data stream, if the method call succeeds.
    • < 0: Failure. See for details and resolution suggestions.
      • -
    - - +
    + + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring.dita index eb272222e0a..1a1bc25aea6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring.dita @@ -17,43 +17,35 @@ - (int)enableInEarMonitoring:(BOOL)enabled; - public abstract int EnableInEarMonitoring(bool enabled); +

    -
    - Details -
    +
    +
    Since
    v4.0.1
    -

    This method enables or disables in-ear monitoring.

    - -
      -
    • This method is for Android and iOS only.
      • -
    • Users must use earphones (wired or Bluetooth) to hear the in-ear monitoring effect.
      • -
    • You can call this method either before or after joining a channel.
      • -
    -
    +

    +

    +
    +
    +
    Parameters - - enabled - Enables in-ear monitoring.
      -
    • : Enables in-ear monitoring.
      • -
    • : (Default) Disables in-ear monitoring.
      • -
    + + +
    -
    - Returns +
    + <ph keyref="return-section-title"/>
      -
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • - 8: Make sure the current audio routing is Bluetooth or headset.
      -
      • -
    - - +
  • 0: Success.
    • +
  • < 0: Failure. See for details and resolution suggestions.
    • - 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_enableinearmonitoring2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita index 465721187a8..3835d251bdb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita @@ -16,8 +16,8 @@ public abstract int enableInEarMonitoring(boolean enabled, int includeAudioFilters); - (int)enableInEarMonitoring:(BOOL)enabled includeAudioFilters:(AgoraEarMonitoringFilterType)includeAudioFilters; virtual int enableInEarMonitoring(bool enabled, int includeAudioFilters) = 0; - UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") - int EnableInEarMonitoring(bool enabled, int includeAudioFilters); + UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") + int EnableInEarMonitoring(bool enabled, int includeAudioFilters); abstract enableInEarMonitoring( enabled: boolean, includeAudioFilters: EarMonitoringFilterType @@ -32,18 +32,21 @@ required EarMonitoringFilterType includeAudioFilters});

    -
    - Details -

    This method enables or disables in-ear monitoring.

    - -
      -
    • Users must use earphones (wired or Bluetooth) to hear the in-ear monitoring effect.
      • -
    • You can call this method either before or after joining a channel.
      • -
    +
    +

    This method enables or disables in-ear monitoring.

    +
    +
    + Call timing +

    It can be called either before or after joining the channel.

    +
    +
    + Restrictions +

    Users must use earphones (wired or Bluetooth) to hear the in-ear monitoring effect.

    +
    Parameters - + enabled Enables or disables in-ear monitoring.
    • : Enables in-ear monitoring.
      • @@ -66,10 +69,10 @@
      <ph keyref="return-section-title"/>

      When the method call succeeds, there is no return value; when fails, the exception is thrown. You need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      -
        -
      • 0: Success.
        • +
          +
        • 0: Success.
        • < 0: Failure. See for details and resolution suggestions.
          • - 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_getconnectionstate.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getconnectionstate.dita index 01dec0a5777..2b1fdadcbb3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getconnectionstate.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getconnectionstate.dita @@ -16,21 +16,25 @@ public abstract RtcConnection.CONNECTION_STATE_TYPE getConnectionState(); - (AgoraConnectionState)getConnectionState; virtual CONNECTION_STATE_TYPE getConnectionState() = 0; - UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") - ECONNECTION_STATE_TYPE GetConnectionState(); + UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") + ECONNECTION_STATE_TYPE GetConnectionState(); abstract getConnectionState(): ConnectionStateType; public abstract CONNECTION_STATE_TYPE GetConnectionState(); abstract getConnectionState(): ConnectionStateType; Future<ConnectionStateType> getConnectionState();

    -
    - Details -

    You can call this method either before or after joining a channel.

    +
    + Call timing +

    It can be called either before or after joining the channel.

    +
    +
    + Restrictions +

    None.

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

    -

    - +
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getuserinfobyuid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getuserinfobyuid.dita index 9fa78b7c7ee..aaab8711463 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getuserinfobyuid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getuserinfobyuid.dita @@ -24,11 +24,22 @@ Future<UserInfo> getUserInfoByUid(int uid);

    -
    - Details -

    After a remote user joins the channel, the SDK gets the user ID and account of the remote user, caches them in a mapping table object, and triggers the callback on the local client. After receiving the callback, you can call this method to get the user account of the remote user from the object by passing in the user ID.

    +
    +

    After a remote user joins the channel, the SDK gets the UID and user account of the remote user, caches them in a mapping table object, and triggers the callback on the local client. After receiving the callback, you can call this method to get the user account of the remote user from the object by passing in the user ID.

    -
    +
    + Call timing +

    Calling this method after receiving the callback.

    +
    +
    + Restrictions +

    None.

    +
    + +
    Parameters @@ -38,9 +49,9 @@ userInfo Input and output parameter. The object that identifies the user information.
      -
    • Input: A object.
      • -
    • Output: A object that contains the user account and user ID of the user.
      • -
    +
  • Input value: A object.
    • +
  • Output: A object that contains the user account and user ID of the user.
    • +     diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getuserinfobyuseraccount.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getuserinfobyuseraccount.dita index 60b5b5efe2b..18f9197749e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getuserinfobyuseraccount.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getuserinfobyuseraccount.dita @@ -24,11 +24,22 @@ Future<UserInfo> getUserInfoByUserAccount(String userAccount);

    -
    - Details -

    +

    +

    After a remote user joins the channel, the SDK gets the UID and user account of the remote user, caches them in a mapping table object, and triggers the callback on the local client. After receiving the callback, you can call this method and pass in the user account to get the UID of the remote user from the object.

    -
    +
    + Call timing +

    Calling this method after receiving the callback.

    +
    +
    + Restrictions +

    None.

    +
    + +
    Parameters 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 9d9400d9388..3129bf0ea9b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita @@ -26,17 +26,20 @@ 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.

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

    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.

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

    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.

    +
    +
    + Restrictions +

    The SDK supports creating only one instance for an app.

    +
    +
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita b/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita index 94a86c6ebbd..3fcfe0fbafc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita @@ -33,7 +33,7 @@
    • This method is for Android and iOS only.
      • -
    • This method must be called after the camera is successfully enabled, that is, after the SDK triggers the callback and returns the local video state as (1).
      • +
    • This method must be called after the SDK triggers the callback and returns the local video state as (2).
    • Before calling , Agora recoomends that you call this method to query whether the current camera supports adjusting the exposure value.
    • By calling this method, you adjust the exposure value of the currently active camera, that is, the camera specified when calling .
     diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita index dd5dc675a67..152b9126ec0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita @@ -25,7 +25,7 @@

    -

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

    +

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

    By default, the SDK subscribes to the video streams of all remote users when joining a channel. To modify this behavior, you can set autoSubscribeVideo to when calling to join the channel, which will cancel the subscription to the video streams of all users upon joining the channel.

     @@ -47,7 +47,7 @@

    Whether to stop subscribing to the video streams of all remote users.

    • : Stop subscribing to the video streams of all remote users.
      • -
    • : (Default) Subscribe to the audio streams of all remote users by default.
      • +
    • : (Default) Subscribe to the video streams of all remote users by default.

     diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_muterecordingsignal.dita b/en-US/dita/RTC-NG/API/api_irtcengine_muterecordingsignal.dita index cb661241184..823102f8721 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muterecordingsignal.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muterecordingsignal.dita @@ -16,26 +16,38 @@ public abstract int muteRecordingSignal(boolean muted); -(int)muteRecordingSignal:(BOOL)muted; virtual int muteRecordingSignal(bool mute) = 0; - UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") - int MuteRecordingSignal(bool mute); + UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") + int MuteRecordingSignal(bool mute); abstract muteRecordingSignal(mute: boolean): number; public abstract int MuteRecordingSignal(bool mute); abstract muteRecordingSignal(mute: boolean): number; Future<void> muteRecordingSignal(bool mute);

    -
    +
    +

    如果你已经调用 调节了音频采集信号音量，则调用该方法并设置为 时，SDK 的行为如下：

      +
    1. 记录调节后的音量。
      2. +
    2. 将音频采集信号静音。
    当你再次调用该方法并设置为 时，录音信号会恢复为静音前 SDK 记录的音量。

    +
    +
    + Call timing +

    It can be called either before or after joining the channel.

    +
    +
    + Restrictions +

    None.

    +
    +
    Parameters - muted - mute + muted + mute
    • : The media file is muted.
    • : (Default) Do not mute the recording signal.
    - If you have already called to adjust the volume, then when you call this method and set it to , the SDK will record the current volume and mute it. To restore the previous volume, call this method again and set it to .
    @@ -46,5 +58,5 @@
  • 0: Success.
  • < 0: Failure. See for details and resolution suggestions.
    • - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita index 8acf08e4f93..1e1bc8bd0db 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita @@ -25,22 +25,32 @@ {required String appId, required String userAccount});

    -
    - Details +

    Once registered, the user account can be used to identify the local user when the user joins the channel. After the registration is successful, the user account can identify the identity of the local user, and the user can use it to join the channel.

    -

    After the user successfully registers a user account, the SDK triggers the callback on the local client, reporting the user ID and account of the local user.

    -

    This method is optional. To join a channel with a user account, you can choose either of the following ways:

      -
    • Call to create a user account, and then call to join the channel.
      • +

      This method is optional. 如果你希望用户使用 User Account 加入频道，可参考下列任意一种方式实现：

        +
      • 先调用 方法注册 Account，再调用 方法加入频道，可以缩短进入频道的时间。
      • Call the method to join the channel.
        • -

      -

      The difference between the two ways is that the time elapsed between calling the method and joining the channel is shorter than directly calling .

      +
    +
      +
    • 先调用 方法注册 Account，再调用 或 方法加入频道，可以缩短进入频道的时间。
      • +
    • Call the method to join the channel.
      • +
    +

    -
      -
    • Ensure that you set the userAccount parameter; otherwise, this method does not take effect.
      • -
    • Ensure that the userAccount is unique in the channel.
      • -
    • To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the ID of the user is set to the same parameter type.
      • -
    -
    +
      +
    • Ensure that the userAccount is unique in the channel.
      • +
    • To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the ID of the user is set to the same parameter type.
      • +
    +
    +
    + Restrictions +

    None.

    +
    + +
    Parameters @@ -69,4 +79,4 @@
  • < 0: Failure. See for details and resolution suggestions.
    • - \ 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 158e10e567c..81441b0a6ab 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita @@ -24,17 +24,21 @@ Future<void> setChannelProfile(ChannelProfileType profile);

    -
    - Details -

    After initializing the SDK, the default channel profile is the live streaming profile. You can call this method to set the channel profile. The Agora SDK differentiates channel profiles and applies optimization algorithms accordingly. For example, it prioritizes smoothness and low latency for a video call and prioritizes video quality for interactive live video streaming.

    - -
      -
    • To ensure the quality of real-time communication, Agora recommends that all users in a channel use the same channel profile.
      • -
    • This method must be called and set before , and cannot be set again after joining the channel.
      • -
    • The default audio route and video encoding bitrate are different in different channel profiles. See and .
      • -
    • The default video encoding bitrate are different in different channel profiles. See .
      • -
    -
    +
    +

    You can call this method to set the channel profile. SDK 会针对不同的使用场景采用不同的优化策略，如直播场景优先保证画质。 After initializing the SDK, the default channel profile is the live streaming profile.

    + +

    The default video encoding bitrate are different in different channel profiles. See .

    +     +
    +
    + Call timing +

    Ensure that you call this method before joining a channel.

    +
    +
    + Restrictions +

    To ensure the quality of real-time communication, Agora recommends that all users in a channel use the same channel profile.

    +
    +
    Parameters @@ -64,7 +68,7 @@ <ph keyref="return-section-title"/>

    When the method call succeeds, there is no return value; when fails, the exception is thrown. You need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      -
    • 0(ERR_OK): Success.
      • +
    • 0: Success.
    • < 0: Failure. See for details and resolution suggestions.
      • -2: The parameter is invalid.
      • -7: The SDK is not initialized.
        • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremoteaudiostreams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremoteaudiostreams.dita index c303fb75e31..9ca58bb49c9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremoteaudiostreams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremoteaudiostreams.dita @@ -30,7 +30,7 @@
        This method is deprecated, use instead.
    -

    Call this method after joining a channel. After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all subsequent users.

    +

    Call this method after joining a channel. After successfully calling this method, the local user stops or resumes subscribing of all subsequent users.

    If you need to resume subscribing to the audio streams of remote users in the channel after calling this method, do the following:

    • To resume subscribing to the audio stream of a specified user, call (), and specify the user ID.
      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremotevideostreams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremotevideostreams.dita index de8fbe13906..dcd24095023 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremotevideostreams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremotevideostreams.dita @@ -24,11 +24,11 @@
    Details -

    Call this method after joining a channel. After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all subsequent users.

    +

    Call this method after joining a channel. After successfully calling this method, the local user stops or resumes subscribing of all subsequent users.

    -

    If you need to resume subscribing to the audio streams of remote users in the channel after calling this method, do the following:

      -
    • To resume subscribing to the audio stream of a specified user, call (), and specify the user ID.
      • -
    • To resume subscribing to the audio streams of multiple remote users, call () multiple times.
      • +

      If you need to resume subscribing to the video streams of remote users in the channel after calling this method, do the following:

        +
      • To resume subscribing to the video stream of a specified user, call (), and specify the user ID.
        • +
      • To resume subscribing to the video streams of multiple remote users, call () multiple times.

    @@ -38,9 +38,9 @@ muted mute -

    Whether to stop subscribing to the audio streams of all remote users by default.

      -
    • : Stop subscribing to the audio streams of all remote users by default.
      • -
    • : (Default) Resume subscribing to the audio streams of all remote users by default.
      • +

      Whether to stop subscribing to the video streams of all remote users by default.

        +
      • : Stop subscribing to the video streams of all remote users by default.
        • +
      • : (Default) Resume subscribing to the video streams of all remote users by default.

      diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita index a4758c10ac6..d1612215ebe 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita @@ -42,6 +42,7 @@

      This method mixes the specified local or online audio file with the audio from the microphone, or replaces the microphone's audio with the specified local or remote audio file. A successful method call triggers the () callback. When the audio mixing file playback finishes, the SDK triggers the () callback on the local client.

      +

      This method supports playing URI files starting with content://.

      • You can call this method either before or after joining a channel. If you need to call multiple times, ensure that the time interval between calling this method is more than 500 ms.
        • 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 439a2160bc4..b581fd459f8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita @@ -79,7 +79,8 @@ 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. See .The video properties of the screen sharing stream only need to be set through this parameter, and are unrelated to . +
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita index bd3753eabda..580c69825cd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita @@ -31,7 +31,8 @@
    Applicable scenarios -

    If you start screen capture by calling , , or , you need to call this method to stop screen capture.

    +

    If you start screen capture by calling , , or , you need to call this method to stop screen capture.

    +

    If you start screen capture by calling , , or , you need to call this method to stop screen capture.

    If you start screen capture by calling , you need to call this method to stop screen capture.

    If you start screen capture by calling or , you need to call this method to stop screen capture.

    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 ebdee033f25..ab04842646b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita @@ -44,7 +44,8 @@ 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. See .The video properties of the screen sharing stream only need to be set through this parameter, and are unrelated to . +
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex.dita index f6268503186..409b86cd1d4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex.dita @@ -20,65 +20,43 @@ ordered:(BOOL)ordered connection:(AgoraRtcConnection * _Nonnull)connection NS_SWIFT_NAME(createDataStreamEx(_:reliable:ordered:connection:)); virtual int createDataStreamEx(int* streamId, bool reliable, bool ordered, const RtcConnection& connection) = 0; - abstract createDataStreamEx( - config: DataStreamConfig, - connection: RtcConnection - ): number; + public abstract int CreateDataStreamEx(ref int streamId, bool reliable, bool ordered, RtcConnection connection);

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

    You can call this method to create a data stream and improve the reliability and ordering of data transmission.

    - -
      -
    • Ensure that you set the same value for reliable and ordered.
      • -
    • Each user can create up to five data streams during the lifecycle of .
      • -
    • The data channel allows a data delay of up to 5 seconds. If the receiver does not receive the data stream within 5 seconds, the data channel reports an error.
      • -
    -
    +

    +

    +
    +
    +