IRtcEngineEx
This interface class contains multi-channel methods.
Inherited from IRtcEngine.
addVideoWatermarkEx
Adds a watermark image to the local video.
virtual int addVideoWatermarkEx(const char* watermarkUrl,
const WatermarkOptions& options,
const RtcConnection& connection) = 0;
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. Agora supports adding only one watermark image onto the local video, and the newly watermark image replaces the previous one.
- If the orientation mode of the encoding video (ORIENTATION_MODE) is fixed landscape mode or the adaptive landscape mode, the watermark uses the landscape orientation.
- If the orientation mode of the encoding video (ORIENTATION_MODE) 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 setVideoEncoderConfigurationEx dimensions set in the 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 [1/2] 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. For details, see WatermarkOptions.
- connection
- The connection infomation. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
clearVideoWatermarkEx
Removes the watermark image from the video stream.
virtual int clearVideoWatermarkEx(const RtcConnection& connection) = 0;
Parameters
- connection
- The connection infomation. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
createDataStreamEx [1/2]
Creates a data stream.
virtual int createDataStreamEx(int* streamId, bool reliable, bool ordered, const RtcConnection& connection) = 0;
- Deprecated:
- This method is deprecated. Use createDataStreamEx [2/2] instead.
You can call this method to create a data stream and improve the reliability and ordering of data transmission.
- Ensure that you set the same value for reliable and ordered.
- Each user can create up to five data streams during the lifecycle of IRtcEngine.
- The data channel allows a data delay of up to 5 seconds. If the receiver does not receive the data stream within 5 seconds, the data channel reports an error.
Parameters
- streamId
- Output parameter. Pointer to the ID of the created data stream.
- reliable
-
Sets whether the recipients are guaranteed to receive the data stream from the sender within five seconds:
true
: The recipients receive the data stream from the sender within five seconds. If the recipient does not receive the data stream within five seconds, an error is reported to the application.false
: There is no guarantee that the recipients receive the data stream from the sender within five seconds. The SDK does not report errors if reception is delayed or data is lost.
- ordered
-
Sets whether the recipients receive the data stream in the sent order:
true
: The recipients receive the data stream in the sent order.false
: There is no guarantee that the recipients receive the data stream in the sent order.
- connection
- The connection infomation. See RtcConnection.
Returns
- 0: The data stream is successfully created.
- < 0: Fails to create the data stream.
createDataStreamEx [2/2]
Creates a data stream.
virtual int createDataStreamEx(int* streamId, DataStreamConfig& config, const RtcConnection& connection) = 0;
Creates a data stream. Each user can create up to five data streams in a single channel.
Compared with createDataStreamEx [1/2] , 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.
Parameters
- streamId
- Output parameter. Pointer to the ID of the created data stream.
- config
- The configurations for the data stream. See DataStreamConfig.
- connection
- The connection infomation. See RtcConnection.
Returns
- 0: The data stream is successfully created.
- < 0: Failure.
enableDualStreamModeEx
Enables or disables dual-stream mode on the sender side.
virtual int enableDualStreamModeEx(bool enabled, const SimulcastStreamConfig& streamConfig,
const RtcConnection& connection) = 0;
- Since
- v4.0.1
- 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.
- This method is applicable to all types of streams from the sender, including but not limited to video streams collected from cameras, screen sharing streams, and custom-collected video streams.
- If you need to enable dual video streams in a multi-channel scenario, you can call the enableDualStreamModeEx method.
- You can call this method either before or after joining a channel.
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 infomation. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
enableLoopbackRecordingEx
Enables loopback audio capture.
virtual int enableLoopbackRecordingEx(const RtcConnection& connection, bool enabled, const char* deviceName = NULL) = 0;
If you enable loopback audio capture, the output of the sound card is mixed into the audio stream sent to the other end.
- Applies to the macOS and Windows platforms only.
- macOS does not support loopback audio capture of the default sound card. If you need to use this method, use a virtual sound card and pass its name to the deviceName parameter. Agora recommends that you use Soundflower for loopback audio capture.
- You can call this method either before or after joining a channel.
Parameters
- connection
- The connection infomation. See RtcConnection.
- enabled
- Sets whether to enable loopback audio capture:
true
: Enable loopback audio capture.false
: (Default) Disable loopback audio capture.
- deviceName
-
- macOS: The device name of the virtual sound card. The default is set to null, which means the SDK uses Soundflower for loopback audio capture.
- 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 capture.
Returns
- 0: Success.
- < 0: Failure.
getConnectionStateEx
Gets the current connection state of the SDK.
virtual CONNECTION_STATE_TYPE getConnectionStateEx(const RtcConnection& connection) = 0;
You can call this method either before or after joining a channel.
Parameters
- connection
- The connection infomation. See RtcConnection.
Returns
The current connection state. For details, see CONNECTION_STATE_TYPE.
joinChannelEx
Joins a channel with the connection ID.
virtual int joinChannelEx(const char* token, const RtcConnection& connection,
const ChannelMediaOptions& options,
IRtcEngineEventHandler* eventHandler) = 0;
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.
- In a multi-camera capture scenario, you need to call the startPreview [2/2] method after calling this method to set the sourceType to VIDEO_SOURCE_CAMERA_SECONDARY, to ensure that the second camera captures normally.
Parameters
- token
- The token generated on your server for authentication. See .
- connection
- The connection infomation. See RtcConnection.
- options
- The channel media options. See ChannelMediaOptions.
- eventHandler
- The callback class of IRtcEngineEx. For details, see IRtcEngineEventHandler.
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 the ChannelMediaOptions structure 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: IRtcEngineThe internal state of the object is wrong. The typical cause is that you call this method to join the channel without calling stopEchoTest to stop the test after calling startEchoTest [2/3] 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 using the onConnectionStateChanged callback to get whether the user is in the channel. Do not call this method to join the channel unless you receive the CONNECTION_STATE_DISCONNECTED(1) state.
- -102: The channel name is invalid. You need to pass in a valid channel name inchannelId 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.
virtual int joinChannelWithUserAccountEx(const char* token, const char* channelId,
const char* userAccount, const ChannelMediaOptions& options,
IRtcEngineEventHandler* eventHandler) = 0;
- 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 .
- 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.
- eventHandler
- The callback class of IRtcEngineEx. For details, see IRtcEngineEventHandler.
Returns
- 0: Success.
- < 0: Failure.
leaveChannelEx
Leaves a channel.
virtual int leaveChannelEx(const RtcConnection& connection, const LeaveChannelOptions& options) = 0;
Parameters
- connection
- The connection infomation. See RtcConnection.
- options
-
- Since
- v4.1.0
The options for leaving the channel. See LeaveChannelOptions.
Note: This parameter only supports the stopMicrophoneRecording member in the LeaveChannelOptionssettings; setting other members does not take effect.
Returns
- 0: Success.
- < 0: Failure.
muteRemoteAudioStreamEx
Stops or resumes receiving the audio stream of a specified user.
virtual int muteRemoteAudioStreamEx(uid_t uid, bool mute, const RtcConnection& connection) = 0;
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 infomation. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
muteRemoteVideoStreamEx
Stops or resumes receiving the video stream of a specified user.
virtual int muteRemoteVideoStreamEx(uid_t uid, bool mute, const RtcConnection& connection) = 0;
This method is used to stops or resumes 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 infomation. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
sendCustomReportMessageEx
Agora supports reporting and analyzing customized messages.
virtual int sendCustomReportMessageEx(const char* id, const char* category, const char* event, const char* label,
int value, const RtcConnection& connection) = 0;
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 dual-stream mode on the sender side.
virtual int setDualStreamModeEx(SIMULCAST_STREAM_MODE mode,
const SimulcastStreamConfig& streamConfig,
const RtcConnection& connection) = 0;
- Since
- v4.0.1
The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to AUTO_SIMULCAST_STREAM. If you want to modify this behavior, you can call this method and modify the mode to DISABLE_SIMULCAST_STREAM(always never send low-quality video streams) or ENABLE_SIMULCAST_STREAM (always send low-quality video streams).
- When calling this method and setting mode to DISABLE_SIMULCAST_STREAM, it has the same effect as
enableDualStreamModeEx(false)
. - When calling this method and setting mode to ENABLE_SIMULCAST_STREAM, it has the same effect as
enableDualStreamModeEx(true)
. - Both methods can be called before and after joining a channel. If they are used at the same time, the settings in the method called later shall prevail.
Parameters
- mode
- The mode in which the video stream is sent. See SIMULCAST_STREAM_MODE.
- streamConfig
-
The configuration of the low-quality video stream. See SimulcastStreamConfig.
- connection
- The connection infomation. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
setRemoteVoicePositionEx
Sets the 2D position (the position on the horizontal plane) of the remote user's voice.
virtual int setRemoteVoicePositionEx(uid_t uid, double pan, double gain, const RtcConnection& connection) = 0;
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 infomation. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
setSubscribeAudioBlacklistEx
Set the blocklist of subscriptions for audio streams.
virtual int setSubscribeAudioBlacklistEx(uid_t* uidList, int uidNumber, const RtcConnection& connection) = 0;
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 setSubscribeAudioBlacklist 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 infomation. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
setSubscribeAudioWhitelistEx
Sets the allowlist of subscriptions for audio streams.
virtual int setSubscribeAudioWhitelistEx(uid_t* uidList, int uidNumber, const RtcConnection& connection) = 0;
You can call this method to specify the audio streams of a user that you want to subscribe to.
- 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.
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 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 infomation. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
setSubscribeVideoBlacklistEx
Set the bocklist of subscriptions for video streams.
virtual int setSubscribeVideoBlacklistEx(uid_t* uidList, int uidNumber, const RtcConnection& connection) = 0;
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 setSubscribeVideoBlacklist 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 infomation. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
setSubscribeVideoWhitelistEx
Set the allowlist of subscriptions for video streams.
virtual int setSubscribeVideoWhitelistEx(uid_t* uidList, int uidNumber, const RtcConnection& connection) = 0;
You can call this method to specify the video streams of a user that you want to subscribe to.
- The allowlist is not affected by the setting in muteRemoteVideoStream, muteAllRemoteVideoStreams and autoSubscribeAudio in ChannelMediaOptions.
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 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 infomation. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
setupRemoteVideoEx
Initializes the video view of a remote user.
virtual int setupRemoteVideoEx(const VideoCanvas& canvas, const RtcConnection& connection) = 0;
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.
Parameters
- canvas
-
The remote video view settings. See VideoCanvas.
- connection
- The connection infomation. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
setVideoEncoderConfigurationEx
Sets the encoder configuration for the local video.
virtual int setVideoEncoderConfigurationEx(const VideoEncoderConfiguration& config, const RtcConnection& connection) = 0;
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 values under ideal network conditions. If the network condition is not good, the video engine cannot use the config renders local video, which automatically reduces to an appropriate video parameter setting.
Parameters
- config
- Video profile. See VideoEncoderConfiguration.
- connection
- The connection infomation. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
sendStreamMessageEx
Sends data stream messages.
virtual int sendStreamMessageEx(int streamId, const char* data, size_t length, const RtcConnection& connection) = 0;
After calling createDataStreamEx [2/2], you can call this method to send data stream messages to all users in the channel.
- Up to 30 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 6 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 [2/2] 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 [2/2].
- data
- The data to be sent.
- length
- The length of the data.
- connection
- The connection infomation. See RtcConnection.
Returns
- 0: Success.
- < 0: Failure.
takeSnapshotEx
Takes a snapshot of a video stream.
virtual int takeSnapshotEx(const RtcConnection& connection, uid_t uid, const char* filePath) = 0;
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.
- 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.
Parameters
- connection
- The connection infomation. 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
- iOS:
/App Sandbox/Library/Caches/example.jpg
- macOS:
~/Library/Logs/example.jpg
- Android:
/storage/emulated/0/Android/data/<package name>/files/example.jpg
- Windows:
Returns
- 0: Success.
- < 0: Failure.
updateChannelMediaOptionsEx
Updates the channel media options after joining the channel.
virtual int updateChannelMediaOptionsEx(const ChannelMediaOptions& options, const RtcConnection& connection) = 0;
Parameters
- options
- The channel media options. See ChannelMediaOptions.
- connection
- The connection infomation. 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 using the onConnectionStateChanged callback to get whether the user is in the channel. If you receive the CONNECTION_STATE_DISCONNECTED (1) or CONNECTION_STATE_FAILED (5) state, the user is not in the channel. You need to call joinChannel [2/2] to join a channel before calling this method.