IRtcEngine

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

Parameters

watermark

The watermark image to be added to the local live streaming: RtcImage.

Returns

• 0: Success.
• < 0: Failure.

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.

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.

Call timing

You need to call this method after calling startAudioMixing [2/2] and receiving the onAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING) callback.

Restrictions

None.

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.

This method adjusts the volume of audio mixing for publishing (sending to other users).

Call timing

Call this method after calling startAudioMixing [2/2] and receiving the onAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING) callback.

Restrictions

None.

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.

This method adjusts the audio mixing volume on both the local client and remote clients.

Call timing

Call this method after startAudioMixing [2/2].

Restrictions

None.

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.

Details

If you want to change the volume of the audio to be played locally, 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.

Details

If you want to change the volume of the audio played remotely, 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.

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.

This method is used to adjust the signal volume of all remote users mixed and played locally. If you need to adjust the signal volume of a specified remote user played locally, it is recommended that you call adjustUserPlaybackSignalVolume instead.

Call timing

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

Restrictions

None.

Parameters

volume

The volume of the user. The value range is [0,400].

• 0: Mute.
• 100: (Default) The original volume.
• 400: Four times the original volume (amplifying the audio signals by four times).

Returns

• 0: Success.
• < 0: Failure.

If you only need to mute the audio signal, Agora recommends that you use muteRecordingSignal instead.

Call timing

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

Restrictions

None.

Parameters

volume

The volume of the user. The value range is [0,400].

• 0: Mute.
• 100: (Default) The original volume.
• 400: Four times the original volume (amplifying the audio signals by four times).

Returns

• 0: Success.
• < 0: Failure.

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 timing

Call this method after joining a channel.

Restrictions

None.

Parameters

uid

The user ID of the remote user.

volume

The volume of the user. The value range is [0,400].

• 0: Mute.
• 100: (Default) The original volume.
• 400: Four times the original volume (amplifying the audio signals by four times).

Returns

• 0: Success.
• < 0: Failure.

Returns

• 0: Success.
• < 0: Failure.

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.
  • -1: A general error occurs (no specified reason).
  • -2: The parameter is invalid.
  • -7: The method is called before IRtcEngine is initialized.

• After calling startRhythmPlayer, you can call this method to reconfigure the virtual metronome.
• 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 want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in ChannelMediaOptions as true.

Call timing

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

Restrictions

None.

Related callbacks

After successfully calling this method, the SDK triggers the onRhythmPlayerStateChanged callback locally to report the status of the virtual metronome.

Parameters

config

The metronome configuration. See AgoraRhythmPlayerConfig.

Returns

• 0: Success.
• < 0: Failure.

Call timing

Before calling other APIs, you must call createAgoraRtcEngine and initialize to create and initialize the IRtcEngine object.

Restrictions

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.

Details

Currently, the Agora RTC SDK v4.x supports creating only one IRtcEngine object for each app.

Returns

Pointer to the IRtcEngine object.

You can call this method to create a data stream and improve the reliability and ordering of data transmission.

Call timing

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

Restrictions

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.

Related callbacks

After setting reliable to true, if the recipient does not receive the data within five seconds, the SDK triggers the onStreamMessageError callback and returns an error code.

Parameters

streamId

An output parameter; the ID of the data stream created.

reliable

Sets whether the recipients are guaranteed to receive the data stream within five seconds:

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

Attention: Please ensure that reliable and ordered are either both set totrue or both set to false.

ordered

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

Compared to createDataStream [1/2], this method does not guarantee the reliability of data transmission. If a data packet is not received five seconds after it was sent, the SDK directly discards the data.

Call timing

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

Restrictions

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.

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.

Before calling any APIs in the IMediaPlayer class, you need to call this method to create an instance of the media player. If you need to create multiple instances, you can call this method multiple times.

Call timing

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

Restrictions

None.

Returns

• An IMediaPlayer object, if the method call succeeds.
• An empty pointer, if the method call fails.

Details

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, 0xffffffff is returned.

Parameters

video_track_id

The video track ID returned by calling the createCustomVideoTrack method.

Returns

• 0: Success.
• < 0: Failure.

Parameters

media_player

One IMediaPlayer object.

Returns

• ≥ 0: Success. Returns the ID of media player instance.
• < 0: Failure.

The audio module is enabled by default, and you can call this method to disable the audio module.

Call timing

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

Restrictions

Returns

• 0: Success.
• < 0: Failure.

Details

After calling enableAudioSpectrumMonitor, if you want to disable audio spectrum monitoring, you can call this method.

Returns

• 0: Success.
• < 0: Failure.

This method is used to disable the video module.

Call timing

Restrictions

• This method affects the internal engine and can be called after leaving the channel.
• Calling this method will reset the entire engine, resulting in a slow response time. You can use the following methods to independently control a specific function of the video module based on your actual needs:
  • 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.

Related callbacks

A successful call of this method triggers the onUserEnableVideo (false) callback on the remote client.

Returns

• 0: Success.
• < 0: Failure.

The audio module is enabled by default After calling disableAudio to disable the audio module, you can call this method to re-enable it.

Call timing

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

Restrictions

• Calling this method will reset the entire engine, resulting in a slow response time. You can use the following methods to independently control a specific function of the audio module based on your actual needs:
  • 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.
• A successful call of this method resets enableLocalAudio, muteRemoteAudioStream, and muteAllRemoteAudioStreams. Proceed it with caution.

Returns

• 0: Success.
• < 0: Failure.

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.

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.

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.

Call timing

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

Restrictions

None.

Related callbacks

The SDK triggers the onAudioVolumeIndication callback according to the interval you set if this method is successfully called and there are users publishing streams in the channel.

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. Ensure this parameter is set to a value greater than 10, otherwise you will not receive the onAudioVolumeIndication callback. Agora recommends that this value is set as greater than 100.

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.

Since

v4.3.1

The portrait center stage feature is off by default. You need to call this method to turn it on. If you need to disable this feature, you need to call this method again and set enabled to false.

Applicable scenarios

The portrait center stage feature can be widely used in scenarios such as online meetings, shows, online education, etc. The host can use this feature to ensure that they are always in the center of the screen, whether they move or not, in order to achieve a good display effect.

Call timing

This method must be called after the camera is successfully enabled, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LOCAL_VIDEO_STREAM_STATE_CAPTURING (1).

Restrictions

Agora recommends that you call isCameraCenterStageSupported to check whether the current device supports portrait center stage before enabling this feature.

Parameters

enabled

Whether to enable the portrait center stage:

• true: Enable portrait center stage.
• false: Disable portrait center stage.

Returns

• 0: Success.
• < 0: Failure.

