IRtcEngine

Details

After calling this method, you can listen for the corresponding events in the IRtcEngine object and obtain data through IRtcEngineEvent. Depending on your project needs, you can add multiple listeners for the same event.

Parameters

eventType

The name of the target event to listen for. See IRtcEngineEvent.

listener

The callback function for eventType. Take adding a listener for onJoinChannelSuccess as an example:

const onJoinChannelSuccess = (connection: RtcConnection, elapsed: number) => {};
engine.addListener('onJoinChannelSuccess', onJoinChannelSuccess);

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 and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying) 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 and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying) 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.

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.

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.

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.

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

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.

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 IRtcEngineEx object for each app.

Returns

One IRtcEngineEx object.

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

config

The configurations for the data stream. See DataStreamConfig.

Returns

• ID of the created data stream, if the method call succeeds.
• < 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

Parameters

trackType

The type of the custom audio track. See AudioTrackType.

Attention: If AudioTrackDirect is specified for this parameter, you must set publishMicrophoneTrack to false in ChannelMediaOptions when calling joinChannel to join the channel; otherwise, joining the channel fails and returns the error code -2.

config

The configuration of the custom audio track. See AudioTrackConfig.

Returns

• If the method call is successful, the audio track ID is returned as the unique identifier of the audio track.
• If the method call fails, 0xffffffff is returned.

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.

Details

Parameters

trackId

The custom audio track ID returned in createCustomAudioTrack.

Returns

• 0: Success.
• < 0: Failure.

Parameters

videoTrackId

The video track ID returned by calling the createCustomVideoTrack method.

Returns

• 0: Success.
• < 0: Failure.

Parameters

mediaPlayer

One IMediaPlayer object.

Returns

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

Details

Parameters

sourceType

The type of the video source. See VideoSourceType.

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 of the remote user.

Details

Parameters

view

The HTMLElement object to be destroyed.

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.

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 LocalVideoStreamStateCapturing (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, ensure that you have contacted technical support to activate the video screenshot upload service.

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.

Note: When the video moderation module is set to video moderation via Agora self-developed extension(ContentInspectSupervision), the video screenshot and upload dynamic library libagora_content_inspect_extension.dll is required. Deleting this library disables the screenshot and upload feature.

Returns

• 0: Success.
• < 0: Failure.

abstract enableCustomAudioLocalPlayback(
    trackId: number,
    enabled: boolean
  ): number;

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 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 DisableSimulcastStream, 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 MediaSourceType.

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.

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

Returns

• 0: Success.
• < 0: Failure.
  • - 8: Make sure the current audio routing is Bluetooth or headset.

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, and enableLocalAudio(false) is applicable to scenarios where the user wants to receive remote audio streams without sending any audio stream to other users in the channel.

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 LocalAudioStreamStateStopped(0) or LocalAudioStreamStateRecording(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 loopback audio capturing.
• false: (Default) Disable loopback audio capturing.

deviceName

• macOS: The device name of the virtual sound card. The default value is set to NULL, which means using AgoraALD for loopback audio capturing.
• Windows: The device name of the sound card. The default is set to NULL, which means the SDK uses the sound card of your device for loopback audio capturing.

Returns

• 0: Success.
• < 0: Failure.

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.

Parameters

enabled

Whether to enable virtual background:

• true: Enable virtual background.
• false: Disable virtual background.

backgroundSource

The custom background. See VirtualBackgroundSource. To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted.

segproperty

Processing properties for background images. See SegmentationProperty.

type

The type of the video source. See MediaSourceType.

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

• The default value is PrimaryCameraSource.
• If you want to use the second camera to capture video, set this parameter to SecondaryCameraSource.

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.

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

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.

Returns

One IAudioDeviceManager object.

Returns

One IVideoDeviceManager object.

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 and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying) 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 and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying) 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 the callId parameter, 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

• The current call ID, if the method succeeds.
• An empty string, if the method call fails.

Call timing

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

Restrictions

None.

Returns

The current connection state. See ConnectionStateType.

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:

• Windows: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example: C:\music\audio.mp4.
• macOS: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example: /var/mobile/Containers/Data/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 or warning code reported by the SDK.

Returns

The specific error or warning description.

Call timing

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

Restrictions

None.

Parameters

provider

The name of the extension provider.

extension

The name of the extension.

key

The key of the extension.

type

Source type of the extension. See MediaSourceType.

bufLen

Maximum length of the JSON string indicating the extension property. The maximum value is 512 bytes.

Returns

• The extension information, if the method call succeeds.
• An empty string, if the method call fails.

Details

Returns

One ILocalSpatialAudioEngine object.

Details

Returns

One IMediaEngine object.

Details

This method retrieves the C++ handle of the SDK, which is used for registering the audio and video frame observer.

Returns

The native handle of the SDK.

Details

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

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

The ScreenCaptureSourceInfo array.

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.

Parameters

Returns

One SDKBuildInfo object.

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.

Returns

• A pointer to the UserInfo instance, if the method call succeeds.
• If the call fails, returns null.

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.

Returns

• A pointer to the UserInfo instance, if the method call succeeds.
• If the call fails, returns null.

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 LocalVideoStreamStateCapturing (1).

Restrictions

None.

Returns

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

Details

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.

