IRtcEngineEx
This interface class contains multi-channel methods.
Inherited from IRtcEngine.
addVideoWatermarkEx
Adds a watermark image to the local video.
abstract addVideoWatermarkEx( watermarkUrl: string, options: WatermarkOptions, connection: RtcConnection ): number;
Details
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.
- 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.
Parameters
- 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.
- options
- The options of the watermark image to be added. See WatermarkOptions.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
adjustUserPlaybackSignalVolumeEx
Adjusts the playback signal volume of a specified remote user.
abstract adjustUserPlaybackSignalVolumeEx( uid: number, volume: number, connection: RtcConnection ): number;
Details
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.
Parameters
- uid
- The user ID of the remote user.
- volume
- Audio mixing volume. The value ranges between 0 and 100. The default value is 100, which means the original volume.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
clearVideoWatermarkEx
Removes the watermark image from the video stream.
abstract clearVideoWatermarkEx(connection: RtcConnection): number;
Parameters
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
createDataStreamEx
Creates a data stream.
abstract createDataStreamEx( config: DataStreamConfig, connection: RtcConnection ): number;
Details
Creates a data stream. Each user can create up to five data streams in a single channel.
Parameters
- config
- The configurations for the data stream. See DataStreamConfig.
- connection
- The connection information. See RtcConnection.
Returns
- ID of the created data stream, if the method call succeeds.
- < 0: Failure.
enableAudioVolumeIndicationEx
Enables the reporting of users' volume indication.
abstract enableAudioVolumeIndicationEx( interval: number, smooth: number, reportVad: boolean, connection: RtcConnection ): number;
Details
This method enables the SDK to regularly report the volume information to the app of the local user who sends a stream and remote users (three users at most) whose instantaneous volumes are the highest. Once you call this method and users send streams in the channel, the SDK triggers the onAudioVolumeIndication callback at the time interval set in this method.
Parameters
- interval
- Sets the time interval between two consecutive volume indications:
- ≤ 0: Disables the volume indication.
- > 0: Time interval (ms) between two consecutive volume indications. The lowest value is 50.
- 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.
- 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.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
enableContentInspectEx
Enables or disables video screenshot and upload.
abstract enableContentInspectEx( enabled: boolean, config: ContentInspectConfig, connection: RtcConnection ): number;
Details
This method can take screenshots for multiple video streams and upload them. When video screenshot and upload function is enabled, the SDK takes screenshots and uploads videos sent by local users based on the type and frequency of the module you set in ContentInspectConfig. After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.
Parameters
- enabled
- Whether to enable video screenshot and upload:
true
: Enables video screenshot and upload.false
: Disables video screenshot and upload.
- config
- Configuration of video screenshot and upload. See ContentInspectConfig.Note: When the video moderation module is set to video moderation via Agora self-developed extension(ContentInspectSupervision), the video screenshot and upload dynamic library
libagora_content_inspect_extension.dll
is required. Deleting this library disables the screenshot and upload feature. - connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
enableLoopbackRecordingEx
Enables loopback audio capturing.
abstract enableLoopbackRecordingEx( connection: RtcConnection, enabled: boolean, deviceName?: string ): number;
Details
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.
Parameters
- connection
- The connection information. See RtcConnection.
- enabled
- Sets whether to enable loopback audio capture:
true
: Enable loopback audio capturing.false
: (Default) Disable loopback audio capturing.
- 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.
enableDualStreamModeEx
Enables or disables dual-stream mode on the sender side.
abstract enableDualStreamModeEx( enabled: boolean, streamConfig: SimulcastStreamConfig, connection: RtcConnection ): number;
Details
- High-quality video stream: High bitrate, high resolution.
- Low-quality video stream: Low bitrate, low resolution.
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.
Parameters
- enabled
-
Whether to enable dual-stream mode:
true
: Enable dual-stream mode.false
: (Default) Disable dual-stream mode.
- streamConfig
-
The configuration of the low-quality video stream. See SimulcastStreamConfig.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
getConnectionStateEx
Gets the current connection state of the SDK.
abstract getConnectionStateEx(connection: RtcConnection): ConnectionStateType;
Details
You can call this method either before or after joining a channel.
Parameters
- connection
- The connection information. See RtcConnection.
Returns
The current connection state. See ConnectionStateType.
joinChannelEx
Joins a channel with the connection ID.
abstract joinChannelEx( token: string, connection: RtcConnection, options: ChannelMediaOptions ): number;
Details
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.
Parameters
- token
- The token generated on your server for authentication. See .Note: If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See Secure authentication with tokens.
- connection
- The connection information. See RtcConnection.
- 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.
joinChannelWithUserAccountEx
Joins the channel with a user account, and configures whether to automatically subscribe to audio or video streams after joining the channel.
abstract joinChannelWithUserAccountEx( token: string, channelId: string, userAccount: string, options: ChannelMediaOptions ): number;
Details
- The local client: onLocalUserRegistered, onJoinChannelSuccess and onConnectionStateChanged callbacks.
- The remote client: The onUserJoined callback, if the user is in the COMMUNICATION profile, and the onUserInfoUpdated callback if the user is a host in the LIVE_BROADCASTING profile.
Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.
Parameters
- token
- The token generated on your server for authentication. See .Note: If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See Secure authentication with tokens.
- channelId
-
The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters:
- All lowercase English letters: a to z.
- All uppercase English letters: A to Z.
- All numeric characters: 0 to 9.
- Space
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
- userAccount
-
The user account. This parameter is used to identify the user in the channel for real-time audio and video engagement. You need to set and manage user accounts yourself and ensure that each user account in the same channel is unique. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as NULL. Supported characters are (89 in total):
- The 26 lowercase English letters: a to z.
- The 26 uppercase English letters: A to Z.
- All numeric characters: 0 to 9.
- Space
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
- options
- The channel media options. See ChannelMediaOptions.
Returns
- 0: Success.
- < 0: Failure.
leaveChannelEx
Sets channel options and leaves the channel.
abstract leaveChannelEx( connection: RtcConnection, options?: LeaveChannelOptions ): number;
Details
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.
- If you want to leave the channels that you joined by calling joinChannel and joinChannelEx, call the leaveChannel method.
Parameters
- connection
- The connection information. See RtcConnection.
- options
-
The options for leaving the channel. See LeaveChannelOptions.
Note: This parameter only supports the stopMicrophoneRecording member in the LeaveChannelOptions settings; setting other members does not take effect.
Returns
- 0: Success.
- < 0: Failure.
muteAllRemoteAudioStreamsEx
Stops or resumes subscribing to the audio streams of all remote users.
abstract muteAllRemoteAudioStreamsEx( mute: boolean, connection: RtcConnection ): number;
Details
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.
Parameters
- 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.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
muteAllRemoteVideoStreamsEx
Stops or resumes subscribing to the video streams of all remote users.
abstract muteAllRemoteVideoStreamsEx( mute: boolean, connection: RtcConnection ): number;
Details
After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.
Parameters
- 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.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
muteLocalAudioStreamEx
Stops or resumes publishing the local audio stream.
abstract muteLocalAudioStreamEx( mute: boolean, connection: RtcConnection ): number;
Details
A successful call of this method triggers the onUserMuteAudio and onRemoteAudioStateChanged callbacks on the remote client.
Parameters
- mute
-
Whether to stop publishing the local audio stream:
true
: Stops publishing the local audio stream.false
: (Default) Resumes publishing the local audio stream.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
muteLocalVideoStreamEx
Stops or resumes publishing the local video stream.
abstract muteLocalVideoStreamEx( mute: boolean, connection: RtcConnection ): number;
Details
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.
Parameters
- mute
-
Whether to stop publishing the local video stream.
true
: Stop publishing the local video stream.false
: (Default) Publish the local video stream.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
muteRemoteAudioStreamEx
Stops or resumes receiving the audio stream of a specified user.
abstract muteRemoteAudioStreamEx( uid: number, mute: boolean, connection: RtcConnection ): number;
Details
This method is used to stops or resumes receiving the audio 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.Parameters
- uid
- The ID of the specified user.
- 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.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
muteRemoteVideoStreamEx
Stops or resumes receiving the video stream of a specified user.
abstract muteRemoteVideoStreamEx( uid: number, mute: boolean, connection: RtcConnection ): number;
Details
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.
Parameters
- uid
-
The user ID of the remote user.
- 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.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
pauseAllChannelMediaRelayEx
Pauses the media stream relay to all target channels.
abstract pauseAllChannelMediaRelayEx(connection: RtcConnection): number;
Details
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.
Parameters
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
resumeAllChannelMediaRelayEx
Resumes the media stream relay to all target channels.
abstract resumeAllChannelMediaRelayEx(connection: RtcConnection): number;
Details
After calling the pauseAllChannelMediaRelayEx method, you can call this method to resume relaying media streams to all destination channels.
Parameters
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
sendCustomReportMessageEx
Agora supports reporting and analyzing customized messages.
abstract sendCustomReportMessageEx( id: string, category: string, event: string, label: string, value: number, connection: RtcConnection ): number;
Details
Agora supports reporting and analyzing customized messages. This function is in the beta stage with a free trial. The ability provided in its beta test version is reporting a maximum of 10 message pieces within 6 seconds, with each message piece not exceeding 256 bytes and each string not exceeding 100 bytes. To try out this function, contact support@agora.io and discuss the format of customized messages with us.
setDualStreamModeEx
Sets the dual-stream mode on the sender side.
abstract setDualStreamModeEx( mode: SimulcastStreamMode, streamConfig: SimulcastStreamConfig, connection: RtcConnection ): number;
Details
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).
- 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.
Parameters
- mode
- The mode in which the video stream is sent. See SimulcastStreamMode.
- streamConfig
-
The configuration of the low-quality video stream. See SimulcastStreamConfig.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
setRemoteVideoStreamTypeEx
Sets the stream type of the remote video.
abstract setRemoteVideoStreamTypeEx( uid: number, streamType: VideoStreamType, connection: RtcConnection ): number;
Details
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.
Parameters
- uid
- The user ID.
- streamType
-
The video stream type: VideoStreamType.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
setRemoteVoicePositionEx
Sets the 2D position (the position on the horizontal plane) of the remote user's voice.
abstract setRemoteVoicePositionEx( uid: number, pan: number, gain: number, connection: RtcConnection ): number;
Details
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.
Parameters
- uid
- The user ID of the remote user.
- 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.
- 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.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
setSubscribeAudioBlocklistEx
Set the blocklist of subscriptions for audio streams.
abstract setSubscribeAudioBlocklistEx( uidList: number[], uidNumber: number, connection: RtcConnection ): number;
Details
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.
Parameters
- 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.
- uidNumber
- The number of users in the user ID list.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
setSubscribeAudioAllowlistEx
Sets the allowlist of subscriptions for audio streams.
abstract setSubscribeAudioAllowlistEx( uidList: number[], uidNumber: number, connection: RtcConnection ): number;
Details
You can call this method to specify the audio streams of a user that you want to subscribe to.
- 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.
- If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.
Parameters
- 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.
- uidNumber
- The number of users in the user ID list.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
setSubscribeVideoBlocklistEx
Set the blocklist of subscriptions for video streams.
abstract setSubscribeVideoBlocklistEx( uidList: number[], uidNumber: number, connection: RtcConnection ): number;
Details
You can call this method to specify the video 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 muteRemoteVideoStream, muteAllRemoteVideoStreams 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.
Parameters
- 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.
- uidNumber
- The number of users in the user ID list.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
setSubscribeVideoAllowlistEx
Set the allowlist of subscriptions for video streams.
abstract setSubscribeVideoAllowlistEx( uidList: number[], uidNumber: number, connection: RtcConnection ): number;
Details
You can call this method to specify the video streams of a user that you want to subscribe to.
- 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.
- Once the allowlist 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.
Parameters
- 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.
- uidNumber
- The number of users in the user ID list.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
setupRemoteVideoEx
Initializes the video view of a remote user.
abstract setupRemoteVideoEx( canvas: VideoCanvas, connection: RtcConnection ): number;
Details
This method initializes the video view of a remote stream on the local device. It affects only the video view that the local user sees. Call this method to bind the remote video stream to a video view and to set the rendering and mirror modes of the video view.
The application specifies the uid of the remote video in the VideoCanvas method before the remote user joins the channel.
If the remote uid is unknown to the application, set it after the application receives the onUserJoined callback. If the Video Recording function is enabled, the Video Recording Service joins the channel as a dummy client, causing other clients to also receive the onUserJoined
callback. Do not bind the dummy client to the application view because the dummy client does not send any video streams.
To unbind the remote user from the view, set the view parameter to NULL.
Once the remote user leaves the channel, the SDK unbinds the remote user.
To update the rendering or mirror mode of the remote video view during a call, use the setRemoteRenderModeEx method.
Parameters
- canvas
-
The remote video view settings. See VideoCanvas.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
setVideoEncoderConfigurationEx
Sets the encoder configuration for the local video.
abstract setVideoEncoderConfigurationEx( config: VideoEncoderConfiguration, connection: RtcConnection ): number;
Details
Each configuration profile corresponds to a set of video parameters, including the resolution, frame rate, and bitrate.
The config specified in this method is the maximum value under ideal network conditions. If the video engine cannot render the video using the specified config due to unreliable network conditions, the parameters further down the list are considered until a successful configuration is found.
Parameters
- config
- Video profile. See VideoEncoderConfiguration.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
setRemoteVideoSubscriptionOptionsEx
Options for subscribing to remote video streams.
abstract setRemoteVideoSubscriptionOptionsEx( uid: number, options: VideoSubscriptionOptions, connection: RtcConnection ): number;
Details
When a remote user has enabled dual-stream mode, you can call this method to choose the option for subscribing to the video streams sent by the remote user.
Parameters
- uid
- The user ID of the remote user.
- options
- The video subscription options. See VideoSubscriptionOptions.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
sendStreamMessageEx
Sends data stream messages.
abstract sendStreamMessageEx(streamId: number, data: Uint8Array, length: number, connection: RtcConnection): number;
Details
After calling createDataStreamEx, you can call this method to send data stream messages to all users in the channel.
- 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.
Parameters
- streamId
- The data stream ID. You can get the data stream ID by calling createDataStreamEx.
- data
- The message to be sent.
- length
- The length of the data.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
startRtmpStreamWithoutTranscodingEx
Starts pushing media streams to a CDN without transcoding.
abstract startRtmpStreamWithoutTranscodingEx( url: string, connection: RtcConnection ): number;
Details
Agora recommends that you use the server-side Media Push function. For details, see Use RESTful API.
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.
- 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.
Parameters
- 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.
- 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.
startRtmpStreamWithTranscodingEx
Starts Media Push and sets the transcoding configuration.
abstract startRtmpStreamWithTranscodingEx( url: string, transcoding: LiveTranscoding, connection: RtcConnection ): number;
Details
Agora recommends that you use the server-side Media Push function. For details, see Use RESTful API.
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.
Parameters
- 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.
- transcoding
-
The transcoding configuration for Media Push. See LiveTranscoding.
- 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.
stopRtmpStreamEx
Stops pushing media streams to a CDN.
abstract stopRtmpStreamEx(url: string, connection: RtcConnection): number;
Details
Agora recommends that you use the server-side Media Push function. For details, see Use RESTful API.
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.
Parameters
- 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.
takeSnapshotEx
Takes a snapshot of a video stream.
abstract takeSnapshotEx( connection: RtcConnection, uid: number, filePath: string ): number;
Details
This method takes a snapshot of a video stream from the specified user, generates a JPG image, and saves it to the specified path.
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.
- 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.
Parameters
- connection
- The connection information. See RtcConnection.
- uid
- The user ID. Set uid as 0 if you want to take a snapshot of the local user's video.
- 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
- Windows:
Returns
- 0: Success.
- < 0: Failure.
updateRtmpTranscodingEx
Updates the transcoding configuration.
abstract updateRtmpTranscodingEx( transcoding: LiveTranscoding, connection: RtcConnection ): number;
Details
Agora recommends that you use the server-side Media Push function. For details, see Use RESTful API.
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.
Parameters
- transcoding
-
The transcoding configuration for Media Push. See LiveTranscoding.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
startChannelMediaRelayEx
Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels.
abstract startChannelMediaRelayEx( configuration: ChannelMediaRelayConfiguration, connection: RtcConnection ): number;
Details
- Deprecated:
- This method is deprecated. Use startOrUpdateChannelMediaRelayEx instead.
- 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 technical support.
- Agora does not support string user accounts in this API.
Parameters
- configuration
- The configuration of the media stream relay. See ChannelMediaRelayConfiguration.
- 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 a host.
- -8: Internal state error. Probably because the user is not a broadcaster.
stopChannelMediaRelayEx
Stops the media stream relay. Once the relay stops, the host quits all the target channels.
abstract stopChannelMediaRelayEx(connection: RtcConnection): number;
Details
After a successful method call, the SDK triggers the onChannelMediaRelayStateChanged callback. If the callback reports RelayStateIdle (0) and RelayOk (0), the host successfully stops the relay.
Parameters
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
updateChannelMediaOptionsEx
Updates the channel media options after joining the channel.
abstract updateChannelMediaOptionsEx( options: ChannelMediaOptions, connection: RtcConnection ): number;
Parameters
- options
- The channel media options. See ChannelMediaOptions.
- 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.
updateChannelMediaRelayEx
Updates the channels for media stream relay.
abstract updateChannelMediaRelayEx( configuration: ChannelMediaRelayConfiguration, connection: RtcConnection ): number;
Details
- 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.
(RelayStateRunning, RelayOk)
; otherwise, the method call fails.Parameters
- configuration
- The configuration of the media stream relay. See ChannelMediaRelayConfiguration.
- connection
- The connection information. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.