When video screenshot and upload function is enabled, the SDK takes screenshots and uploads videos sent by local users based on the type and frequency of the module you set in ContentInspectConfig. After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.

Call timing

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

Restrictions

• Before calling this method, make sure you have enabled video screenshot and upload on Agora console.
• When the video moderation module is set to video moderation via Agora self-developed extension(CONTENT_INSPECT_SUPERVISION), the video screenshot and upload dynamic library libagora_content_inspect_extension.dll is required. Deleting this library disables the screenshot and upload feature.

Parameters

enabled

Whether to enalbe video screenshot and upload:

• true: Enables video screenshot and upload.
• false: Disables video screenshot and upload.

config

Screenshot and upload configuration. See ContentInspectConfig.

Returns

• 0: Success.
• < 0: Failure.

virtual int enableCustomAudioLocalPlayback(track_id_t trackId, bool enabled) = 0;

Details

After calling this method to enable the local playback of external audio source, if you need to stop local playback, you can call this method again and set enabled to false.

You can call adjustCustomAudioPlayoutVolume to adjust the local playback volume of the custom audio track.

Parameters

trackId

The audio track ID. Set this parameter to the custom audio track ID returned in createCustomAudioTrack.

enabled

Whether to play the external audio source:

• true: Play the external audio source.
• false: (Default) Do not play the external source.

Returns

• 0: Success.
• < 0: Failure.

Details

Deprecated:

This method is deprecated as of v4.2.0. Use setDualStreamMode [1/2] instead.

After you enable dual-stream mode, you can call setRemoteVideoStreamType to choose to receive either the high-quality video stream or the low-quality video stream on the subscriber side.

Parameters

enabled

Whether to enable dual-stream mode:

• true: Enable dual-stream mode.
• false: (Default) Disable dual-stream mode.

Returns

• 0: Success.
• < 0: Failure.

Details

Deprecated:

This method is deprecated as of v4.2.0. Use setDualStreamMode [2/2] instead.

After you enable dual-stream mode, you can call setRemoteVideoStreamType to choose to receive either the high-quality video stream or the low-quality video stream on the subscriber side.

Parameters

enabled

Whether to enable dual-stream mode:

• true: Enable dual-stream mode.
• false: (Default) Disable dual-stream mode.

streamConfig

The configuration of the low-quality video stream. See SimulcastStreamConfig.

Note: When setting mode to DISABLE_SIMULCAST_STREAM, setting streamConfig will not take effect.

Returns

• 0: Success.
• < 0: Failure.

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.

Applicable scenarios

Scenarios with higher security requirements.

Call timing

Call this method before joining a channel.

Restrictions

• All users within the same channel must set the same encryption configurations when calling this method.
• If you enable the built-in encryption, you cannot use the Media Push function.

Parameters

enabled

Whether to enable built-in encryption:

• true: Enable the built-in encryption.
• false: (Default) 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.

Call timing

Agora recommends that you call this method after joining a channel.

Restrictions

• If you want to enable multiple extensions, you need to call this method multiple times.
• After a successful call of this method, you cannot load other extensions.

Related callbacks

When this method is successfully called within the channel, it triggers onExtensionStartedWithContext or onExtensionStoppedWithContext.

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

Source type of the extension. See MEDIA_SOURCE_TYPE.

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.

Call timing

This method needs to be called after the camera is started (for example, by calling startPreview [2/2] or enableVideo).

Restrictions

None.

Related callbacks

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.

This method enables or disables in-ear monitoring.

Call timing

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

Restrictions

Users must use earphones (wired or Bluetooth) to hear the in-ear monitoring effect.

Parameters

enabled

Enables or disables in-ear monitoring.

• true: Enables in-ear monitoring.
• false: (Default) Disables in-ear monitoring.

includeAudioFilters

The audio filter types 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.

Since

v4.1.1

After successfully calling this method, the SDK enables the instant frame rendering mode, which can speed up the first frame rendering after the user joins the channel.

Applicable scenarios

Agora recommends that you enable this mode for the audience in a live streaming scenario.

Call timing

Call this method before joining a channel.

Restrictions

Both the host and audience member need to call this method in order to experience instant rendering of audio and video frames.

Once the method is successfully called, you can only cancel instant rendering by calling release to destroy the IRtcEngine object.

Returns

• 0: Success.
• < 0: Failure.
  • -7: The method is called before IRtcEngine is initialized.

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.

Applicable scenarios

This method does not affect receiving the remote audio streams. enableLocalAudio(false) is suitable for scenarios where the user wants to receive remote audio streams without sending locally captured audio.

Call timing

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.

Restrictions

None.

Related callbacks

Once the local audio function is disabled or re-enabled, the SDK triggers the onLocalAudioStateChanged callback, which reports LOCAL_AUDIO_STREAM_STATE_STOPPED(0) or LOCAL_AUDIO_STREAM_STATE_RECORDING(1).

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.

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.

If you call enableLocalVideo(false) to disable local video capture within the channel, it also simultaneously stops publishing the video stream within the channel. If you want to restart video catpure, you can call enableLocalVideo(true) and then call updateChannelMediaOptions to set the options parameter to publish the locally captured video stream in the channel.

After the local video capturer is successfully disabled or re-enabled, the SDK triggers the onRemoteVideoStateChanged callback on the remote client.

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 to false, this method does not require a local camera.

Returns

• 0: Success.
• < 0: Failure.

Details

If you enable loopback audio capturing, the output of the sound card is mixed into the audio stream sent to the other end.

Parameters

enabled

Sets whether to enable loopback audio capturing.

• true: Enable sound card capturing. You can find the name of the virtual sound card in your system'sAudio Devices > Output.
• false: Disable sound card capturing. The name of the virtual sound card will not be shown in your system's Audio Devices > Output.

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.

Details

Since

v4.1.0

This method applies to iOS only.

When using this function, ensure that the system version is 13.0 or 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.

Details

After enabling the spatial audio effect, you can call setRemoteUserSpatialAudioParams to set the spatial audio effect parameters of the remote user.

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.

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.

The video module is disabled by default, call this method to enable it. If you need to disable the video module later, you need to call disableVideo.

Call timing

Restrictions

• This method enables the internal engine and is valid after leaving the channel.
• Calling this method will reset the entire engine, resulting in a slow response time. You can use the following methods to independently control a specific function of the video module based on your actual needs:
  • 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.
• A successful call of this method resets enableLocalVideo, muteRemoteVideoStream, and muteAllRemoteVideoStreams. Proceed it with caution.

Related callbacks

A successful call of this method triggers the onRemoteVideoStateChanged callback on the remote client.

Returns

• 0: Success.
• < 0: Failure.

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.

Call timing

Call this method after joining a channel.

Restrictions

