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..af3bbd5a7df 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita @@ -42,7 +42,7 @@ Ensure that you call this method before joining a channel.

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

  1. Call this method to create a custom audio track and get the audio track ID.
    2. -
  2. Call to join the channel. In , set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
    3. +
  3. Call to join the channel. In , set publishCustomAudioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
  4. Call and specify trackId as the audio track ID set in step 2. You can then publish the corresponding custom audio source in the channel.

@@ -62,7 +62,7 @@ Returns - + \ 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 629adcbd387..7f493e53111 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 @@

Before calling this method to push external audio data, perform the following steps:

  1. Call to create a custom audio track and get the audio track ID.
    2. -
  2. Call to join the channel. In , set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
    3. +
  3. Call to join the channel. In , set publishCustomAudioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_getmute.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getmute.dita index bcbac604362..aa3a4fdfec0 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getmute.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_getmute.dita @@ -32,7 +32,7 @@ muted An output parameter. Whether the media file is muted:
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_adjustplaybacksignalvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_adjustplaybacksignalvolume.dita index 37f651b128b..0ab5ed1a010 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustplaybacksignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustplaybacksignalvolume.dita @@ -29,7 +29,7 @@
Call timing -

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

+

This method can be called either before or after joining the channel.

Restrictions diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita index 20313d0c685..2c070dc9fc3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita @@ -29,7 +29,7 @@
Call timing -

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

+

This method can be called either before or after joining the channel.

Restrictions 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..9e3966dd69a 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
- + \ 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 e6d8b33f337..8bf3b21bcb9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream.dita @@ -24,34 +24,36 @@

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

    + Please ensure that reliable and ordered are either both set to or both set to . 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 753c91c228e..95388169a1c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita @@ -25,12 +25,18 @@ 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.

+
+

Compared to , this method does not guarantee the reliability of data transmission. 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_disableaudio.dita b/en-US/dita/RTC-NG/API/api_irtcengine_disableaudio.dita index 066a19eb300..f7b0d6af8f3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_disableaudio.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_disableaudio.dita @@ -29,7 +29,7 @@
Call timing -

It can be called either before or after joining the channel. It is still valid after one leaves channel.

+

This method can be called either before or after joining the channel. It is still valid after one leaves channel.

Restrictions diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableaudio.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableaudio.dita index 91c2c896bef..748a3f01984 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableaudio.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableaudio.dita @@ -29,7 +29,7 @@
Call timing -

It can be called either before or after joining the channel. It is still valid after one leaves channel.

+

This method can be called either before or after joining the channel. It is still valid after one leaves channel.

Restrictions diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiovolumeindication.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiovolumeindication.dita index 6cf817abf67..4c3a483d27a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiovolumeindication.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiovolumeindication.dita @@ -40,7 +40,7 @@
Call timing -

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

+

This method can be called either before or after joining the channel.

Restrictions 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 82bb3d3cdd4..1a1bc25aea6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring.dita @@ -22,38 +22,30 @@