This method supports setting the media options when joining a channel, such as whether to publish audio and video streams within the 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 ConnectionStateDisconnected(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
• "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

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 ConnectionStateDisconnected(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. 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.

unloadAfterUse

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

uid

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

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.

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 AudioScenarioChorus, 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.

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:

• Windows: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example: C:\music\audio.mp4.
• macOS: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example: /var/mobile/Containers/Data/audio.mp4.

startPos

The playback position (ms) of the audio effect file.

Returns

• 0: Success.
• < 0: Failure.

Details

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.

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

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.

The encoded audio observer. See IAudioEncodedFrameObserver.

Returns

One IAudioEncodedFrameObserver object.

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

One IAudioSpectrumObserver object.

Details

The SDK uses the IRtcEngineEventHandler class to send callbacks to the app. The app inherits the methods of this class to receive these callbacks. All methods in this class have default (empty) implementations. Therefore, apps only need to inherits callbacks according to the scenarios. In the callbacks, avoid time-consuming tasks or calling APIs that can block the thread, such as the sendStreamMessage method. Otherwise, the SDK may not work properly.

Parameters

eventHandler

Callback events to be added. See IRtcEngineEventHandler.

Returns

• true: Success.
• false: Failure.

Details

You can call this method too remove all added callback events.

Parameters

eventHandler

Callback events to be removed. See IRtcEngineEventHandler.

Returns

• true: Success.
• false: Failure.

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

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.

Parameters

observer

The metadata observer. See IMetadataObserver.

type

The metadata type. The SDK currently only supports VideoMetadata. See MetadataType.

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.

Related callbacks

• onTokenPrivilegeWillExpire
• onRequestToken
• onConnectionStateChanged

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

Parameters

eventType

The name of the target event to listen for. See IRtcEngineEvent.

Details

For listened events, if you no longer need to receive the callback message, you can call this method to remove the corresponding listener.

Parameters

eventType

The name of the target event to listen for. See IRtcEngineEvent.

listener

The callback function for eventType. Must pass in the same function object in addListener. Take removing the listener for onJoinChannelSuccess as an example:

// Create an onJoinChannelSuccess object
const onJoinChannelSuccess = (connection: RtcConnection, elapsed: number) => {};
// Add one onJoinChannelSuccess listener
engine.addListener('onJoinChannelSuccess', onJoinChannelSuccess);
// Remove the onJoinChannelSuccess listener
engine.removeListener('onJoinChannelSuccess', onJoinChannelSuccess);

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

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

If the metadata is sent successfully, the SDK triggers the onMetadataReceived callback on the receiver.

Parameters

metadata

Media metadata. See Metadata.

sourceType

The type of the video source. See VideoSourceType.

Returns

• 0: Success.
• < 0: Failure.

Details

After calling createDataStream, 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.

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.

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

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

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:

• RoomAcoustics3dVoice, 3D voice effect:
  • You need to set the profile parameter in setAudioProfile to AudioProfileMusicStandardStereo(3) or AudioProfileMusicHighQualityStereo(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.
• PitchCorrection, Pitch correction effect:

param1

• If you set preset to RoomAcoustics3dVoice, 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 PitchCorrection, 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 RoomAcoustics3dVoice , you need to set param2 to 0.
• If you set preset to PitchCorrection, 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 to AudioProfileSpeechStandard(1) or AudioProfileIot(6), or the method does not take effect.
• If you call setAudioEffectPreset and set enumerators except for RoomAcoustics3dVoice or PitchCorrection, 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 AudioEffectPreset.

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 and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying) callback.

Restrictions

This method only applies to stereo audio files.

Parameters

mode

The channel mode. See AudioMixingDualMonoMode.

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 and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying) 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

Ensure you call this method after calling startAudioMixing receiving the onAudioMixingStateChanged callback reporting the state as AudioMixingStatePlaying.

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 and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying) callback.

Restrictions

None.

Parameters

pos

Integer. The playback position (ms).

Returns

• 0: Success.
• < 0: Failure.

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 AudioProfileMusicHighQuality(4) and scenario to AudioScenarioGameStreaming(3).

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

scenario

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

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 AudioScenarioGameStreaming(3).

Call timing

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

Restrictions

None.

Parameters

scenario

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

Returns

• 0: Success.
• < 0: Failure.

Enables or disables image enhancement, and sets the options.

Call timing

Call this method after calling enableVideo or startPreview.

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

Source type of the extension. See MediaSourceType.

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.

Call timing

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

Restrictions

None.

Parameters

config

The camera capture configuration. See CameraCapturerConfiguration.

Returns

• < 0: Failure.

Details

Parameters

type

The video source type. See VideoSourceType.

orientation

The clockwise rotation angle. See VideoOrientation.

Returns

• 0: Success.
• < 0: Failure.

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

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 (ConnectionStateConnecting, ConnectionChangedSettingProxyServer) callback.

To disable the cloud proxy that has been set, call the setCloudProxy(NoneProxy).

To change the cloud proxy type that has been set, call the setCloudProxy(NoneProxy) first, and then call the setCloudProxy to set the proxyType you want.

Parameters

proxyType

The type of the cloud proxy. See CloudProxyType.

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 the user role is set to host, the audience latency level can only be set to AudienceLatencyLevelUltraLowLatency.

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

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 video source. See MediaSourceType.

Returns

• 0: Success.
• < 0: Failure.