None.

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.

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 after calling enableVideo or startPreview [2/2].

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 media source to which the filter effect is applied. See MEDIA_SOURCE_TYPE.

Attention: In this method, this parameter supports only the following two settings:

• Use the default value PRIMARY_CAMERA_SOURCE if you use camera to capture local video.
• Set this parameter to CUSTOM_VIDEO_SOURCE if you use custom video source.

Returns

• 0: Success.
• < 0: Failure.
  • -4: The device capabilities do not meet the requirements for the virtual background feature. Agora recommends you try it on devices with higher performance.

Since

v4.4.0

The voice AI tuner supports enhancing sound quality and adjusting tone style.

Applicable scenarios

Social entertainment scenes including online KTV, online podcast and live streaming in showrooms, where high sound quality is required.

Call timing

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

Restrictions

None.

Parameters

enabled

Whether to enable the voice AI tuner:

• true: Enables the voice AI tuner.
• false: (Default) Disable the voice AI tuner.

type

Voice AI tuner sound types, see VOICE_AI_TUNER_TYPE.

Returns

• 0: Success.
• < 0: Failure.

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.

Details

After calling this method, you can get whether the audio device supports ultra-low-latency capture and playback.

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.

Details

Retrieves the playback position (ms) of the audio.

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.

Retrieves the total duration (ms) of the audio.

Call timing

Call this method after startAudioMixing [2/2] and receiving the onAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING) callback.

Restrictions

None.

Returns

• ≥ 0: The audio mixing duration, if this method call succeeds.
• < 0: Failure.

You can call this method to get the local playback volume of the mixed audio file, which helps in troubleshooting volume‑related issues.

Call timing

Call this method after startAudioMixing [2/2] and receiving the onAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING) callback.

Restrictions

None.

Returns

• ≥ 0: The audio mixing volume, if this method call succeeds. The value range is [0,100].
• < 0: Failure.

Details

This method helps troubleshoot audio volume‑related issues.

Returns

• ≥ 0: The audio mixing volume, if this method call succeeds. The value range is [0,100].
• < 0: Failure.

Details

Returns

• The SDK returns the index of the audio tracks if the method call succeeds.
• < 0: Failure.

When a user joins a channel on a client, a callId is generated to identify the call from the client. You can call this method to get callId, and pass it in when calling methods such as rate and complain.

Call timing

Call this method after joining a channel.

Restrictions

None.

Parameters

callId

Output parameter, the current call ID.

Returns

• 0: Success.
• < 0: Failure.

Details

Returns

The maximum zoom factor.

Call timing

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

Restrictions

None.

Returns

The current connection state. See CONNECTION_STATE_TYPE.

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

Call timing

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

Restrictions

None.

Returns

• ≥0: The method call is successful, and returns the current Monotonic Time of the SDK (in milliseconds).
• < 0: Failure.

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.

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.

Returns

• The total duration (ms) of the specified audio effect file, if the method call succeeds.
• < 0: Failure.

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.

Parameters

code

The error code reported by the SDK.

Returns

The specific error description.

Call timing

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

Restrictions

None.

Parameters

provider

An output parameter. The name of the extension provider.

extension

An output parameter. The name of the extension.

key

An output parameter. The key of the extension.

value

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

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.

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.

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

IScreenCaptureSourceList

After a remote user joins the channel, the SDK gets the UID and user account of the remote user, caches them in a mapping table object, and triggers the onUserInfoUpdated callback on the local client. After receiving the callback, you can call this method and passi in the UID.to get the user account of the specified user from the UserInfo object.

Call timing

Call this method after receiving the onUserInfoUpdated callback.

Restrictions

None.

Related callbacks

onUserInfoUpdated

Parameters

uid

The user ID.

userInfo

Input and output parameter. The UserInfo object that identifies the user information.

• Input value: A UserInfo object.
• Output: A UserInfo object that contains both the user account and UID.

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 (89 characters in total):

• All lowercase English letters: a to z.
• All uppercase English letters: A to Z.
• All numeric characters: 0 to 9.
• "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

localUserAccount

The user account of the local user.

Returns

• 0: Success.
• < 0: Failure.

After a remote user joins the channel, the SDK gets the UID and user account of the remote user, caches them in a mapping table object, and triggers the onUserInfoUpdated callback on the local client. After receiving the callback, you can call this method and pass in the user account to get the UID of the remote user from the UserInfo object.

Call timing

Call this method after receiving the onUserInfoUpdated callback.

Restrictions

None.

Related callbacks

onUserInfoUpdated

Parameters

userAccount

The user account.

userInfo

Input and output parameter. The UserInfo object that identifies the user information.

• Input value: A UserInfo object.
• Output: A UserInfo object that contains both the user account and UID.

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 (89 characters in total):

• All lowercase English letters: a to z.
• All uppercase English letters: A to Z.
• All numeric characters: 0 to 9.
• "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

localUserAccount

The user account of the local user.

Returns

• 0: Success.
• < 0: Failure.

Parameters

build

The SDK build index.

Returns

The SDK version number. The format is a string.

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.

Details

Returns

• true: The device supports auto exposure.
• false: The device does not support auto exposure.

Details

Returns

• true: The device supports the face auto-focus function.
• false: The device does not support the face auto-focus function.

Details

Returns

• true: The device supports manual exposure.
• false: The device does not support manual exposure.

Details

Since

v4.2.2

Returns

• true: Success.
• false: Failure.

Returns

• true: The device camera supports face detection.
• false: The device camera does not support face detection.

Details

Returns

• true: The device supports the manual focus function.
• false: The device does not support the manual focus function.

Since

v4.3.1

Before calling enableCameraCenterStage to enable portrait center stage, it is recommended to call this method to check if the current device supports the feature.

Call timing

This method must be called after the camera is successfully enabled, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LOCAL_VIDEO_STREAM_STATE_CAPTURING (1).

Restrictions

None.

Returns

• true: The current camera supports the portrait center stage.
• false: The current camera supports the portrait center stage.

Details

Returns

• true: The device supports camera flash.
• false: The device does not support camera flash.

Call timing

This method must be called after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LOCAL_VIDEO_STREAM_STATE_CAPTURING (1).

Restrictions

None.

Returns

• true: The device supports camera zoom.
• false: The device does not support camera zoom.

Details

Since

v4.2.3

Checks whether the capabilities of the current device meet the requirements for advanced features such as virtual background and image enhancement.

Applicable scenarios

Before using advanced features, you can check whether the current device supports these features based on the call result. This helps to avoid performance degradation or unavailable features when enabling advanced features on low-end devices. Based on the return value of this method, you can decide whether to display or enable the corresponding feature button, or notify the user when the device's capabilities are insufficient.

Parameters

type

