agora-electron-sdk 4.2.2-dev.4 → 4.2.2-dev.7

package/ts/Private/IAgoraRtcEngineEx.ts

@@ -41,20 +41,31 @@ export class RtcConnection {
 /**
  * This interface class contains multi-channel methods.
  *
- * Inherited from IRtcEngine .
+ * Inherited from IRtcEngine.
  */
 export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Joins a channel with the connection ID.
    *
-   * You can call this method multiple times to join more than one channel. If you are already in a channel, you cannot rejoin it with the same user ID. If you want to join the same channel from different devices, ensure that the user IDs are different for all devices. Ensure that the app ID you use to generate the token is the same as the app ID used when creating the IRtcEngine instance.
+   * You can call this method multiple times to join more than one channel.
+   *  If you are already in a channel, you cannot rejoin it with the same user ID.
+   *  If you want to join the same channel from different devices, ensure that the user IDs are different for all devices.
+   *  Ensure that the app ID you use to generate the token is the same as the app ID used when creating the IRtcEngine instance.
    *
    * @param token The token generated on your server for authentication.
    * @param connection The connection information. See RtcConnection.
    * @param options The channel media options. See ChannelMediaOptions.
    *
    * @returns
-   * 0: Success. < 0: Failure. -2: The parameter is invalid. For example, the token is invalid, the uid parameter is not set to an integer, or the value of a member in ChannelMediaOptions is invalid. You need to pass in a valid parameter and join the channel again. -3: Failes to initialize the IRtcEngine object. You need to reinitialize the IRtcEngine object. -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method. -8: The internal state of the IRtcEngine object is wrong. The typical cause is that you call this method to join the channel without calling startEchoTest to stop the test after calling stopEchoTest to start a call loop test. You need to call stopEchoTest before calling this method. -17: The request to join the channel is rejected. The typical cause is that the user is in the channel. Agora recommends that you use the onConnectionStateChanged callback to determine whether the user exists in the channel. Do not call this method to join the channel unless you receive the ConnectionStateDisconnected (1) state. -102: The channel name is invalid. You need to pass in a valid channelname in channelId to rejoin the channel. -121: The user ID is invalid. You need to pass in a valid user ID in uid to rejoin the channel.
+   * 0: Success.
+   *  < 0: Failure.
+   *  -2: The parameter is invalid. For example, the token is invalid, the uid parameter is not set to an integer, or the value of a member in ChannelMediaOptions is invalid. You need to pass in a valid parameter and join the channel again.
+   *  -3: Failes to initialize the IRtcEngine object. You need to reinitialize the IRtcEngine object.
+   *  -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
+   *  -8: The internal state of the IRtcEngine object is wrong. The typical cause is that you call this method to join the channel without calling startEchoTest to stop the test after calling stopEchoTest to start a call loop test. You need to call stopEchoTest before calling this method.
+   *  -17: The request to join the channel is rejected. The typical cause is that the user is in the channel. Agora recommends that you use the onConnectionStateChanged callback to determine whether the user exists in the channel. Do not call this method to join the channel unless you receive the ConnectionStateDisconnected (1) state.
+   *  -102: The channel name is invalid. You need to pass in a valid channelname in channelId to rejoin the channel.
+   *  -121: The user ID is invalid. You need to pass in a valid user ID in uid to rejoin the channel.
    */
   abstract joinChannelEx(
     token: string,
@@ -65,13 +76,16 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Sets channel options and leaves the channel.
    *
-   * This method lets the user leave the channel, for example, by hanging up or exiting the call. After calling joinChannelEx 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 onLeaveChannel callback. After actually leaving the channel, the local user triggers the onLeaveChannel callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the onUserOffline callback. If you call release immediately after calling this method, the SDK does not trigger the onLeaveChannel callback. Calling leaveChannel will leave the channels when calling joinChannel and joinChannelEx at the same time.
+   * This method lets the user leave the channel, for example, by hanging up or exiting the call. After calling joinChannelEx 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 onLeaveChannel callback. After actually leaving the channel, the local user triggers the onLeaveChannel callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the onUserOffline callback.
+   *  If you call release immediately after calling this method, the SDK does not trigger the onLeaveChannel callback.
+   *  Calling leaveChannel will leave the channels joined by calling joinChannel and joinChannelEx.
    *
    * @param connection The connection information. See RtcConnection.
-   * @param options The options for leaving the channel. See LeaveChannelOptions.This parameter only supports the stopMicrophoneRecording member in the LeaveChannelOptions settings; setting other members does not take effect.
+   * @param options The options for leaving the channel. See LeaveChannelOptions. This parameter only supports the stopMicrophoneRecording member in the LeaveChannelOptions settings; setting other members does not take effect.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract leaveChannelEx(
     connection: RtcConnection,
@@ -85,7 +99,11 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure. -2: The value of a member in the ChannelMediaOptions structure is invalid. For example, the token or the user ID is invalid. You need to fill in a valid parameter. -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method. -8: The internal state of the IRtcEngine object is wrong. The possible reason is that the user is not in the channel. Agora recommends that you use the onConnectionStateChanged callback to determine whether the user exists in the channel. If you receive the ConnectionStateDisconnected (1) or ConnectionStateFailed (5) state, the user is not in the channel. You need to call joinChannel to join a channel before calling this method.
+   * 0: Success.
+   *  < 0: Failure.
+   *  -2: The value of a member in the ChannelMediaOptions structure is invalid. For example, the token or the user ID is invalid. You need to fill in a valid parameter.
+   *  -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
+   *  -8: The internal state of the IRtcEngine object is wrong. The possible reason is that the user is not in the channel. Agora recommends that you use the onConnectionStateChanged callback to determine whether the user exists in the channel. If you receive the ConnectionStateDisconnected (1) or ConnectionStateFailed (5) state, the user is not in the channel. You need to call joinChannel to join a channel before calling this method.
    */
   abstract updateChannelMediaOptionsEx(
     options: ChannelMediaOptions,
@@ -101,7 +119,8 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setVideoEncoderConfigurationEx(
     config: VideoEncoderConfiguration,
@@ -117,7 +136,8 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setupRemoteVideoEx(
     canvas: VideoCanvas,
@@ -128,11 +148,12 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    * Stops or resumes receiving the audio stream of a specified user.
    *
    * @param uid The ID of the specified user.
-   * @param mute Whether to stop receiving the audio stream of the specified user:true: Stop receiving the audio stream of the specified user.false: (Default) Resume receiving the audio stream of the specified user.
+   * @param mute Whether to stop receiving the audio stream of the specified user: true : Stop receiving the audio stream of the specified user. false : (Default) Resume receiving the audio stream of the specified user.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract muteRemoteAudioStreamEx(
     uid: number,
@@ -146,11 +167,12 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    * This method is used to stop or resume receiving the video stream of a specified user. You can call this method before or after joining a channel. If a user leaves a channel, the settings in this method become invalid.
    *
    * @param uid The user ID of the remote user.
-   * @param mute Whether to stop receiving the video stream of the specified user:true: Stop receiving the video stream of the specified user.false: (Default) Resume receiving the video stream of the specified user.
+   * @param mute Whether to stop receiving the video stream of the specified user: true : Stop receiving the video stream of the specified user. false : (Default) Resume receiving the video stream of the specified user.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract muteRemoteVideoStreamEx(
     uid: number,
@@ -161,14 +183,15 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Sets the stream type of the remote video.
    *
-   * Under limited network conditions, if the publisher has not disabled the dual-stream mode using enableDualStreamModeEx ( false ) , the receiver can choose to receive either the high-quality video stream or the low-quality video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate. By default, users receive the high-quality video stream. Call this method if you want to switch to the low-quality video stream. This method allows the app to adjust the corresponding video stream type based on the size of the video window to reduce the bandwidth and resources. The aspect ratio of the low-quality video stream is the same as the high-quality video stream. Once the resolution of the high-quality video stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-quality video stream. The SDK enables the low-quality video stream auto mode on the sender by default (not actively sending low-quality video streams). The host at the receiving end can call this method to initiate a low-quality video stream stream request on the receiving end, and the sender automatically switches to the low-quality video stream mode after receiving the request.
+   * Under limited network conditions, if the publisher has not disabled the dual-stream mode using enableDualStreamModeEx (false), the receiver can choose to receive either the high-quality video stream or the low-quality video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate. By default, users receive the high-quality video stream. Call this method if you want to switch to the low-quality video stream. This method allows the app to adjust the corresponding video stream type based on the size of the video window to reduce the bandwidth and resources. The aspect ratio of the low-quality video stream is the same as the high-quality video stream. Once the resolution of the high-quality video stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-quality video stream. The SDK enables the low-quality video stream auto mode on the sender by default (not actively sending low-quality video streams). The host at the receiving end can call this method to initiate a low-quality video stream stream request on the receiving end, and the sender automatically switches to the low-quality video stream mode after receiving the request.
    *
    * @param uid The user ID.
    * @param streamType The video stream type: VideoStreamType.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setRemoteVideoStreamTypeEx(
     uid: number,
@@ -181,11 +204,12 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    *
    * This method does not affect any ongoing audio recording, because it does not disable the audio capture device. A successful call of this method triggers the onUserMuteAudio and onRemoteAudioStateChanged callbacks on the remote client.
    *
-   * @param mute Whether to stop publishing the local audio stream:true: Stops publishing the local audio stream.false: (Default) Resumes publishing the local audio stream.
+   * @param mute Whether to stop publishing the local audio stream: true : Stops publishing the local audio stream. false : (Default) Resumes publishing the local audio stream.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract muteLocalAudioStreamEx(
     mute: boolean,
@@ -195,15 +219,15 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Stops or resumes publishing the local video stream.
    *
-   * A successful call of this method triggers the onUserMuteVideo callback on the remote client. This method does not affect any ongoing video recording, because it does not disable the camera.
+   * A successful call of this method triggers the onUserMuteVideo callback on the remote client.
+   *  This method does not affect any ongoing video recording, because it does not disable the camera.
    *
-   * @param mute Whether to stop publishing the local video stream.
-   *  true: Stop publishing the local video stream.
-   *  false: (Default) Publish the local video stream.
+   * @param mute Whether to stop publishing the local video stream. true : Stop publishing the local video stream. false : (Default) Publish the local video stream.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract muteLocalVideoStreamEx(
     mute: boolean,
@@ -213,13 +237,16 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Stops or resumes subscribing to the audio streams of all remote users.
    *
-   * After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including the ones join the channel subsequent to this call. Call this method after joining a channel. If you do not want to subscribe the audio streams of remote users before joining a channel, you can set autoSubscribeAudio as false when calling joinChannel .
+   * After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including the ones join the channel subsequent to this call.
+   *  Call this method after joining a channel.
+   *  If you do not want to subscribe the audio streams of remote users before joining a channel, you can set autoSubscribeAudio as false when calling joinChannel.
    *
-   * @param mute Whether to stop subscribing to the audio streams of all remote users:true: Stops subscribing to the audio streams of all remote users.false: (Default) Subscribes to the audio streams of all remote users by default.
+   * @param mute Whether to stop subscribing to the audio streams of all remote users: true : Stops subscribing to the audio streams of all remote users. false : (Default) Subscribes to the audio streams of all remote users by default.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract muteAllRemoteAudioStreamsEx(
     mute: boolean,
@@ -231,11 +258,12 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    *
    * After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.
    *
-   * @param mute Whether to stop subscribing to the video streams of all remote users.true: Stop subscribing to the video streams of all remote users.false: (Default) Subscribe to the audio streams of all remote users by default.
+   * @param mute Whether to stop subscribing to the video streams of all remote users. true : Stop subscribing to the video streams of all remote users. false : (Default) Subscribe to the audio streams of all remote users by default.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract muteAllRemoteVideoStreamsEx(
     mute: boolean,
@@ -245,14 +273,19 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Set the blocklist of subscriptions for audio streams.
    *
-   * You can call this method to specify the audio streams of a user that you do not want to subscribe to. You can call this method either before or after joining a channel. The blocklist is not affected by the setting in muteRemoteAudioStream , muteAllRemoteAudioStreams , and autoSubscribeAudio in ChannelMediaOptions . Once the blocklist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel. If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.
+   * You can call this method to specify the audio streams of a user that you do not want to subscribe to.
+   *  You can call this method either before or after joining a channel.
+   *  The blocklist is not affected by the setting in muteRemoteAudioStream, muteAllRemoteAudioStreams, and autoSubscribeAudio in ChannelMediaOptions.
+   *  Once the blocklist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
+   *  If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.
    *
-   * @param uidList The user ID list of users that you do not want to subscribe to.If you want to specify the audio streams of a user that you do not want to subscribe to, add the user ID in this list. If you want to remove a user from the blocklist, you need to call the setSubscribeAudioBlocklist method to update the user ID list; this means you only add the uid of users that you do not want to subscribe to in the new user ID list.
+   * @param uidList The user ID list of users that you do not want to subscribe to. If you want to specify the audio streams of a user that you do not want to subscribe to, add the user ID in this list. If you want to remove a user from the blocklist, you need to call the setSubscribeAudioBlocklist method to update the user ID list; this means you only add the uid of users that you do not want to subscribe to in the new user ID list.
    * @param uidNumber The number of users in the user ID list.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setSubscribeAudioBlocklistEx(
     uidList: number[],
@@ -263,14 +296,19 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Sets the allowlist of subscriptions for audio streams.
    *
-   * You can call this method to specify the audio streams of a user that you want to subscribe to. If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect. You can call this method either before or after joining a channel. The allowlist is not affected by the setting in muteRemoteAudioStream , muteAllRemoteAudioStreams and autoSubscribeAudio in ChannelMediaOptions . Once the allowlist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
+   * You can call this method to specify the audio streams of a user that you want to subscribe to.
+   *  If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.
+   *  You can call this method either before or after joining a channel.
+   *  The allowlist is not affected by the setting in muteRemoteAudioStream, muteAllRemoteAudioStreams and autoSubscribeAudio in ChannelMediaOptions.
+   *  Once the allowlist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
    *
-   * @param uidList The user ID list of users that you want to subscribe to.If you want to specify the audio streams of a user for subscription, add the user ID in this list. If you want to remove a user from the allowlist, you need to call the setSubscribeAudioAllowlist method to update the user ID list; this means you only add the uid of users that you want to subscribe to in the new user ID list.
+   * @param uidList The user ID list of users that you want to subscribe to. If you want to specify the audio streams of a user for subscription, add the user ID in this list. If you want to remove a user from the allowlist, you need to call the setSubscribeAudioAllowlist method to update the user ID list; this means you only add the uid of users that you want to subscribe to in the new user ID list.
    * @param uidNumber The number of users in the user ID list.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setSubscribeAudioAllowlistEx(
     uidList: number[],
@@ -281,15 +319,19 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Set the blocklist of subscriptions for video streams.
    *
-   * You can call this method to specify the video streams of a user that you do not want to subscribe to. If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect. Once the blocklist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel. You can call this method either before or after joining a channel. The blocklist is not affected by the setting in muteRemoteVideoStream , muteAllRemoteVideoStreams and autoSubscribeAudio in ChannelMediaOptions .
+   * You can call this method to specify the video streams of a user that you do not want to subscribe to.
+   *  If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.
+   *  Once the blocklist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
+   *  You can call this method either before or after joining a channel.
+   *  The blocklist is not affected by the setting in muteRemoteVideoStream, muteAllRemoteVideoStreams and autoSubscribeAudio in ChannelMediaOptions.
    *
-   * @param uidList The user ID list of users that you do not want to subscribe to.
-   *  If you want to specify the video streams of a user that you do not want to subscribe to, add the user ID of that user in this list. If you want to remove a user from the blocklist, you need to call the setSubscribeVideoBlocklist method to update the user ID list; this means you only add the uid of users that you do not want to subscribe to in the new user ID list.
+   * @param uidList The user ID list of users that you do not want to subscribe to. If you want to specify the video streams of a user that you do not want to subscribe to, add the user ID of that user in this list. If you want to remove a user from the blocklist, you need to call the setSubscribeVideoBlocklist method to update the user ID list; this means you only add the uid of users that you do not want to subscribe to in the new user ID list.
    * @param uidNumber The number of users in the user ID list.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setSubscribeVideoBlocklistEx(
     uidList: number[],
@@ -300,14 +342,19 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Set the allowlist of subscriptions for video streams.
    *
-   * You can call this method to specify the video streams of a user that you want to subscribe to. If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect. Once the allowlist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel. You can call this method either before or after joining a channel. The allowlist is not affected by the setting in muteRemoteVideoStream , muteAllRemoteVideoStreams and autoSubscribeAudio in ChannelMediaOptions .
+   * You can call this method to specify the video streams of a user that you want to subscribe to.
+   *  If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.
+   *  Once the allowlist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
+   *  You can call this method either before or after joining a channel.
+   *  The allowlist is not affected by the setting in muteRemoteVideoStream, muteAllRemoteVideoStreams and autoSubscribeAudio in ChannelMediaOptions.
    *
-   * @param uidList The user ID list of users that you want to subscribe to.If you want to specify the video streams of a user for subscription, add the user ID of that user in this list. If you want to remove a user from the allowlist, you need to call the setSubscribeVideoAllowlist method to update the user ID list; this means you only add the uid of users that you want to subscribe to in the new user ID list.
+   * @param uidList The user ID list of users that you want to subscribe to. If you want to specify the video streams of a user for subscription, add the user ID of that user in this list. If you want to remove a user from the allowlist, you need to call the setSubscribeVideoAllowlist method to update the user ID list; this means you only add the uid of users that you want to subscribe to in the new user ID list.
    * @param uidNumber The number of users in the user ID list.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setSubscribeVideoAllowlistEx(
     uidList: number[],
@@ -337,15 +384,21 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Sets the 2D position (the position on the horizontal plane) of the remote user's voice.
    *
-   * This method sets the voice position and volume of a remote user. When the local user calls this method to set the voice position of a remote user, the voice difference between the left and right channels allows the local user to track the real-time position of the remote user, creating a sense of space. This method applies to massive multiplayer online games, such as Battle Royale games. For the best voice positioning, Agora recommends using a wired headset. Call this method after joining a channel.
+   * This method sets the voice position and volume of a remote user. When the local user calls this method to set the voice position of a remote user, the voice difference between the left and right channels allows the local user to track the real-time position of the remote user, creating a sense of space. This method applies to massive multiplayer online games, such as Battle Royale games.
+   *  For the best voice positioning, Agora recommends using a wired headset.
+   *  Call this method after joining a channel.
    *
    * @param uid The user ID of the remote user.
-   * @param pan The voice position of the remote user. The value ranges from -1.0 to 1.0:-1.0: The remote voice comes from the left.0.0: (Default) The remote voice comes from the front.1.0: The remote voice comes from the right.
+   * @param pan The voice position of the remote user. The value ranges from -1.0 to 1.0:
+   *  -1.0: The remote voice comes from the left.
+   *  0.0: (Default) The remote voice comes from the front.
+   *  1.0: The remote voice comes from the right.
    * @param gain The volume of the remote user. The value ranges from 0.0 to 100.0. The default value is 100.0 (the original volume of the remote user). The smaller the value, the lower the volume.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setRemoteVoicePositionEx(
     uid: number,
@@ -366,7 +419,9 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Sets the video display mode of a specified remote user.
    *
-   * After initializing the video view of a remote user, you can call this method to update its rendering and mirror modes. This method affects only the video view that the local user sees. Call this method after initializing the remote view by calling the setupRemoteVideo method. During a call, you can call this method as many times as necessary to update the display mode of the video view of a remote user.
+   * After initializing the video view of a remote user, you can call this method to update its rendering and mirror modes. This method affects only the video view that the local user sees.
+   *  Call this method after initializing the remote view by calling the setupRemoteVideo method.
+   *  During a call, you can call this method as many times as necessary to update the display mode of the video view of a remote user.
    *
    * @param uid The user ID of the remote user.
    * @param renderMode The video display mode of the remote user. See RenderModeType.
@@ -374,7 +429,8 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setRemoteRenderModeEx(
     uid: number,
@@ -386,15 +442,18 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Enables loopback audio capturing.
    *
-   * If you enable loopback audio capturing, the output of the sound card is mixed into the audio stream sent to the other end. macOS does not support loopback audio capture of the default sound card. If you need to use this function, use a virtual sound card and pass its name to the deviceName parameter. Agora recommends using AgoraALD as the virtual sound card for audio capturing. This method only supports using one sound card for audio capturing.
+   * If you enable loopback audio capturing, the output of the sound card is mixed into the audio stream sent to the other end.
+   *  macOS does not support loopback audio capture of the default sound card. If you need to use this function, use a virtual sound card and pass its name to the deviceName parameter. Agora recommends using AgoraALD as the virtual sound card for audio capturing.
+   *  This method only supports using one sound card for audio capturing.
    *
    * @param connection The connection information. See RtcConnection.
-   * @param enabled Sets whether to enable loopback audio capture:true: Enable loopback audio capturing.false: (Default) Disable loopback audio capturing.
+   * @param enabled Sets whether to enable loopback audio capture: true : Enable loopback audio capturing. false : (Default) Disable loopback audio capturing.
    * @param deviceName macOS: The device name of the virtual sound card. The default value is set to NULL, which means using AgoraALD for loopback audio capturing.
    *  Windows: The device name of the sound card. The default is set to NULL, which means the SDK uses the sound card of your device for loopback audio capturing.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract enableLoopbackRecordingEx(
     connection: RtcConnection,
@@ -421,14 +480,17 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Adjusts the playback signal volume of a specified remote user.
    *
-   * You can call this method to adjust the playback volume of a specified remote user. To adjust the playback volume of different remote users, call the method as many times, once for each remote user. Call this method after joining a channel. The playback volume here refers to the mixed volume of a specified remote user.
+   * You can call this method to adjust the playback volume of a specified remote user. To adjust the playback volume of different remote users, call the method as many times, once for each remote user.
+   *  Call this method after joining a channel.
+   *  The playback volume here refers to the mixed volume of a specified remote user.
    *
    * @param uid The user ID of the remote user.
    * @param volume Audio mixing volume. The value ranges between 0 and 100. The default value is 100, which means the original volume.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract adjustUserPlaybackSignalVolumeEx(
     uid: number,
@@ -444,7 +506,7 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * The current connection state. See ConnectionStateType .
+   * The current connection state. See ConnectionStateType.
    */
   abstract getConnectionStateEx(connection: RtcConnection): ConnectionStateType;
 
@@ -460,13 +522,14 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Creates a data stream.
    *
-   * Creates a data stream. Each user can create up to five data streams in a single channel. Compared with createDataStreamEx , 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.
+   * Creates a data stream. Each user can create up to five data streams in a single channel.
    *
    * @param config The configurations for the data stream. See DataStreamConfig.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * ID of the created data stream, if the method call succeeds. < 0: Failure.
+   * ID of the created data stream, if the method call succeeds.
+   *  < 0: Failure.
    */
   abstract createDataStreamEx(
     config: DataStreamConfig,
@@ -476,8 +539,13 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Sends data stream messages.
    *
-   * After calling createDataStreamEx , you can call this method to send data stream messages to all users in the channel. The SDK has the following restrictions on this method: Up to 60 packets can be sent per second in a channel with each packet having a maximum size of 1 KB. Each client can send up to 30 KB of data per second. Each user can have up to five data streams simultaneously. A successful method call triggers the onStreamMessage callback on the remote client, from which the remote user gets the stream message.
-   * A failed method call triggers the onStreamMessageError callback on the remote client. Ensure that you call createDataStreamEx to create a data channel before calling this method. This method applies only to the COMMUNICATION profile or to the hosts in the LIVE_BROADCASTING profile. If an audience in the LIVE_BROADCASTING profile calls this method, the audience may be switched to a host.
+   * After calling createDataStreamEx, you can call this method to send data stream messages to all users in the channel. The SDK has the following restrictions on this method:
+   *  Up to 60 packets can be sent per second in a channel with each packet having a maximum size of 1 KB.
+   *  Each client can send up to 30 KB of data per second.
+   *  Each user can have up to five data streams simultaneously. A successful method call triggers the onStreamMessage callback on the remote client, from which the remote user gets the stream message.
+   * A failed method call triggers the onStreamMessageError callback on the remote client.
+   *  Ensure that you call createDataStreamEx to create a data channel before calling this method.
+   *  This method applies only to the COMMUNICATION profile or to the hosts in the LIVE_BROADCASTING profile. If an audience in the LIVE_BROADCASTING profile calls this method, the audience may be switched to a host.
    *
    * @param streamId The data stream ID. You can get the data stream ID by calling createDataStreamEx.
    * @param data The message to be sent.
@@ -485,7 +553,8 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract sendStreamMessageEx(
     streamId: number,
@@ -497,14 +566,23 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Adds a watermark image to the local video.
    *
-   * This method adds a PNG watermark image to the local video in the live streaming. Once the watermark image is added, all the audience in the channel (CDN audience included), and the capturing device can see and capture it. The Agora SDK supports adding only one watermark image onto a local video or CDN live stream. The newly added watermark image replaces the previous one. The watermark coordinates are dependent on the settings in the setVideoEncoderConfigurationEx method: If the orientation mode of the encoding video ( OrientationMode ) is fixed landscape mode or the adaptive landscape mode, the watermark uses the landscape orientation. If the orientation mode of the encoding video ( OrientationMode ) is fixed portrait mode or the adaptive portrait mode, the watermark uses the portrait orientation. When setting the watermark position, the region must be less than the dimensions set in the setVideoEncoderConfigurationEx method; otherwise, the watermark image will be cropped. Ensure that you have called enableVideo before calling this method. This method supports adding a watermark image in the PNG file format only. Supported pixel formats of the PNG image are RGBA, RGB, Palette, Gray, and Alpha_gray. If the dimensions of the PNG image differ from your settings in this method, the image will be cropped or zoomed to conform to your settings. If you have enabled the local video preview by calling the startPreview method, you can use the visibleInPreview member to set whether or not the watermark is visible in the preview. If you have enabled the mirror mode for the local video, the watermark on the local video is also mirrored. To avoid mirroring the watermark, Agora recommends that you do not use the mirror and watermark functions for the local video at the same time. You can implement the watermark function in your application layer.
+   * This method adds a PNG watermark image to the local video in the live streaming. Once the watermark image is added, all the audience in the channel (CDN audience included), and the capturing device can see and capture it. The Agora SDK supports adding only one watermark image onto a local video or CDN live stream. The newly added watermark image replaces the previous one. The watermark coordinates are dependent on the settings in the setVideoEncoderConfigurationEx method:
+   *  If the orientation mode of the encoding video (OrientationMode) is fixed landscape mode or the adaptive landscape mode, the watermark uses the landscape orientation.
+   *  If the orientation mode of the encoding video (OrientationMode) is fixed portrait mode or the adaptive portrait mode, the watermark uses the portrait orientation.
+   *  When setting the watermark position, the region must be less than the dimensions set in the setVideoEncoderConfigurationEx method; otherwise, the watermark image will be cropped.
+   *  Ensure that you have called enableVideo before calling this method.
+   *  This method supports adding a watermark image in the PNG file format only. Supported pixel formats of the PNG image are RGBA, RGB, Palette, Gray, and Alpha_gray.
+   *  If the dimensions of the PNG image differ from your settings in this method, the image will be cropped or zoomed to conform to your settings.
+   *  If you have enabled the local video preview by calling the startPreview method, you can use the visibleInPreview member to set whether or not the watermark is visible in the preview.
+   *  If you have enabled the mirror mode for the local video, the watermark on the local video is also mirrored. To avoid mirroring the watermark, Agora recommends that you do not use the mirror and watermark functions for the local video at the same time. You can implement the watermark function in your application layer.
    *
    * @param watermarkUrl The local file path of the watermark image to be added. This method supports adding a watermark image from the local absolute or relative file path.
    * @param options The options of the watermark image to be added. See WatermarkOptions.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract addVideoWatermarkEx(
     watermarkUrl: string,
@@ -518,7 +596,8 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract clearVideoWatermarkEx(connection: RtcConnection): number;
 
@@ -545,12 +624,12 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    *  ≤ 0: Disables the volume indication.
    *  > 0: Time interval (ms) between two consecutive volume indications. The lowest value is 50.
    * @param smooth The smoothing factor that sets the sensitivity of the audio volume indicator. The value ranges between 0 and 10. The recommended value is 3. The greater the value, the more sensitive the indicator.
-   * @param reportVad true: Enables the voice activity detection of the local user. Once it is enabled, the vad parameter of the onAudioVolumeIndication callback reports the voice activity status of the local user.
-   *  false: (Default) Disables the voice activity detection of the local user. Once it is disabled, the vad parameter of the onAudioVolumeIndication callback does not report the voice activity status of the local user, except for the scenario where the engine automatically detects the voice activity of the local user.
+   * @param reportVad true : Enables the voice activity detection of the local user. Once it is enabled, the vad parameter of the onAudioVolumeIndication callback reports the voice activity status of the local user. false : (Default) Disables the voice activity detection of the local user. Once it is disabled, the vad parameter of the onAudioVolumeIndication callback does not report the voice activity status of the local user, except for the scenario where the engine automatically detects the voice activity of the local user.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract enableAudioVolumeIndicationEx(
     interval: number,
@@ -562,13 +641,20 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Starts pushing media streams to a CDN without transcoding.
    *
-   * Ensure that you enable the Media Push service before using this function. See Enable Media Push . Call this method after joining a channel. Only hosts in the LIVE_BROADCASTING profile can call this method. If you want to retry pushing streams after a failed push, make sure to call stopRtmpStream first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push. Agora recommends that you use the server-side Media Push function.  You can call this method to push an audio or video stream to the specified CDN address. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times. After you call this method, the SDK triggers the onRtmpStreamingStateChanged callback on the local client to report the state of the streaming.
+   * Ensure that you enable the Media Push service before using this function. See Enable Media Push.
+   *  Call this method after joining a channel.
+   *  Only hosts in the LIVE_BROADCASTING profile can call this method.
+   *  If you want to retry pushing streams after a failed push, make sure to call stopRtmpStream first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push. Agora recommends that you use the server-side Media Push function. You can call this method to push an audio or video stream to the specified CDN address. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times. After you call this method, the SDK triggers the onRtmpStreamingStateChanged callback on the local client to report the state of the streaming.
    *
    * @param url The address of Media Push. The format is RTMP or RTMPS. The character length cannot exceed 1024 bytes. Special characters such as Chinese characters are not supported.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure. -2: The URL is null or the string length is 0. -7: The SDK is not initialized before calling this method. -19: The Media Push URL is already in use, use another URL instead.
+   * 0: Success.
+   *  < 0: Failure.
+   *  -2: The URL is null or the string length is 0.
+   *  -7: The SDK is not initialized before calling this method.
+   *  -19: The Media Push URL is already in use, use another URL instead.
    */
   abstract startRtmpStreamWithoutTranscodingEx(
     url: string,
@@ -578,14 +664,22 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Starts Media Push and sets the transcoding configuration.
    *
-   * Agora recommends that you use the server-side Media Push function.  You can call this method to push a live audio-and-video stream to the specified CDN address and set the transcoding configuration. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times. After you call this method, the SDK triggers the onRtmpStreamingStateChanged callback on the local client to report the state of the streaming. Ensure that you enable the Media Push service before using this function. Call this method after joining a channel. Only hosts in the LIVE_BROADCASTING profile can call this method. If you want to retry pushing streams after a failed push, make sure to call stopRtmpStreamEx first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push.
+   * Agora recommends that you use the server-side Media Push function. You can call this method to push a live audio-and-video stream to the specified CDN address and set the transcoding configuration. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times. After you call this method, the SDK triggers the onRtmpStreamingStateChanged callback on the local client to report the state of the streaming.
+   *  Ensure that you enable the Media Push service before using this function.
+   *  Call this method after joining a channel.
+   *  Only hosts in the LIVE_BROADCASTING profile can call this method.
+   *  If you want to retry pushing streams after a failed push, make sure to call stopRtmpStreamEx first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push.
    *
    * @param url The address of Media Push. The format is RTMP or RTMPS. The character length cannot exceed 1024 bytes. Special characters such as Chinese characters are not supported.
    * @param transcoding The transcoding configuration for Media Push. See LiveTranscoding.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure. -2: The URL is null or the string length is 0. -7: The SDK is not initialized before calling this method. -19: The Media Push URL is already in use, use another URL instead.
+   * 0: Success.
+   *  < 0: Failure.
+   *  -2: The URL is null or the string length is 0.
+   *  -7: The SDK is not initialized before calling this method.
+   *  -19: The Media Push URL is already in use, use another URL instead.
    */
   abstract startRtmpStreamWithTranscodingEx(
     url: string,
@@ -596,13 +690,14 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Updates the transcoding configuration.
    *
-   * Agora recommends that you use the server-side Media Push function.  After you start pushing media streams to CDN with transcoding, you can dynamically update the transcoding configuration according to the scenario. The SDK triggers the onTranscodingUpdated callback after the transcoding configuration is updated.
+   * Agora recommends that you use the server-side Media Push function. After you start pushing media streams to CDN with transcoding, you can dynamically update the transcoding configuration according to the scenario. The SDK triggers the onTranscodingUpdated callback after the transcoding configuration is updated.
    *
    * @param transcoding The transcoding configuration for Media Push. See LiveTranscoding.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract updateRtmpTranscodingEx(
     transcoding: LiveTranscoding,
@@ -612,25 +707,37 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Stops pushing media streams to a CDN.
    *
-   * Agora recommends that you use the server-side Media Push function.  You can call this method to stop the live stream on the specified CDN address. This method can stop pushing media streams to only one CDN address at a time, so if you need to stop pushing streams to multiple addresses, call this method multiple times. After you call this method, the SDK triggers the onRtmpStreamingStateChanged callback on the local client to report the state of the streaming.
+   * Agora recommends that you use the server-side Media Push function. You can call this method to stop the live stream on the specified CDN address. This method can stop pushing media streams to only one CDN address at a time, so if you need to stop pushing streams to multiple addresses, call this method multiple times. After you call this method, the SDK triggers the onRtmpStreamingStateChanged callback on the local client to report the state of the streaming.
    *
    * @param url The address of Media Push. The format is RTMP or RTMPS. The character length cannot exceed 1024 bytes. Special characters such as Chinese characters are not supported.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract stopRtmpStreamEx(url: string, connection: RtcConnection): number;
 
   /**
    * Starts relaying media streams across channels or updates channels for media relay.
    *
-   * The first successful call to this method starts relaying media streams from the source channel to the destination channels. To relay the media stream to other channels, or exit one of the current media relays, you can call this method again to update the destination channels. After a successful method call, the SDK triggers the onChannelMediaRelayStateChanged callback, and this callback returns the state of the media stream relay. Common states are as follows: If the onChannelMediaRelayStateChanged callback returns RelayStateRunning (2) and RelayOk (0), it means that the SDK starts relaying media streams from the source channel to the destination channel. If the onChannelMediaRelayStateChanged callback returns RelayStateFailure (3), an exception occurs during the media stream relay. Call this method after joining the channel. This method takes effect only when you are a host in a live streaming channel. The relaying media streams across channels function needs to be enabled by contacting . Agora does not support string user accounts in this API.
+   * The first successful call to this method starts relaying media streams from the source channel to the destination channels. To relay the media stream to other channels, or exit one of the current media relays, you can call this method again to update the destination channels. This feature supports relaying media streams to a maximum of six destination channels. After a successful method call, the SDK triggers the onChannelMediaRelayStateChanged callback, and this callback returns the state of the media stream relay. Common states are as follows:
+   *  If the onChannelMediaRelayStateChanged callback returns RelayStateRunning (2) and RelayOk (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
+   *  If the onChannelMediaRelayStateChanged callback returns RelayStateFailure (3), an exception occurs during the media stream relay.
+   *  Call this method after joining the channel.
+   *  This method takes effect only when you are a host in a live streaming channel.
+   *  The relaying media streams across channels function needs to be enabled by contacting.
+   *  Agora does not support string user accounts in this API.
    *
    * @param configuration The configuration of the media stream relay. See ChannelMediaRelayConfiguration.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure. -1: A general error occurs (no specified reason). -2: The parameter is invalid. -7: The method call was rejected. It may be because the SDK has not been initialized successfully, or the user role is not an host. -8: Internal state error. Probably because the user is not an audience member.
+   * 0: Success.
+   *  < 0: Failure.
+   *  -1: A general error occurs (no specified reason).
+   *  -2: The parameter is invalid.
+   *  -7: The method call was rejected. It may be because the SDK has not been initialized successfully, or the user role is not a host.
+   *  -8: Internal state error. Probably because the user is not a broadcaster.
    */
   abstract startOrUpdateChannelMediaRelayEx(
     configuration: ChannelMediaRelayConfiguration,
@@ -640,13 +747,25 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels.
    *
-   * Deprecated: This method is deprecated. Use startOrUpdateChannelMediaRelayEx instead. After a successful method call, the SDK triggers the onChannelMediaRelayStateChanged and onChannelMediaRelayEvent callbacks, and these callbacks return the state and events of the media stream relay. If the onChannelMediaRelayStateChanged callback returns RelayStateRunning (2) and RelayOk (0), and the onChannelMediaRelayEvent callback returns RelayEventPacketSentToDestChannel (4), it means that the SDK starts relaying media streams between the source channel and the target channel. If the onChannelMediaRelayStateChanged callback returns RelayStateFailure (3), an exception occurs during the media stream relay. Call this method after joining the channel. This method takes effect only when you are a host in a live streaming channel. After a successful method call, if you want to call this method again, ensure that you call the stopChannelMediaRelayEx method to quit the current relay. The relaying media streams across channels function needs to be enabled by contacting . Agora does not support string user accounts in this API.
+   * Deprecated: This method is deprecated. Use startOrUpdateChannelMediaRelayEx instead. After a successful method call, the SDK triggers the onChannelMediaRelayStateChanged and onChannelMediaRelayEvent callbacks, and these callbacks return the state and events of the media stream relay.
+   *  If the onChannelMediaRelayStateChanged callback returns RelayStateRunning (2) and RelayOk (0), and the onChannelMediaRelayEvent callback returns RelayEventPacketSentToDestChannel (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
+   *  If the onChannelMediaRelayStateChanged callback returns RelayStateFailure (3), an exception occurs during the media stream relay.
+   *  Call this method after joining the channel.
+   *  This method takes effect only when you are a host in a live streaming channel.
+   *  After a successful method call, if you want to call this method again, ensure that you call the stopChannelMediaRelayEx method to quit the current relay.
+   *  The relaying media streams across channels function needs to be enabled by contacting.
+   *  Agora does not support string user accounts in this API.
    *
    * @param configuration The configuration of the media stream relay. See ChannelMediaRelayConfiguration.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure. -1: A general error occurs (no specified reason). -2: The parameter is invalid. -7: The method call was rejected. It may be because the SDK has not been initialized successfully, or the user role is not an host. -8: Internal state error. Probably because the user is not an audience member.
+   * 0: Success.
+   *  < 0: Failure.
+   *  -1: A general error occurs (no specified reason).
+   *  -2: The parameter is invalid.
+   *  -7: The method call was rejected. It may be because the SDK has not been initialized successfully, or the user role is not a host.
+   *  -8: Internal state error. Probably because the user is not a broadcaster.
    */
   abstract startChannelMediaRelayEx(
     configuration: ChannelMediaRelayConfiguration,
@@ -656,13 +775,14 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Updates the channels for media stream relay.
    *
-   * Deprecated: This method is deprecated. Use startOrUpdateChannelMediaRelayEx instead. After the media relay starts, if you want to relay the media stream to more channels, or leave the current relay channel, you can call this method. After a successful method call, the SDK triggers the onChannelMediaRelayEvent callback with the RelayEventPacketUpdateDestChannel (7) state code. Call the method after successfully calling the startChannelMediaRelayEx method and receiving onChannelMediaRelayStateChanged ( RelayStateRunning , RelayOk ) ; otherwise, the method call fails.
+   * Deprecated: This method is deprecated. Use startOrUpdateChannelMediaRelayEx instead. After the media relay starts, if you want to relay the media stream to more channels, or leave the current relay channel, you can call this method. After a successful method call, the SDK triggers the onChannelMediaRelayEvent callback with the RelayEventPacketUpdateDestChannel (7) state code. Call the method after successfully calling the startChannelMediaRelayEx method and receiving onChannelMediaRelayStateChanged (RelayStateRunning, RelayOk); otherwise, the method call fails.
    *
    * @param configuration The configuration of the media stream relay. See ChannelMediaRelayConfiguration.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract updateChannelMediaRelayEx(
     configuration: ChannelMediaRelayConfiguration,
@@ -677,31 +797,34 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract stopChannelMediaRelayEx(connection: RtcConnection): number;
 
   /**
    * Pauses the media stream relay to all target channels.
    *
-   * After the cross-channel media stream relay starts, you can call this method to pause relaying media streams to all target channels; after the pause, if you want to resume the relay, call resumeAllChannelMediaRelay . Call this method after startOrUpdateChannelMediaRelayEx .
+   * After the cross-channel media stream relay starts, you can call this method to pause relaying media streams to all target channels; after the pause, if you want to resume the relay, call resumeAllChannelMediaRelay. Call this method after startOrUpdateChannelMediaRelayEx.
    *
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract pauseAllChannelMediaRelayEx(connection: RtcConnection): number;
 
   /**
    * Resumes the media stream relay to all target channels.
    *
-   * After calling the pauseAllChannelMediaRelayEx method, you can call this method to resume relaying media streams to all destination channels. Call this method after pauseAllChannelMediaRelayEx .
+   * After calling the pauseAllChannelMediaRelayEx method, you can call this method to resume relaying media streams to all destination channels. Call this method after pauseAllChannelMediaRelayEx.
    *
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract resumeAllChannelMediaRelayEx(connection: RtcConnection): number;
 
@@ -721,16 +844,17 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Enables or disables dual-stream mode on the sender side.
    *
-   * After you enable dual-stream mode, you can call setRemoteVideoStreamType to choose to receive either the high-quality video stream or the low-quality video stream on the subscriber side. You can call this method to enable or disable the dual-stream mode on the publisher side. Dual streams are a pairing of a high-quality video stream and a low-quality video stream: High-quality video stream: High bitrate, high resolution. Low-quality video stream: Low bitrate, low resolution. This method is applicable to all types of streams from the sender, including but not limited to video streams collected from cameras, screen sharing streams, and custom-collected video streams.
+   * After you enable dual-stream mode, you can call setRemoteVideoStreamType to choose to receive either the high-quality video stream or the low-quality video stream on the subscriber side. You can call this method to enable or disable the dual-stream mode on the publisher side. Dual streams are a pairing of a high-quality video stream and a low-quality video stream:
+   *  High-quality video stream: High bitrate, high resolution.
+   *  Low-quality video stream: Low bitrate, low resolution. This method is applicable to all types of streams from the sender, including but not limited to video streams collected from cameras, screen sharing streams, and custom-collected video streams.
    *
-   * @param enabled Whether to enable dual-stream mode:
-   *  true: Enable dual-stream mode.
-   *  false: (Default) Disable dual-stream mode.
+   * @param enabled Whether to enable dual-stream mode: true : Enable dual-stream mode. false : (Default) Disable dual-stream mode.
    * @param streamConfig The configuration of the low-quality video stream. See SimulcastStreamConfig.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract enableDualStreamModeEx(
     enabled: boolean,
@@ -741,14 +865,18 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Sets the dual-stream mode on the sender side.
    *
-   * The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to AutoSimulcastStream . If you want to modify this behavior, you can call this method and modify the mode to DisableSimulcastStream (never send low-quality video streams) or EnableSimulcastStream (always send low-quality video streams). The difference and connection between this method and enableDualStreamModeEx is as follows: When calling this method and setting mode to DisableSimulcastStream , it has the same effect as enableDualStreamModeEx ( false ) . When calling this method and setting mode to EnableSimulcastStream , it has the same effect as enableDualStreamModeEx ( true ) . Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
+   * The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to AutoSimulcastStream. If you want to modify this behavior, you can call this method and modify the mode to DisableSimulcastStream (never send low-quality video streams) or EnableSimulcastStream (always send low-quality video streams). The difference and connection between this method and enableDualStreamModeEx is as follows:
+   *  When calling this method and setting mode to DisableSimulcastStream, it has the same effect as enableDualStreamModeEx (false).
+   *  When calling this method and setting mode to EnableSimulcastStream, it has the same effect as enableDualStreamModeEx (true).
+   *  Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
    *
    * @param mode The mode in which the video stream is sent. See SimulcastStreamMode.
    * @param streamConfig The configuration of the low-quality video stream. See SimulcastStreamConfig.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setDualStreamModeEx(
     mode: SimulcastStreamMode,
@@ -769,17 +897,20 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Takes a snapshot of a video stream.
    *
-   * The method is asynchronous, and the SDK has not taken the snapshot when the method call returns. After a successful method call, the SDK triggers the onSnapshotTaken callback to report whether the snapshot is successfully taken, as well as the details for that snapshot. This method takes a snapshot of a video stream from the specified user, generates a JPG image, and saves it to the specified path. Call this method after the joinChannelEx method. This method takes a snapshot of the published video stream specified in ChannelMediaOptions . If the user's video has been preprocessed, for example, watermarked or beautified, the resulting snapshot includes the pre-processing effect.
+   * The method is asynchronous, and the SDK has not taken the snapshot when the method call returns. After a successful method call, the SDK triggers the onSnapshotTaken callback to report whether the snapshot is successfully taken, as well as the details for that snapshot. This method takes a snapshot of a video stream from the specified user, generates a JPG image, and saves it to the specified path.
+   *  Call this method after the joinChannelEx method.
+   *  When used for local video snapshots, this method takes a snapshot for the video streams specified in ChannelMediaOptions.
+   *  If the user's video has been preprocessed, for example, watermarked or beautified, the resulting snapshot includes the pre-processing effect.
    *
    * @param connection The connection information. See RtcConnection.
    * @param uid The user ID. Set uid as 0 if you want to take a snapshot of the local user's video.
    * @param filePath The local path (including filename extensions) of the snapshot. For example:
    *  Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.jpg
-   *  macOS: ～/Library/Logs/example.jpg
-   *  Ensure that the path you specify exists and is writable.
+   *  macOS: ～/Library/Logs/example.jpg Ensure that the path you specify exists and is writable.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract takeSnapshotEx(
     connection: RtcConnection,
@@ -790,12 +921,14 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Enables tracing the video frame rendering process.
    *
-   * By default, the SDK starts tracing the video rendering event automatically when the local user successfully joins the channel. You can call this method at an appropriate time according to the actual application scenario to customize the tracing process. After the local user leaves the current channel, the SDK automatically resets the time point to the next time when the user successfully joins the channel. The SDK starts tracing the rendering status of the video frames in the channel from the moment this method is successfully called and reports information about the event through the onVideoRenderingTracingResult callback.
+   * By default, the SDK starts tracing the video rendering event automatically when the local user successfully joins the channel. You can call this method at an appropriate time according to the actual application scenario to customize the tracing process.
+   *  After the local user leaves the current channel, the SDK automatically resets the time point to the next time when the user successfully joins the channel. The SDK starts tracing the rendering status of the video frames in the channel from the moment this method is successfully called and reports information about the event through the onVideoRenderingTracingResult callback.
    *
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract startMediaRenderingTracingEx(connection: RtcConnection): number;
 }