Details

Parameters

mode

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

streamConfig

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

Note: When setting mode to DisableSimulcastStream, 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 RawAudioFrameOpModeType.

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.

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

Returns

• 0: Success.
• < 0: Failure.

You can call this method to set the attributes of the extension provider and initialize the relevant parameters according to the type of the provider.

Call timing

Call this method before enableExtension and after registerExtension.

Restrictions

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

Parameters

provider

The name of the extension provider.

key

The key of the extension.

value

The value of the extension key.

Returns

• 0: Success.
• < 0: Failure.

After enabling the external audio sink, you can call pullAudioFrame to pull remote audio frames. The app can process the remote audio and play it with the audio effects that you want.

Applicable scenarios

This method applies to scenarios where you want to use external audio data for playback.

Call timing

Call this method before joining a channel.

Restrictions

Once you enable the external audio sink, the app will not retrieve any audio data from the onPlaybackAudioFrame callback.

Parameters

enabled

Whether to enable or disable the external audio sink:

• true: Enables the external audio sink.
• false: (Default) Disables the external audio sink.

sampleRate

The sample rate (Hz) of the external audio sink, which can be set as 16000, 32000, 44100, or 48000.

channels

The number of audio channels of the external audio sink:

• 1: Mono.
• 2: Stereo.

Returns

• 0: Success.
• < 0: Failure.

Details

This method is mainly used in spatial audio effect scenarios. You can select the preset headphone equalizer to listen to the audio to achieve the expected audio experience.

Parameters

preset

The preset headphone equalization effect. See HeadphoneEqualizerPreset.

Returns

• 0: Success.
• < 0: Failure.
  • -1: A general error occurs (no specified reason).

Details

In a spatial audio effect scenario, if the preset headphone equalization effect is not achieved after calling the setHeadphoneEQPreset method, you can further adjust the headphone equalization effect by calling this method.

Parameters

lowGain

The low-frequency parameters of the headphone equalizer. The value range is [-10,10]. The larger the value, the deeper the sound.

highGain

The high-frequency parameters of the headphone equalizer. The value range is [-10,10]. The larger the value, the sharper the sound.

Returns

• 0: Success.
• < 0: Failure.
  • -1: A general error occurs (no specified reason).

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

After initializing the local video view, you can call this method to update its rendering and mirror modes. It affects only the video view that the local user sees and does not impact the publishing of the local video.

Call timing

• Ensure that you have called the setupLocalVideo method to initialize the local video view before calling this method.
• During a call, you can call this method as many times as necessary to update the display mode of the local video view.

Restrictions

This method only takes effect on the primary camera (PrimaryCameraSource). In scenarios involving custom video capture or the use of alternative video sources, you need to use setupLocalVideo instead of this method.

Parameters

renderMode

The local video display mode. See RenderModeType.

mirrorMode

The mirror mode of the local video view. See VideoMirrorModeType.

Attention: If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default.

Returns

• 0: Success.
• < 0: Failure.

Details

Deprecated:

This method is deprecated.

Use setupLocalVideo or setLocalRenderMode instead.

Parameters

mirrorMode

The local video mirror mode. See VideoMirrorModeType.

Returns

• 0: Success.
• < 0: Failure.

Call timing

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

Restrictions

None.

Parameters

bandFrequency

The band frequency. The value ranges between 0 and 9; representing the respective 10-band center frequencies of the voice effects, including 31, 62, 125, 250, 500, 1k, 2k, 4k, 8k, and 16k Hz. See AudioEqualizationBandFrequency.

bandGain

The gain of each band in dB. The value ranges between -15 and 15. The default value is 0.

Returns

• 0: Success.
• < 0: Failure.

Call timing

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

Restrictions

None.

Parameters

pitch

The local voice pitch. The value range is [0.5,2.0]. The lower the value, the lower the pitch. The default value is 1.0 (no change to the pitch).

Returns

• 0: Success.
• < 0: Failure.

Details

The SDK provides an easier-to-use method, setAudioEffectPreset, to directly implement preset reverb effects for such as pop, R&B, and KTV.

Parameters

reverbKey

The reverberation key. Agora provides five reverberation keys, see AudioReverbType.

value

The value of the reverberation key.

Returns

• 0: Success.
• < 0: Failure.

Deprecated:

This method is deprecated. Set the log file path by configuring the context parameter when calling initialize.

Specifies an SDK output log file. The log file records all log data for the SDK’s operation.

Call timing

This method needs to be called immediately after initialize, otherwise the output log may be incomplete.

Restrictions

Ensure that the directory for the log file exists and is writable.

Parameters

filePath

The complete path of the log files. These log files are encoded in UTF-8.

Returns

• 0: Success.
• < 0: Failure.

Details

Deprecated:

Use the logConfig parameter in initialize instead.

By default, the SDK generates five SDK log files and five API call log files with the following rules:

• The SDK log files are: agorasdk.log, agorasdk.1.log, agorasdk.2.log, agorasdk.3.log, and agorasdk.4.log.
• The API call log files are: agoraapi.log, agoraapi.1.log, agoraapi.2.log, agoraapi.3.log, and agoraapi.4.log.
• The default size of each SDK log file and API log file is 2,048 KB. These log files are encoded in UTF-8.
• The SDK writes the latest logs in agorasdk.log or agoraapi.log.
• When agorasdk.log is full, the SDK processes the log files in the following order:
  1. Delete the agorasdk.4.log file (if any).
  2. Rename agorasdk.3.log to agorasdk.4.log.
  3. Rename agorasdk.2.log to agorasdk.3.log.
  4. Rename agorasdk.1.log to agorasdk.2.log.
  5. Create a new agorasdk.log file.