The type of the advanced feature, see FeatureType.

Returns

• true: The current device supports the specified feature.
• false: The current device does not support the specified feature.

Call timing

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

Restrictions

None.

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.

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 stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.

Call timing

Call this method after initialize.

Restrictions

• This method only supports users joining one channel at a time.
• Users with different App IDs cannot call each other.
• Before joining a channel, ensure that the App ID you use to generate a token is the same as that you pass in the initialize method; otherwise, you may fail to join the channel with the token.

Related callbacks

When the connection between the local 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 .

Note:

• (Recommended) If your project has enabled the security mode (using APP ID and Token for authentication), this parameter is required.
• If you have only enabled the testing mode (using APP ID for authentication), this parameter is optional. You will automatically exit the channel 24 hours after successfully joining in.
• If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See Secure authentication with tokens.

channelId

The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):

• All lowercase English letters: a to z.
• All uppercase English letters: A to Z.
• All numeric characters: 0 to 9.
• "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

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 2³²-1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and onJoinChannelSuccess returns it in the 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: Fails 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 after calling startEchoTest to start a call loop test, you call this method to join the channel without calling stopEchoTest to stop the 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 already in the channel. Agora recommends that you use the onConnectionStateChanged callback to see whether the user is in the channel. Do not call this method to join the channel unless you receive the CONNECTION_STATE_DISCONNECTED(1) state.
  • -102: The channel name is invalid. You need to pass in a valid channel name 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.

Compared to joinChannel [1/2], this method has the options parameter which is used to set media options, such as whether to publish audio and video streams within a channel, or whether to automatically subscribe to the audio and video streams of all remote users when joining a 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 stop subscribing to other streams, set the options parameter or call the corresponding mute methods.

Call timing

Call this method after initialize.

Restrictions

• This method only supports users joining one channel at a time.
• Users with different App IDs cannot call each other.
• Before joining a channel, ensure that the App ID you use to generate a token is the same as that you pass in the initialize method; otherwise, you may fail to join the channel with the token.

Related callbacks

When the connection between the local 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 .

Note:

• (Recommended) If your project has enabled the security mode (using APP ID and Token for authentication), this parameter is required.
• If you have only enabled the testing mode (using APP ID for authentication), this parameter is optional. You will automatically exit the channel 24 hours after successfully joining in.
• If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See Secure authentication with tokens.

channelId

The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):

• All lowercase English letters: a to z.
• All uppercase English letters: A to Z.
• All numeric characters: 0 to 9.
• "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

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 2³²-1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and onJoinChannelSuccess returns it in the 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: Fails 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 after calling startEchoTest to start a call loop test, you call this method to join the channel without calling stopEchoTest to stop the 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 already in the channel. Agora recommends that you use the onConnectionStateChanged callback to see whether the user is in the channel. Do not call this method to join the channel unless you receive the CONNECTION_STATE_DISCONNECTED(1) state.
  • -102: The channel name is invalid. You need to pass in a valid channel name 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.

Before calling this method, if you have not called registerLocalUserAccount to register a user account, when you call this method to join a channel, the SDK automatically creates a user account for you. Calling the registerLocalUserAccount method to register a user account, and then calling this method to join a channel can shorten the time it takes to enter the channel.

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 billings. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.

Call timing

Call this method after initialize.

Restrictions

• This method only supports users joining one channel at a time.
• Users with different App IDs cannot call each other.
• Before joining a channel, ensure that the App ID you use to generate a token is the same as that you pass in the initialize method; otherwise, you may fail to join the channel with the token.

Related callbacks

Parameters

token

The token generated on your server for authentication. See .

Note:

• (Recommended) If your project has enabled the security mode (using APP ID and Token for authentication), this parameter is required.
• If you have only enabled the testing mode (using APP ID for authentication), this parameter is optional. You will automatically exit the channel 24 hours after successfully joining in.
• If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See Secure authentication with tokens.

channelId

The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):

• All lowercase English letters: a to z.
• All uppercase English letters: A to Z.
• All numeric characters: 0 to 9.
• "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

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 follows(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. 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: Fails 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 after calling startEchoTest to start a call loop test, you call this method to join the channel without calling stopEchoTest to stop the 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 already in the channel. Agora recommends that you use the onConnectionStateChanged callback to see whether the user is in the channel. Do not call this method to join the channel unless you receive the CONNECTION_STATE_DISCONNECTED(1) state.
  • -102: The channel name is invalid. You need to pass in a valid channel name 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.

Before calling this method, if you have not called registerLocalUserAccount to register a user account, when you call this method to join a channel, the SDK automatically creates a user account for you. Calling the registerLocalUserAccount method to register a user account, and then calling this method to join a channel can shorten the time it takes to enter the channel.

Compared to joinChannelWithUserAccount [1/2], this method has the options parameter which is used to set media options, such as whether to publish audio and video streams within a 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 stop subscribing to other streams, set the options parameter or call the corresponding mute methods.

Call timing

Call this method after initialize.

Restrictions

• This method only supports users joining one channel at a time.
• Users with different App IDs cannot call each other.
• Before joining a channel, ensure that the App ID you use to generate a token is the same as that you pass in the initialize method; otherwise, you may fail to join the channel with the token.

Related callbacks

Parameters

token

The token generated on your server for authentication. See .

Note:

• (Recommended) If your project has enabled the security mode (using APP ID and Token for authentication), this parameter is required.
• If you have only enabled the testing mode (using APP ID for authentication), this parameter is optional. You will automatically exit the channel 24 hours after successfully joining in.
• If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See Secure authentication with tokens.

channelId

The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):