-
- 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 4c6c43e03de..5271b2a2bf1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita @@ -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 +

    This method 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 ecff08251f9..891cf61b720 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getconnectionstate.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getconnectionstate.dita @@ -24,13 +24,17 @@ Future<ConnectionStateType> getConnectionState();

    -
    - Details -

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

    +
    + Call timing +

    This method 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..209d19c5753 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 and passi in the UID.to get the user account of the specified user from the object.

    -
    +
    + Call timing +

    Call 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 both the user account and UID.
    • +     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..57c8cee2139 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 +

    Call 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..44fa7adefd8 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_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_leavechannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel.dita index db351fa957c..fb0bd48217e 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 - +
    +

    After calling this method, the SDK terminates the audio and video interaction, leaves the current channel, and releases all resources related to the session.

    +

    After joining the channel, you must call this method 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.
      • +
    • If you have called to join multiple channels, calling this method will leave all the channels you joined.
     +
    +
    + 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..d4c02cf9e96 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,29 @@ 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.

    -
    -
    +
    +

    After calling this method, the SDK terminates the audio and video interaction, leaves the current channel, and releases all resources related to the session.

    +

    After joining a 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 all the channels you joined.

    +

    After joining the channel, you must call this method to end the call; otherwise, the next call cannot be started. If you have called to join multiple channels, calling this method will leave all the channels you joined.

    + This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. +
    +
    + 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_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_mutelocalaudiostream.dita b/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalaudiostream.dita index 741bb42a030..28a7799e356 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalaudiostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalaudiostream.dita @@ -29,7 +29,7 @@
    Call timing -

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

    +

    This method can be called either before or after joining the channel.

    Restrictions diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita b/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita index eba2dacfecc..4ae4ccfb942 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita @@ -30,7 +30,7 @@
    Call timing -

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

    +

    This method can be called either before or after joining the channel.

    Restrictions 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 fbbfe79b3b7..67f463881d0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muterecordingsignal.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muterecordingsignal.dita @@ -24,18 +24,30 @@ Future<void> muteRecordingSignal(bool mute);

    -
    +
    +

    If you have already called to adjust the recording signal volume, when you call this method and set it to , the SDK behaves as follows:

      +
    1. Records the adjusted volume.
      2. +
    2. Mutes the recording signal.
    When you call this method again and set it to , the recording signal volume will be restored to the volume recorded by the SDK before muting.

    +
    +
    + Call timing +

    This method can be called either before or after joining the channel.

    +
    +
    + Restrictions +

    None.

    +
    +
    Parameters - muted - mute + muted + mute
      -
    • : The media file is muted.
      • +
    • : Mute the recording signal.
    • : (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_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_pushaudioframe2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita index 34520cc18ab..a721d57a289 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita @@ -33,7 +33,7 @@

    Before calling this method to push external audio data, perform the following steps:

    1. Call to create a custom audio track and get the audio track ID.
      2. -
    2. Call to join the channel. In , set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
      3. +
    3. Call to join the channel. In , set publishCustomAudioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
    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..b6d32280ad9 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.
      • -
    • 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 .

    +

    This method is optional. If you want to join a channel using a user account, you can choose one of the following methods:

      +
    • Call the method to register a user account, and then call the method to join a channel, which can shorten the time it takes to enter the channel.
      • +
    • Call the method to join a channel.
      • +
    +
      +
    • Call the method to register a user account, and then call the or method to join a channel, which can shorten the time it takes to enter the channel.
      • +
    • Call the or method to join a 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..4f84d5e9780 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. The SDK adopts different optimization strategies for different channel profiles. For example, in a live streaming scenario, the SDK prioritizes video quality. After initializing the SDK, the default channel profile is the live streaming profile.

    + +

    In different channel scenarios, the default audio routing of the SDK is different. 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_setclientrole.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita index 634ef94e76f..a616cca6607 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.

    +
    +

    By default,the SDK sets the user role as audience. You can call this method to set the user role as host. The user role (roles) determines the users' permissions at the SDK level, including whether they can publish audio and video streams in a channel.

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

    When calling this method before joining a channel and setting the user role to BROADCASTER, the callback will not be triggered on the local client.

    +
    + -
    +
    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..1a7ec63c4c4 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. + Set the user role and the audience latency level in a live streaming scenario. @@ -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.

    +
    +

    By default,the SDK sets the user role as audience. You can call this method to set the user role as host. The user role (roles) determines the users' permissions at the SDK level, including whether they can publish audio and video streams in a channel.

    +

    The difference between this method and is that, the former supports setting the audienceLatencyLevel. audienceLatencyLevel needs to be used together with role to determine the level of service that users can enjoy within their permissions. For example, an audience member can choose to receive remote streams with low latency or ultra-low latency. Latency of different levels differ in billing. See .

    +
    +
    + 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 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 role as the host before joining the channel and call the method to enable video rendering, the local video preview is automatically enabled when the user joins the channel.

    +

    If you call this method to set the user role after joining a channel, the SDK will automatically call the and method to change the state for publishing audio and video streams.

    +
    +
    + Restrictions +

    When the user role is set to host, the audience latency level can only be set to .

    +

    When calling this method before joining a channel and setting the role to BROADCASTER, the callback will not be triggered on the local client.

    +
    + +
    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_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_setinearmonitoringvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setinearmonitoringvolume.dita index 52705ddc848..0fb799f7360 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setinearmonitoringvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setinearmonitoringvolume.dita @@ -29,7 +29,7 @@
    Call timing -

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

    +

    This method can be called either before or after joining the channel.

    Restrictions 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 c0ae827326d..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,7 +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.

    +

    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/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_startdirectcdnstreaming.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita index 078b756ef81..8c7bf8955df 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita @@ -40,7 +40,7 @@

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

      Media options

      Agora does not support setting the value of publishCameraTrack and publishCustomVideoTrack as , or the value of publishMicrophoneTrack and publishCustomAudioTrack as at the same time. When choosing media setting options (), you can refer to the following examples:

      -

      If you want to push audio and video streams published by the host to the CDN, the media setting options should be set as follows:

      +

      If you want to push audio and video streams captured by the host from a custom source, the media setting options should be set as follows:

      • publishCustomAudioTrack is set as and call the method
      • publishCustomAudioTrack is set as and call the or method
        • 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 b983156fd57..7fafb9b9fb6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita @@ -42,8 +42,8 @@
        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.
          • +
        • Call this method first and 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.

        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..1db9a40e8b6 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 first and 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.
      • +

    Restrictions 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_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/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 2b95f3eb39e..409b86cd1d4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex.dita @@ -25,57 +25,38 @@

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

    +

    +
    +
    +