IRtcEngine
The basic interface of the Agora SDK that implements the core functions of real-time communication.
IRtcEngine provides the main methods that your app can call.
Before calling other APIs, you must call createAgoraRtcEngine to create an IRtcEngine object.
addVideoWatermark [1/2]
Adds a watermark image to the local video.
virtual int addVideoWatermark(const RtcImage& watermark) = 0;
Details
- Deprecated:
- This method is deprecated. Use addVideoWatermark [2/2] instead.
This method adds a PNG watermark image to the local video stream in a live streaming session. Once the watermark image is added, all the users in the channel (CDN audience included) and the video capturing device can see and capture it. If you only want to add a watermark to the CDN live streaming, see descriptions in setLiveTranscoding.
- The URL descriptions are different for the local video and CDN live streaming: In a local video stream, URL refers to the absolute path of the added watermark image file in the local video stream. In a CDN live stream, URL refers to the URL address of the added watermark image in the CDN live streaming.
- The source file of the watermark image must be in the PNG file format. If the width and height of the PNG file differ from your settings in this method, the PNG file will be cropped to conform to your settings.
- 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.
Parameters
- watermark
- The watermark image to be added to the local live streaming: RtcImage.
Returns
- 0: Success.
- < 0: Failure.
addVideoWatermark [2/2]
Adds a watermark image to the local video.
virtual int addVideoWatermark(const char* watermarkUrl, const WatermarkOptions& options) = 0;
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 (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 dimensions set in the setVideoEncoderConfiguration method; otherwise, the watermark image will be cropped.
- Ensure that calling this method after enableVideo.
- If you only want to add a watermark to the media push, you can call this method or the setLiveTranscoding 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. See WatermarkOptions.
Returns
- 0: Success.
- < 0: Failure.
adjustAudioMixingPlayoutVolume
Adjusts the volume of audio mixing for local playback.
virtual int adjustAudioMixingPlayoutVolume(int volume) = 0;
Details
onAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)
callback.Parameters
- volume
- The volume of audio mixing for local playback. The value ranges between 0 and 100 (default). 100 represents the original volume.
Returns
- 0: Success.
- < 0: Failure.
adjustAudioMixingPublishVolume
Adjusts the volume of audio mixing for publishing.
virtual int adjustAudioMixingPublishVolume(int volume) = 0;
Details
This method adjusts the volume of audio mixing for publishing (sending to other users).
Call this method after calling startAudioMixing [2/2] and receiving the onAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)
callback.
Parameters
- volume
- The volume of audio mixing for local playback. The value ranges between 0 and 100 (default). 100 represents the original volume.
Returns
- 0: Success.
- < 0: Failure.
adjustAudioMixingVolume
Adjusts the volume during audio mixing.
virtual int adjustAudioMixingVolume(int volume) = 0;
Details
This method adjusts the audio mixing volume on both the local client and remote clients.
- Call this method after startAudioMixing [2/2].
- This method does not affect the playback volume you set through the playEffect method.
Parameters
- volume
- Audio mixing volume. The value ranges between 0 and 100. The default value is 100, which means the original volume.
Returns
- 0: Success.
- < 0: Failure.
adjustCustomAudioPublishVolume
Adjusts the volume of the custom external audio source when it is published in the channel.
virtual int adjustCustomAudioPublishVolume(track_id_t trackId, int volume) = 0;
Details
If you want to change the volume of the audio to be published, you need to call this method again.
Parameters
- trackId
- The audio track ID. Set this parameter to the custom audio track ID returned in createCustomAudioTrack.
- volume
- The volume of the audio source. The value can range from 0 to 100. 0 means mute; 100 means the original volume.
Returns
- 0: Success.
- < 0: Failure.
adjustLoopbackSignalVolume
Adjusts the volume of the signal captured by the sound card.
virtual int adjustLoopbackSignalVolume(int volume) = 0;
Details
After calling enableLoopbackRecording to enable loopback audio capturing, you can call this method to adjust the volume of the signal captured by the sound card.
Parameters
- volume
- Audio mixing volume. The value ranges between 0 and 100. The default value is 100, which means the original volume.
Returns
- 0: Success.
- < 0: Failure.
adjustPlaybackSignalVolume
Adjusts the playback signal volume of all remote users.
virtual int adjustPlaybackSignalVolume(int volume) = 0;
Details
- This method adjusts the playback volume that is the mixed volume of all remote users.
- You can call this method either before or after joining a channel.
Parameters
- volume
-
The volume of the user. The value range is [0,400].
- 0: Mute.Note: If you only need to mute the audio signal, Agora recommends that you use muteRecordingSignal instead.
- 100: (Default) The original volume.
- 400: Four times the original volume (amplifying the audio signals by four times).
- 0: Mute.
Returns
- 0: Success.
- < 0: Failure.
adjustRecordingSignalVolume
Adjusts the capturing signal volume.
virtual int adjustRecordingSignalVolume(int volume) = 0;
Details
You can call this method either before or after joining a channel.
Parameters
- volume
-
The volume of the user. The value range is [0,400].
- 0: Mute.Note: If you only need to mute the audio signal, Agora recommends that you use muteRecordingSignal instead.
- 100: (Default) The original volume.
- 400: Four times the original volume (amplifying the audio signals by four times).
- 0: Mute.
Returns
- 0: Success.
- < 0: Failure.
adjustUserPlaybackSignalVolume
Adjusts the playback signal volume of a specified remote user.
virtual int adjustUserPlaybackSignalVolume(unsigned int uid, int volume) = 0;
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.
Returns
- 0: Success.
- < 0: Failure.
clearVideoWatermarks
Removes the watermark image from the video stream.
virtual int clearVideoWatermarks() = 0;
Returns
- 0: Success.
- < 0: Failure.
complain
Allows a user to complain about the call quality after a call ends.
virtual int complain(const char* callId, const char* description) = 0;
Details
This method allows users to complain about the quality of the call. Call this method after the user leaves the channel.
Parameters
- callId
- The current call ID. You can get the call ID by calling getCallId.
- description
- (Optional) A description of the call. The string length should be less than 800 bytes.
Returns
- 0: Success.
- < 0: Failure.
- -2: The parameter is invalid.
- - 3: The SDK is not ready. Possible reasons include the following:
- The initialization of IRtcEngine fails. Reinitialize the IRtcEngine.
- No user has joined the channel when the method is called. Please check your code logic.
- The user has not left the channel when the rate or complain method is called. Please check your code logic.
- The audio module is disabled. The program is not complete.
configRhythmPlayer
Configures the virtual metronome.
virtual int configRhythmPlayer(const AgoraRhythmPlayerConfig& config) = 0;
Details
After calling startRhythmPlayer, you can call this method to reconfigure the virtual metronome.
After successfully calling this method, the SDK triggers the onRhythmPlayerStateChanged callback locally to report the status of the virtual metronome.
- This method is for Android and iOS only.
- After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning, and controls the playback duration of each file according to beatsPerMinute you set in AgoraRhythmPlayerConfig. For example, if you set beatsPerMinute as
60
, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration. - By default, the sound of the virtual metronome is published in the channel. If you do not want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in ChannelMediaOptions as
false
.
Parameters
- config
- The metronome configuration. See AgoraRhythmPlayerConfig.
Returns
- 0: Success.
- < 0: Failure.
initialize
Initializes IRtcEngine.
virtual int initialize(const RtcEngineContext& context) = 0;
Details
All called methods provided by the IRtcEngine class are executed asynchronously. Agora recommends calling these methods in the same thread.
- Before calling other APIs, you must call createAgoraRtcEngine and initialize to create and initialize the IRtcEngine object.
- The SDK supports creating only one IRtcEngine instance for an app.
Parameters
- context
-
Configurations for the IRtcEngine instance. See RtcEngineContext.
Returns
- 0: Success.
- < 0: Failure.
- -1: A general error occurs (no specified reason).
- -2: The parameter is invalid.
- -7: The SDK is not initialized.
- -22: The resource request failed. The SDK fails to allocate resources because your app consumes too much system resource or the system resources are insufficient.
- -101: The App ID is invalid.
createAgoraRtcEngine
Creates one IRtcEngine object.
AGORA_API agora::rtc::IRtcEngine *AGORA_CALL createAgoraRtcEngine ()
Details
Currently, the Agora RTC SDK v4.x supports creating only one IRtcEngine object for each app.
Returns
Pointer to the IRtcEngine object.
createDataStream [1/2]
Creates a data stream.
virtual int createDataStream(int* streamId, bool reliable, bool ordered) = 0;
Details
Each user can create up to five data streams during the lifecycle of IRtcEngine. The data stream will be destroyed when leaving the channel, and the data stream needs to be recreated if needed.
- Call this method after joining a channel.
- Agora does not support setting reliable as
true
and ordered asfalse
.
Parameters
- streamId
- An output parameter; the ID of the data stream created.
- reliable
-
Whether or not the data stream is reliable:
true
: The recipients receive the data from the sender within five seconds. If the recipient does not receive the data within five seconds, the SDK triggers the onStreamMessageError callback and returns an error code.false
: There is no guarantee that the recipients receive the data stream within five seconds and no error message is reported for any delay or missing data stream.
- ordered
-
Whether or not the recipients receive the data stream in the sent order:
true
: The recipients receive the data in the sent order.false
: The recipients do not receive the data in the sent order.
Returns
- 0: The data stream is successfully created.
- < 0: Failure.
createDataStream [2/2]
Creates a data stream.
virtual int createDataStream(int* streamId, DataStreamConfig& config) = 0;
Details
Creates a data stream. Each user can create up to five data streams in a single channel.
Compared with createDataStream [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
- An output parameter; the ID of the data stream created.
- config
- The configurations for the data stream. See DataStreamConfig.
Returns
- 0: The data stream is successfully created.
- < 0: Failure.
createMediaPlayer
Creates a media player instance.
virtual agora_refptr <IMediaPlayer> createMediaPlayer() = 0;
Returns
- The IMediaPlayer instance, if the method call succeeds.
- An empty pointer, if the method call fails.
createMediaRecorder
Creates a recording object for audio and video recording.
virtual agora_refptr<IMediaRecorder> createMediaRecorder(const RecorderStreamInfo& info) = 0;
Details
- Since
- v4.2.0
Before you start recording, you need to call this method to create a recording object. Agora SDKs support recording the audio and video streams of both local and remote users. You can call this method as needed to create muitiple recording objects and specify the streams that you want to record through the info parameter.
After successfully creating a recording object, you need to call setMediaRecorderObserver to register a recording observer to listen for recording callbacks, and then call startRecording to start recording.
Parameters
- info
- The information about the media streams you want to record. See RecorderStreamInfo.
Returns
- The IMediaRecorder object, if the method call succeeds.
- An empty pointer, if the method call fails.
createCustomVideoTrack
Creates a customized video track.
virtual video_track_id_t createCustomVideoTrack() = 0;
Details
- Call this method to create a video track and get the video track ID.
- In each channel's ChannelMediaOptions, set the customVideoTrackId parameter to the ID of the video track you want to publish, and set publishCustomVideoTrack to
true
. - If you call pushVideoFrame, and specify customVideoTrackId as the videoTrackId set in step 2, you can publish the corresponding custom video source in multiple channels.
Returns
- If the method call is successful, the video track ID is returned as the unique identifier of the video track.
- If the method call fails, a negative value is returned.
destroyCustomVideoTrack
Destroys the specified video track.
virtual int destroyCustomVideoTrack(video_track_id_t video_track_id) = 0;
Parameters
- video_track_id
- The video track ID returned by calling the createCustomVideoTrack method.
Returns
- 0: Success.
- < 0: Failure.
destroyMediaPlayer
Destroys the media player instance.
virtual int destroyMediaPlayer(agora_refptr<IMediaPlayer> media_player) = 0;
Parameters
- media_player
-
One IMediaPlayer object.
Returns
- ≥ 0: Success. Returns the ID of media player instance.
- < 0: Failure.
destroyMediaRecorder
Destroys a recording object for audio and video recording.
virtual int destroyMediaRecorder(agora_refptr<IMediaRecorder> mediaRecorder) = 0;
Details
- Since
- v4.2.0
When you do not need to record any audio and video streams, you can call this method to destroy the recording object. Before you call this method, if you are recording a media stream, you need to call stopRecording to stop recording.
Parameters
- mediaRecorder
- The recording object to be destroyed.
Returns
- 0: Success.
- < 0: Failure.
disableAudio
Disables the audio module.
virtual int disableAudio() = 0;
Details
- This method disables the internal engine and can be called anytime after initialization. It is still valid after one leaves channel.
- This method resets the internal engine and takes some time to take effect. Agora recommends using the following API methods to control the audio modules separately:
- enableLocalAudio: Whether to enable the microphone to create the local audio stream.
- muteLocalAudioStream: Whether to publish the local audio stream.
- muteRemoteAudioStream: Whether to subscribe and play the remote audio stream.
- muteAllRemoteAudioStreams: Whether to subscribe to and play all remote audio streams.
Returns
- 0: Success.
- < 0: Failure.
disableAudioSpectrumMonitor
Disables audio spectrum monitoring.
virtual int disableAudioSpectrumMonitor() = 0;
Details
After calling enableAudioSpectrumMonitor, if you want to disable audio spectrum monitoring, you can call this method.
You can call this method either before or after joining a channel.
Returns
- 0: Success.
- < 0: Failure.
disableVideo
Disables the video module.
virtual int disableVideo() = 0;
Details
This method can be called before joining a channel or during a call to disable the video module. If it is called before joining a channel, an audio call starts when you join the channel; if called during a call, a video call switches to an audio call. Call enableVideo to enable the video module.
A successful call of this method triggers the onUserEnableVideo (false
) callback on the remote client.
- This method affects the internal engine and can be called after leaving the channel.
- This method resets the internal engine and thus might takes some time to take effect. Agora recommends using the following APIs to control the video modules separately:
- enableLocalVideo: Whether to enable the camera to create the local video stream.
- muteLocalVideoStream: Whether to publish the local video stream.
- muteRemoteVideoStream: Whether to subscribe to and play the remote video stream.
- muteAllRemoteVideoStreams: Whether to subscribe to and play all remote video streams.
Returns
- 0: Success.
- < 0: Failure.
enableAudio
Enables the audio module.
virtual int enableAudio() = 0;
Details
The audio mode is enabled by default.
- This method enables the internal engine and can be called anytime after initialization. It is still valid after one leaves channel.
- This method enables the whole audio module and thus might take a while to take effect. Agora recommends using the following APIs to control the audio module separately:
- enableLocalAudio: Whether to enable the microphone to create the local audio stream.
- muteLocalAudioStream: Whether to publish the local audio stream.
- muteRemoteAudioStream: Whether to subscribe and play the remote audio stream.
- muteAllRemoteAudioStreams: Whether to subscribe to and play all remote audio streams.
Returns
- 0: Success.
- < 0: Failure.
enableAudioSpectrumMonitor
Turns on audio spectrum monitoring.
virtual int enableAudioSpectrumMonitor(int intervalInMS = 100) = 0;
Details
If you want to obtain the audio spectrum data of local or remote users, you can register the audio spectrum observer and enable audio spectrum monitoring.
You can call this method either before or after joining a channel.
Parameters
- intervalInMS
-
The interval (in milliseconds) at which the SDK triggers the onLocalAudioSpectrum and onRemoteAudioSpectrum callbacks. The default value is 100. Do not set this parameter to a value less than 10, otherwise calling this method would fail.
Returns
- 0: Success.
- < 0: Failure.
- -2: Invalid parameters.
enableAudioVolumeIndication
Enables the reporting of users' volume indication.
virtual int enableAudioVolumeIndication(int interval, int smooth, bool reportVad) = 0;
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.
Returns
- 0: Success.
- < 0: Failure.
enableContentInspect
Enables or disables video screenshot and upload.
virtual int enableContentInspect(bool enabled, const media::ContentInspectConfig &config) = 0;
Details
When video screenshot and upload function is enabled, the SDK takes screenshots and upload 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.
- Before calling this method, ensure that the video screenshot upload service has been activated.
- This method relies on the video screenshot and upload dynamic library
libagora_content_inspect_extension.dll
. If the dynamic library is deleted, the function cannot be enabled normally.
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.
Returns
- 0: Success.
- < 0: Failure.
enableDualStreamMode [1/2]
Enables or disables dual-stream mode on the sender side.
virtual int enableDualStreamMode(bool enabled) = 0;
Details
- Deprecated:
- This method is deprecated as of v4.2.0. Use setDualStreamMode [1/2] instead.
- 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.
Returns
- 0: Success.
- < 0: Failure.
enableDualStreamMode [2/2]
Enables or disables the dual-stream mode on the sender and sets the low-quality video stream.
virtual int enableDualStreamMode(bool enabled, const SimulcastStreamConfig& streamConfig) = 0;
Details
- Deprecated:
- This method is deprecated as of v4.2.0. Use setDualStreamMode [2/2] instead.
- 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.
Returns
- 0: Success.
- < 0: Failure.
enableEncryption
Enables or disables the built-in encryption.
virtual int enableEncryption(bool enabled, const EncryptionConfig& config) = 0;
Details
In scenarios requiring high security, Agora recommends calling this method to enable the built-in encryption before joining a channel.
All users in the same channel must use the same encryption mode and encryption key. After the user leaves the channel, the SDK automatically disables the built-in encryption. To enable the built-in encryption, call this method before the user joins the channel again.
Parameters
- enabled
-
Whether to enable built-in encryption:
- true: Enable the built-in encryption.
- false: Disable the built-in encryption.
- config
- Built-in encryption configurations. See EncryptionConfig.
Returns
- 0: Success.
- < 0: Failure.
- -2: An invalid parameter is used. Set the parameter with a valid value.
- -4: The built-in encryption mode is incorrect or the SDK fails to load the external encryption library. Check the enumeration or reload the external encryption library.
- -7: The SDK is not initialized. Initialize the IRtcEngine instance before calling this method.
enableExtension
Enables or disables extensions.
virtual int enableExtension(
const char* provider, const char* extension, bool enable=true, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
Details
To call this method, call it immediately after initializing the IRtcEngine object.
- If you want to enable multiple extensions, you need to call this method multiple times.
- The data processing order of different extensions in the SDK is determined by the order in which the extensions are enabled. That is, the extension that is enabled first will process the data first.
Parameters
- provider
- The name of the extension provider.
- extension
- The name of the extension.
- enable
-
Whether to enable the extension:
true
: Enable the extension.false
: Disable the extension.
- type
- Type of media source. See MEDIA_SOURCE_TYPE.Attention: In this method, this parameter supports only the following two settings:
- The default value is UNKNOWN_MEDIA_SOURCE.
- If you want to use the second camera to capture video, set this parameter to SECONDARY_CAMERA_SOURCE.
Returns
- 0: Success.
- < 0: Failure.
- -3: The extension library is not loaded. Agora recommends that you check the storage location or the name of the dynamic library.
enableFaceDetection
Enables or disables face detection for the local user.
virtual int enableFaceDetection(bool enabled) = 0;
Details
You can call this method either before or after joining a channel.
- The width and height of the local video.
- The position of the human face in the local view.
- The distance between the human face and the screen.
This method needs to be called after the camera is started (for example, by calling startPreview [1/2] or joinChannel [2/2]).
Parameters
- enabled
- Whether to enable face detection for the local user:
true
: Enable face detection.false
: (Default) Disable face detection.
Returns
- 0: Success.
- < 0: Failure.
enableInEarMonitoring
Enables in-ear monitoring.
virtual int enableInEarMonitoring(bool enabled, int includeAudioFilters) = 0;
Details
This method enables or disables in-ear monitoring.
- Users must use earphones (wired or Bluetooth) to hear the in-ear monitoring effect.
- You can call this method either before or after joining a channel.
Parameters
- enabled
- Enables or disables in-ear monitoring.
true
: Enables in-ear monitoring.false
: (Default) Disables in-ear monitoring.
- includeAudioFilters
- The audio filter of in-ear monitoring: See EAR_MONITORING_FILTER_TYPE.
Returns
- 0: Success.
- < 0: Failure.
- - 8: Make sure the current audio routing is Bluetooth or headset.
enableInstantMediaRendering
Enables audio and video frame instant rendering.
virtual int enableInstantMediaRendering() = 0;
Details
- Since
- v4.1.1
- Once the instant rendering function is enabled, it can only be canceled by calling the release method to destroy the IRtcEngine object.
- In this mode, the SDK uses Agora's custom encryption algorithm to shorten the time required to establish transmission links, and the security is reduced compared to the standard DTLS (Datagram Transport Layer Security). If the application scenario requires higher security standards, Agora recommends that you do not use this method.
Applicable scenarios
Agora recommends that you enable this mode for the audience in a live streaming scenario.
Returns
- 0: Success.
- < 0: Failure.
- -7: The method is called before IRtcEngine is initialized.
enableLocalAudio
Enables or disables the local audio capture.
virtual int enableLocalAudio(bool enabled) = 0;
Details
The audio function is enabled by default when users joining a channel. This method disables or re-enables the local audio function to stop or restart local audio capturing.
This method does not affect receiving or playing the remote audio streams, and enableLocalAudio(false)
is applicable to scenarios where the user wants to receive remote audio streams without sending any audio stream to other users in the channel.
- The difference between this method and muteLocalAudioStream are as follow:
- enableLocalAudio: Disables or re-enables the local audio capturing and processing. If you disable or re-enable local audio capturing using the enableLocalAudio method, the local user might hear a pause in the remote audio playback.
- muteLocalAudioStream: Sends or stops sending the local audio streams.
- You can call this method either before or after joining a channel. Calling it before joining a channel only sets the device state, and it takes effect immediately after you join the channel.
Parameters
- enabled
-
true
: (Default) Re-enable the local audio function, that is, to start the local audio capturing device (for example, the microphone).false
: Disable the local audio function, that is, to stop local audio capturing.
Returns
- 0: Success.
- < 0: Failure.
enableLocalVideo
Enables/Disables the local video capture.
virtual int enableLocalVideo(bool enabled) = 0;
Details
This method disables or re-enables the local video capture, and does not affect receiving the remote video stream.
After calling enableVideo, the local video capture is enabled by default. You can call enableLocalVideo(false
) to disable the local video capture. If you want to re-enable the local video capture, call enableLocalVideo(true
).
After the local video capturer is successfully disabled or re-enabled, the SDK triggers the onRemoteVideoStateChanged callback on the remote client.
- You can call this method either before or after joining a channel.
- This method enables the internal engine and is valid after leaving the channel.
Parameters
- enabled
-
Whether to enable the local video capture.
true
: (Default) Enable the local video capture.false
: Disable the local video capture. Once the local video is disabled, the remote users cannot receive the video stream of the local user, while the local user can still receive the video streams of remote users. When set tofalse
, this method does not require a local camera.
Returns
- 0: Success.
- < 0: Failure.
enableLoopbackRecording
Enables loopback audio capturing.
virtual int enableLoopbackRecording(bool enabled, const char* deviceName = NULL) = 0;
Details
If you enable loopback audio capturing, the output of the sound card is mixed into the audio stream sent to the other end.
- This method applies to the macOS and Windows only.
- 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.
- You can call this method either before or after joining a channel.
Parameters
- enabled
- Whether to enable loopback audio capturing.
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.
enableMultiCamera
Enables or disables multi-camera capture.
#if defined(__APPLE__) && TARGET_OS_IOS virtual int enableMultiCamera(bool enabled, const CameraCapturerConfiguration& config) = 0; #endif
Details
- Since
- v4.1.0
- Call this method to enable multi-channel camera capture.
- Call startPreview [1/2] to start the local video preview.
- Call startCameraCapture, and set sourceType to start video capture with the second camera.
- Call joinChannelEx, and set publishSecondaryCameraTrack to
true
to publish the video stream captured by the second camera in the channel.
- Call stopCameraCapture.
- Call this method with enabled set to
false
.
- If it is enabled before startPreview [1/2], the local video preview shows the image captured by the two cameras at the same time.
- If it is enabled after startPreview [1/2], the SDK stops the current camera capture first, and then enables the primary camera and the second camera. The local video preview appears black for a short time, and then automatically returns to normal.
This method applies to iOS only.
When using this function, ensure that the system version is 13.0 or later.
- iPhone XR
- iPhone XS
- iPhone XS Max
- iPad Pro 3rd generation and later
Parameters
- enabled
- Whether to enable multi-camera video capture mode:
true
: Enable multi-camera capture mode; the SDK uses multiple cameras to capture video.false
: Disable multi-camera capture mode; the SDK uses a single camera to capture video.
- config
- Capture configuration for the second camera. See CameraCapturerConfiguration.
Returns
- 0: Success.
- < 0: Failure.
enableSpatialAudio
Enables or disables the spatial audio effect.
virtual int enableSpatialAudio(bool enabled) = 0;
Details
After enabling the spatial audio effect, you can call setRemoteUserSpatialAudioParams to set the spatial audio effect parameters of the remote user.
- You can call this method either before or after joining a channel.
- This method relies on the spatial audio dynamic library
libagora_spatial_audio_extension.dll
. If the dynamic library is deleted, the function cannot be enabled normally.
Parameters
- enabled
- Whether to enable the spatial audio effect:
true
: Enable the spatial audio effect.false
: Disable the spatial audio effect.
Returns
- 0: Success.
- < 0: Failure.
enableSoundPositionIndication
Enables or disables stereo panning for remote users.
virtual int enableSoundPositionIndication(bool enabled) = 0;
Details
Ensure that you call this method before joining a channel to enable stereo panning for remote users so that the local user can track the position of a remote user by calling setRemoteVoicePosition.
Parameters
- enabled
- Whether to enable stereo panning for remote users:
true
: Enable stereo panning.false
: Disable stereo panning.
Returns
- 0: Success.
- < 0: Failure.
enableVideo
Enables the video module.
virtual int enableVideo() = 0;
Details
Call this method either before joining a channel or during a call. If this method is called before joining a channel, the call starts in the video mode; if called during a call, the audio call switches to a video call. Call disableVideo to disable the video mode.
A successful call of this method triggers the onRemoteVideoStateChanged callback on the remote client.
- This method enables the internal engine and is valid after leaving the channel.
- This method resets the internal engine and thus might takes some time to take effect. Agora recommends using the following APIs to control the video modules separately:
- enableLocalVideo: Whether to enable the camera to create the local video stream.
- muteLocalVideoStream: Whether to publish the local video stream.
- muteRemoteVideoStream: Whether to subscribe to and play the remote video stream.
- muteAllRemoteVideoStreams: Whether to subscribe to and play all remote video streams.
Returns
- 0: Success.
- < 0: Failure.
enableVideoImageSource
Sets whether to replace the current video feeds with images when publishing video streams.
virtual int enableVideoImageSource(bool enable, const ImageTrackOptions& options) = 0;
Details
When publishing video streams, you can call this method to replace the current video feeds with custom images.
Once you enable this function, you can select images to replace the video feeds through the ImageTrackOptions parameter. If you disable this function, the remote users see the video feeds that you publish.
Parameters
- enable
- Whether to replace the current video feeds with custom images:
true
: Replace the current video feeds with custom images.false
: (Default) Do not replace the current video feeds with custom images.
- options
- Image configurations. See ImageTrackOptions.
Returns
- 0: Success.
- < 0: Failure.
enableVirtualBackground
Enables/Disables the virtual background.
virtual int enableVirtualBackground(bool enabled, VirtualBackgroundSource backgroundSource, SegmentationProperty segproperty, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;
Details
The virtual background feature enables the local user to replace their original background with a static image, dynamic video, blurred background, or portrait-background segmentation to achieve picture-in-picture effect. Once the virtual background feature is enabled, all users in the channel can see the custom background.
Call this method before calling enableVideo or startPreview [1/2].
- This feature requires high performance devices. Agora recommends that you implement it on devices equipped with the following chips:
- Snapdragon 700 series 750G and later
- Snapdragon 800 series 835 and later
- Dimensity 700 series 720 and later
- Kirin 800 series 810 and later
- Kirin 900 series 980 and later
- Devices with an i5 CPU and better
- Devices with an A9 chip and better, as follows:
- iPhone 6S and later
- iPad Air 3rd generation and later
- iPad 5th generation and later
- iPad Pro 1st generation and later
- iPad mini 5th generation and later
- Agora recommends that you use this feature in scenarios that meet the following conditions:
- A high-definition camera device is used, and the environment is uniformly lit.
- There are few objects in the captured video. Portraits are half-length and unobstructed. Ensure that the background is a solid color that is different from the color of the user's clothing.
- This method relies on the virtual background dynamic library
libagora_segmentation_extension.dll
. If the dynamic library is deleted, the function cannot be enabled normally.
Parameters
- enabled
- Whether to enable virtual background:
true
: Enable virtual background.false
: Disable virtual background.
- backgroundSource
- The custom background. See VirtualBackgroundSource. To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted.
- segproperty
- Processing properties for background images. See SegmentationProperty.
- type
- The type of the video source. See MEDIA_SOURCE_TYPE.Attention: In this method, this parameter supports only the following two settings:
- The default value is PRIMARY_CAMERA_SOURCE.
- If you want to use the second camera to capture video, set this parameter to SECONDARY_CAMERA_SOURCE.
Returns
- 0: Success.
- < 0: Failure.
- -1: The custom background image does not exist. Check the value of source in VirtualBackgroundSource.
- -2: The color format of the custom background image is invalid. Check the value of color in VirtualBackgroundSource.
- -3: The device does not support virtual background.
enableWebSdkInteroperability
Enables interoperability with the Agora Web SDK (applicable only in the live streaming scenarios).
virtual int enableWebSdkInteroperability(bool enabled) = 0;
Details
- Deprecated:
- The SDK automatically enables interoperability with the Web SDK, so you no longer need to call this method.
You can call this method to enable or disable interoperability with the Agora Web SDK. If a channel has Web SDK users, ensure that you call this method, or the video of the Native user will be a black screen for the Web user.
This method is only applicable in live streaming scenarios, and interoperability is enabled by default in communication scenarios.
Parameters
- enabled
- Whether to enable interoperability:
true
: Enable interoperability.false
: (Default) Disable interoperability.
Returns
- 0: Success.
- < 0: Failure.
getAudioDeviceInfo
Gets the audio device information.
virtual int getAudioDeviceInfo(DeviceInfo& deviceInfo) = 0;
Details
After calling this method, you can get whether the audio device supports ultra-low-latency capture and playback.
- This method is for Android only.
- You can call this method either before or after joining a channel.
Parameters
- deviceInfo
- Input and output parameter. A DeviceInfo object that identifies the audio device information.
- Input value: A DeviceInfo object.
- Output value: A DeviceInfo object containing audio device information.
Returns
- 0: Success.
- < 0: Failure.
getAudioMixingCurrentPosition
Retrieves the playback position (ms) of the music file.
virtual int getAudioMixingCurrentPosition() = 0;
Details
Retrieves the playback position (ms) of the audio.
- You need to call this method after calling startAudioMixing [2/2] and receiving the
onAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)
callback. - If you need to call getAudioMixingCurrentPosition multiple times, ensure that the time interval between calling this method is more than 500 ms.
Returns
- ≥ 0: The current playback position (ms) of the audio mixing, if this method call succeeds. 0 represents that the current music file does not start playing.
- < 0: Failure.
getAudioMixingDuration
Retrieves the duration (ms) of the music file.
virtual int getAudioMixingDuration() = 0;
Details
Retrieves the total duration (ms) of the audio.
You need to call this method after calling startAudioMixing [2/2] and receiving the onAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)
callback.
Returns
- ≥ 0: The audio mixing duration, if this method call succeeds.
- < 0: Failure.
getAudioMixingPlayoutVolume
Retrieves the audio mixing volume for local playback.
virtual int getAudioMixingPlayoutVolume() = 0;
Details
This method helps troubleshoot audio volume‑related issues.
You need to call this method after calling startAudioMixing [2/2] and receiving the onAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)
callback.
Returns
- ≥ 0: The audio mixing volume, if this method call succeeds. The value range is [0,100].
- < 0: Failure.
getAudioMixingPublishVolume
Retrieves the audio mixing volume for publishing.
virtual int getAudioMixingPublishVolume() = 0;
Details
This method helps troubleshoot audio volume‑related issues.
onAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)
callback.Returns
- ≥ 0: The audio mixing volume, if this method call succeeds. The value range is [0,100].
- < 0: Failure.
getAudioTrackCount
Gets the index of audio tracks of the current music file.
virtual int getAudioTrackCount() = 0;
Details
- You need to call this method after calling startAudioMixing [2/2] and receiving the
onAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)
callback.
Returns
- The SDK returns the index of the audio tracks if the method call succeeds.
- < 0: Failure.
getCallId
Retrieves the call ID.
virtual int getCallId(agora::util::AString& callId) = 0;
Details
When a user joins a channel on a client, a callId is generated to identify the call from the client. Some methods, such as rate and complain, must be called after the call ends to submit feedback to the SDK. These methods require the callId parameter.
Parameters
- callId
- Output parameter, the current call ID.
Returns
- 0: Success.
- < 0: Failure.
getCameraMaxZoomFactor
Gets the maximum zoom ratio supported by the camera.
virtual float getCameraMaxZoomFactor() = 0;
Details
- This method is for Android and iOS only.
- Call this method after enabling the local camera, for example, by calling joinChannel [2/2], enableVideo, or enableLocalVideo, depending on which method you use to turn on your local camera.
Returns
The maximum zoom factor.
getConnectionState
Gets the current connection state of the SDK.
virtual CONNECTION_STATE_TYPE getConnectionState() = 0;
Details
You can call this method either before or after joining a channel.
Returns
The current connection state. See CONNECTION_STATE_TYPE.
getCurrentMonotonicTimeInMs
Gets the current Monotonic Time of the SDK.
virtual int64_t getCurrentMonotonicTimeInMs() = 0;
Details
- Since
- v4.2.0
Monotonic Time refers to a monotonically increasing time series whose value increases over time. The unit is milliseconds.
In custom video capture and custom audio capture scenarios, in order to ensure audio and video synchronization, Agora recommends that you call this method to obtain the current Monotonic Time of the SDK, and then pass this value into the timestamp parameter in the captured video frame (VideoFrame) and audio frame (AudioFrame).
Returns
- ≥0: The method call is successful, and returns the current Monotonic Time of the SDK (in milliseconds).
- < 0: Failure.
getEffectCurrentPosition
Retrieves the playback position of the audio effect file.
virtual int getEffectCurrentPosition(int soundId) = 0;
Details
Parameters
- soundId
- The audio effect ID. The ID of each audio effect file is unique.
Returns
- The playback position (ms) of the specified audio effect file, if the method call succeeds.
- < 0: Failure.
getEffectDuration
Retrieves the duration of the audio effect file.
virtual int getEffectDuration(const char* filePath) = 0;
Details
Parameters
- filePath
- File path:
- Android: The file path, which needs to be accurate to the file name and suffix. Agora supports URL addresses, absolute paths, or file paths that start with
/assets/
. You might encounter permission issues if you use an absolute path to access a local file, so Agora recommends using a URI address instead. For example: content://com.android.providers.media.documents/document/audio%3A14441
- Windows: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example
: C:\music\audio.mp4
.
- Android: The file path, which needs to be accurate to the file name and suffix. Agora supports URL addresses, absolute paths, or file paths that start with
Returns
- The total duration (ms) of the specified audio effect file, if the method call succeeds.
- < 0: Failure.
getEffectsVolume
Retrieves the volume of the audio effects.
virtual int getEffectsVolume() = 0;
Details
The volume is an integer ranging from 0 to 100. The default value is 100, which means the original volume.
Returns
- Volume of the audio effects, if this method call succeeds.
- < 0: Failure.
getErrorDescription
Gets the warning or error description.
virtual const char* getErrorDescription(int code) = 0;
Parameters
- code
- The error code or warning code reported by the SDK.
Returns
The specific error or warning description.
getExtensionProperty
Gets detailed information on the extensions.
virtual int getExtensionProperty(
const char* provider, const char* extension,
const char* key, char* value, int buf_len, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
Details
Parameters
- provider
- Output parameter. The name of the extension provider.
- extension
- Output parameter. The name of the extension.
- key
- Output parameter. The key of the extension.
- value
- Output parameter. The value of the extension key.
- type
- Source type of the extension. See MEDIA_SOURCE_TYPE.
- buf_len
- Maximum length of the JSON string indicating the extension property. The maximum value is 512 bytes.
Returns
- 0: Success.
- < 0: Failure.
getNetworkType
Gets the type of the local network connection.
virtual int getNetworkType() = 0;
Details
- Since
- v4.0.1
You can use this method to get the type of network in use at any stage.
Returns
- ≥ 0: The method call is successful, and the local network connection type is returned.
- 0: The SDK disconnects from the network.
- 1: The network type is LAN.
- 2: The network type is Wi-Fi (including hotspots).
- 3: The network type is mobile 2G.
- 4: The network type is mobile 3G.
- 5: The network type is mobile 4G.
- 6: The network type is mobile 5G.
- < 0: The method call failed with an error code.
- -1: The network type is unknown.
getNtpWallTimeInMs
Gets the current NTP (Network Time Protocol) time.
virtual uint64_t getNtpWallTimeInMs() = 0;
Details
- Since
- v4.2.0
In the real-time chorus scenario, especially when the downlink connections are inconsistent due to network issues among multiple receiving ends, you can call this method to obtain the current NTP time as the reference time, in order to align the lyrics and music of multiple receiving ends and achieve chorus synchronization.
Returns
The Unix timestamp (ms) of the current NTP time.
getScreenCaptureSources
Gets a list of shareable screens and windows.
virtual IScreenCaptureSourceList* getScreenCaptureSources(const SIZE& thumbSize, const SIZE& iconSize, const bool includeScreen) = 0;
Details
You can call this method before sharing a screen or window to get a list of shareable screens and windows, which enables a user to use thumbnails in the list to easily choose a particular screen or window to share. This list also contains important information such as window ID and screen ID, with which you can call startScreenCaptureByWindowId or startScreenCaptureByDisplayId to start the sharing.
Parameters
- thumbSize
- The target size of the screen or window thumbnail (the width and height are in pixels). See SIZE. The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and thumbSize is 100 × 100, the actual size of the thumbnail is 100 × 75. If the target size is larger than the original size, the thumbnail is the original image and the SDK does not scale it.
- iconSize
- The target size of the icon corresponding to the application program (the width and height are in pixels). See SIZE. The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and iconSize is 100 × 100, the actual size of the icon is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it.
- includeScreen
- Whether the SDK returns the screen information in addition to the window information:
true
: The SDK returns screen and window information.false
: The SDK returns window information only.
Returns
getUserInfoByUid
Gets the user information by passing in the user ID.
virtual int getUserInfoByUid(uid_t uid, rtc::UserInfo* userInfo, const char* channelId = NULL, const char* localUserAccount = NULL) = 0;
Details
After a remote user joins the channel, the SDK gets the user ID and account of the remote user, caches them in a mapping table object, and triggers the onUserInfoUpdated callback on the local client. After receiving the callback, you can call this method to get the user account of the remote user from the UserInfo object by passing in the user ID.
Parameters
- uid
- The user ID.
- userInfo
- Input and output parameter. The UserInfo object that identifies the user information.
- Input: A UserInfo object.
- Output: A UserInfo object that contains the user account and user ID of the user.
- 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
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
- localUserAccount
- The user account of the local user.
Returns
- 0: Success.
- < 0: Failure.
getUserInfoByUserAccount
Gets the user information by passing in the user account.
virtual int getUserInfoByUserAccount(const char* userAccount, rtc::UserInfo* userInfo, const char* channelId = NULL, const char* localUserAccount = NULL) = 0;
Details
After a remote user joins the channel, the SDK gets the user ID and account of the remote user, caches them in a mapping table object, and triggers the onUserInfoUpdated callback on the local client. After receiving the callback, you can call this method to get the user account of the remote user from the UserInfo object by passing in the user ID.
Parameters
- userAccount
- The user account.
- userInfo
- Input and output parameter. The UserInfo object that identifies the user information.
- Input: A UserInfo object.
- Output: A UserInfo object that contains the user account and user ID of the user.
- 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
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
- localUserAccount
- The user account of the local user.
Returns
- 0: Success.
- < 0: Failure.
getVersion
Gets the SDK version.
virtual const char* getVersion(int* build) = 0;
Parameters
- build
- The SDK build index.
Returns
The SDK version number. The format is a string.
getVolumeOfEffect
Gets the volume of a specified audio effect file.
virtual int getVolumeOfEffect(int soundId) = 0;
Parameters
- soundId
- The ID of the audio effect file.
Returns
- ≥ 0: Returns the volume of the specified audio effect, if the method call is successful. The value ranges between 0 and 100. 100 represents the original volume.
- < 0: Failure.
isCameraAutoExposureFaceModeSupported
Checks whether the device supports auto exposure.
virtual bool isCameraAutoExposureFaceModeSupported() = 0;
Details
- This method applies to iOS only.
- Call this method before calling joinChannel [2/2], enableVideo, or enableLocalVideo, depending on which method you use to turn on your local camera.
Returns
true
: The device supports auto exposure.false
: The device does not support auto exposure.
isCameraAutoFocusFaceModeSupported
Checks whether the device supports the face auto-focus function.
virtual bool isCameraAutoFocusFaceModeSupported() = 0;
Details
- This method is for Android and iOS only.
- Call this method after enabling the local camera, for example, by calling joinChannel [2/2], enableVideo, or enableLocalVideo, depending on which method you use to turn on your local camera.
Returns
true
: The device supports the face auto-focus function.false
: The device does not support the face auto-focus function.
isCameraExposurePositionSupported
Checks whether the device supports manual exposure.
virtual bool isCameraExposurePositionSupported() = 0;
Details
- This method is for Android and iOS only.
- Call this method after enabling the local camera, for example, by calling joinChannel [2/2], enableVideo, or enableLocalVideo, depending on which method you use to turn on your local camera.
Returns
true
: The device supports manual exposure.false
: The device does not support manual exposure.
isCameraFaceDetectSupported
Checks whether the device camera supports face detection.
virtual bool isCameraFaceDetectSupported() = 0;
- This method is for Android and iOS only.
- Call this method after enabling the local camera, for example, by calling joinChannel [2/2], enableVideo, or enableLocalVideo, depending on which method you use to turn on your local camera.
Returns
true
: The device camera supports face detection.false
: The device camera does not support face detection.
isCameraFocusSupported
Check whether the device supports the manual focus function.
virtual bool isCameraFocusSupported() = 0;
Details
- This method is for Android and iOS only.
- Call this method after enabling the local camera, for example, by calling joinChannel [2/2], enableVideo, or enableLocalVideo, depending on which method you use to turn on your local camera.
Returns
true
: The device supports the manual focus function.false
: The device does not support the manual focus function.
isCameraTorchSupported
Checks whether the device supports camera flash.
virtual bool isCameraTorchSupported() = 0;
Details
- This method is for Android and iOS only.
- Call this method after enabling the local camera, for example, by calling joinChannel [2/2], enableVideo, or enableLocalVideo, depending on which method you use to turn on your local camera.
- The app enables the front camera by default. If your front camera does not support enabling the flash, this method returns false. If you want to check whether the rear camera supports the flash function, call switchCamera before this method.
- On iPads with system version 15, even if isCameraTorchSupported returns
true
, you might fail to successfully enable the flash by calling setCameraTorchOn due to system issues.
Returns
true
: The device supports camera flash.false
: The device does not support camera flash.
isCameraZoomSupported
Checks whether the device supports camera zoom.
virtual bool isCameraZoomSupported() = 0;
Details
- This method is for Android and iOS only.
- Call this method after enabling the local camera, for example, by calling joinChannel [2/2], enableVideo, or enableLocalVideo, depending on which method you use to turn on your local camera.
Returns
true
: The device supports camera zoom.false
: The device does not support camera zoom.
isSpeakerphoneEnabled
Checks whether the speakerphone is enabled.
virtual bool isSpeakerphoneEnabled() = 0;
- This method is for Android and iOS only.
- You can call this method either before or after joining a channel.
Returns
true
: The speakerphone is enabled, and the audio plays from the speakerphone.false
: The speakerphone is not enabled, and the audio plays from devices other than the speakerphone. For example, the headset or earpiece.
joinChannel [1/2]
Joins a channel.
virtual int joinChannel(const char* token, const char* channelId, const char* info,
uid_t uid) = 0;
Details
This method enables users to join a channel. Users in the same channel can talk to each other, and multiple users in the same channel can start a group chat. Users with different App IDs cannot call each other.
- The local client: The onJoinChannelSuccess and onConnectionStateChanged callbacks.
- The remote client: onUserJoined, if the user joining the channel is in the Communication profile or is a host in the Live-broadcasting profile.
When the connection between the client and Agora's server is interrupted due to poor network conditions, the SDK tries reconnecting to the server. When the local client successfully rejoins the channel, the SDK triggers the onRejoinChannelSuccess callback on the local client.
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
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
- info
- (Optional) Reserved for future use.
- uid
- The user ID. This parameter is used to identify the user in the channel for real-time audio and video interaction. You need to set and manage user IDs yourself, and ensure that each user ID in the same channel is unique. This parameter is a 32-bit unsigned integer. The value range is 1 to 232-1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and returns it in the onJoinChannelSuccess callback. Your application must record and maintain the returned user ID, because the SDK does not do so.
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 [3/3] 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 CONNECTION_STATE_DISCONNECTED(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.
joinChannel [2/2]
Joins a channel with media options.
virtual int joinChannel(const char* token, const char* channelId, uid_t uid,
const ChannelMediaOptions& options) = 0;
Details
This method enables users to join a channel. Users in the same channel can talk to each other, and multiple users in the same channel can start a group chat. Users with different App IDs cannot call each other.
- The local client: The onJoinChannelSuccess and onConnectionStateChanged callbacks.
- The remote client: onUserJoined, if the user joining the channel is in the Communication profile or is a host in the Live-broadcasting profile.
When the connection between the client and Agora's server is interrupted due to poor network conditions, the SDK tries reconnecting to the server. When the local client successfully rejoins the channel, the SDK triggers the onRejoinChannelSuccess callback on the local client.
Compared to joinChannel [1/2], this method adds the options parameter to configure whether to automatically subscribe to all remote audio and video streams in the channel when the user joins the channel. By default, the user subscribes to the audio and video streams of all the other users in the channel, giving rise to usage and billings. To unsubscribe, set the options parameter or call the mute methods accordingly.
- This method allows users to join only one channel at a time.
- Ensure that the app ID you use to generate the token is the same app ID that you pass in the initialize method; otherwise, you may fail to join the channel by token.
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
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
- uid
- The user ID. This parameter is used to identify the user in the channel for real-time audio and video interaction. You need to set and manage user IDs yourself, and ensure that each user ID in the same channel is unique. This parameter is a 32-bit unsigned integer. The value range is 1 to 232-1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and returns it in the onJoinChannelSuccess callback. Your application must record and maintain the returned user ID, because the SDK does not do so.
- 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 [3/3] 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 CONNECTION_STATE_DISCONNECTED(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.
joinChannelWithUserAccount [1/2]
Joins a channel with a User Account and Token.
virtual int joinChannelWithUserAccount(const char* token,
const char* channelId,
const char* userAccount) = 0;
Details
- The local client: onLocalUserRegistered, onJoinChannelSuccess and onConnectionStateChanged callbacks.
- The remote client: onUserJoined and onUserInfoUpdated callbacks, if the user joining the channel is in the communication profile or is a host in the live streaming 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
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
Returns
- 0: Success.
- < 0: Failure.
- -2: The parameter is invalid.
- -3: The initialization of the SDK fails. You can try to initialize the SDK again.
- -5: The request is rejected.
- -17: The request to join the channel is rejected. Since the SDK only supports users to join one IRtcEngine channel at a time; this error code will be returned when the user who has joined the IRtcEngine channel calls the join channel method in the IRtcEngine class again with a valid channel name.
joinChannelWithUserAccount [2/2]
Joins the channel with a user account, and configures whether to automatically subscribe to audio or video streams after joining the channel.
virtual int joinChannelWithUserAccount(const char* token,
const char* channelId,
const char* userAccount,
const ChannelMediaOptions& options) = 0;
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.
Compared to joinChannelWithUserAccount [1/2], this method adds the options parameter to configure whether to automatically subscribe to all remote audio and video streams in the channel when the user joins the channel. By default, the user subscribes to the audio and video streams of all the other users in the channel, giving rise to usage and billings. To unsubscribe, set the options parameter or call the mute methods accordingly.
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.
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 [3/3] 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 CONNECTION_STATE_DISCONNECTED(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.
leaveChannel [1/2]
Leaves a channel.
virtual int leaveChannel() = 0;
Details
This method releases all resources related to the session.
This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel.
After joining the channel, you must call this method or leaveChannel [2/2] to end the call, otherwise, the next call cannot be started.
- The local client: onLeaveChannel.
- The remote client: onUserOffline, if the user joining the channel is in the Communication profile, or is a host in the Live-broadcasting profile.
- If you call release immediately after calling this method, the SDK does not trigger the onLeaveChannel callback.
- If you have called joinChannelEx to join multiple channels, calling this method will leave the channels when calling joinChannel [2/2] and joinChannelEx at the same time.
Returns
- 0: Success.
- < 0: Failure.
- -1: A general error occurs (no specified reason).
- -2: The parameter is invalid.
- -7: The SDK is not initialized.
leaveChannel [2/2]
Sets channel options and leaves the channel.
virtual int leaveChannel(const LeaveChannelOptions& options) = 0;
Details
This method will release all resources related to the session, leave the channel, that is, hang up or exit the call. This method can be called whether or not a call is currently in progress.
After joining the channel, you must call this method or to end the call, otherwise, the next call cannot be started.
This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After actually leaving the channel, the local user triggers the 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 have called joinChannelEx to join multiple channels, calling this method will leave the channels when calling joinChannel [2/2] and joinChannelEx at the same time.
Parameters
- options
- The options for leaving the channel. See LeaveChannelOptions.
Returns
- 0: Success.
- < 0: Failure.
loadExtensionProvider
Adds an extension to the SDK.
virtual int loadExtensionProvider(const char* path, bool unload_after_use = false) = 0;
Details
Parameters
- path
- The extension library path and name. For example:
/library/libagora_segmentation_extension.dll
. - unload_after_use
- Whether to uninstall the current extension when you no longer using it:
true
: Uninstall the extension when the IRtcEngine is destroyed.false
: (Rcommended) Do not uninstall the extension until the process terminates.
Returns
- 0: Success.
- < 0: Failure.
muteAllRemoteAudioStreams
Stops or resumes subscribing to the audio streams of all remote users.
virtual int muteAllRemoteAudioStreams(bool mute) = 0;
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.
- 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 [2/2]. - See recommended settings in Set the Subscribing State.
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.
Returns
- 0: Success.
- < 0: Failure.
muteAllRemoteVideoStreams
Stops or resumes subscribing to the video streams of all remote users.
virtual int muteAllRemoteVideoStreams(bool mute) = 0;
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.
- Call this method after joining a channel.
- If you do not want to subscribe the video streams of remote users before joining a channel, you can call joinChannel [2/2] and set autoSubscribeVideo as
false
.
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.
Returns
- 0: Success.
- < 0: Failure.
muteLocalAudioStream
Stops or resumes publishing the local audio stream.
virtual int muteLocalAudioStream(bool mute) = 0;
Details
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.
Returns
- 0: Success.
- < 0: Failure.
muteLocalVideoStream
Stops or resumes publishing the local video stream.
virtual int muteLocalVideoStream(bool mute) = 0;
Details
A successful call of this method triggers the onUserMuteVideo callback on the remote client.
- This method executes faster than the enableLocalVideo(
false
) method, which controls the sending of the local video stream. - 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.
Returns
- 0: Success.
- < 0: Failure.
muteRecordingSignal
Whether to mute the recording signal.
virtual int muteRecordingSignal(bool mute) = 0;
Parameters
- mute
-
true
: The media file is muted.false
: (Default) Do not mute the recording signal.
Note: If you have already called adjustRecordingSignalVolume to adjust the volume, then when you call this method and set it totrue
, the SDK will record the current volume and mute it. To restore the previous volume, call this method again and set it tofalse
.
Returns
- 0: Success.
- < 0: Failure.
muteRemoteAudioStream
Stops or resumes subscribing to the audio stream of a specified user.
virtual int muteRemoteAudioStream(uid_t uid, bool mute) = 0;
Details
- Call this method after joining a channel.
Parameters
- uid
- The user ID of the specified user.
- mute
-
Whether to subscribe to the specified remote user's audio stream.
true
: Stop subscribing to the audio stream of the specified user.false
: (Default) Subscribe to the audio stream of the specified user.
Returns
- 0: Success.
- < 0: Failure.
muteRemoteVideoStream
Stops or resumes subscribing to the video stream of a specified user.
virtual int muteRemoteVideoStream(uid_t userId, bool mute) = 0;
Details
- Call this method after joining a channel.
Parameters
- userId
- The user ID of the specified user.
- mute
-
Whether to subscribe to the specified remote user's video stream.
true
: Stop subscribing to the video streams of the specified user.false
: (Default) Subscribe to the video stream of the specified user.
Returns
- 0: Success.
- < 0: Failure.
pauseAllChannelMediaRelay
Pauses the media stream relay to all target channels.
virtual int pauseAllChannelMediaRelay() = 0;
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.
Returns
- 0: Success.
- < 0: Failure.
pauseAllEffects
Pauses all audio effects.
virtual int pauseAllEffects() = 0;
Returns
- 0: Success.
- < 0: Failure.
pauseAudioMixing
Pauses playing and mixing the music file.
virtual int pauseAudioMixing() = 0;
Details
Call this method after joining a channel.
Returns
- 0: Success.
- < 0: Failure.
pauseEffect
Pauses a specified audio effect file.
virtual int pauseEffect(int soundId) = 0;
Parameters
- soundId
- The audio effect ID. The ID of each audio effect file is unique.
Returns
- 0: Success.
- < 0: Failure.
playAllEffects
Plays all audio effect files.
virtual int playAllEffects(int loopCount, double pitch, double pan, int gain, bool publish = false) = 0;
Details
After calling preloadEffect multiple times to preload multiple audio effects into the memory, you can call this method to play all the specified audio effects for all users in the channel.
Parameters
- loopCount
- The number of times the audio effect loops:
- -1: Play the audio effect files in an indefinite loop until you call stopEffect or stopAllEffects.
- 0: Play the audio effect once.
- 1: Play the audio effect twice.
- pitch
-
The pitch of the audio effect. The value ranges between 0.5 and 2.0. The default value is 1.0 (original pitch). The lower the value, the lower the pitch.
- pan
- The spatial position of the audio effect. The value ranges between -1.0 and 1.0:
- -1.0: The audio effect shows on the left.
- 0: The audio effect shows ahead.
- 1.0: The audio effect shows on the right.
- gain
-
The volume of the audio effect. The value range is [0, 100]. The default value is 100 (original volume). The smaller the value, the lower the volume.
- publish
- Whether to publish the audio effect to the remote users:
true
: Publish the audio effect to the remote users. Both the local user and remote users can hear the audio effect.false
: (Default) Do not publish the audio effect to the remote users. Only the local user can hear the audio effect.
Returns
- 0: Success.
- < 0: Failure.
playEffect
Plays the specified local or online audio effect file.
virtual int playEffect(int soundId,
const char* filePath,
int loopCount,
double pitch,
double pan,
int gain,
bool publish,
int startPos) = 0;
Details
To play multiple audio effect files at the same time, call this method multiple times with different soundId and filePath. To achieve the optimal user experience, Agora recommends that do not playing more than three audio files at the same time. After the playback of an audio effect file completes, the SDK triggers the onAudioEffectFinished callback.
Parameters
- soundId
- The audio effect ID. The ID of each audio effect file is unique.Attention: If you have preloaded an audio effect into memory by calling preloadEffect, ensure that the value of this parameter is the same as that of soundId in preloadEffect.
- filePath
-
The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example,
C:\music\audio.mp4
. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. See supported audio formats.Attention: If you have preloaded an audio effect into memory by calling preloadEffect, ensure that the value of this parameter is the same as that of filePath in preloadEffect. - loopCount
-
The number of times the audio effect loops.
- ≥ 0: The number of playback times. For example, 1 means looping one time, which means playing the audio effect two times in total.
- -1: Play the audio file in an infinite loop.
- pitch
- The pitch of the audio effect. The value range is 0.5 to 2.0. The default value is 1.0, which means the original pitch. The lower the value, the lower the pitch.
- pan
-
The spatial position of the audio effect. The value ranges between -1.0 and 1.0:
- -1.0: The audio effect is heard on the left of the user.
- 0.0: The audio effect is heard in front of the user.
- 1.0: The audio effect is heard on the right of the user.
- gain
- The volume of the audio effect. The value range is 0.0 to 100.0. The default value is 100.0, which means the original volume. The smaller the value, the lower the volume.
- publish
-
Whether to publish the audio effect to the remote users:
true
: Publish the audio effect to the remote users. Both the local user and remote users can hear the audio effect.false
: Do not publish the audio effect to the remote users. Only the local user can hear the audio effect.
- startPos
-
The playback position (ms) of the audio effect file.
Returns
- 0: Success.
- < 0: Failure.
preloadEffect
Preloads a specified audio effect file into the memory.
virtual int preloadEffect(int soundId, const char* filePath) = 0;
Details
To ensure smooth communication, It is recommended that you limit the size of the audio effect file. You can call this method to preload the audio effect before calling joinChannel [2/2].
- This method does not support online audio effect files.
- For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support.
Parameters
- soundId
- The audio effect ID. The ID of each audio effect file is unique.
- filePath
- File path:
- Android: The file path, which needs to be accurate to the file name and suffix. Agora supports URL addresses, absolute paths, or file paths that start with
/assets/
. You might encounter permission issues if you use an absolute path to access a local file, so Agora recommends using a URI address instead. For example: content://com.android.providers.media.documents/document/audio%3A14441
- Windows: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example
: C:\music\audio.mp4
.
- Android: The file path, which needs to be accurate to the file name and suffix. Agora supports URL addresses, absolute paths, or file paths that start with
Returns
- 0: Success.
- < 0: Failure.
queryCodecCapability
Queries the current device's supported video codec capabilities.
virtual int queryCodecCapability(CodecCapInfo* codecInfo, int& size) = 0;
Details
- Since
- v4.2.0
Parameters
- codecInfo
-
Input and output parameter. An array representing the video codec capabilities of the device. See CodecCapInfo.
- Input value: One CodecCapInfo defined by the user when executing this method, representing the video codec capability to be queried.
- Output value: The CodecCapInfo after the method is executed, representing the actual video codec capabilities supported by the device.
- size
- Input and output parameter, represent the size of the CodecCapInfo array.
- Input value: Size of the CodecCapInfo defined by the user when executing the method.
- Output value: Size of the output CodecCapInfo after this method is executed.
Returns
- 0: Success.
- < 0: Failure.
queryInterface
Gets the pointer to the specified interface.
virtual int queryInterface(INTERFACE_ID_TYPE iid, void** inter) = 0;
Parameters
- iid
- The ID of the interface. See INTERFACE_ID_TYPE.
- inter
- Output parameter. The pointer to the specified interface.
Returns
- 0: Success.
- < 0: Failure.
queryScreenCaptureCapability
Queries the highest frame rate supported by the device during screen sharing.
#if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) virtual int queryScreenCaptureCapability() = 0; #endif
Details
- Since
- v4.2.0
Applicable scenarios
This method is for Android and iOS only.
To ensure optimal screen sharing performance, particularly in enabling high frame rates like 60 fps, Agora recommends you to query the device's maximum supported frame rate using this method beforehand. This way, if the device cannot support such a high frame rate, you can adjust the screen sharing stream accordingly to avoid any negative impact on the sharing quality. If the device does not support high frame rate, you can reduce the frame rate of the screen sharing stream appropriately when sharing the screen to ensure that the sharing effect meets your expectation.
Returns
- The highest frame rate supported by the device, if the method is called successfully. See SCREEN_CAPTURE_FRAMERATE_CAPABILITY.
- < 0: Failure.
rate
Allows a user to rate a call after the call ends.
virtual int rate(const char* callId,
int rating,
const char* description) = 0;
Details
Parameters
- callId
- The current call ID. You can get the call ID by calling getCallId.
- rating
- The rating of the call. The value is between 1 (the lowest score) and 5 (the highest score). If you set a value out of this range, the SDK returns the -2 (
ERR_INVALID_ARGUMENT
) error. - description
- (Optional) A description of the call. The string length should be less than 800 bytes.
Returns
- 0: Success.
- < 0: Failure.
- -2 (
ERR_INVALID_ARGUMENT
). - -3 (
ERR_NOT_READY
).
- -2 (
registerAudioEncodedFrameObserver
Registers an encoded audio observer.
virtual int registerAudioEncodedFrameObserver(const AudioEncodedFrameObserverConfig& config, IAudioEncodedFrameObserver *observer) = 0;
Details
- Call this method after joining a channel.
- You can call this method or startAudioRecording [3/3] to set the recording type and quality of audio files, but Agora does not recommend using this method and startAudioRecording [3/3] at the same time. Only the method called later will take effect.
Parameters
- config
- Observer settings for the encoded audio. See AudioEncodedFrameObserverConfig.
- observer
- The encoded audio observer. See IAudioEncodedFrameObserver.
Returns
- 0: Success.
- < 0: Failure.
registerAudioSpectrumObserver
Register an audio spectrum observer.
virtual int registerAudioSpectrumObserver(agora::media::IAudioSpectrumObserver * observer) = 0;
Details
After successfully registering the audio spectrum observer and calling enableAudioSpectrumMonitor to enable the audio spectrum monitoring, the SDK reports the callback that you implement in the IAudioSpectrumObserver class according to the time interval you set.
Parameters
- observer
-
The audio spectrum observer. See IAudioSpectrumObserver.
Returns
- 0: Success.
- < 0: Failure.
registerExtension
Registers an extension.
virtual int registerExtension(const char* provider, const char* extension,
agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
Details
- Since
- v4.1.0
After the extension is loaded, you can call this method to register the extension.
This method applies to Windows only.
Parameters
- provider
- The name of the extension provider.
- extension
- The name of the extension.
- type
- Type of media source. See MEDIA_SOURCE_TYPE.Attention: In this method, this parameter supports only the following two settings:
- The default value is UNKNOWN_MEDIA_SOURCE.
- If you want to use the second camera to capture video, set this parameter to SECONDARY_CAMERA_SOURCE.
Returns
- 0: Success.
- < 0: Failure.
registerLocalUserAccount
Registers a user account.
virtual int registerLocalUserAccount(const char* appId, const char* userAccount) = 0;
Details
Once registered, the user account can be used to identify the local user when the user joins the channel. After the registration is successful, the user account can identify the identity of the local user, and the user can use it to join the channel.
After the user successfully registers a user account, the SDK triggers the onLocalUserRegistered callback on the local client, reporting the user ID and account of the local user.
- Call registerLocalUserAccount to create a user account, and then call joinChannelWithUserAccount [2/2] to join the channel.
- Call the joinChannelWithUserAccount [2/2] method to join the channel.
The difference between the two ways is that the time elapsed between calling the registerLocalUserAccount method and joining the channel is shorter than directly calling joinChannelWithUserAccount [2/2].
- Ensure that you set the userAccount parameter; otherwise, this method does not take effect.
- Ensure that the userAccount is unique in the channel.
- To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the ID of the user is set to the same parameter type.
Parameters
- appId
- The App ID of your project on Agora Console.
- 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 as follow(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
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
Returns
- 0: Success.
- < 0: Failure.
registerMediaMetadataObserver
Registers the metadata observer.
virtual int registerMediaMetadataObserver(IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type) = 0;
Details
You need to implement the IMetadataObserver class and specify the metadata type in this method. This method enables you to add synchronized metadata in the video stream for more diversified live interactive streaming, such as sending shopping links, digital coupons, and online quizzes.
A successful call of this method triggers the getMaxMetadataSize callback.
Parameters
- observer
- The metadata observer. See IMetadataObserver.
- type
-
The metadata type. The SDK currently only supports VIDEO_METADATA. See METADATA_TYPE.
Returns
- 0: Success.
- < 0: Failure.
registerPacketObserver
Registers a packet observer.
virtual int registerPacketObserver(IPacketObserver* observer) = 0;
Details
Call this method registers a packet observer. When the Agora SDK triggers IPacketObserver callbacks registered by for voice or video packet transmission, you can call this method to process the packets, such as encryption and decryption.
- The size of the packet sent to the network after processing should not exceed 1200 bytes, otherwise, the SDK may fail to send the packet.
- Ensure that both receivers and senders call this method; otherwise, you may meet undefined behaviors such as no voice and black screen.
- When you use the Media Push or recording functions, Agora doesn't recommend calling this method.
- Call this method before joining a channel.
Parameters
- observer
- IPacketObserver.
Returns
- 0: Success.
- < 0: Failure.
release
Releases the IRtcEngine instance.
virtual void release(bool sync = false) = 0;
Details
This method releases all resources used by the Agora SDK. Use this method for apps in which users occasionally make voice or video calls. When users do not make calls, you can free up resources for other operations.
After a successful method call, you can no longer use any method or callback in the SDK anymore. If you want to use the real-time communication functions again, you must call createAgoraRtcEngine and initialize to create a new IRtcEngine instance.
Parameters
- sync
-
Whether the method is called synchronously:
true
: Synchronous call. Agora suggests calling this method in a sub-thread to avoid congestion in the main thread because the synchronous call and the app cannot move on to another task until the resources used by IRtcEngine are released. Besides, you cannot call release in any method or callback of the SDK. Otherwise, the SDK cannot release the resources until the callbacks return results, which may result in a deadlock.false
: Asynchronous call. Currently this method only supports synchronous calls, do not set this parameter to this value.
renewToken
Renews the token.
virtual int renewToken(const char* token) = 0;
Details
You can call this method to pass a new token to the SDK. A token expires after a certain period of time. In the following two cases, the app should call this method to pass in a new token. Failure to do so will result in the SDK disconnecting from the server.- The SDK triggers the onTokenPrivilegeWillExpire callback.
- The onConnectionStateChanged callback reports CONNECTION_CHANGED_TOKEN_EXPIRED(9).
Parameters
- token
- The new token.
Returns
- 0: Success.
- < 0: Failure.
- -2: The parameter is invalid. For example, the token 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.
resumeAllChannelMediaRelay
Resumes the media stream relay to all target channels.
virtual int resumeAllChannelMediaRelay() = 0;
Details
After calling the pauseAllChannelMediaRelay method, you can call this method to resume relaying media streams to all destination channels.
Returns
- 0: Success.
- < 0: Failure.
resumeAllEffects
Resumes playing all audio effect files.
virtual int resumeAllEffects() = 0;
Returns
- 0: Success.
- < 0: Failure.
resumeAudioMixing
Resumes playing and mixing the music file.
virtual int resumeAudioMixing() = 0;
Details
This method resumes playing and mixing the music file. Call this method when you are in a channel.
Returns
- 0: Success.
- < 0: Failure.
resumeEffect
Resumes playing a specified audio effect.
virtual int resumeEffect(int soundId) = 0;
Parameters
- soundId
- The audio effect ID. The ID of each audio effect file is unique.
Returns
- 0: Success.
- < 0: Failure.
selectAudioTrack
Selects the audio track used during playback.
virtual int selectAudioTrack(int index) = 0;
Details
After getting the track index of the audio file, you can call this method to specify any track to play. For example, if different tracks of a multi-track file store songs in different languages, you can call this method to set the playback language.
- For the supported formats of audio files, see .
- You need to call this method after calling startAudioMixing [2/2] and receiving the
onAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)
callback.
Parameters
- index
- The audio track you want to specify. The value range is [0, getAudioTrackCount()].
Returns
- 0: Success.
- < 0: Failure.
sendCustomReportMessage
Reports customized messages.
virtual int sendCustomReportMessage(const char *id,
const char* category,
const char* event,
const char* label,
int value) = 0;
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 and discuss the format of customized messages with us.
sendStreamMessage
Sends data stream messages.
virtual int sendStreamMessage(int streamId,
const char* data,
size_t length) = 0;
Details
- 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 createDataStream [2/2] to create a data channel before calling this method.
- In live streaming scenarios, this method only applies to hosts.
Parameters
- streamId
- The data stream ID. You can get the data stream ID by calling createDataStream [2/2].
- data
- The message to be sent.
- length
- The length of the data.
Returns
- 0: Success.
- < 0: Failure.
setAdvancedAudioOptions
Sets audio advanced options.
virtual int setAdvancedAudioOptions(media::base::AdvancedAudioOptions &options) = 0;
Details
If you have advanced audio processing requirements, such as capturing and sending stereo audio, you can call this method to set advanced audio options.
Parameters
- options
- The advanced options for audio. See AdvancedAudioOptions.
Returns
- 0: Success.
- < 0: Failure.
setAINSMode
Sets whether to enable the AI noise reduction function and set the noise reduction mode.
virtual int setAINSMode(bool enabled, AUDIO_AINS_MODE mode) = 0;
Details
- Since
- v4.2.0
- Television;
- Air conditioner;
- Machinery, etc.
- Thunder;
- Explosion;
- Cracking, etc.
Applicable scenarios
In scenarios such as co-hosting, online education and video meeting, this function can detect and reduce background noises to improve experience.
Parameters
- enabled
- Whether to enable the AI noise reduction function:
true
: Enable the AI noise reduction.false
: (Default) Disable the AI noise reduction.
- mode
-
The AI noise reduction modes. See AUDIO_AINS_MODE.
Returns
- 0: Success.
- < 0: Failure.
setAudioEffectParameters
Sets parameters for SDK preset audio effects.
virtual int setAudioEffectParameters(AUDIO_EFFECT_PRESET preset, int param1, int param2) = 0;
Details
- 3D voice effect: Sets the cycle period of the 3D voice effect.
- Pitch correction effect: Sets the basic mode and tonic pitch of the pitch correction effect. Different songs have different modes and tonic pitches. Agora recommends bounding this method with interface elements to enable users to adjust the pitch correction interactively.
After setting the audio parameters, all users in the channel can hear the effect.
- You can call this method either before or after joining a channel.
- To get better audio effect quality, Agora recommends setting the scenario parameter of setAudioProfile [1/2] as AUDIO_SCENARIO_GAME_STREAMING(3) before calling this method.
- Do not set the profile parameter in setAudioProfile [1/2] to AUDIO_PROFILE_SPEECH_STANDARD(1)AUDIO_PROFILE_IOT or (6), or the method does not take effect.
- This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
- After calling setAudioEffectParameters, Agora does not recommend you to call the following methods, otherwise the effect set by setAudioEffectParameters will be overwritten:
Parameters
- preset
- The options for SDK preset audio effects:
- ROOM_ACOUSTICS_3D_VOICE, 3D voice effect:
- Call setAudioProfile [1/2] and set the profile parameter in to AUDIO_PROFILE_MUSIC_STANDARD_STEREO(3) or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5) before setting this enumerator; otherwise, the enumerator setting does not take effect.
- If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect.
- PITCH_CORRECTION, Pitch correction effect: To achieve better audio effect quality, Agora recommends setting the profile parameter in setAudioProfile [1/2] to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4) or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5) before setting this enumerator.
- ROOM_ACOUSTICS_3D_VOICE, 3D voice effect:
- param1
-
- If you set preset to ROOM_ACOUSTICS_3D_VOICE, param1 sets the cycle period of the 3D voice effect. The value range is [1,60] and the unit is seconds. The default value is 10, indicating that the voice moves around you every 10 seconds.
- If you set preset to PITCH_CORRECTION, param1 indicates the basic mode of the pitch correction effect:
1
: (Default) Natural major scale.2
: Natural minor scale.3
: Japanese pentatonic scale.
- param2
-
- If you set preset to ROOM_ACOUSTICS_3D_VOICE , you need to set param2 to
0
. - If you set preset to PITCH_CORRECTION, param2 indicates the tonic pitch of the pitch correction effect:
1
: A2
: A#3
: B4
: (Default) C5
: C#6
: D7
: D#8
: E9
: F10
: F#11
: G12
: G#
- If you set preset to ROOM_ACOUSTICS_3D_VOICE , you need to set param2 to
Returns
- 0: Success.
- < 0: Failure.
setAudioEffectPreset
Sets an SDK preset audio effect.
virtual int setAudioEffectPreset(AUDIO_EFFECT_PRESET preset) = 0;
Details
Call this method to set an SDK preset audio effect for the local user who sends an audio stream. This audio effect does not change the gender characteristics of the original voice. After setting an audio effect, all users in the channel can hear the effect.
To get better audio effect quality, Agora recommends setting the scenario parameter of setAudioProfile [1/2] as AUDIO_SCENARIO_GAME_STREAMING(3) before calling this method.
- You can call this method either before or after joining a channel.
- Do not set the profile parameter in setAudioProfile [1/2] to AUDIO_PROFILE_SPEECH_STANDARD(1)AUDIO_PROFILE_IOT or (6), or the method does not take effect.
- This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
- If you call setAudioEffectPreset and set enumerators except for ROOM_ACOUSTICS_3D_VOICE or PITCH_CORRECTION, do not call setAudioEffectParameters; otherwise, setAudioEffectPreset is overridden.
- After calling setAudioEffectPreset, Agora does not recommend you to call the following methods, otherwise the effect set by setAudioEffectPreset will be overwritten:
- This method relies on the voice beautifier dynamic library
libagora_audio_beauty_extension.dll
. If the dynamic library is deleted, the function cannot be enabled normally.
Parameters
- preset
- The options for SDK preset audio effects. See AUDIO_EFFECT_PRESET.
Returns
- 0: Success.
- < 0: Failure.
setAudioMixingDualMonoMode
Sets the channel mode of the current audio file.
virtual int setAudioMixingDualMonoMode(media::AUDIO_MIXING_DUAL_MONO_MODE mode) = 0;
Details
In a stereo music file, the left and right channels can store different audio data. According to your needs, you can set the channel mode to original mode, left channel mode, right channel mode, or mixed channel mode. For example, in the KTV scenario, the left channel of the music file stores the musical accompaniment, and the right channel stores the singing voice. If you only need to listen to the accompaniment, call this method to set the channel mode of the music file to left channel mode; if you need to listen to the accompaniment and the singing voice at the same time, call this method to set the channel mode to mixed channel mode.
- Call this method after calling startAudioMixing [2/2] and receiving the
onAudioMixingStateChanged (AUDIO_MIXING_STATE_PLAYING)
callback. - This method only applies to stereo audio files.
Parameters
- mode
- The channel mode. See AUDIO_MIXING_DUAL_MONO_MODE.
Returns
- 0: Success.
- < 0: Failure.
setAudioMixingPitch
Sets the pitch of the local music file.
virtual int setAudioMixingPitch(int pitch) = 0;
Details
When a local music file is mixed with a local human voice, call this method to set the pitch of the local music file only.
onAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)
callback.Parameters
- pitch
- Sets the pitch of the local music file by the chromatic scale. The default value is 0, which means keeping the original pitch. The value ranges from -12 to 12, and the pitch value between consecutive values is a chromatic value. The greater the absolute value of this parameter, the higher or lower the pitch of the local music file.
Returns
- 0: Success.
- < 0: Failure.
setAudioMixingPosition
Sets the audio mixing position.
virtual int setAudioMixingPosition(int pos /*in ms*/) = 0;
Details
Call this method to set the playback position of the music file to a different starting position (the default plays from the beginning).
onAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)
callback.Parameters
- pos
- Integer. The playback position (ms).
Returns
- 0: Success.
- < 0: Failure.
setAudioProfile [1/2]
Sets the audio profile and audio scenario.
virtual int setAudioProfile(AUDIO_PROFILE_TYPE profile, AUDIO_SCENARIO_TYPE scenario) = 0;
Details
- Deprecated:
- This method is deprecated. If you need to set the audio profile, use setAudioProfile [2/2]; if you need to set the audio scenario, use setAudioScenario.
- You can call this method either before or after joining a channel.
- In scenarios requiring high-quality audio, such as online music tutoring, Agora recommends you set profile as
AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
and scenario asAUDIO_SCENARIO_GAME_STREAMING(3)
.
Parameters
- profile
-
The audio profile, including the sampling rate, bitrate, encoding mode, and the number of channels. See AUDIO_PROFILE_TYPE.
- scenario
- The audio scenarios. See AUDIO_SCENARIO_TYPE. Under different audio scenarios, the device uses different volume types.
Returns
- 0: Success.
- < 0: Failure.
setAudioProfile [2/2]
Sets the audio parameters and application scenarios.
virtual int setAudioProfile(AUDIO_PROFILE_TYPE profile) = 0;
Details
- You can call this method either before or after joining a channel.
- In scenarios requiring high-quality audio, such as online music tutoring, Agora recommends you set
profile
asAUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
. - If you need to set the audio scenario, you can either call setAudioScenario, or initialize and set the audioScenario in RtcEngineContext.
Parameters
- profile
-
The audio profile, including the sampling rate, bitrate, encoding mode, and the number of channels. See AUDIO_PROFILE_TYPE.
Returns
- 0: Success.
- < 0: Failure.
setAudioScenario
Sets audio scenarios.
virtual int setAudioScenario(AUDIO_SCENARIO_TYPE scenario) = 0;
Details
Parameters
- scenario
- The audio scenarios. See AUDIO_SCENARIO_TYPE. Under different audio scenarios, the device uses different volume types.
Returns
- 0: Success.
- < 0: Failure.
setBeautyEffectOptions
Sets the image enhancement options.
virtual int setBeautyEffectOptions(bool enabled, BeautyOptions options) = 0;
Details
Enables or disables image enhancement, and sets the options.
- Call this method before calling enableVideo or startPreview [1/2].
- This method relies on the video enhancement dynamic library
libagora_clear_vision_extension.dll
. If the dynamic library is deleted, the function cannot be enabled normally.
Parameters
- enabled
- Whether to enable the image enhancement function:
true
: Enable the image enhancement function.false
: (Default) Disable the image enhancement function.
- options
- The image enhancement options. See BeautyOptions.
Returns
- 0: Success.
- < 0: Failure.
setCameraAutoFocusFaceModeEnabled
Enables the camera auto-face focus function.
virtual int setCameraAutoFocusFaceModeEnabled(bool enabled) = 0;
Details
- This method is for Android and iOS only.
- Call this method after the camera is started, such as after joinChannel [2/2], enableVideo or enableLocalVideo.
Parameters
- enabled
-
Whether to enable face autofocus:
true
: Enable the camera auto-face focus function.false
: Disable face autofocus.
Returns
- 0: Success.
- < 0: Failure.
setCameraAutoExposureFaceModeEnabled
Sets whether to enable auto exposure.
virtual int setCameraAutoExposureFaceModeEnabled(bool enabled) = 0;
Details
- This method applies to iOS only.
- Call this method before calling joinChannel [2/2], enableVideo, or enableLocalVideo, depending on which method you use to turn on your local camera.
Parameters
- enabled
-
Whether to enable auto exposure:
true
: Enable auto exposure.false
: Disable auto exposure.
Returns
- 0: Success.
- < 0: Failure.
setCameraCapturerConfiguration
Sets the camera capture configuration.
virtual int setCameraCapturerConfiguration(const CameraCapturerConfiguration& config) = 0;
Details
- This method is for Android and iOS only.
- Call this method before calling joinChannel [2/2], enableVideo, or enableLocalVideo, depending on which method you use to turn on your local camera.
Parameters
- config
- The camera capture configuration. See CameraCapturerConfiguration.Note: In this method, you do not need to set the deviceId parameter.
Returns
- 0: Success.
- < 0: Failure.
setCameraDeviceOrientation
Sets the rotation angle of the captured video.
virtual int setCameraDeviceOrientation(VIDEO_SOURCE_TYPE type, VIDEO_ORIENTATION orientation) = 0;
Details
This method applies to Windows only.
When the video capture device does not have the gravity sensing function, you can call this method to manually adjust the rotation angle of the captured video.
Parameters
- type
- The video source type. See VIDEO_SOURCE_TYPE.
- orientation
- The clockwise rotation angle. See VIDEO_ORIENTATION.
Returns
- 0: Success.
- < 0: Failure.
setCameraExposurePosition
Sets the camera exposure position.
virtual int setCameraExposurePosition(float positionXinView, float positionYinView) = 0;
Details
This method needs to be called after the camera is started (for example, by calling startPreview [1/2] or joinChannel [2/2]).
After a successful method call, the SDK triggers the onCameraExposureAreaChanged callback.
Parameters
- positionXinView
- The horizontal coordinate of the touchpoint in the view.
- positionYinView
- The vertical coordinate of the touchpoint in the view.
Returns
- 0: Success.
- < 0: Failure.
setCameraFocusPositionInPreview
Sets the camera manual focus position.
virtual int setCameraFocusPositionInPreview(float positionX, float positionY) = 0;
Details
This method needs to be called after the camera is started (for example, by calling startPreview [1/2] or joinChannel [2/2]). After a successful method call, the SDK triggers the onCameraFocusAreaChanged callback.
Parameters
- positionX
- The horizontal coordinate of the touchpoint in the view.
- positionY
- The vertical coordinate of the touchpoint in the view.
Returns
- 0: Success.
- < 0: Failure.
setCameraTorchOn
Enables the camera flash.
virtual int setCameraTorchOn(bool isOn) = 0;
Details
- This method is for Android and iOS only.
- Call this method before calling joinChannel [2/2], enableVideo, or enableLocalVideo, depending on which method you use to turn on your local camera.
Parameters
- isOn
-
Whether to turn on the camera flash:
true
: Turn on the flash.false
: (Default) Turn off the flash.
Returns
- 0: Success.
- < 0: Failure.
setCameraZoomFactor
Sets the camera zoom ratio.
virtual int setCameraZoomFactor(float factor) = 0;
Details
- This method is for Android and iOS only.
- Call this method before calling joinChannel [2/2], enableVideo, or enableLocalVideo, depending on which method you use to turn on your local camera.
Parameters
- The camera zoom ratio. The value ranges between 1.0 and the maximum zoom supported by the device. You can get the maximum zoom ratio supported by the device by calling the getCameraMaxZoomFactor method.
Returns
- The camera zoom factor value, if successful.
- < 0: if the method if failed.
setChannelProfile
Sets the channel profile.
virtual int setChannelProfile(CHANNEL_PROFILE_TYPE profile) = 0;
Details
After initializing the SDK, the default channel profile is the live streaming profile. You can call this method to set the usage scenario of the channel. For example, it prioritizes smoothness and low latency for a video call, and prioritizes video quality for the interactive live video streaming.
- To ensure the quality of real-time communication, Agora recommends that all users in a channel use the same channel profile.
- This method must be called and set before joinChannel [2/2], and cannot be set again after joining the channel.
- The default audio route and video encoding bitrate are different in different channel profiles. See setDefaultAudioRouteToSpeakerphone and setVideoEncoderConfiguration.
Parameters
- profile
-
The channel profile. See CHANNEL_PROFILE_TYPE.
Returns
- 0(ERR_OK): Success.
- < 0: Failure.
- -2: The parameter is invalid.
- -7: The SDK is not initialized.
setCloudProxy
Sets up cloud proxy service.
virtual int setCloudProxy(CLOUD_PROXY_TYPE proxyType) = 0;
Details
When users' network access is restricted by a firewall, configure the firewall to allow specific IP addresses and ports provided by Agora; then, call this method to enable the cloud proxyType and set the cloud proxy type with the proxyType parameter.
After successfully connecting to the cloud proxy, the SDK triggers the onConnectionStateChanged (CONNECTION_STATE_CONNECTING, CONNECTION_CHANGED_SETTING_PROXY_SERVER) callback.
To disable the cloud proxy that has been set, call the setCloudProxy (NONE_PROXY)
.
To change the cloud proxy type that has been set, call the setCloudProxy (NONE_PROXY)
first, and then call the setCloudProxy to set the proxyType you want.
- Agora recommends that you call this method after joining a channel.
- When a user is behind a firewall and uses the Force UDP cloud proxy, the services for Media Push and cohosting across channels are not available.
- When you use the Force TCP cloud proxy, note that an error would occur when calling the startAudioMixing [2/2] method to play online music files in the HTTP protocol. The services for Media Push and cohosting across channels use the cloud proxy with the TCP protocol.
Parameters
- proxyType
-
The type of the cloud proxy. See CLOUD_PROXY_TYPE.
This parameter is mandatory. The SDK reports an error if you do not pass in a value.
Returns
- 0: Success.
- < 0: Failure.
- -2: The parameter is invalid.
- -7: The SDK is not initialized.
setClientRole [1/2]
Sets the client role.
virtual int setClientRole(CLIENT_ROLE_TYPE role) = 0;
Details
You can call this method either before or after joining the channel to set the user role as audience or host.
If you call this method to set the user's role as the host before joining the channel and set the local video property through the setupLocalVideo method, the local video preview is automatically enabled when the user joins the channel.
- The local client: onClientRoleChanged.
- The remote client: onUserJoined or
onUserOffline(USER_OFFLINE_BECOME_AUDIENCE)
.
Parameters
- role
-
The user role. See CLIENT_ROLE_TYPE.
Returns
- 0: Success.
- < 0: Failure.
- -1: A general error occurs (no specified reason).
- -2: The parameter is invalid.
- -7: The SDK is not initialized.
setClientRole [2/2]
Sets the user role and level in an interactive live streaming channel.
virtual int setClientRole(CLIENT_ROLE_TYPE role, const ClientRoleOptions& options) = 0;
Details
In the interactive live streaming profile, the SDK sets the user role as audience by default. You can call this method to set the user role as host.
You can call this method either before or after joining a channel.
If you call this method to set the user's role as the host before joining the channel and set the local video property through the setupLocalVideo method, the local video preview is automatically enabled when the user joins the channel.
- Calls muteLocalAudioStream and muteLocalVideoStream to change the publishing state.
- Triggers onClientRoleChanged on the local client.
- Triggers onUserJoined or onUserOffline on the remote client.
- The user role (role) determines the permissions that the SDK grants to a user, such as permission to send local streams, receive remote streams, and push streams to a CDN address.
- The user level (level) determines the level of services that a user can enjoy within the permissions of the user's role. For example, an audience member can choose to receive remote streams with low latency or ultra-low latency. User level affects the pricing of services.
Parameters
- role
- The user role in the interactive live streaming. See CLIENT_ROLE_TYPE.
- options
- The detailed options of a user, including the user level. See ClientRoleOptions.
Returns
- 0: Success.
- < 0: Failure.
- -1: A general error occurs (no specified reason).
- -2: The parameter is invalid.
- -5: The request is rejected.
- -7: The SDK is not initialized.
setColorEnhanceOptions
Sets color enhancement.
virtual int setColorEnhanceOptions(bool enabled, const ColorEnhanceOptions& options) = 0;
Details
The video images captured by the camera can have color distortion. The color enhancement feature intelligently adjusts video characteristics such as saturation and contrast to enhance the video color richness and color reproduction, making the video more vivid.
You can call this method to enable the color enhancement feature and set the options of the color enhancement effect.
- Call this method after calling enableVideo.
- The color enhancement feature has certain performance requirements on devices. With color enhancement turned on, Agora recommends that you change the color enhancement level to one that consumes less performance or turn off color enhancement if your device is experiencing severe heat problems.
- Both this method and setExtensionProperty can enable color enhancement:
- When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
- When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using setExtensionProperty.
- This method relies on the video enhancement dynamic library
libagora_clear_vision_extension.dll
. If the dynamic library is deleted, the function cannot be enabled normally.
Parameters
- enabled
- Whether to enable color enhancement:
true
Enable color enhancement.false
: (Default) Disable color enhancement.
- options
- The color enhancement options. See ColorEnhanceOptions.
- type
- The type of the video source. See MEDIA_SOURCE_TYPE.
Returns
- 0: Success.
- < 0: Failure.
setDefaultAudioRouteToSpeakerphone
Sets the default audio playback route.
virtual int setDefaultAudioRouteToSpeakerphone(bool defaultToSpeaker) = 0;
Details
- This method applies to Android and iOS only.
- Ensure that you call this method before joining a channel. If you need to change the audio route after joining a channel, call setEnableSpeakerphone.
Most mobile phones have two audio routes: an earpiece at the top, and a speakerphone at the bottom. The earpiece plays at a lower volume, and the speakerphone at a higher volume. When setting the default audio route, you determine whether audio playback comes through the earpiece or speakerphone when no external audio device is connected.
- Voice call: Earpiece.
- Audio broadcast: Speakerphone.
- Video call: Speakerphone.
- Video broadcast: Speakerphone.
You can call this method to change the default audio route. After a successful method call, the SDK triggers the onAudioRoutingChanged callback.
The system audio route changes when an external audio device, such as a headphone or a Bluetooth audio device, is connected. See Audio Route for detailed change principles.
Parameters
- defaultToSpeaker
- Whether to set the speakerphone as the default audio route:
true
: Set the speakerphone as the default audio route.false
: Set the earpiece as the default audio route.
Returns
- 0: Success.
- < 0: Failure.
setDirectCdnStreamingAudioConfiguration
Sets the audio profile of the audio streams directly pushed to the CDN by the host.
virtual int setDirectCdnStreamingAudioConfiguration(AUDIO_PROFILE_TYPE profile) = 0;
When you set the publishMicrophoneTrack or publishCustomAudioTrack in the DirectCdnStreamingMediaOptions as true
to capture audios, you can call this method to set the audio profile.
Parameters
- profile
-
The audio profile, including the sampling rate, bitrate, encoding mode, and the number of channels. See AUDIO_PROFILE_TYPE.
Returns
- 0: Success.
- < 0: Failure.
setDirectCdnStreamingVideoConfiguration
Sets the video profile of the media streams directly pushed to the CDN by the host.
virtual
int setDirectCdnStreamingVideoConfiguration(const VideoEncoderConfiguration& config)
= 0;
Details
This method only affects video streams captured by cameras or screens, or from custom video capture sources. That is, when you set publishCameraTrack or publishCustomVideoTrack in DirectCdnStreamingMediaOptions as true
to capture videos, you can call this method to set the video profiles.
If your local camera does not support the video resolution you set,the SDK automatically adjusts the video resolution to a value that is closest to your settings for capture, encoding or streaming, with the same aspect ratio as the resolution you set. You can get the actual resolution of the video streams through the onDirectCdnStreamingStats callback.
Parameters
- config
- Video profile. See VideoEncoderConfiguration.Note: During CDN live streaming, Agora only supports setting ORIENTATION_MODE as ORIENTATION_FIXED_LANDSCAPE or ORIENTATION_FIXED_PORTRAIT.
Returns
- 0: Success.
- < 0: Failure.
setDualStreamMode [1/2]
Sets the dual-stream mode on the sender side.
virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode) = 0;
Details
- Since
- v4.0.1
- If you want to modify this behavior, you can call this method and modify the mode to DISABLE_SIMULCAST_STREAM (never send low-quality video streams) or ENABLE_SIMULCAST_STREAM (always send low-quality video streams).
- If you want to restore the default behavior after making changes, you can call this method again with mode set to AUTO_SIMULCAST_STREAM.
- When calling this method and setting mode to DISABLE_SIMULCAST_STREAM, it has the same effect as
enableDualStreamMode [1/2](false)
. - When calling this method and setting mode to ENABLE_SIMULCAST_STREAM, it has the same effect as
enableDualStreamMode [1/2](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 SIMULCAST_STREAM_MODE.
Returns
- 0: Success.
- < 0: Failure.
setDualStreamMode [2/2]
Sets dual-stream mode configuration on the sender, and sets the low-quality video stream.
virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode,
const SimulcastStreamConfig& streamConfig) = 0;
Details
- 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 (never send low-quality video streams) or ENABLE_SIMULCAST_STREAM (always send low-quality video streams).
The difference between this method and setDualStreamMode [1/2] is that this method can also configure the low-quality video stream, and the SDK sends the stream according to the configuration in streamConfig.
- When calling this method and setting mode to DISABLE_SIMULCAST_STREAM, it has the same effect as
enableDualStreamMode [1/2](false)
. - When calling this method and setting mode to ENABLE_SIMULCAST_STREAM, it has the same effect as
enableDualStreamMode [1/2](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 SIMULCAST_STREAM_MODE.
- streamConfig
-
The configuration of the low-quality video stream. See SimulcastStreamConfig.
Note: When setting mode to DISABLE_SIMULCAST_STREAM, setting streamConfig will not take effect.
Returns
- 0: Success.
- < 0: Failure.
setEarMonitoringAudioFrameParameters
Sets the format of the in-ear monitoring raw audio data.
virtual int setEarMonitoringAudioFrameParameters(int sampleRate, int channel,
RAW_AUDIO_FRAME_OP_MODE_TYPE mode,
int samplesPerCall) = 0;
Details
This method is used to set the in-ear monitoring audio data format reported by the onEarMonitoringAudioFrame callback.
- Before calling this method, you need to call enableInEarMonitoring, and set includeAudioFilters to EAR_MONITORING_FILTER_BUILT_IN_AUDIO_FILTERS or EAR_MONITORING_FILTER_NOISE_SUPPRESSION.
- The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method.Sample interval (sec) = samplePerCall/(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the onEarMonitoringAudioFrame callback according to the sampling interval.
Parameters
- sampleRate
- The sample rate of the audio data reported in the onEarMonitoringAudioFrame callback, which can be set as 8,000, 16,000, 32,000, 44,100, or 48,000 Hz.
- channel
-
The number of audio channels reported in the onEarMonitoringAudioFrame callback.
- 1: Mono.
- 2: Stereo.
- mode
-
The use mode of the audio frame. See RAW_AUDIO_FRAME_OP_MODE_TYPE.
- samplesPerCall
- The number of data samples reported in the onEarMonitoringAudioFrame callback, such as 1,024 for the Media Push.
Returns
- 0: Success.
- < 0: Failure.
setEffectPosition
Sets the playback position of an audio effect file.
virtual int setEffectPosition(int soundId, int pos) = 0;
Details
After a successful setting, the local audio effect file starts playing at the specified position.
Parameters
- soundId
- The audio effect ID. The ID of each audio effect file is unique.
- pos
- The playback position (ms) of the audio effect file.
Returns
- 0: Success.
- < 0: Failure.
setEffectsVolume
Sets the volume of the audio effects.
virtual int setEffectsVolume(int volume) = 0;
Details
Parameters
- volume
- The playback volume. The value range is [0, 100]. The default value is 100, which represents the original volume.
Returns
- 0: Success.
- < 0: Failure.
setEnableSpeakerphone
Enables/Disables the audio route to the speakerphone.
virtual int setEnableSpeakerphone(bool speakerOn) = 0;
Details
If the default audio route of the SDK (see Set the Audio Route) or the setting in setDefaultAudioRouteToSpeakerphone cannot meet your requirements, you can call setEnableSpeakerphone to switch the current audio route. After a successful method call, the SDK triggers the onAudioRoutingChanged callback.
This method only sets the audio route in the current channel and does not influence the default audio route. If the user leaves the current channel and joins another channel, the default audio route is used.
- This method applies to Android and iOS only.
- Call this method after joining a channel.
- If the user uses an external audio playback device such as a Bluetooth or wired headset, this method does not take effect, and the SDK plays audio through the external device. When the user uses multiple external devices, the SDK plays audio through the last connected device.
Parameters
- speakerOn
-
Sets whether to enable the speakerphone or earpiece:
true
: Enable device state monitoring. The audio route is the speakerphone.false
: Disable device state monitoring. The audio route is the earpiece.
Returns
- 0: Success.
- < 0: Failure.
setEncryptionMode
Sets the built-in encryption mode.
virtual int setEncryptionMode(const char* encryptionMode) = 0;
Details
- Deprecated:
- Use enableEncryption instead.
The SDK supports built-in encryption schemes, AES-128-GCM is supported by default. Call this method to use other encryption modes. All users in the same channel must use the same encryption mode and secret. Refer to the information related to the AES encryption algorithm on the differences between the encryption modes.
Parameters
- encryptionMode
-
The following encryption modes:
- "
aes-128-xts
": 128-bit AES encryption, XTS mode. - "
aes-128-ecb
": 128-bit AES encryption, ECB mode. - "
aes-256-xts
": 256-bit AES encryption, XTS mode. - "
sm4-128-ecb
": 128-bit SM4 encryption, ECB mode. - "
aes-128-gcm
": 128-bit AES encryption, GCM mode. - "
aes-256-gcm
": 256-bit AES encryption, GCM mode. - "": When this parameter is set as null, the encryption mode is set as "
aes-128-gcm
" by default.
- "
Returns
- 0: Success.
- < 0: Failure.
setEncryptionSecret
Enables built-in encryption with an encryption password before users join a channel.
virtual int setEncryptionSecret(const char* secret) = 0;
Details
- Deprecated:
- Use enableEncryption instead.
Before joining the channel, you need to call this method to set the secret parameter to enable the built-in encryption. All users in the same channel should use the same secret. The secret is automatically cleared once a user leaves the channel. If you do not specify the secret or secret is set as null, the built-in encryption is disabled.
- Do not use this method for Media Push.
- For optimal transmission, ensure that the encrypted data size does not exceed the original data size + 16 bytes. 16 bytes is the maximum padding size for AES encryption.
Parameters
- secret
- The encryption password.
Returns
- 0: Success.
- < 0: Failure.
setExtensionProperty
Sets the properties of the extension.
virtual int setExtensionProperty(
const char* provider, const char* extension,
const char* key, const char* value, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
Details
After enabling the extension, you can call this method to set the properties of the extension.
Parameters
- provider
- The name of the extension provider.
- extension
- The name of the extension.
- key
- The key of the extension.
- value
- The value of the extension key.
- type
- Type of media source. See MEDIA_SOURCE_TYPE.Attention: In this method, this parameter supports only the following two settings:
- The default value is UNKNOWN_MEDIA_SOURCE.
- If you want to use the second camera to capture video, set this parameter to SECONDARY_CAMERA_SOURCE.
Returns
- 0: Success.
- < 0: Failure.
setExtensionProviderProperty
Sets the properties of the extension provider.
virtual int setExtensionProviderProperty(
const char* provider, const char* key, const char* value) = 0;
Details
You can call this method to set the attributes of the extension provider and initialize the relevant parameters according to the type of the provider.
Call this method after enableExtension, and before enabling the audio (enableAudio/enableLocalAudio) or the video (enableVideo/enableLocalVideo).
Parameters
- provider
- The name of the extension provider.
- key
- The key of the extension.
- value
- The value of the extension key.
Returns
- 0: Success.
- < 0: Failure.
setExternalAudioSink
Sets the external audio sink.
virtual int setExternalAudioSink(bool enabled, int sampleRate, int channels) = 0;
Details
This method applies to scenarios where you want to use external audio data for playback. After you set the external audio sink, you can call pullAudioFrame to pull remote audio frames. The app can process the remote audio and play it with the audio effects that you want.
Parameters
- enabled
-
Whether to enable or disable the external audio sink:
true
: Enables the external audio sink.false
: (Default) Disables the external audio sink.
- sampleRate
-
The sample rate (Hz) of the external audio sink, which can be set as 16000, 32000, 44100, or 48000.
- channels
- The number of audio channels of the external audio sink:
- 1: Mono.
- 2: Stereo.
Returns
- 0: Success.
- < 0: Failure.
setExternalAudioSource
Sets the external audio source parameters.
virtual int setExternalAudioSource(bool enabled,
int sampleRate,
int channels,
int sourceNumber,
bool localPlayback = false,
bool publish = true) = 0;
Details
Parameters
- enabled
-
Whether to enable the external audio source:
true
: Enable the external audio source.false
: (Default) Disable the external audio source.
- sampleRate
- The sample rate (Hz) of the external audio source which can be set as
8000
,16000
,32000
,44100
, or48000
. - channels
- The number of channels of the external audio source, which can be set as
1
(Mono) or2
(Stereo). - sourceNumber
- The number of external audio sources. The value of this parameter should be larger than 0. The SDK creates a corresponding number of custom audio tracks based on this parameter value and names the audio tracks starting from 0. In ChannelMediaOptions, you can set publishCustomAudioSourceId to the audio track ID you want to publish.
- localPlayback
-
Whether to play the external audio source:
true
: Play the external audio source.false
: (Default) Do not play the external source.
- publish
-
Whether to publish audio to the remote users:
true
: (Default) Publish audio to the remote users.false
: Do not publish audio to the remote users.
Returns
- 0: Success.
- < 0: Failure.
setHeadphoneEQParameters
Sets the low- and high-frequency parameters of the headphone equalizer.
virtual int setHeadphoneEQParameters(int lowGain, int highGain) = 0;
Details
- Since
- v4.1.0
In a spatial audio effect scenario, if the preset headphone equalization effect is not achieved after calling the setHeadphoneEQPreset method, you can further adjust the headphone equalization effect by calling this method.
Parameters
- lowGain
- The low-frequency parameters of the headphone equalizer. The value range is [-10,10]. The larger the value, the deeper the sound.
- highGain
- The high-frequency parameters of the headphone equalizer. The value range is [-10,10]. The larger the value, the sharper the sound.
Returns
- 0: Success.
- < 0: Failure.
- -1: A general error occurs (no specified reason).
setHeadphoneEQPreset
Sets the preset headphone equalization effect.
virtual int setHeadphoneEQPreset(HEADPHONE_EQUALIZER_PRESET preset) = 0;
Details
- Since
- v4.0.1
This method is mainly used in spatial audio effect scenarios. You can select the preset headphone equalizer to listen to the audio to achieve the expected audio experience.
Parameters
- preset
- The preset headphone equalization effect. See HEADPHONE_EQUALIZER_PRESET.
Returns
- 0: Success.
- < 0: Failure.
- -1: A general error occurs (no specified reason).
setInEarMonitoringVolume
Sets the volume of the in-ear monitor.
virtual int setInEarMonitoringVolume(int volume) = 0;
Details
- This method applies to Android and iOS only.
- Users must use wired earphones to hear their own voices.
- You can call this method either before or after joining a channel.
Parameters
- volume
- The volume of the in-ear monitor. The value ranges between 0 and 100. The default value is 100.
Returns
- 0: Success.
- < 0: Failure.
setLocalRenderMode [1/2]
Sets the local video display mode.
virtual int setLocalRenderMode(media::base::RENDER_MODE_TYPE renderMode) = 0;
Details
- Deprecated:
- This method is deprecated. Use setLocalRenderMode [2/2] instead.
Call this method to set the local video display mode. This method can be called multiple times during a call to change the display mode.
Parameters
- renderMode
-
The local video display mode. See RENDER_MODE_TYPE.
Returns
- 0: Success.
- < 0: Failure.
setLocalRenderMode [2/2]
Updates the display mode of the local video view.
virtual int setLocalRenderMode(media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0;
Details
After initializing the local video view, you can call this method to update its rendering and mirror modes. It affects only the video view that the local user sees, not the published local video stream.
- Ensure that you have called the setupLocalVideo method to initialize the local video view before calling this method.
- During a call, you can call this method as many times as necessary to update the display mode of the local video view.
Parameters
- renderMode
-
The local video display mode. See RENDER_MODE_TYPE.
- mirrorMode
-
The mirror mode of the local video view. See VIDEO_MIRROR_MODE_TYPE.
Attention: If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default.
Returns
- 0: Success.
- < 0: Failure.
setLocalVideoMirrorMode
Sets the local video mirror mode.
virtual int setLocalVideoMirrorMode(VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0;
Details
- Deprecated:
- This method is deprecated.
Parameters
- mirrorMode
-
The local video mirror mode. See VIDEO_MIRROR_MODE_TYPE.
Returns
- 0: Success.
- < 0: Failure.
setLocalVoiceEqualization
Sets the local voice equalization effect.
virtual int setLocalVoiceEqualization(AUDIO_EQUALIZATION_BAND_FREQUENCY bandFrequency, int bandGain) = 0;
Details
Parameters
- bandFrequency
- The band frequency. The value ranges between 0 and 9; representing the respective 10-band center frequencies of the voice effects, including 31, 62, 125, 250, 500, 1k, 2k, 4k, 8k, and 16k Hz. See AUDIO_EQUALIZATION_BAND_FREQUENCY.
- bandGain
- The gain of each band in dB. The value ranges between -15 and 15. The default value is 0.
Returns
- 0: Success.
- < 0: Failure.
setLocalVoiceFormant
Set the formant ratio to change the timbre of human voice.
virtual int setLocalVoiceFormant(double formantRatio) = 0;
Details
- Since
- v4.2.0
Formant ratio affects the timbre of voice. The smaller the value, the deeper the sound will be, and the larger, the sharper.
Parameters
- formantRatio
- The formant ratio. The value range is [-1.0, 1.0]. The default value is 0.0, which means do not change the timbre of the voice.Note: Agora recommends setting this value within the range of [-0.4, 0.6]. Otherwise, the voice may be seriously distorted.
Returns
- 0: Success.
- < 0: Failure.
setLocalVoicePitch
Changes the voice pitch of the local speaker.
virtual int setLocalVoicePitch(double pitch) = 0;
Details
Parameters
- pitch
- The local voice pitch. The value range is [0.5,2.0]. The lower the value, the lower the pitch. The default value is 1.0 (no change to the pitch).
Returns
- 0: Success.
- < 0: Failure.
setLocalVoiceReverb
Sets the local voice reverberation.
virtual int setLocalVoiceReverb(AUDIO_REVERB_TYPE reverbKey, int value) = 0;
Details
The SDK provides an easier-to-use method, setAudioEffectPreset, to directly implement preset reverb effects for such as pop, R&B, and KTV.
Parameters
- reverbKey
- The reverberation key. Agora provides five reverberation keys, see AUDIO_REVERB_TYPE.
- value
- The value of the reverberation key.
Returns
- 0: Success.
- < 0: Failure.
setLogFile
Sets the log file.
virtual int setLogFile(const char* filePath) = 0;
Details
- Deprecated:
- Use the
mLogConfig
parameter in initialize method instead.
Specifies an SDK output log file. The log file records all log data for the SDK’s operation. Ensure that the directory for the log file exists and is writable.
Ensure that you call initialize immediately after calling the IRtcEngine method, or the output log may not be complete.
Parameters
- filePath
- The complete path of the log files. These log files are encoded in UTF-8.
Returns
- 0: Success.
- < 0: Failure.
setLogFileSize
Sets the log file size.
virtual int setLogFileSize(unsigned int fileSizeInKBytes) = 0;
Details
- Deprecated:
- Use the
logConfig
parameter in initialize instead.
By default, the SDK generates five SDK log files and five API call log files with the following rules:
- The SDK log files are:
agorasdk.log
,agorasdk.1.log
,agorasdk.2.log
,agorasdk.3.log
, andagorasdk.4.log
. - The API call log files are:
agoraapi.log
,agoraapi.1.log
,agoraapi.2.log
,agoraapi.3.log
, andagoraapi.4.log
. - The default size for each SDK log file is 1,024 KB; the default size for each API call log file is 2,048 KB. These log files are encoded in UTF-8.
- The SDK writes the latest logs in
agorasdk.log
oragoraapi.log
. - When
agorasdk.log
is full, the SDK processes the log files in the following order:- Delete the
agorasdk.4.log
file (if any). - Rename
agorasdk.3.log
toagorasdk.4.log
. - Rename
agorasdk.2.log
toagorasdk.3.log
. - Rename
agorasdk.1.log
toagorasdk.2.log
. - Create a new
agorasdk.log
file.
- Delete the
- The overwrite rules for the
agoraapi.log
file are the same as foragorasdk.log
.
This method is used to set the size of the agorasdk.log
file only and does not effect the agoraapi.log file
.
Parameters
- fileSizeInKBytes
-
The size (KB) of an
agorasdk.log
file. The value range is [128,20480]. The default value is 1,024 KB. If you setfileSizeInKByte
smaller than 128 KB, the SDK automatically adjusts it to 128 KB; if you setfileSizeInKByte
greater than 20,480 KB, the SDK automatically adjusts it to 20,480 KB.
Returns
- 0: Success.
- < 0: Failure.
setLogFilter
Sets the log output level of the SDK.
virtual int setLogFilter(unsigned int filter) = 0;
Details
- Deprecated:
- Use logConfig in initialize instead.
This method sets the output log level of the SDK. You can use one or a combination of the log filter levels. The log level follows the sequence of LOG_FILTER_OFF, LOG_FILTER_CRITICAL, LOG_FILTER_ERROR, LOG_FILTER_WARN, LOG_FILTER_INFO, and LOG_FILTER_DEBUG. Choose a level to see the logs preceding that level.
If, for example, you set the log level to LOG_FILTER_WARN, you see the logs within levels LOG_FILTER_CRITICAL, LOG_FILTER_ERROR and LOG_FILTER_WARN.
Parameters
- filter
-
The output log level of the SDK. See LOG_FILTER_TYPE.
Returns
- 0: Success.
- < 0: Failure.
setLogLevel
Sets the output log level of the SDK.
virtual int setLogLevel(commons::LOG_LEVEL level) = 0;
Details
- Deprecated:
- This method is deprecated. Use RtcEngineContext instead to set the log output level.
Choose a level to see the logs preceding that level.
Parameters
- level
- The log level: LOG_LEVEL.
Returns
- 0: Success.
- < 0: Failure.
setLowlightEnhanceOptions
Sets low-light enhancement.
virtual int setLowlightEnhanceOptions(bool enabled, const LowlightEnhanceOptions& options) = 0;
Details
The low-light enhancement feature can adaptively adjust the brightness value of the video captured in situations with low or uneven lighting, such as backlit, cloudy, or dark scenes. It restores or highlights the image details and improves the overall visual effect of the video.
You can call this method to enable the color enhancement feature and set the options of the color enhancement effect.
- Call this method after calling enableVideo.
- Dark light enhancement has certain requirements for equipment performance. The low-light enhancement feature has certain performance requirements on devices. If your device overheats after you enable low-light enhancement, Agora recommends modifying the low-light enhancement options to a less performance-consuming level or disabling low-light enhancement entirely.
- Both this method and setExtensionProperty can turn on low-light enhancement:
- When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
- When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using setExtensionProperty.
- This method relies on the video enhancement dynamic library
libagora_clear_vision_extension.dll
. If the dynamic library is deleted, the function cannot be enabled normally.
Parameters
- enabled
- Whether to enable low-light enhancement function:
true
: Enable low-light enhancement function.false
: (Default) Disable low-light enhancement function.
- options
- The low-light enhancement options. See LowlightEnhanceOptions.
- type
- The type of the video source. See MEDIA_SOURCE_TYPE.
Returns
- 0: Success.
- < 0: Failure.
setMixedAudioFrameParameters
Sets the audio data format reported by onMixedAudioFrame.
virtual int setMixedAudioFrameParameters(int sampleRate, int channel, int samplesPerCall) = 0;
Parameters
- sampleRate
-
The sample rate (Hz) of the audio data, which can be set as
8000
,16000
,32000
,44100
, or48000
.
- channel
-
The number of channels of the audio data, which can be set as
1(Mono)
or2(Stereo)
.
- samplesPerCall
-
Sets the number of samples. In Media Push scenarios, set it as
1024
.
The SDK triggers the onMixedAudioFrame callback according to the sample interval. Sampleinterval (sec) = samplePerCall
/(sampleRate
× channel
) Ensure that the value of sample interval more than or equal to 0.01.
Returns
- 0: Success.
- < 0: Failure.
setParameters [1/2]
Provides technical preview functionalities or special customizations by configuring the SDK with JSON options.
virtual int setParameters(const char* parameters) = 0;
- Since
- v4.1.0
Contact to get the JSON configuration method.
Parameters
- parameters
- Pointer to the set parameters in a JSON string.
Returns
- 0: Success.
- < 0: Failure.
setParameters [2/2]
Provides the technical preview functionalities or special customizations by configuring the SDK with JSON options.
virtual int setParameters(const char* parameters) = 0;
Details
Contact to get the JSON configuration method.
Parameters
- parameters
- Pointer to the set parameters in a JSON string.
Returns
- 0: Success.
- < 0: Failure.
setPlaybackAudioFrameBeforeMixingParameters
Sets the audio data format reported by onPlaybackAudioFrameBeforeMixing.
virtual int setPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel) = 0;
Parameters
- sampleRate
-
The sample rate (Hz) of the audio data, which can be set as
8000
,16000
,32000
,44100
, or48000
.
- channel
-
The number of channels of the external audio source, which can be set as
1
(Mono) or2
(Stereo).
Returns
- 0: Success.
- < 0: Failure.
setPlaybackAudioFrameParameters
Sets the audio data format for playback.
virtual int setPlaybackAudioFrameParameters(int sampleRate,
int channel,
RAW_AUDIO_FRAME_OP_MODE_TYPE mode,
int samplesPerCall) = 0;
Details
Sets the data format for the onPlaybackAudioFrame callback.
- Ensure that you call this method before joining a channel.
- The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method.Sample interval (sec) = samplePerCall/(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the callback according to the sampling interval.onPlaybackAudioFrame
Parameters
- sampleRate
- The sample rate returned in the onPlaybackAudioFrame callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
- channel
-
The number of channels returned in the onPlaybackAudioFrame callback:
- 1: Mono.
- 2: Stereo.
- mode
-
The use mode of the audio frame. See RAW_AUDIO_FRAME_OP_MODE_TYPE.
- samplesPerCall
- The number of data samples returned in the onPlaybackAudioFrame callback, such as 1024 for the Media Push.
Returns
- 0: Success.
- < 0: Failure.
setRecordingAudioFrameParameters
Sets the format of the captured raw audio data.
virtual int setRecordingAudioFrameParameters(int sampleRate,
int channel,
RAW_AUDIO_FRAME_OP_MODE_TYPE mode,
int samplesPerCall) = 0;
Details
Sets the audio format for the onRecordAudioFrame callback.
- Ensure that you call this method before joining a channel.
- The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method.Sample interval (sec) = samplePerCall/(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the onRecordAudioFrame callback according to the sampling interval.
Parameters
- sampleRate
- The sample rate returned in the onRecordAudioFrame callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
- channel
-
The number of channels returned in the onRecordAudioFrame callback:
- 1: Mono.
- 2: Stereo.
- mode
-
The use mode of the audio frame. See RAW_AUDIO_FRAME_OP_MODE_TYPE.
- samplesPerCall
- The number of data samples returned in the onRecordAudioFrame callback, such as 1024 for the Media Push.
Returns
- 0: Success.
- < 0: Failure.
setRemoteDefaultVideoStreamType
Sets the default stream type of subscrption for remote video streams.
virtual int setRemoteDefaultVideoStreamType(VIDEO_STREAM_TYPE streamType) = 0;
Details
Under limited network conditions, if the publisher has not disabled the dual-stream mode using enableDualStreamMode [2/2] (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.
- Call this method before joining a channel. The SDK does not support changing the default subscribed video stream type after joining a channel.
- If you call both this method and setRemoteVideoStreamType, the SDK applies the settings in the setRemoteVideoStreamType method.
Parameters
- streamType
-
The default video-stream type. See VIDEO_STREAM_TYPE.
Returns
- 0: Success.
- < 0: Failure.
setRemoteUserSpatialAudioParams
Sets the spatial audio effect parameters of the remote user.
virtual int setRemoteUserSpatialAudioParams(uid_t uid, const agora::SpatialAudioParams& params) = 0;
Details
Call this method after enableSpatialAudio. After successfully setting the spatial audio effect parameters of the remote user, the local user can hear the remote user with a sense of space.
Parameters
- uid
- The user ID. This parameter must be the same as the user ID passed in when the user joined the channel.
- params
- The spatial audio parameters. See SpatialAudioParams.
Returns
- 0: Success.
- < 0: Failure.
setupRemoteVideo
Initializes the video view of a remote user.
virtual int setupRemoteVideo(const VideoCanvas& canvas) = 0;
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.
You need to specify the ID of the remote user in this method. If the remote user ID is unknown to the application, set it after the app receives the onUserJoined callback.
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 setRemoteRenderMode method.
- If you use the Agora recording function, the recording client joins the channel as a placeholder client, triggering the onUserJoined callback. Do not bind the placeholder client to the app view because the placeholder client does not send any video streams. If your app does not recognize the placeholder client, bind the remote user to the view when the SDK triggers the onFirstRemoteVideoDecoded callback.
Parameters
- canvas
-
The remote video view and settings. See VideoCanvas.
Returns
- 0: Success.
- < 0: Failure.
setRemoteRenderMode
Updates the display mode of the video view of a remote user.
virtual int setRemoteRenderMode(uid_t userId, RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0;
Details
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.
Parameters
- userId
- The user ID of the remote user.
- renderMode
-
The rendering mode of the remote user view. For details, see RENDER_MODE_TYPE.
- mirrorMode
-
The mirror mode of the remote user view. See VIDEO_MIRROR_MODE_TYPE.
Returns
- 0: Success.
- < 0: Failure.
setRemoteVideoStreamType
Sets the stream type of the remote video.
virtual int setRemoteVideoStreamType(uid_t uid, VIDEO_STREAM_TYPE streamType) = 0;
Details
Under limited network conditions, if the publisher has not disabled the dual-stream mode using enableDualStreamMode [2/2](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: VIDEO_STREAM_TYPE.
Returns
- 0: Success.
- < 0: Failure.
setRemoteVideoSubscriptionOptions
Options for subscribing to remote video streams.
virtual int setRemoteVideoSubscriptionOptions(uid_t uid, const VideoSubscriptionOptions &options) = 0;
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.
- If you only register one IVideoFrameObserver object, the SDK subscribes to the raw video data and encoded video data by default (the effect is equivalent to setting encodedFrameOnly to
false
). - If you only register one IVideoEncodedFrameObserver object, the SDK only subscribes to the encoded video data by default (the effect is equivalent to setting encodedFrameOnly to
true
). - If you register one IVideoFrameObserver object and one IVideoEncodedFrameObserver object successively, the SDK subscribes to the encoded video data by default (the effect is equivalent to setting encodedFrameOnly to
false
). - If you call this method first with the options parameter set, and then register one IVideoFrameObserver or IVideoEncodedFrameObserver object, you need to call this method again and set the options parameter as described in the above two items to get the desired results.
- Set autoSubscribeVideo to
false
when calling joinChannel [2/2] to join a channel. - Call this method after receiving the onUserJoined callback to set the subscription options for the specified remote user's video stream.
- Call the muteRemoteVideoStream method to resume subscribing to the video stream of the specified remote user. If you set encodedFrameOnly to
true
in the previous step, the SDK triggers the onEncodedVideoFrameReceived callback locally to report the received encoded video frame information.
Parameters
- uid
- The user ID of the remote user.
- options
- The video subscription options. See VideoSubscriptionOptions.
Returns
- 0: Success.
- < 0: Failure.
setRemoteVoicePosition
Sets the 2D position (the position on the horizontal plane) of the remote user's voice.
virtual int setRemoteVoicePosition(uid_t uid, double pan, double gain) = 0;
Details
This method sets the 2D position and volume of a remote user, so that the local user can easily hear and identify the remote user's position.
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 this method to work, enable stereo panning for remote users by calling the enableSoundPositionIndication method before joining a channel.
- 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:
- 0.0: (Default) The remote voice comes from the front.
- -1.0: The remote voice comes from the left.
- 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.
Returns
- 0: Success.
- < 0: Failure.
setScreenCaptureContentHint
Sets the content hint for screen sharing.
virtual int setScreenCaptureContentHint(VIDEO_CONTENT_HINT contentHint) = 0;
Details
A content hint suggests the type of the content being shared, so that the SDK applies different optimization algorithms to different types of content. If you don't call this method, the default content hint is CONTENT_HINT_NONE.
Parameters
- contentHint
- The content hint for screen sharing. See VideoContentHint.
Returns
- 0: Success.
- < 0: Failure.
- -2: The parameter is invalid.
- -8: The screen sharing state is invalid. Probably because you have shared other screens or windows. Try calling stopScreenCapture [1/2] to stop the current sharing and start sharing the screen again.
setScreenCaptureScenario
Sets the screen sharing scenario.
virtual int setScreenCaptureScenario(SCREEN_SCENARIO_TYPE screenScenario) = 0;
Details
When you start screen sharing or window sharing, you can call this method to set the screen sharing scenario. The SDK adjusts the video quality and experience of the sharing according to the scenario.
Parameters
- screenScenario
- The screen sharing scenario. See SCREEN_SCENARIO_TYPE.
Returns
- 0: Success.
- < 0: Failure.
setSubscribeAudioBlocklist
Set the blocklist of subscriptions for audio streams.
virtual int setSubscribeAudioBlocklist(uid_t* uidList, int uidNumber) = 0;
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.
Returns
- 0: Success.
- < 0: Failure.
setSubscribeAudioAllowlist
Sets the allowlist of subscriptions for audio streams.
virtual int setSubscribeAudioAllowlist(uid_t* uidList, int uidNumber) = 0;
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.
Returns
- 0: Success.
- < 0: Failure.
setSubscribeVideoBlocklist
Set the blocklist of subscriptions for video streams.
virtual int setSubscribeVideoBlocklist(uid_t* uidList, int uidNumber) = 0;
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.
Returns
- 0: Success.
- < 0: Failure.
setSubscribeVideoAllowlist
Set the allowlist of subscriptions for video streams.
virtual int setSubscribeVideoAllowlist(uid_t* uidList, int uidNumber) = 0;
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.
Returns
- 0: Success.
- < 0: Failure.
setVideoDenoiserOptions
Sets video noise reduction.
virtual int setVideoDenoiserOptions(bool enabled, const VideoDenoiserOptions& options) = 0;
Details
Underlit environments and low-end video capture devices can cause video images to contain significant noise, which affects video quality. In real-time interactive scenarios, video noise also consumes bitstream resources and reduces encoding efficiency during encoding.
You can call this method to enable the video noise reduction feature and set the options of the video noise reduction effect.
- Call this method after calling enableVideo.
- Video noise reduction has certain requirements for equipment performance. If your device overheats after you enable video noise reduction, Agora recommends modifying the video noise reduction options to a less performance-consuming level or disabling video noise reduction entirely.
- Both this method and setExtensionProperty can turn on video noise reduction function:
- When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
- When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using setExtensionProperty.
- This method relies on the video enhancement dynamic library
libagora_clear_vision_extension.dll
. If the dynamic library is deleted, the function cannot be enabled normally.
Parameters
- enabled
- Whether to enable video noise reduction:
true
: Enable video noise reduction.false
: (Default) Disable video noise reduction.
- options
- The video noise reduction options. See VideoDenoiserOptions.
- type
- The type of the video source. See MEDIA_SOURCE_TYPE.
Returns
- 0: Success.
- < 0: Failure.
setVideoEncoderConfiguration
Sets the video encoder configuration.
virtual int setVideoEncoderConfiguration(const VideoEncoderConfiguration& config) = 0;
Details
Sets the encoder configuration for the local video.
- You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before enableVideo to reduce the time to render the first video frame.
- Both this method and the getMirrorApplied method support setting the mirroring effect. Agora recommends that you only choose one method to set it up. Using both methods at the same time causes the mirroring effect to overlap, which causes the mirroring settings to fail.
Parameters
- config
- Video profile. See VideoEncoderConfiguration.
Returns
- 0: Success.
- < 0: Failure.
setupLocalVideo
Initializes the local video view.
virtual int setupLocalVideo(const VideoCanvas& canvas) = 0;
Details
This method initializes the video view of a local stream on the local device. It affects only the video view that the local user sees, not the published local video stream. Call this method to bind the local video stream to a video view and to set the rendering and mirror modes of the video view.
After initialization, call this method to set the local video and then join the channel. The local video still binds to the view after you leave the channel. To unbind the local video from the view, set the view parameter as NULL.
- You can call this method either before or after joining a channel.
- To update the rendering or mirror mode of the local video view during a call, use the setLocalRenderMode [2/2] method.
Parameters
- canvas
- The local video view and settings. See VideoCanvas.
Returns
- 0: Success.
- < 0: Failure.
setVideoScenario
Sets video application scenarios.
virtual int setVideoScenario(VIDEO_APPLICATION_SCENARIO_TYPE scenarioType) = 0;
Details
- Since
- v4.2.0
After successfully calling this method, the SDK will automatically enable the best practice strategies and adjust key performance metrics based on the specified scenario, to optimize the video experience.
Parameters
- scenarioType
- The type of video application scenario. See VIDEO_APPLICATION_SCENARIO_TYPE.If set to APPLICATION_SCENARIO_MEETING (1), the SDK automatically enables the following strategies:
- In meeting scenarios where low-quality video streams are required to have a high bitrate, the SDK automatically enables multiple technologies used to deal with network congestions, to enhance the performance of the low-quality streams and to ensure the smooth reception by subscribers.
- The SDK monitors the number of subscribers to the high-quality video stream in real time and dynamically adjusts its configuration based on the number of subscribers.
- If nobody subscribers to the high-quality stream, the SDK automatically reduces its bitrate and frame rate to save upstream bandwidth.
- If someone subscribes to the high-quality stream, the SDK resets the high-quality stream to the VideoEncoderConfiguration configuration used in the most recent calling of setVideoEncoderConfiguration. If no configuration has been set by the user previously, the following values are used:
- Resolution: (Windows and macOS) 1280 × 720; (Android and iOS) 960 × 540
- Frame rate: 15 fps
- Bitrate: (Windows and macOS) 1600 Kbps; (Android and iOS) 1000 Kbps
- The SDK monitors the number of subscribers to the low-quality video stream in real time and dynamically enables or disables it based on the number of subscribers.Note: If the user has called setDualStreamMode [2/2] to set that never send low-quality video stream (DISABLE_SIMULCAST_STREAM), the dynamic adjustment of the low-quality stream in meeting scenarios will not take effect.
- If nobody subscribes to the low-quality stream, the SDK automatically disables it to save upstream bandwidth.
- If someone subscribes to the low-quality stream, the SDK enables the low-quality stream and resets it to the SimulcastStreamConfig configuration used in the most recent calling of setDualStreamMode [2/2]. If no configuration has been set by the user previously, the following values are used:
- Resolution: 480 × 272
- Frame rate: 15 fps
- Bitrate: 500 Kbps
Returns
- 0: Success.
- < 0: Failure.
setVoiceBeautifierParameters
Sets parameters for the preset voice beautifier effects.
virtual int setVoiceBeautifierParameters(VOICE_BEAUTIFIER_PRESET preset, int param1, int param2) = 0;
Details
Call this method to set a gender characteristic and a reverberation effect for the singing beautifier effect. This method sets parameters for the local user who sends an audio stream. After setting the audio parameters, all users in the channel can hear the effect.
For better voice effects, Agora recommends that you call setAudioProfile [1/2] and set scenario to AUDIO_SCENARIO_GAME_STREAMING(3) and profile to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4) or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5) before calling this method.
- You can call this method either before or after joining a channel.
- Do not set the profile parameter in setAudioProfile [1/2] to AUDIO_PROFILE_SPEECH_STANDARD(1) or AUDIO_PROFILE_IOT(6), or the method does not take effect.
- This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
- After calling setVoiceBeautifierParameters, Agora does not recommend calling the following methods, otherwise the effect set by setVoiceBeautifierParameters will be overwritten:
Parameters
- preset
- The option for the preset audio effect:
SINGING_BEAUTIFIER
: The singing beautifier effect.
- param1
- The gender characteristics options for the singing voice:
1
: A male-sounding voice.2
: A female-sounding voice.
- param2
- The reverberation effect options for the singing voice:
1
: The reverberation effect sounds like singing in a small room.2
: The reverberation effect sounds like singing in a large room.3
: The reverberation effect sounds like singing in a hall.
Returns
- 0: Success.
- < 0: Failure.
setVoiceBeautifierPreset
Sets a preset voice beautifier effect.
virtual int setVoiceBeautifierPreset(VOICE_BEAUTIFIER_PRESET preset) = 0;
Details
Call this method to set a preset voice beautifier effect for the local user who sends an audio stream. After setting a voice beautifier effect, all users in the channel can hear the effect. You can set different voice beautifier effects for different scenarios.
For better voice effects, Agora recommends that you call setAudioProfile [1/2] and set scenario to AUDIO_SCENARIO_GAME_STREAMING(3) and profile to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4) or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5) before calling this method.
- You can call this method either before or after joining a channel.
- Do not set the profile parameter in setAudioProfile [1/2] to AUDIO_PROFILE_SPEECH_STANDARD(1) or AUDIO_PROFILE_IOT(6), or the method does not take effect.
- This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
- After calling setVoiceBeautifierPreset, Agora does not recommend calling the following methods, otherwise the effect set by setVoiceBeautifierPreset will be overwritten:
- This method relies on the voice beautifier dynamic library
libagora_audio_beauty_extension.dll
. If the dynamic library is deleted, the function cannot be enabled normally.
Parameters
- preset
-
The preset voice beautifier effect options: VOICE_BEAUTIFIER_PRESET.
Returns
- 0: Success.
- < 0: Failure.
setVoiceConversionPreset
Sets a preset voice beautifier effect.
virtual int setVoiceConversionPreset(VOICE_CONVERSION_PRESET preset) = 0;
Details
Call this method to set a preset voice beautifier effect for the local user who sends an audio stream. After setting an audio effect, all users in the channel can hear the effect. You can set different voice beautifier effects for different scenarios. For the applicable scenarios of each voice beautifier effect, refer to Set the Voice Effect.
To achieve better audio effect quality, Agora recommends that you call setAudioProfile [1/2] and set the profile to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4) or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5) and scenario to AUDIO_SCENARIO_GAME_STREAMING(3) before calling this method.
- You can call this method either before or after joining a channel.
- Do not set the profile parameter in setAudioProfile [1/2] to AUDIO_PROFILE_SPEECH_STANDARD(1) or AUDIO_PROFILE_IOT(6), or the method does not take effect.
- This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
- After calling setVoiceConversionPreset, Agora does not recommend you to call the following methods, otherwise the effect set by setVoiceConversionPreset will be overwritten:
- This method relies on the voice beautifier dynamic library
libagora_audio_beauty_extension.dll
. If the dynamic library is deleted, the function cannot be enabled normally.
Parameters
- preset
-
The options for the preset voice beautifier effects: VOICE_CONVERSION_PRESET.
Returns
- 0: Success.
- < 0: Failure.
setVolumeOfEffect
Sets the volume of a specified audio effect.
virtual int setVolumeOfEffect(int soundId, int volume) = 0;
Parameters
- soundId
- The ID of the audio effect. The ID of each audio effect file is unique.
- volume
- The playback volume. The value range is [0, 100]. The default value is 100, which represents the original volume.
Returns
- 0: Success.
- < 0: Failure.
startAudioMixing [1/2]
Starts playing the music file.
virtual int startAudioMixing(const char* filePath,
bool loopback,
bool replace,
int cycle) = 0;
Details
- Deprecated:
- Use startAudioMixing [2/2] instead.
This method mixes the specified local or online audio file with the audio from the microphone, or replaces the microphone's audio with the specified local or remote audio file. A successful method call triggers the onAudioMixingStateChanged (AUDIO_MIXING_STATE_PLAYING) callback. When the audio mixing file playback finishes, the SDK triggers the onAudioMixingStateChanged (AUDIO_MIXING_STATE_STOPPED) callback on the local client.
- You can call this method either before or after joining a channel. If you need to call startAudioMixing [1/2] multiple times, ensure that the time interval between calling this method is more than 500 ms.
- If the local music file does not exist, the SDK does not support the file format, or the the SDK cannot access the music file URL, the SDK reports 701.
- On Android, there are following considerations:
- To use this method, ensure that the Android device is v4.2 or later, and the API version is v16 or later.
- If you need to play an online music file, Agora does not recommend using the redirected URL address. Some Android devices may fail to open a redirected URL address.
- If you call this method on an emulator, ensure that the music file is in the
/sdcard/
directory and the format is MP3.
Parameters
- filePath
-
The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example,
C:\music\audio.mp4
. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. See supported audio formats. - loopback
-
Whether to only play music files on the local client:
true
: Only play music files on the local client so that only the local user can hear the music.false
: Publish music files to remote clients so that both the local user and remote users can hear the music.
- cycle
-
The number of times the music file plays.
- ≥ 0: The number of playback times. For example, 0 means that the SDK does not play the music file while 1 means that the SDK plays once.
- -1: Play the audio file in an infinite loop.
Returns
- 0: Success.
- < 0: Failure.
startAudioMixing [2/2]
Starts playing the music file.
virtual int startAudioMixing(const char* filePath, bool loopback, int cycle, int startPos) = 0;
Details
This method mixes the specified local or online audio file with the audio from the microphone, or replaces the microphone's audio with the specified local or remote audio file. A successful method call triggers the onAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)
callback. When the audio mixing file playback finishes, the SDK triggers the onAudioMixingStateChanged(AUDIO_MIXING_STATE_STOPPED)
callback on the local client.
- You can call this method either before or after joining a channel. If you need to call startAudioMixing [2/2] multiple times, ensure that the time interval between calling this method is more than 500 ms.
- If the local music file does not exist, the SDK does not support the file format, or the the SDK cannot access the music file URL, the SDK reports 701.
- For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support.
- On Android, there are following considerations:
- To use this method, ensure that the Android device is v4.2 or later, and the API version is v16 or later.
- If you need to play an online music file, Agora does not recommend using the redirected URL address. Some Android devices may fail to open a redirected URL address.
- If you call this method on an emulator, ensure that the music file is in the
/sdcard/
directory and the format is MP3.
Parameters
- filePath
- File path:
- Android: The file path, which needs to be accurate to the file name and suffix. Agora supports URL addresses, absolute paths, or file paths that start with
/assets/
. You might encounter permission issues if you use an absolute path to access a local file, so Agora recommends using a URI address instead. For example: content://com.android.providers.media.documents/document/audio%3A14441
- Windows: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example
: C:\music\audio.mp4
.
- Android: The file path, which needs to be accurate to the file name and suffix. Agora supports URL addresses, absolute paths, or file paths that start with
- loopback
-
Whether to only play music files on the local client:
true
: Only play music files on the local client so that only the local user can hear the music.false
: Publish music files to remote clients so that both the local user and remote users can hear the music.
- cycle
-
The number of times the music file plays.
- ≥ 0: The number of playback times. For example, 0 means that the SDK does not play the music file while 1 means that the SDK plays once.
- -1: Play the audio file in an infinite loop.
- startPos
- The playback position (ms) of the music file.
Returns
- 0: Success.
- < 0: Failure.
- -1: A general error occurs (no specified reason).
- -2: The parameter is invalid.
- -3: The SDK is not ready.
- The audio module is disabled.
- The program is not complete.
- The initialization of IRtcEngine fails. Reinitialize the IRtcEngine.
StartAudioRecording [1/3]
Starts audio recording on the client.
virtual int startAudioRecording(const char* filePath, AUDIO_RECORDING_QUALITY_TYPE quality) = 0;
Details
.wav
: Large file size with high fidelity..aac
: Small file size with low fidelity.
Ensure that the directory for the recording file exists and is writable. This method should be called after the joinChannel [1/2] method. The recording automatically stops when you call the leaveChannel [1/2] method.
Parameters
- filePath
- The absolute path (including the filename extensions) of the recording file. For example:
C:\music\audio.mp4
.Attention:Ensure that the directory for the log files exists and is writable.
- quality
- Audio recording quality. See AUDIO_RECORDING_QUALITY_TYPE.
Returns
- 0: Success.
- < 0: Failure.
StartAudioRecording [2/3]
Starts audio recording on the client and sets the sample rate of recording.
virtual int startAudioRecording(const char* filePath,
int sampleRate,
AUDIO_RECORDING_QUALITY_TYPE quality) = 0;
Details
- .wav: Large file size with high fidelity.
- .aac: Small file size with low fidelity.
- Ensure that the directory you use to save the recording file exists and is writable.
- This method should be called after the joinChannel [2/2] method. The recording automatically stops when you call the leaveChannel [1/2] method.
- For better recording effects, set quality to AUDIO_RECORDING_QUALITY_MEDIUM or AUDIO_RECORDING_QUALITY_HIGH when sampleRate is 44.1 kHz or 48 kHz.
Parameters
- filePath
- The absolute path (including the filename extensions) of the recording file. For example:
C:\music\audio.mp4
.Attention:Ensure that the directory for the log files exists and is writable.
- sampleRate
-
The sample rate (kHz) of the recording file. Supported values are as follows:
- 16000
- (Default) 32000
- 44100
- 48000
- quality
- Recording quality. See AUDIO_RECORDING_QUALITY_TYPE.
Returns
- 0: Success.
- < 0: Failure.
startAudioRecording [3/3]
Starts audio recording on the client and sets recording configurations.
virtual int startAudioRecording(const AudioFileRecordingConfig& config) = 0;
Details
- WAV: High-fidelity files with typically larger file sizes. For example, if the sample rate is 32,000 Hz, the file size for 10-minute recording is approximately 73 MB.
- AAC: Low-fidelity files with typically smaller file sizes. For example, if the sample rate is 32,000 Hz and the recording quality is AUDIO_RECORDING_QUALITY_MEDIUM, the file size for 10-minute recording is approximately 2 MB.
Once the user leaves the channel, the recording automatically stops.
Parameters
- config
- Recording configurations. See AudioRecordingConfiguration.
Returns
- 0: Success.
- < 0: Failure.
startCameraCapture
Starts camera capture.
virtual int startCameraCapture(VIDEO_SOURCE_TYPE sourceType, const CameraCapturerConfiguration& config) = 0;
Details
- Since
- v4.2.0
You can call this method to start capturing video from one or more cameras by specifying sourceType.
true
before calling this method.Parameters
- sourceType
-
The type of the video source. See VIDEO_SOURCE_TYPE.
Note:- On the mobile platforms, you can capture video from up to 2 cameras, provided the device has dual cameras or supports an external camera.
- On the desktop platforms, you can capture video from up to 4 cameras.
- config
-
The configuration of the video capture. See CameraCapturerConfiguration.
Note: On the iOS platform, this parameter has no practical function. Use the config parameter in enableMultiCamera instead to set the video capture configuration.
Returns
- 0: Success.
- < 0: Failure.
startChannelMediaRelay
Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels.
virtual int startChannelMediaRelay(const ChannelMediaRelayConfiguration &configuration) = 0;
Details
- Deprecated:
- This method is deprecated. Use startOrUpdateChannelMediaRelay instead.
- If the onChannelMediaRelayStateChanged callback returns RELAY_STATE_RUNNING (2) and RELAY_OK (0), and the onChannelMediaRelayEvent callback returns RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
- If the onChannelMediaRelayStateChanged callback returns RELAY_STATE_FAILURE (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 stopChannelMediaRelay 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.
Parameters
- configuration
- The configuration of the media stream relay. See ChannelMediaRelayConfiguration.
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.
startDirectCdnStreaming
Starts pushing media streams to the CDN directly.
virtual int startDirectCdnStreaming(IDirectCdnStreamingEventHandler* eventHandler,
const char* publishUrl, const DirectCdnStreamingMediaOptions& options) = 0;
Details
Aogra does not support pushing media streams to one URL repeatedly.
Media options
Agora does not support setting the value of publishCameraTrack and publishCustomVideoTrack as true
, or the value of publishMicrophoneTrack and publishCustomAudioTrack as true
at the same time. When choosing media setting options (DirectCdnStreamingMediaOptions), you can refer to the following examples:
If you want to push audio and video streams published by the host to the CDN, the media setting options should be set as follows:
- publishCustomAudioTrack is set as
true
and call the pushAudioFrame method - publishCustomVideoTrack is set as
true
and call the pushVideoFrame method - publishCameraTrack is set as
false
(the default value) - publishMicrophoneTrack is set as
false
(the default value)
true
and call pushAudioFrame to push audio streams. Parameters
- eventHandler
- See onDirectCdnStreamingStateChanged and onDirectCdnStreamingStats.
- publishUrl
- The CDN live streaming URL.
- options
- The media setting options for the host. See DirectCdnStreamingMediaOptions.
Returns
- 0: Success.
- < 0: Failure.
startEchoTest [1/3]
Starts an audio call test.
virtual int startEchoTest() = 0;
Details
- Deprecated:
- This method is deprecated, use startEchoTest [2/3] instead.
This method starts an audio call test to determine whether the audio devices (for example, headset and speaker) and the network connection are working properly. To conduct the test, the user speaks, and the recording is played back within 10 seconds. If the user can hear the recording within the interval, the audio devices and network connection are working properly.
- Call this method before joining a channel.
- After calling startEchoTest [1/3], you must call stopEchoTest to end the test. Otherwise, the app cannot perform the next echo test, and you cannot join the channel.
- In the live streaming channels, only a host can call this method.
Returns
- 0: Success.
- < 0: Failure.
startEchoTest [2/3]
Starts an audio call test.
virtual int startEchoTest(int intervalInSeconds) = 0;
Details
- Deprecated:
- This method is deprecated as of v4.0.1. Use startEchoTest [3/3] instead.
This method starts an audio call test to determine whether the audio devices (for example, headset and speaker) and the network connection are working properly. To conduct the test, let the user speak for a while, and the recording is played back within the set interval. If the user can hear the recording within the interval, the audio devices and network connection are working properly.
- Call this method before joining a channel.
- After calling startEchoTest [2/3], you must call stopEchoTest to end the test. Otherwise, the app cannot perform the next echo test, and you cannot join the channel.
- In the live streaming channels, only a host can call this method.
Parameters
- intervalInSeconds
- The time interval (s) between when you speak and when the recording plays back. The value range is [2, 10].
Returns
- 0: Success.
- < 0: Failure.
startEchoTest [3/3]
Starts an audio device loopback test.
virtual int startEchoTest(const EchoTestConfiguration& config) = 0;
Details
To test whether the user's local sending and receiving streams are normal, you can call this method to perform an audio and video call loop test, which tests whether the audio and video devices and the user's upstream and downstream networks are working properly.
- You can call this method either before or after joining a channel.
- After calling this method, call stopEchoTest to end the test; otherwise, the user cannot perform the next audio and video call loop test and cannot join the channel.
- In live streaming scenarios, this method only applies to hosts.
Parameters
- config
- The configuration of the audio and video call loop test. See EchoTestConfiguration.
Returns
- 0: Success.
- < 0: Failure.
startLastmileProbeTest
Starts the last mile network probe test.
virtual int startLastmileProbeTest(const LastmileProbeConfig& config) = 0;
Details
This method starts the last-mile network probe test before joining a channel to get the uplink and downlink last mile network statistics, including the bandwidth, packet loss, jitter, and round-trip time (RTT).
- onLastmileQuality: The SDK triggers this callback within two seconds depending on the network conditions. This callback rates the network conditions and is more closely linked to the user experience.
- onLastmileProbeResult: The SDK triggers this callback within 30 seconds depending on the network conditions. This callback returns the real-time statistics of the network conditions and is more objective.
- Before a user joins a channel, call this method to check the uplink network quality.
- In a live streaming channel, call this method to check the uplink network quality before an audience member switches to a host.
- Do not call other methods before receiving the onLastmileQuality and onLastmileProbeResult callbacks. Otherwise, the callbacks may be interrupted.
- A host should not call this method after joining a channel (when in a call).
Parameters
- config
- The configurations of the last-mile network probe test. See LastmileProbeConfig.
Returns
- 0: Success.
- < 0: Failure.
startLocalVideoTranscoder
Starts the local video mixing.
virtual int startLocalVideoTranscoder(const LocalTranscoderConfiguration& config) = 0;
Details
After calling this method, you can merge multiple video streams into one video stream locally. For example, you can merge the video streams captured by the camera, screen sharing, media player, remote video, video files, images, etc. into one video stream, and then publish the mixed video stream to the channel.
- Local video mixing requires more CPU resources. Therefore, Agora recommends enabling this function on devices with higher performance.
- If you need to mix locally captured video streams, the SDK supports the following capture combinations:
- On the Windows platform, it supports up to 4 video streams captured by cameras + 4 screen sharing streams.
- On the macOS platform, it supports up to 4 video streams captured by cameras + 1 screen sharing stream.
- On Android and iOS platforms, it supports video streams captured by up to 2 cameras (the device itself needs to support dual cameras or supports external cameras) + 1 screen sharing stream.
- If you need to mix the locally collected video streams, you need to call this method after startCameraCapture or startScreenCapture [2/2].
- If you want to publish the mixed video stream to the channel, you need to set publishTranscodedVideoTrack in ChannelMediaOptions to
true
when calling joinChannel [2/2] or updateChannelMediaOptions.
Applicable scenarios
You can enable the local video mixing function in scenarios such as remote conferences, live streaming, and online education, which allows users to view and manage multiple videos more conveniently, and supports portrait-in-picture effect and other functions.
- Call enableVirtualBackground, and set the custom background image to BACKGROUND_NONE, that is, separate the portrait and the background in the video captured by the camera.
- Call startScreenCapture [2/2] to start capturing the screen sharing video stream.
- Call this method and set the video source for capturing portraits as one of the video sources participating in the local video mixing, and the portrait picture-invideo mixing can be added in the mixed image video.Note: When configuring the local video mixing, it is necessary to ensure that the layer number of the video stream capturing the portrait is greater than the layer number of the screen sharing stream. Otherwise, the portrait will be covered by the screen sharing and will not be displayed in the final mixed video stream.
Parameters
- config
- Configuration of the local video mixing, see LocalTranscoderConfiguration.Attention:
- The maximum resolution of each video stream participating in the local video mixing is 4096 × 2160. If this limit is exceeded, video mixing does not take effect.
- The maximum resolution of the mixed video stream is 4096 × 2160.
Returns
- 0: Success.
- < 0: Failure.
startMediaRenderingTracing
Enables tracing the video frame rendering process.
virtual int startMediaRenderingTracing() = 0;
Details
- Since
- v4.1.1
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.
Applicable scenarios
Agora recommends that you use this method in conjunction with the UI settings (such as buttons and sliders) in your app to improve the user experience. For example, call this method when the user clicks the Join Channel
button, and then get the indicators in the video frame rendering process through the onVideoRenderingTracingResult callback, so as to optimize the indicators accordingly.
Returns
- 0: Success.
- < 0: Failure.
- -7: The method is called before IRtcEngine is initialized.
startOrUpdateChannelMediaRelay
Starts relaying media streams across channels or updates channels for media relay.
virtual int startOrUpdateChannelMediaRelay(const ChannelMediaRelayConfiguration &configuration) = 0;
Details
- Since
- v4.2.0
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.
- If the onChannelMediaRelayStateChanged callback returns RELAY_STATE_RUNNING (2) and RELAY_OK (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
- If the onChannelMediaRelayStateChanged callback returns RELAY_STATE_FAILURE (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.
Parameters
- configuration
- The configuration of the media stream relay. See ChannelMediaRelayConfiguration.
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.
startPreview [1/2]
Enables the local video preview.
virtual int startPreview() = 0;
Details
- Call setupLocalVideo to set the local preview window.
- Call enableVideo to enable the video.
- The local preview enables the mirror mode by default.
- After the local video preview is enabled, if you call leaveChannel [1/2] to exit the channel, the local preview remains until you call stopPreview [1/2] to disable it.
Returns
- 0: Success.
- < 0: Failure.
startPreview [2/2]
Enables the local video preview and specifies the video source for the preview.
virtual int startPreview(VIDEO_SOURCE_TYPE sourceType) = 0;
Details
- Call setupLocalVideo to set the local preview window.
- Call enableVideo to enable the video.
- The local preview enables the mirror mode by default.
- After the local video preview is enabled, if you call leaveChannel [1/2] to exit the channel, the local preview remains until you call stopPreview [2/2] to disable it.
- The video source type set in this method needs to be consistent with the video source type of VideoCanvas you set in setupLocalVideo.
Parameters
- sourceType
- The type of the video source. See VIDEO_SOURCE_TYPE.
Returns
- 0: Success.
- < 0: Failure.
startRhythmPlayer
Enables the virtual metronome.
virtual int startRhythmPlayer(const char* sound1, const char* sound2, const AgoraRhythmPlayerConfig& config) = 0;
Details
In music education, physical education and other scenarios, teachers usually need to use a metronome so that students can practice with the correct beat. The meter is composed of a downbeat and upbeats. The first beat of each measure is called a downbeat, and the rest are called upbeats.
In this method, you need to set the file path of the upbeat and downbeat, the number of beats per measure, the beat speed, and whether to send the sound of the metronome to remote users.
After successfully calling this method, the SDK triggers the onRhythmPlayerStateChanged callback locally to report the status of the virtual metronome.
- This method is for Android and iOS only.
- After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning, and controls the playback duration of each file according to beatsPerMinute you set in AgoraRhythmPlayerConfig. For example, if you set beatsPerMinute as
60
, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration. - By default, the sound of the virtual metronome is published in the channel. If you do not want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in ChannelMediaOptions as
false
.
Parameters
- sound1
- The absolute path or URL address (including the filename extensions) of the file for the downbeat. For example,
C:\music\audio.mp4
. For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. - sound2
- The absolute path or URL address (including the filename extensions) of the file for the upbeats. For example,
C:\music\audio.mp4
. For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. - config
- The metronome configuration. See AgoraRhythmPlayerConfig.
Returns
- 0: Success.
- < 0: Failure.
- -22: Cannot find audio effect files. Please set the correct paths for sound1 and sound2.
startRtmpStreamWithoutTranscoding
Starts pushing media streams to a CDN without transcoding.
virtual int startRtmpStreamWithoutTranscoding(const char* url) = 0;
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.
- 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.
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.
- -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.
startRtmpStreamWithTranscoding
Starts Media Push and sets the transcoding configuration.
virtual int startRtmpStreamWithTranscoding(const char* url, const LiveTranscoding& transcoding) = 0;
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. 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.
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.
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.
startScreenCapture [1/2]
Starts screen capture.
#if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) virtual int startScreenCapture(const ScreenCaptureParameters2& captureParams) = 0; #endif
Details
- Call this method before joining a channel, then call joinChannel [2/2] to join channel and set publishScreenCaptureVideo to
true
to start screen sharing. - Call this method after joining a channel, then call updateChannelMediaOptions and set publishScreenCaptureVideo to
true
to start screen sharing.
- This method applies to Android and iOS only.
- On the iOS platform, screen sharing is only available on iOS 12.0 and later.
- The billing for the screen sharing stream is based on the dimensions in ScreenVideoParameters. When you do not pass in a value, Agora bills you at 1280 × 720; when you pass a value in, Agora bills you at that value. See Pricing.
- If you are using the custom audio source instead of the SDK to capture audio, Agora recommends you add the keep-alive processing logic to your application to avoid screen sharing stopping when the application goes to the background.
- This feature requires high-performance device, and Agora recommends that you use it on iPhone X and later models.
- This method relies on the iOS screen sharing dynamic library
AgoraReplayKitExtension.xcframework
. If the dynamic library is deleted, screen sharing cannot be enabled normally. - On the Android platform, make sure the user has granted the app screen capture permission.
- Make sure that the Android API level is not earlier than 21, otherwise, the SDK reports error codes
ERR_SCREEN_CAPTURE_PERMISSION_DENIED(16)
andERR_SCREEN_CAPTURE_SYSTEM_NOT_SUPPORTED(2)
. - To capture system audio during screen sharing, ensure that the Android API level is not earlier than 29 as well; otherwise, the SDK reports the error code
ERR_SCREEN_CAPTURE_SYSTEM_AUDIO_NOT_SUPPORTED(3)
. - On Android 9 and later, to avoid the application being killed by the system after going to the background, Agora recommends you add the foreground service
android.permission.FOREGROUND_SERVICE
to the/app/Manifests/AndroidManifest.xml
file. - Due to performance limitations, screen sharing is not supported on Android TV.
- Due to system limitations, if you are using Huawei