• All lowercase English letters: a to z.
• All uppercase English letters: A to Z.
• All numeric characters: 0 to 9.
• "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

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 follows(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: Fails 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 after calling startEchoTest to start a call loop test, you call this method to join the channel without calling stopEchoTest to stop the 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 already in the channel. Agora recommends that you use the onConnectionStateChanged callback to see whether the user is in the channel. Do not call this method to join the channel unless you receive the CONNECTION_STATE_DISCONNECTED(1) state.
  • -102: The channel name is invalid. You need to pass in a valid channel name 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.

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

After joining the channel, you must call this method to end the call; otherwise, the next call cannot be started.

Call timing

Call this method after joining a channel.

Restrictions

If you call release immediately after calling this method, the SDK does not trigger the onLeaveChannel callback.

Related callbacks

Returns

• 0: Success.
• < 0: Failure.
  • -1: A general error occurs (no specified reason).
  • -2: The parameter is invalid.
  • -7: The SDK is not initialized.

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

After joining a channel, you must call this method or leaveChannel [1/2] to end the call, otherwise, the next call cannot be started. If you have called joinChannelEx to join multiple channels, calling this method will leave all the channels you joined.

Call timing

Call this method after joining a channel.

Restrictions

If you call release immediately after calling this method, the SDK does not trigger the onLeaveChannel callback.

Related callbacks

Parameters

options

The options for leaving the channel. See LeaveChannelOptions.

Returns

• 0: Success.
• < 0: Failure.

This method is used to add extensions external to the SDK (such as those from Extensions Marketplace and SDK extensions) to the SDK.

Call timing

Make sure the IRtcEngine is initialized before you call this method.

Restrictions

If you want to load multiple extensions, you need to call this method multiple times.

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.

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 timing

Call this method after joining a channel.

Restrictions

If you call this method and then call enableAudio or disableAudio, the latest call will prevail.

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.

After successfully calling this method, the local user stops or resumes subscribing to the video streams of all remote users, including all subsequent users.

Call timing

Call this method after joining a channel.

Restrictions

If you call this method and then call enableVideo or disableVideo, the latest call will prevail.

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 video streams of all remote users by default.

Returns

• 0: Success.
• < 0: Failure.

This method is used to control whether to publish the locally captured audio stream. If you call this method to stop publishing locally captured audio streams, the audio capturing device will still work and won't be affected.

Call timing

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

Restrictions

None.

Related callbacks

After successfully calling this method, the local end triggers callback onAudioPublishStateChanged; the remote end triggers onUserMuteAudio and onRemoteAudioStateChanged callbacks.

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.

This method is used to control whether to publish the locally captured video stream. If you call this method to stop publishing locally captured video streams, the video capturing device will still work and won't be affected.

Compared to enableLocalVideo(false), which can also cancel the publishing of local video stream by turning off the local video stream capture, this method responds faster.

Call timing

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

Restrictions

None.

Related callbacks

After successfully calling this method, the local end triggers callback onVideoPublishStateChanged; the remote end triggers onUserMuteVideo and onRemoteVideoStateChanged callbacks.

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.

Call timing

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

Restrictions

None.

Parameters

mute

• true: Mute the recording signal.
• false: (Default) Do not mute the recording signal.

Returns

• 0: Success.
• < 0: Failure.

Call timing

Call this method after joining a channel.

Restrictions

None.

Related callbacks

After a successful method call, the SDK triggers the onAudioSubscribeStateChanged callback.

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.

Call timing

Call this method after joining a channel.

Restrictions

None.

Related callbacks

After a successful method call, the SDK triggers the onVideoSubscribeStateChanged callback.

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.

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.
  • -5: The method call was rejected. There is no ongoing channel media relay.

Returns

• 0: Success.
• < 0: Failure.

After calling startAudioMixing [2/2] to play a music file, you can call this method to pause the playing. If you need to stop the playback, call stopAudioMixing.

Call timing

Call this method after joining a channel.

Restrictions

None.

Returns

• 0: Success.
• < 0: Failure.

Parameters

soundId

The audio effect ID. The ID of each audio effect file is unique.

Returns

• 0: Success.
• < 0: Failure.

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.

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 you do not playing more than three audio files at the same time.

Call timing

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

Restrictions

If you need to play an online audio effect file, Agora recommends that you cache the online audio effect file to your local device, call preloadEffect to preload the file into memory, and then call this method to play the audio effect. Otherwise, you might encounter playback failures or no sound during playback due to loading timeouts or failures.

Related callbacks

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 file path. The SDK supports URLs and absolute path of local files. The absolute path needs to be accurate to the file name and extension. 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.

Since

v4.2.2

When audience members need to switch between different channels frequently, calling the method can help shortening the time of joining a channel, thus reducing the time it takes for audience members to hear and see the host.

If you join a preloaded channel, leave it and want to rejoin the same channel, you do not need to call this method unless the token for preloading the channel expires.

Call timing

To improve the user experience of preloading channels, Agora recommends that before joining the channel, calling this method as early as possible once confirming the channel name and user information.

Restrictions

• When calling this method, ensure you set the user role as audience and do not set the audio scenario as AUDIO_SCENARIO_CHORUS, otherwise, this method does not take effect.
• You also need to make sure that the channel name, user ID and token passed in for preloading are the same as the values passed in when joinning the channel, otherwise, this method does not take effect.
• One IRtcEngine instance supports preloading 20 channels at most. When exceeding this limit, the latest 20 preloaded channels take effect.

Parameters

token

The token generated on your server for authentication. See .

When the token for preloading channels expires, you can update the token based on the number of channels you preload.

• When preloading one channel, calling this method to pass in the new token.
• When preloading more than one channels:
  • If you use a wildcard token for all preloaded channels, call updatePreloadChannelToken to update the token.
    Note: When generating a wildcard token, ensure the user ID is not set as 0. See Secure authentication with tokens.
  • If you use different tokens to preload different channels, call this method to pass in your user ID, channel name and the new token.

channelId

The channel name that you want to preload. 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 (89 characters in total):

• All lowercase English letters: a to z.
• All uppercase English letters: A to Z.
• All numeric characters: 0 to 9.
• "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

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 2³²-1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and onJoinChannelSuccess returns it in the callback. Your application must record and maintain the returned user ID, because the SDK does not do so.

Returns

• 0: Success.
• < 0: Failure.
  • -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
  • -102: The channel name is invalid. You need to pass in a valid channel name and join the channel again.

Since

v4.2.2

When audience members need to switch between different channels frequently, calling the method can help shortening the time of joining a channel, thus reducing the time it takes for audience members to hear and see the host.

If you join a preloaded channel, leave it and want to rejoin the same channel, you do not need to call this method unless the token for preloading the channel expires.

Call timing

To improve the user experience of preloading channels, Agora recommends that before joining the channel, calling this method as early as possible once confirming the channel name and user information.

Restrictions

Parameters

token

The token generated on your server for authentication. See .

When the token for preloading channels expires, you can update the token based on the number of channels you preload.

• When preloading one channel, calling this method to pass in the new token.
• When preloading more than one channels:
  • If you use a wildcard token for all preloaded channels, call updatePreloadChannelToken to update the token.
    Note: When generating a wildcard token, ensure the user ID is not set as 0. See Secure authentication with tokens.
  • If you use different tokens to preload different channels, call this method to pass in your user ID, channel name and the new token.

channelId

The channel name that you want to preload. 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 (89 characters in total):

• All lowercase English letters: a to z.
• All uppercase English letters: A to Z.
• All numeric characters: 0 to 9.
• "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

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 follows(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. For example, the User Account is empty. You need to pass in a valid parameter and join the channel again.
  • -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
  • -102: The channel name is invalid. You need to pass in a valid channel name and join the channel again.

Ensure the size of all preloaded files does not exceed the limit.

For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support.

Call timing

Agora recommends that you call this method before joining a channel.

Restrictions

None.

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.

Returns

• 0: Success.
• < 0: Failure.

Details

Since

v4.3.1

If you want to enable the wide-angle or ultra-wide-angle mode for camera capture, it is recommended to start by calling this method to check whether the device supports the required focal length capability. Then, adjust the camera's focal length configuration based on the query result by calling setCameraCapturerConfiguration, ensuring the best camera capture performance.

Parameters

focalLengthInfos

Input and output parameter. The pointer to an array of FocalLengthInfo objects:

• Input value: The pointer to an array of FocalLengthInfo objects, used to store focal length information.
• Output value: After the method is executed, output the queried focal length information.

size

Input and output parameter. The number of focal length information items:

• Input value: Specifies the maximum number of focal length information items that focalLengthInfos can hold. Ensure this value is not less than 8, meaning focalLengthInfos has space for at least 8 focal length information items.
• Output value: After the method is executed, output the number of focal length information items retrieved.

Returns

• 0: Success.
• < 0: Failure.

Details

Since

v4.2.0

Parameters

codecInfo

Input and output parameter. An array representing the video codec capabilities of the SDK. See CodecCapInfo.

• Input value: One CodecCapInfodefined 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 of the SDK.

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.

Details

Since

v4.3.0

Applicable scenarios

In high-definition or ultra-high-definition video scenarios, you can first call this method to query the device's score. If the returned score is low (for example, below 60), you need to lower the video resolution to avoid affecting the video experience. The minimum device score required for different business scenarios is varied. For specific score recommendations, please technical support.

Returns

• >0: The method call succeeeds, the value is the current device's score, the range is [0,100], the larger the value, the stronger the device capability. Most devices are rated between 60 and 100.
• < 0: Failure.

Parameters

iid

The ID of the interface. See INTERFACE_ID_TYPE.

inter

An output parameter. The pointer to the specified interface.

Returns

• 0: Success.
• < 0: Failure.

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.

Details

Parameters

callId

The current call ID. You can get the call ID by calling getCallId.

rating

The value is between 1 (the lowest score) and 5 (the highest score).

description

(Optional) A description of the call. The string length should be less than 800 bytes.

Returns

• 0: Success.
• < 0: Failure.
  • -1: A general error occurs (no specified reason).
  • -2: The parameter is invalid.

Details

Parameters

config

Observer settings for the encoded audio. See AudioEncodedFrameObserverConfig.

observer

The encoded audio observer. See IAudioEncodedFrameObserver.

Returns

• 0: Success.
• < 0: Failure.

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.

Since

v4.1.0

For extensions external to the SDK (such as those from Extensions Marketplace and SDK Extensions), you need to load them before calling this method. Extensions internal to the SDK (those included in the full SDK package) are automatically loaded and registered after the initialization of IRtcEngine.

Call timing

• Agora recommends you call this method after the initialization of IRtcEngine and before joining a channel.
• For video extensions (such as the image enhancement extension), you need to call this method after enabling the video module by calling enableVideo or enableLocalVideo.
• Before calling this method, you need to call loadExtensionProvider to load the extension first.

Restrictions

• If you want to register 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 registered. That is, the extension that is registered first will process the data first.

Parameters

provider

The name of the extension provider.

extension

The name of the extension.

type

Source type of the extension. See MEDIA_SOURCE_TYPE.

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.

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.

Restrictions

None.

Related callbacks

After successfully calling this method, the onLocalUserRegistered callback will be triggered on the local client to report the local user's UID and user account.

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.

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.

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.

Parameters

observer

IPacketObserver.

Returns

• 0: Success.
• < 0: Failure.

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.
• false: Asynchronous call. Currently this method only supports synchronous calls. Do not set this parameter to this value.

You can call this method to pass a new token to the SDK. A token will expire after a certain period of time, at which point the SDK will be unable to establish a connection with the server.

Call timing

Restrictions

None.

Parameters

token

The new token.

Returns

• 0: Success.
• < 0: Failure.
  • -2: The parameter is invalid. For example, the token is empty.
  • -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
  • 110: Invalid token. Ensure the following:
    • The user ID specified when generating the token is consistent with the user ID used when joining the channel.
    • The generated token is the same as the token passed in to join the channel.

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.
  • -5: The method call was rejected. There is no paused channel media relay.

After you call pauseAllEffects to pause the playback, you can call this method to resume the playback.

Call timing

Call this method after pauseAllEffects.

Restrictions

None.

Returns

• 0: Success.
• < 0: Failure.

After calling pauseAudioMixing to pause the playback, you can call this method to resume the playback.

Call timing

Call this method after joining a channel.

Restrictions

None.

Returns

• 0: Success.
• < 0: Failure.

Parameters

soundId

The audio effect ID. The ID of each audio effect file is unique.

Returns

• 0: Success.
• < 0: Failure.

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.

Parameters

index

The audio track you want to specify. The value should be greater than 0 and less than that of returned by getAudioTrackCount.

Returns

• 0: Success.
• < 0: Failure.

Details

Since

v4.3.0

You can call this method to determine the audio track to be played on your local device and published to the channel.

Before calling this method, you need to open the media file with the openWithMediaSource method and set enableMultiAudioTrack in MediaSource as true.

Applicable scenarios

For example, in KTV scenarios, the host can choose to play the original sound locally and publish the accompaniment track to the channel.

Parameters

playoutTrackIndex

The index of audio tracks for local playback. You can obtain the index through getStreamInfo.

publishTrackIndex

The index of audio tracks to be published in the channel. You can obtain the index through getStreamInfo.

Returns

• 0: Success.
• < 0: Failure.

Details

Agora supports reporting and analyzing customized messages. This function is in the beta stage with a free trial. The ability provided in its beta test version is reporting a maximum of 10 message pieces within 6 seconds, with each message piece not exceeding 256 bytes and each string not exceeding 100 bytes. To try out this function, contact support@agora.io and discuss the format of customized messages with us.

Details

After calling createDataStream [2/2], you can call this method to send data stream messages to all users in the channel.

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.

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.

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.

Since

v4.2.0

Applicable scenarios

In scenarios such as co-streaming, online education and video meeting, this function can detect and reduce background noises to improve experience.

Call timing

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

Restrictions

• This method relies on the AI noise suppression dynamic library libagora_ai_noise_suppression_extension.dll. If the dynamic library is deleted, the function cannot be enabled.
• Agora does not recommend enabling this function on devices running Android 6.0 and below.

Parameters

enabled

Whether to enable the AI noise suppression function:

• true: Enable the AI noise suppression.
• false: (Default) Disable the AI noise suppression.

mode

The AI noise suppression modes. See AUDIO_AINS_MODE.

Returns

• 0: Success.
• < 0: Failure.

Details

After setting the audio parameters, all users in the channel can hear the effect.

Parameters

preset

The options for SDK preset audio effects:

• ROOM_ACOUSTICS_3D_VOICE, 3D voice effect:
  • You need to set the profile parameter in setAudioProfile [2/2] 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:

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: A
  • 2: A#
  • 3: B
  • 4: (Default) C
  • 5: C#
  • 6: D
  • 7: D#
  • 8: E
  • 9: F
  • 10: F#
  • 11: G
  • 12: G#

Returns

• 0: Success.
• < 0: Failure.

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.

Call timing

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

Restrictions

• Do not set the profile parameter in setAudioProfile [2/2] to AUDIO_PROFILE_SPEECH_STANDARD(1) or AUDIO_PROFILE_IOT(6), or the method does not take effect.
• 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:
  • setVoiceBeautifierPreset
  • setLocalVoicePitch
  • setLocalVoiceEqualization
  • setLocalVoiceReverb
  • setVoiceBeautifierParameters
  • setVoiceConversionPreset
• 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.

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.

Applicable scenarios

Call timing

Call this method after startAudioMixing [2/2] and receiving the onAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING) callback.

Restrictions

This method only applies to stereo audio files.

Parameters

mode

The channel mode. See AUDIO_MIXING_DUAL_MONO_MODE.

Returns

• 0: Success.
• < 0: Failure.

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.

Call timing

You need to call this method after calling startAudioMixing [2/2] and receiving the onAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING) callback.