• The overwrite rules for the agoraapi.log file are the same as for agorasdk.log.

Parameters

fileSizeInKBytes

The size (KB) of an agorasdk.log file. The value range is [128,20480]. The default value is 2,048 KB. If you set fileSizeInKByte smaller than 128 KB, the SDK automatically adjusts it to 128 KB; if you set fileSizeInKByte greater than 20,480 KB, the SDK automatically adjusts it to 20,480 KB.

Returns

• 0: Success.
• < 0: Failure.

Details

Deprecated:

Use logConfig in initialize instead.

This method sets the output log level of the SDK. You can use one or a combination of the log filter levels. The log level follows the sequence of LogFilterOff, LogFilterCritical, LogFilterError, LogFilterWarn, LogFilterInfo, and LogFilterDebug. Choose a level to see the logs preceding that level.

If, for example, you set the log level to LogFilterWarn, you see the logs within levels LogFilterCritical, LogFilterError and LogFilterWarn.

Parameters

filter

The output log level of the SDK. See LogFilterType.

Returns

• 0: Success.
• < 0: Failure.

Deprecated:

This method is deprecated. Set the log file level by configuring the context parameter when calling initialize.

Choose a level to see the logs preceding that level.

Parameters

level

The log level. See LogLevel.

Returns

• 0: Success.
• < 0: Failure.

Details

After calling registerMediaMetadataObserver, you can call this method to set the maximum size of the media metadata.

Parameters

size

The maximum size of media metadata.

Returns

• 0: Success.
• < 0: Failure.

Details

The low-light enhancement feature can adaptively adjust the brightness value of the video captured in situations with low or uneven lighting, such as backlit, cloudy, or dark scenes. It restores or highlights the image details and improves the overall visual effect of the video.

You can call this method to enable the color enhancement feature and set the options of the color enhancement effect.

Parameters

enabled

Whether to enable low-light enhancement:

• true: Enable low-light enhancement.
• false: (Default) Disable low-light enhancement.

options

The low-light enhancement options. See LowlightEnhanceOptions.

type

The type of the video source. See MediaSourceType.

Returns

• 0: Success.
• < 0: Failure.