Restrictions

None.

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.

Details

Since

v4.3.1

Ensure you call this method after calling startAudioMixing [2/2] receiving the onAudioMixingStateChanged callback reporting the state as AUDIO_MIXING_STATE_PLAYING.

Parameters

speed

The playback speed. Agora recommends that you set this to a value between 50 and 400, defined as follows:

• 50: Half the original speed.
• 100: The original speed.
• 400: 4 times the original speed.

Returns

• 0: Success.
• < 0: Failure.

Call this method to set the playback position of the music file to a different starting position (the default plays from the beginning).

Call timing

Call this method after startAudioMixing [2/2] and receiving the onAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING) callback.

Restrictions

None.

Parameters

pos

Integer. The playback position (ms).

Returns

• 0: Success.
• < 0: Failure.

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.

Applicable scenarios

This method is suitable for various audio scenarios. You can choose as needed. For example, in scenarios with high audio quality requirements such as music teaching, it is recommended to set profile to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4) and scenario to AUDIO_SCENARIO_GAME_STREAMING(3).

Call timing

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

Restrictions

Due to iOS system restrictions, some audio routes cannot be recognized in call volume mode. Therefore, if you need to use an external sound card, it is recommended to set the audio scenario to AUDIO_SCENARIO_GAME_STREAMING(3). In this scenario, the SDK will switch to media volume to avoid this issue.

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. Under different audio scenarios, the device uses different volume types. See AUDIO_SCENARIO_TYPE.

Returns

• 0: Success.
• < 0: Failure.

If you need to set the audio scenario, you can either call setAudioScenario, or initialize and set the audioScenario in RtcEngineContext.

Applicable scenarios

This method is suitable for various audio scenarios. You can choose as needed. For example, in scenarios with high audio quality requirements such as music teaching, it is recommended to set profile to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4).

Call timing

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

Restrictions

None.

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.

Applicable scenarios

This method is suitable for various audio scenarios. You can choose as needed. For example, in scenarios such as music teaching that require high sound quality, it is recommended to set scenario to AUDIO_SCENARIO_GAME_STREAMING(3).

Call timing

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

Restrictions

Due to iOS system restrictions, some audio routes cannot be recognized in call volume mode. Therefore, if you need to use an external sound card, it is recommended to set the audio scenario to AUDIO_SCENARIO_GAME_STREAMING(3). In this scenario, the SDK will switch to media volume to avoid this issue.

Parameters

scenario

The audio scenarios. Under different audio scenarios, the device uses different volume types. See AUDIO_SCENARIO_TYPE.

Returns

• 0: Success.
• < 0: Failure.

Details

The SDK and the app can both configure the audio session by default. If you need to only use the app to configure the audio session, this method restricts the operational permission of the SDK on the audio session.

You can call this method either before or after joining a channel. Once you call this method to restrict the operational permission of the SDK on the audio session, the restriction takes effect when the SDK needs to change the audio session.

Parameters

restriction

The operational permission of the SDK on the audio session. See AUDIO_SESSION_OPERATION_RESTRICTION. This parameter is in bit mask format, and each bit corresponds to a permission.

Returns

• 0: Success.
• < 0: Failure.

Enables or disables image enhancement, and sets the options.

Call timing

Call this method after calling enableVideo or startPreview [2/2].

Restrictions

• This method relies on the image enhancement dynamic library libagora_clear_vision_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.
• This feature has high requirements on device performance. When calling this method, the SDK automatically checks the capabilities of the current device.

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.

type

The type of the media source to which the filter effect is applied. See MEDIA_SOURCE_TYPE.

Attention: In this method, this parameter supports only the following two settings:

• Use the default value PRIMARY_CAMERA_SOURCE if you use camera to capture local video.
• Set this parameter to CUSTOM_VIDEO_SOURCE if you use custom video source.

Returns

• 0: Success.
• < 0: Failure.
  • -4: The current device does not support this feature. Possible reasons include:
    • The current device capabilities do not meet the requirements for image enhancement. Agora recommends you replace it with a high-performance device.

By default, the SDK disables face autofocus on Android and enables face autofocus on iOS. To set face autofocus, call this method.

Call timing

This method must be called after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LOCAL_VIDEO_STREAM_STATE_CAPTURING (1).

Restrictions

None.

Parameters

enabled

Whether to enable face autofocus:

• true: Enable the camera auto-face focus function.
• false: Disable face autofocus.

Returns

• 0: Success.
• < 0: Failure.

Details

Parameters

enabled

Whether to enable auto exposure:

• true: Enable auto exposure.
• false: Disable auto exposure.

Returns

• 0: Success.
• < 0: Failure.

Call timing

Call this method before enabling local camera capture, such as before calling startPreview [2/2] and joinChannel [2/2].

Restrictions

To adjust the camera focal length configuration, It is recommended to call queryCameraFocalLengthCapability first to check the device's focal length capabilities, and then configure based on the query results.

Due to limitations on some Android devices, even if you set the focal length type according to the results returned in queryCameraFocalLengthCapability, the settings may not take effect.

Parameters

config

The camera capture configuration. See CameraCapturerConfiguration.

Attention: In this method, you do not need to set the deviceId parameter.