The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method.Sample interval (sec) = samplePerCall/(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the onMixedAudioFrame callback according to the sampling interval.

Call timing

Call this method before joining a channel.

Restrictions

None.

Parameters

sampleRate

The sample rate returned in the callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.

channel

The number of audio channels. You can set the value as 1 or 2.

• 1: Mono.
• 2: Stereo.

samplesPerCall

The number of data samples, such as 1024 for the Media Push.

Returns

• 0: Success.
• < 0: Failure.

The SDK triggers the onPlaybackAudioFrameBeforeMixing callback according to the sampling interval.

Call timing

Call this method before joining a channel.

Restrictions

None.

Parameters

sampleRate

The sample rate returned in the callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.

channel

The number of audio channels. You can set the value as 1 or 2.

• 1: Mono.
• 2: Stereo.

Returns

• 0: Success.
• < 0: Failure.

The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method.Sample interval (sec) = samplePerCall/(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the onPlaybackAudioFrame callback according to the sampling interval.

Call timing

Call this method before joining a channel.

Restrictions

None.

Parameters

sampleRate

The sample rate returned in the callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.

channel

The number of audio channels. You can set the value as 1 or 2.

• 1: Mono.
• 2: Stereo.

mode

The use mode of the audio frame. See RawAudioFrameOpModeType.

samplesPerCall

The number of data samples, such as 1024 for the Media Push.

Returns

• 0: Success.
• < 0: Failure.

The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method.Sample interval (sec) = samplePerCall/(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the onRecordAudioFrame callback according to the sampling interval.

Call timing

Call this method before joining a channel.

Restrictions

None.

Parameters

sampleRate

The sample rate returned in the callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.

channel

The number of audio channels. You can set the value as 1 or 2.

• 1: Mono.
• 2: Stereo.

mode

The use mode of the audio frame. See RawAudioFrameOpModeType.

samplesPerCall

The number of data samples, such as 1024 for the Media Push.

Returns

• 0: Success.
• < 0: Failure.

Parameters

parameters

Pointer to the set parameters in a JSON string.

Returns

• 0: Success.
• < 0: Failure.

The SDK will dynamically adjust the size of the corresponding video stream based on the size of the video window to save bandwidth and computing resources. The default aspect ratio of the low-quality video stream is the same as that of the high-quality video stream. According to the current aspect ratio of the high-quality video stream, the system will automatically allocate the resolution, frame rate, and bitrate of the low-quality video stream.

Call timing

Call this method before joining a channel. The SDK does not support changing the default subscribed video stream type after joining a channel.

Restrictions

If you call both this method and setRemoteVideoStreamType, the setting of setRemoteVideoStreamType takes effect.

Parameters

streamType

The default video-stream type. See VideoStreamType.

Returns

• 0: Success.
• < 0: Failure.

Details

An unstable network affects the audio and video quality in a video call or interactive live video streaming. If option is set as StreamFallbackOptionVideoStreamLow or StreamFallbackOptionAudioOnly, the SDK automatically switches the video from a high-quality stream to a low-quality stream or disables the video when the downlink network conditions cannot support both audio and video to guarantee the quality of the audio. Meanwhile, the SDK continuously monitors network quality and resumes subscribing to audio and video streams when the network quality improves.

When the subscribed video stream falls back to an audio-only stream, or recovers from an audio-only stream to an audio-video stream, the SDK triggers the onRemoteSubscribeFallbackToAudioOnly callback.

Parameters

option

Fallback options for the subscribed stream. See STREAM_FALLBACK_OPTIONS.

Returns

• 0: Success.
• < 0: Failure.

Details

Call this method after enableSpatialAudio. After successfully setting the spatial audio effect parameters of the remote user, the local user can hear the remote user with a sense of space.

Parameters

uid

The user ID. This parameter must be the same as the user ID passed in when the user joined the channel.

The spatial audio parameters. See SpatialAudioParams.

Returns

• 0: Success.
• < 0: Failure.

Details

This method initializes the video view of a remote stream on the local device. It affects only the video view that the local user sees. Call this method to bind the remote video stream to a video view and to set the rendering and mirror modes of the video view.

You need to specify the ID of the remote user in this method. If the remote user ID is unknown to the application, set it after the app receives the onUserJoined callback.

To unbind the remote user from the view, set the view parameter to NULL.

Once the remote user leaves the channel, the SDK unbinds the remote user.

Parameters

canvas

The remote video view and settings. See VideoCanvas.

Returns

• 0: Success.
• < 0: Failure.

Details

After initializing the video view of a remote user, you can call this method to update its rendering and mirror modes. This method affects only the video view that the local user sees.

Parameters

uid

The user ID of the remote user.

renderMode

The rendering mode of the remote user view. For details, see RenderModeType.

mirrorMode

The mirror mode of the remote user view. See VideoMirrorModeType.

Returns

• 0: Success.
• < 0: Failure.

Details

The SDK will dynamically adjust the size of the corresponding video stream based on the size of the video window to save bandwidth and computing resources. The default aspect ratio of the low-quality video stream is the same as that of the high-quality video stream. According to the current aspect ratio of the high-quality video stream, the system will automatically allocate the resolution, frame rate, and bitrate of the low-quality video stream.

Parameters

uid

The user ID.

streamType

The video stream type, see VideoStreamType.

Returns

• 0: Success.
• < 0: Failure.

Details

When a remote user has enabled dual-stream mode, you can call this method to choose the option for subscribing to the video streams sent by the remote user.

Parameters

uid

The user ID of the remote user.

options

The video subscription options. See VideoSubscriptionOptions.

Returns

• 0: Success.
• < 0: Failure.

Details

This method sets the 2D position and volume of a remote user, so that the local user can easily hear and identify the remote user's position.

When the local user calls this method to set the voice position of a remote user, the voice difference between the left and right channels allows the local user to track the real-time position of the remote user, creating a sense of space. This method applies to massive multiplayer online games, such as Battle Royale games.

Parameters

uid

The user ID of the remote user.

pan

The voice position of the remote user. The value ranges from -1.0 to 1.0:

• 0.0: (Default) The remote voice comes from the front.
• -1.0: The remote voice comes from the left.
• 1.0: The remote voice comes from the right.

gain

The volume of the remote user. The value ranges from 0.0 to 100.0. The default value is 100.0 (the original volume of the remote user). The smaller the value, the lower the volume.

Returns

• 0: Success.
• < 0: Failure.

Details

A content hint suggests the type of the content being shared, so that the SDK applies different optimization algorithms to different types of content. If you don't call this method, the default content hint is ContentHintNone.

Parameters

contentHint

The content hint for screen sharing. See VideoContentHint.

Returns

• 0: Success.
• < 0: Failure.
  • -2: The parameter is invalid.
  • -8: The screen sharing state is invalid. Probably because you have shared other screens or windows. Try calling stopScreenCapture to stop the current sharing and start sharing the screen again.

Details

When you start screen sharing or window sharing, you can call this method to set the screen sharing scenario. The SDK adjusts the video quality and experience of the sharing according to the scenario.

Parameters

screenScenario

The screen sharing scenario. See ScreenScenarioType.

Returns

• 0: Success.
• < 0: Failure.

Details

You can call this method to specify the audio streams of a user that you do not want to subscribe to.

Parameters

uidList

The user ID list of users that you do not want to subscribe to.

If you want to specify the audio streams of a user that you do not want to subscribe to, add the user ID in this list. If you want to remove a user from the blocklist, you need to call the setSubscribeAudioBlocklist method to update the user ID list; this means you only add the uid of users that you do not want to subscribe to in the new user ID list.

uidNumber

The number of users in the user ID list.

Returns

• 0: Success.
• < 0: Failure.

Details

You can call this method to specify the audio streams of a user that you want to subscribe to.

Parameters

uidList

The user ID list of users that you want to subscribe to.

If you want to specify the audio streams of a user for subscription, add the user ID in this list. If you want to remove a user from the allowlist, you need to call the setSubscribeAudioAllowlist method to update the user ID list; this means you only add the uid of users that you want to subscribe to in the new user ID list.

uidNumber

The number of users in the user ID list.

Returns

• 0: Success.
• < 0: Failure.

Details

You can call this method to specify the video streams of a user that you do not want to subscribe to.

Parameters

uidList

The user ID list of users that you do not want to subscribe to.

If you want to specify the video streams of a user that you do not want to subscribe to, add the user ID of that user in this list. If you want to remove a user from the blocklist, you need to call the setSubscribeVideoBlocklist method to update the user ID list; this means you only add the uid of users that you do not want to subscribe to in the new user ID list.

uidNumber

The number of users in the user ID list.

Returns

• 0: Success.
• < 0: Failure.

Details

You can call this method to specify the video streams of a user that you want to subscribe to.

Parameters

uidList

The user ID list of users that you want to subscribe to.

If you want to specify the video streams of a user for subscription, add the user ID of that user in this list. If you want to remove a user from the allowlist, you need to call the setSubscribeVideoAllowlist method to update the user ID list; this means you only add the uid of users that you want to subscribe to in the new user ID list.

uidNumber

The number of users in the user ID list.

Returns

• 0: Success.
• < 0: Failure.

Details

Underlit environments and low-end video capture devices can cause video images to contain significant noise, which affects video quality. In real-time interactive scenarios, video noise also consumes bitstream resources and reduces encoding efficiency during encoding.

You can call this method to enable the video noise reduction feature and set the options of the video noise reduction effect.

Parameters

enabled

Whether to enable video noise reduction:

• true: Enable video noise reduction.
• false: (Default) Disable video noise reduction.

options

The video noise reduction options. See VideoDenoiserOptions.

type

The type of the video source. See MediaSourceType.

Returns

• 0: Success.
• < 0: Failure.

Sets the encoder configuration for the local video. Each configuration profile corresponds to a set of video parameters, including the resolution, frame rate, and bitrate.

Call timing

You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before enableVideo to reduce the time to render the first video frame.

Restrictions

• The config specified in this method is the maximum value under ideal network conditions. If the video engine cannot render the video using the specified config due to unreliable network conditions, the parameters further down the list are considered until a successful configuration is found.

Parameters

config

Video profile. See VideoEncoderConfiguration.

Returns

• 0: Success.
• < 0: Failure.

Details

After successfully calling this method, the SDK will automatically enable the best practice strategies and adjust key performance metrics based on the specified scenario, to optimize the video experience.

Parameters

scenarioType

The type of video application scenario. See VideoApplicationScenarioType.

ApplicationScenarioMeeting (1) is suitable for meeting scenarios. The SDK automatically enables the following strategies:

• In meeting scenarios where low-quality video streams are required to have a high bitrate, the SDK automatically enables multiple technologies used to deal with network congestions, to enhance the performance of the low-quality streams and to ensure the smooth reception by subscribers.
• The SDK monitors the number of subscribers to the high-quality video stream in real time and dynamically adjusts its configuration based on the number of subscribers.
  • If nobody subscribers to the high-quality stream, the SDK automatically reduces its bitrate and frame rate to save upstream bandwidth.
  • If someone subscribes to the high-quality stream, the SDK resets the high-quality stream to the VideoEncoderConfiguration configuration used in the most recent calling of setVideoEncoderConfiguration. If no configuration has been set by the user previously, the following values are used:
    • Resolution: 1280 × 720
    • Frame rate: 15 fps
    • Bitrate: 1600 Kbps
• The SDK monitors the number of subscribers to the low-quality video stream in real time and dynamically enables or disables it based on the number of subscribers.
  Note: If the user has called setDualStreamMode to set that never send low-quality video stream (DisableSimulcastStream), the dynamic adjustment of the low-quality stream in meeting scenarios will not take effect.
  • If nobody subscribes to the low-quality stream, the SDK automatically disables it to save upstream bandwidth.
  • If someone subscribes to the low-quality stream, the SDK enables the low-quality stream and resets it to the SimulcastStreamConfig configuration used in the most recent calling of setDualStreamMode. If no configuration has been set by the user previously, the following values are used:
    • Resolution: 480 × 272
    • Frame rate: 15 fps
    • Bitrate: 500 Kbps

ApplicationScenario1v1 (2) is suitable for 1v1 video call scenarios. To meet the requirements for low latency and high-quality video in this scenario, the SDK optimizes its strategies, improving performance in terms of video quality, first frame rendering, latency on mid-to-low-end devices, and smoothness under weak network conditions.

Returns

• 0: Success.
• < 0: Failure.
  • -1: A general error occurs (no specified reason).
  • -4: Video application scenarios are not supported. Possible reasons include that you use the Voice SDK instead of the Video SDK.
  • -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.

This method initializes the video view of a local stream on the local device. It only affects the video seen by the local user and does not impact the publishing of the local video. Call this method to bind the local video stream to a video view (view) and to set the rendering and mirror modes of the video view.

The binding remains valid after leaving the channel. To stop rendering or unbind the local video from the view, set view as null.

Applicable scenarios

After initialization, call this method to set the local video and then join the channel.

In real-time interactive scenarios, if you need to simultaneously view multiple preview frames in the local video preview, and each frame is at a different observation position along the video link, you can repeatedly call this method to set different views and set different observation positions for each view. For example, by setting the video source to the camera and then configuring two views with position setting to PositionPostCapturerOrigin and PositionPostCapturer, you can simultaneously preview the raw, unprocessed video frame and the video frame that has undergone preprocessing (image enhancement effects, virtual background, watermark) in the local video preview.

Call timing

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

Restrictions

None.

Parameters

canvas

The local video view and settings. See VideoCanvas.

Returns

• 0: Success.
• < 0: Failure.

Details

Call this method to set a gender characteristic and a reverberation effect for the singing beautifier effect. This method sets parameters for the local user who sends an audio stream. After setting the audio parameters, all users in the channel can hear the effect.

Parameters

preset

The option for the preset audio effect:

• SINGING_BEAUTIFIER: The singing beautifier effect.

param1

The gender characteristics options for the singing voice:

• 1: A male-sounding voice.
• 2: A female-sounding voice.

param2

The reverberation effect options for the singing voice:

• 1: The reverberation effect sounds like singing in a small room.
• 2: The reverberation effect sounds like singing in a large room.
• 3: The reverberation effect sounds like singing in a hall.

Returns

• 0: Success.
• < 0: Failure.

Call this method to set a preset voice beautifier effect for the local user who sends an audio stream. After setting a voice beautifier effect, all users in the channel can hear the effect. You can set different voice beautifier effects for different scenarios.

Call timing

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

Restrictions

• Do not set the profile parameter in setAudioProfile to AudioProfileSpeechStandard(1) or AudioProfileIot(6), or the method does not take effect.
• This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
• After calling setVoiceBeautifierPreset, Agora does not recommend calling the following methods, otherwise the effect set by setVoiceBeautifierPreset will be overwritten:
  • setAudioEffectPreset
  • setAudioEffectParameters
  • 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 preset voice beautifier effect options: VoiceBeautifierPreset.

Returns

• 0: Success.
• < 0: Failure.

Call this method to set a preset voice changing effect for the local user who publishes an audio stream in a channel. After setting the voice changing effect, all users in the channel can hear the effect. You can set different voice changing effects for the user depending on different scenarios.

Call timing

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

Restrictions

• Do not set the profile parameter in setAudioProfile to AudioProfileSpeechStandard(1) or AudioProfileIot(6), or the method does not take effect.
• This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
• After calling setVoiceConversionPreset, Agora does not recommend you to call the following methods, otherwise the effect set by setVoiceConversionPreset will be overwritten:
  • setAudioEffectPreset
  • setAudioEffectParameters
  • setVoiceBeautifierPreset
  • setVoiceBeautifierParameters
  • setLocalVoicePitch
  • setLocalVoiceFormant
  • setLocalVoiceEqualization
  • setLocalVoiceReverb
• This method relies on the voice beautifier dynamic library libagora_audio_beauty_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.

Parameters

preset

The options for the preset voice beautifier effects: VoiceConversionPreset.

Returns

• 0: Success.
• < 0: Failure.

Call timing

Call this method after playEffect.

Restrictions

None.

Parameters

soundId

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

volume

The playback volume. The value range is [0, 100]. The default value is 100, which represents the original volume.

Returns

• 0: Success.
• < 0: Failure.

For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. If the local music file does not exist, the SDK does not support the file format, or the the SDK cannot access the music file URL, the SDK reports AudioMixingReasonCanNotOpen.

Call timing

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

Restrictions

• If you call this method to play short sound effect files, you may encounter playback failure. Agora recommends using playEffect instead to play such files.
• If you need to call this method multiple times, ensure that the time interval between calling this method is more than 500 ms.

Related callbacks

A successful method call triggers the onAudioMixingStateChanged(AudioMixingStatePlaying) callback. When the audio mixing file playback finishes, the SDK triggers the onAudioMixingStateChanged(AudioMixingStateStopped) callback on the local client.

Parameters

filePath

File path:

• Windows: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example: C:\music\audio.mp4.
• macOS: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example: /var/mobile/Containers/Data/audio.mp4.

loopback

Whether to only play music files on the local client:

• true: Only play music files on the local client so that only the local user can hear the music.
• false: Publish music files to remote clients so that both the local user and remote users can hear the music.

cycle

The number of times the music file plays.

• >0: The number of times for playback. For example, 1 represents playing 1 time.
• -1: Play the audio file in an infinite loop.

startPos

The playback position (ms) of the music file.

Returns

• 0: Success.
• < 0: Failure.
  • -1: A general error occurs (no specified reason).
  • -2: The parameter is invalid.
  • -3: The SDK is not ready.
    • The audio module is disabled.
    • The program is not complete.
    • The initialization of IRtcEngine fails. Reinitialize the IRtcEngine.

Once the user leaves the channel, the recording automatically stops.

Call timing

Call this method after joining a channel.

Restrictions

None.

Parameters

config

Recording configurations. See AudioRecordingConfiguration.

Returns

• 0: Success.
• < 0: Failure.

Details

You can call this method to start capturing video from one or more cameras by specifying sourceType.

Parameters

sourceType

The type of the video source. See VideoSourceType.

Note:

• On the desktop platforms, you can capture video from up to 4 cameras.

config

The configuration of the video capture. See CameraCapturerConfiguration.

Returns

• 0: Success.
• < 0: Failure.

Details

After calling startCameraCapture to start capturing video through one or more cameras, you can call this method and set the sourceType parameter to stop the capture from the specified cameras.

Parameters

sourceType

The type of the video source. See VideoSourceType.

Returns

• 0: Success.
• < 0: Failure.

This method starts the last-mile network probe test before joining a channel to get the uplink and downlink last mile network statistics, including the bandwidth, packet loss, jitter, and round-trip time (RTT).

Call timing

Do not call other methods before receiving the onLastmileQuality and onLastmileProbeResult callbacks. Otherwise, the callbacks may be interrupted.

Restrictions

None.

Related callbacks

Parameters

config

The configurations of the last-mile network probe test. See LastmileProbeConfig.

Returns

• 0: Success.
• < 0: Failure.

After calling this method, you can merge multiple video streams into one video stream locally. For example, you can merge the video streams captured by the camera, screen sharing, media player, remote video, video files, images, etc. into one video stream, and then publish the mixed video stream to the channel.

Applicable scenarios

You can enable the local video mixing function in scenarios such as remote conferences, live streaming, and online education, which allows users to view and manage multiple videos more conveniently, and supports portrait-in-picture effect and other functions.

Call timing

• If you need to mix the locally collected video streams, you need to call this method after startCameraCapture or startScreenCaptureBySourceType.
• If you want to publish the mixed video stream to the channel, you need to set publishTranscodedVideoTrack in ChannelMediaOptions to true when calling joinChannel or updateChannelMediaOptions.

Restrictions

• Local video mixing requires more CPU resources. Therefore, Agora recommends enabling this function on devices with higher performance.
• If you need to mix locally captured video streams, the SDK supports the following capture combinations:
  • On the Windows platform, it supports up to 4 video streams captured by cameras + 4 screen sharing streams.
  • On the macOS platform, it supports up to 4 video streams captured by cameras + 1 screen sharing stream.
• When configuring the local video mixing, it is necessary to ensure that the layer number of the video stream capturing the portrait is greater than the layer number of the screen sharing stream. Otherwise, the portrait will be covered by the screen sharing and will not be displayed in the final mixed video stream.

Related callbacks

When you fail to call this method, the SDK triggers the onLocalVideoTranscoderError callback to report the reason.

Parameters

config

Configuration of the local video mixing, see LocalTranscoderConfiguration.

Attention:

• The maximum resolution of each video stream participating in the local video mixing is 4096 × 2160. If this limit is exceeded, video mixing does not take effect.
• The maximum resolution of the mixed video stream is 4096 × 2160.

Returns

• 0: Success.
• < 0: Failure.

Details

The first successful call to this method starts relaying media streams from the source channel to the destination channels. To relay the media stream to other channels, or exit one of the current media relays, you can call this method again to update the destination channels. This feature supports relaying media streams to a maximum of six destination channels.

Parameters

configuration

The configuration of the media stream relay. See ChannelMediaRelayConfiguration.

Returns

• 0: Success.
• < 0: Failure.
  • -1: A general error occurs (no specified reason).
  • -2: The parameter is invalid.
  • -8: Internal state error. Probably because the user is not a broadcaster.

You can call this method to enable local video preview.

Call timing

This method must be called after enableVideo.

Restrictions

• The local preview enables the mirror mode by default.
• After leaving the channel, local preview remains enabled. You need to call stopPreview to disable local preview.

Returns

• 0: Success.
• < 0: Failure.

This method is used to start local video preview and specify the video source that appears in the preview screen.

Call timing

This method must be called after enableVideo.

Restrictions

• The local preview enables the mirror mode by default.
• After leaving the channel, local preview remains enabled. You need to call stopPreview to disable local preview.

Parameters

sourceType

The type of the video source. See VideoSourceType.

Returns

• 0: Success.
• < 0: Failure.

Details

Agora recommends that you use the server-side Media Push function. For details, see Use RESTful API.

You can call this method to push an audio or video stream to the specified CDN address. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times.

After you call this method, the SDK triggers the onRtmpStreamingStateChanged callback on the local client to report the state of the streaming.

Parameters

url

The address of Media Push. The format is RTMP or RTMPS. The character length cannot exceed 1024 bytes. Special characters such as Chinese characters are not supported.

Returns

• 0: Success.
• < 0: Failure.
  • -2: The URL or configuration of transcoding is invalid; check your URL and transcoding configurations.
  • -7: The SDK is not initialized before calling this method.
  • -19: The Media Push URL is already in use; use another URL instead.

Details

Agora recommends that you use the server-side Media Push function. For details, see Use RESTful API.

You can call this method to push a live audio-and-video stream to the specified CDN address and set the transcoding configuration. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times.

Under one Agora project, the maximum number of concurrent tasks to push media streams is 200 by default. If you need a higher quota, contact technical support.

After you call this method, the SDK triggers the onRtmpStreamingStateChanged callback on the local client to report the state of the streaming.

Parameters

url

The address of Media Push. The format is RTMP or RTMPS. The character length cannot exceed 1024 bytes. Special characters such as Chinese characters are not supported.

transcoding

The transcoding configuration for Media Push. See LiveTranscoding.

Returns

• 0: Success.
• < 0: Failure.
  • -2: The URL or configuration of transcoding is invalid; check your URL and transcoding configurations.
  • -7: The SDK is not initialized before calling this method.
  • -19: The Media Push URL is already in use; use another URL instead.