Returns

• 0: Success.
• < 0: Failure.

Details

Parameters

type

The video source type. See VIDEO_SOURCE_TYPE.

orientation

The clockwise rotation angle. See VIDEO_ORIENTATION.

Returns

• 0: Success.
• < 0: Failure.

Details

Since

v4.2.2

Insufficient or excessive lighting in the shooting environment can affect the image quality of video capture. To achieve optimal video quality, you can use this method to adjust the camera's exposure value.

Parameters

factor

The camera exposure value. The default value is 0, which means using the default exposure of the camera. The larger the value, the greater the exposure. When the video image is overexposed, you can reduce the exposure value; when the video image is underexposed and the dark details are lost, you can increase the exposure value. If the exposure value you specified is beyond the range supported by the device, the SDK will automatically adjust it to the actual supported range of the device.

On Android, the value range is [-20.0, 20.0]. On iOS, the value range is [-8.0, 8.0].

Returns

• 0: Success.
• < 0: Failure.

Details

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.

Details

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.

Since

v4.3.1

The camera stabilization mode is off by default. You need to call this method to turn it on and set the appropriate stabilization mode.

Applicable scenarios

When shooting on the move, in low light conditions, or with mobile devices, you can set the camera stabilization mode to reduce the impact of camera shake and get a more stable, clear picture.

Call timing

This method must be called after the camera is successfully enabled, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LOCAL_VIDEO_STREAM_STATE_CAPTURING (1).

Restrictions

• Camera stabilization only works for scenarios with a video resolution greater than 1280 x 720.
• After enabling camera stabilization, the higher the camera stabilization level, the smaller the camera's field of view and the greater the camera's latency. To improve user experience, it is recommended that you set the mode parameter to CAMERA_STABILIZATION_MODE_LEVEL_1.

Parameters

mode

Camera stabilization mode. See CAMERA_STABILIZATION_MODE.

Returns

• 0: Success.
• < 0: Failure.

Details

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.

Details

For iOS devices equipped with multi-lens rear cameras, such as those featuring dual-camera (wide-angle and ultra-wide-angle) or triple-camera (wide-angle, ultra-wide-angle, and telephoto), you can call setCameraCapturerConfiguration first to set the cameraFocalLengthType as CAMERA_FOCAL_LENGTH_DEFAULT (0) (standard lens). Then, adjust the camera zoom factor to a value less than 1.0. This configuration allows you to capture video with an ultra-wide-angle perspective.

Parameters

factor

The camera zoom factor. For devices that do not support ultra-wide-angle, the value ranges from 1.0 to the maximum zoom factor; for devices that support ultra-wide-angle, the value ranges from 0.5 to the maximum zoom factor. You can get the maximum zoom factor supported by the device by calling the getCameraMaxZoomFactor method.

Returns

• The camera zoom factor value, if successful.
• < 0: if the method if failed.

You can call this method to set the channel profile. The SDK adopts different optimization strategies for different channel profiles. For example, in a live streaming scenario, the SDK prioritizes video quality. After initializing the SDK, the default channel profile is the live streaming profile.

Call timing

Call this method before joining a channel.

Restrictions

To ensure the quality of real-time communication, Agora recommends that all users in a channel use the same channel profile.

Parameters

profile

The channel profile. See CHANNEL_PROFILE_TYPE.

Returns

• 0: Success.
• < 0: Failure.
  • -2: The parameter is invalid.
  • -7: The SDK is not initialized.

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.

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.

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

Call timing

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

If you call this method to set the user 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.

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

Restrictions

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

Related callbacks

If you call this method to set the user role after joining a channel but encounter a failure, the SDK trigger the onClientRoleChangeFailed callback to report the reason for the failure and the current user role.

Parameters

role

The user role. See CLIENT_ROLE_TYPE.

Note: If you set the user role as an audience member, you cannot publish audio and video streams in the channel. If you want to publish media streams in a channel during live streaming, ensure you set the user role as broadcaster.

Returns

• 0: Success.
• < 0: Failure.
  • -1: A general error occurs (no specified reason).
  • -2: The parameter is invalid.
  • -7: The SDK is not initialized.

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

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

Call timing

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

If you call this method to set the user 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.

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

Restrictions

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

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

Related callbacks

If you call this method to set the user role after joining a channel but encounter a failure, the SDK trigger the onClientRoleChangeFailed callback to report the reason for the failure and the current user role.

Parameters

role

The user role. See CLIENT_ROLE_TYPE.

Note: If you set the user role as an audience member, you cannot publish audio and video streams in the channel. If you want to publish media streams in a channel during live streaming, ensure you set the user role as broadcaster.

options

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.

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.

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 media source to which the filter effect is applied. See MEDIA_SOURCE_TYPE.

Attention: In this method, this parameter supports only the following two settings:

• Use the default value PRIMARY_CAMERA_SOURCE if you use camera to capture local video.
• Set this parameter to CUSTOM_VIDEO_SOURCE if you use custom video source.

Returns

• 0: Success.
• < 0: Failure.

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.

You can call this method to change the default audio route.

Call timing

Call this method before joining a channel. If you need to change the audio route after joining a channel, call setEnableSpeakerphone.

Restrictions

None.

Related callbacks

After successfully calling this method, the SDK triggers the onAudioRoutingChanged callback to report the current audio route.

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.

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.

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_MODE_FIXED_LANDSCAPE or ORIENTATION_MODE_FIXED_PORTRAIT.

Returns

• 0: Success.
• < 0: Failure.

Details

Since

v4.0.1

Parameters

mode

The mode in which the video stream is sent. See SIMULCAST_STREAM_MODE.

Returns

• 0: Success.
• < 0: Failure.

Details

Since

v4.0.1

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.

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.

Details

This method is used to set the in-ear monitoring audio data format reported by the onEarMonitoringAudioFrame callback.

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.

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.

Call timing

Call this method after playEffect.

Restrictions

None.

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.

Applicable scenarios

If the default audio route of the SDK or the setting in setDefaultAudioRouteToSpeakerphone cannot meet your requirements, you can call this method to switch the current audio route.

Call timing

Call this method after joining a channel.

Restrictions

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

Related callbacks

After successfully calling this method, the SDK triggers the onAudioRoutingChanged callback to report the current audio route.

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.

After enabling the extension, you can call this method to set the properties of the extension.

Call timing

Call this mehtod after calling enableExtension.

Restrictions

If you want to set properties for multiple extensions, you need to call this method multiple times.

Related callbacks

After calling this method, it may trigger the onExtensionEventWithContext callback, and the specific triggering logic is related to the extension itself.

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

Source type of the extension. See MEDIA_SOURCE_TYPE.

Returns

• 0: Success.
• < 0: Failure.