AgoraRtcEngineKit

Details

Deprecated:

This method is deprecated. Use addVideoWatermark [2/2] instead.

This method adds a PNG watermark image to the local video stream in a live streaming session. Once the watermark image is added, all the users in the channel (CDN audience included) and the video capturing device can see and capture it. If you only want to add a watermark to the CDN live streaming, see descriptions in setLiveTranscoding.

Parameters

watermark

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

Returns

• 0: Success.
• < 0: Failure.

Details

This method adds a PNG watermark image to the local video in the live streaming. Once the watermark image is added, all the audience in the channel (CDN audience included), and the capturing device can see and capture it. The Agora SDK supports adding only one watermark image onto a local video or CDN live stream. The newly added watermark image replaces the previous one.

Parameters

url

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.

Details

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.

Details

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

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.

Details

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

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.

Details

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

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 published, you need to call this method again.

Parameters

trackId

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

volume

The volume of the audio source. The value can range from 0 to 100. 0 means mute; 100 means the original volume.

Returns

• 0: Success.
• < 0: Failure.

Details

Parameters

volume

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

• 0: Mute.
  Note: If you only need to mute the audio signal, Agora recommends that you use muteRecordingSignal instead.
• 100: (Default) The original volume.
• 400: Four times the original volume (amplifying the audio signals by four times).

Returns

• 0: Success.
• < 0: Failure.

Details

Parameters

volume

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

• 0: Mute.
  Note: If you only need to mute the audio signal, Agora recommends that you use muteRecordingSignal instead.
• 100: (Default) The original volume.
• 400: Four times the original volume (amplifying the audio signals by four times).

Returns

• 0: Success.
• < 0: Failure.

Details

You can call this method to adjust the playback volume of a specified remote user. To adjust the playback volume of different remote users, call the method as many times, once for each remote user.

Parameters

uid

The user ID of the remote user.

volume

Audio mixing volume. The value ranges between 0 and 100. The default value is 100, which means the original volume.

Returns

• 0: Success.
• < 0: Failure.

Returns

• 0: Success.
• < 0: Failure.

Details

This method allows users to complain about the quality of the call. Call this method after the user leaves the channel.

Parameters

callId

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

description

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

Returns

• 0: Success.
• < 0: Failure.
  • -2: The parameter is invalid.
  • - 3: The SDK is not ready. Possible reasons include the following:
    • The initialization of AgoraRtcEngineKit fails. Reinitialize the AgoraRtcEngineKit.
    • No user has joined the channel when the method is called. Please check your code logic.
    • The user has not left the channel when the rate or complain method is called. Please check your code logic.
    • The audio module is disabled. The program is not complete.

Details

After calling startRhythmPlayer, you can call this method to reconfigure the virtual metronome.

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

Parameters

config

The metronome configuration. See AgoraRhythmPlayerConfig.

Returns

• 0: Success.
• < 0: Failure.

Details

All called methods provided by the AgoraRtcEngineKit class are executed asynchronously. Agora recommends calling these methods in the same thread.

Parameters

appId

The App ID issued by Agora for your project. Only users in apps with the same App ID can join the same channel and communicate with each other. An App ID can only be used to create one AgoraRtcEngineKit instance. To change your App ID, call destroy to destroy the current AgoraRtcEngineKit instance, and then create a new one.

delegate

The event handler for AgoraRtcEngineKit. See AgoraRtcEngineDelegate.

Returns

• The AgoraRtcEngineKit instance, if the method call succeeds.
• An error code, if the method call fails.
  • -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

Returns

• If the method call is successful, the video track ID is returned as the unique identifier of the video track.
• If the method call fails, a negative value is returned.

Details

Each user can create up to five data streams during the lifecycle of AgoraRtcEngineKit. The data stream will be destroyed when leaving the channel, and the data stream needs to be recreated if needed.

Parameters

streamId

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

reliable

Whether or not the data stream is reliable:

• YES: The recipients receive the data from the sender within five seconds. If the recipient does not receive the data within five seconds, the SDK triggers the didOccurStreamMessageErrorFromUid callback and returns an error code.
• NO: There is no guarantee that the recipients receive the data stream within five seconds and no error message is reported for any delay or missing data stream.

ordered

Whether or not the recipients receive the data stream in the sent order:

• YES: The recipients receive the data in the sent order.
• NO: The recipients do not receive the data in the sent order.

Returns

• 0: The data stream is successfully created.
• < 0: Failure.

Details

Creates a data stream. Each user can create up to five data streams in a single channel.

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

Parameters

streamId

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

config

The configurations for the data stream. See AgoraDataStreamConfig.

Returns

• 0: The data stream is successfully created.
• < 0: Failure.

Parameters

delegate

The event handler for AgoraRtcEngineKit. See AgoraRtcEngineDelegate.

Returns

• The AgoraRtcMediaPlayerProtocol instance, if the method call succeeds.
• An empty pointer, if the method call fails.

An AgoraRtcMediaPlayerProtocol instance, if the method call succeeds.

Details

The SDK uses AgoraRtcEngineDelegate to inform the app on engine runtime events. All methods defined in the delegate are optional implementation methods.

Parameters

position

The video track ID returned by calling the createCustomVideoTrack method.

Returns

• 0: Success.
• < 0: Failure.

Details

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.

Details

This method can be called before joining a channel or during a call to disable the video module. If it is called before joining a channel, an audio call starts when you join the channel; if called during a call, a video call switches to an audio call. Call enableVideo to enable the video module.

A successful call of this method triggers the didVideoEnabled (NO) callback on the remote client.

Returns

• 0: Success.
• < 0: Failure.

Details

The audio mode is enabled by default.

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.

Details

This method enables the SDK to regularly report the volume information to the app of the local user who sends a stream and remote users (three users at most) whose instantaneous volumes are the highest. Once you call this method and users send streams in the channel, the SDK triggers the reportAudioVolumeIndicationOfSpeakers callback at the time interval set in this method.

Parameters

interval

Sets the time interval between two consecutive volume indications:

• ≤ 0: Disables the volume indication.
• > 0: Time interval (ms) between two consecutive volume indications. The lowest value is 50.

smooth

The smoothing factor that sets the sensitivity of the audio volume indicator. The value ranges between 0 and 10. The recommended value is 3. The greater the value, the more sensitive the indicator.

reportVad

• YES: Enables the voice activity detection of the local user. Once it is enabled, the vad parameter of the reportAudioVolumeIndicationOfSpeakers callback reports the voice activity status of the local user.
• NO: (Default) Disables the voice activity detection of the local user. Once it is disabled, the vad parameter of the reportAudioVolumeIndicationOfSpeakers 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.

Details

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

Parameters

enabled

Whether to enable video screenshot and upload:

• YES: Enables video screenshot and upload.
• NO: Disables video screenshot and upload.

config

Configuration of video screenshot and upload. See AgoraContentInspectConfig.

Returns

• 0: Success.
• < 0: Failure.

Details

Deprecated:

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

After you enable dual-stream mode, you can call setRemoteVideoStream 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:

• YES: Enable dual-stream mode.
• NO: (Default) Disable dual-stream mode.

Returns

• 0: Success.
• < 0: Failure.

Details

Deprecated:

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

After you enable dual-stream mode, you can call setRemoteVideoStream 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:

• YES: Enable dual-stream mode.
• NO: (Default) Disable dual-stream mode.

streamConfig

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

Returns

• 0: Success.
• < 0: Failure.

Details

In scenarios requiring high security, Agora recommends calling this method to enable the built-in encryption before joining a channel.

All users in the same channel must use the same encryption mode and encryption key. After the user leaves the channel, the SDK automatically disables the built-in encryption. To enable the built-in encryption, call this method before the user joins the channel again.

Parameters

enabled

Whether to enable built-in encryption:

• YES: Enable the built-in encryption.
• NO: Disable the built-in encryption.

config

Built-in encryption configurations. See AgoraEncryptionConfig.

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 AgoraRtcEngineKit instance before calling this method.

Details

To call this method, call it immediately after initializing the AgoraRtcEngineKit object.

Parameters

provider

The name of the extension provider.

extension

The name of the extension.

enabled

Whether to enable the extension:

• YES: Enable the extension.
• NO: Disable the extension.

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.

Details

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

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

Parameters

enable

Whether to enable face detection for the local user:

• YES: Enable face detection.
• NO: (Default) Disable face detection.

Returns

• 0: Success.
• < 0: Failure.

Details

This method enables or disables in-ear monitoring.

Parameters

enabled

Enables in-ear monitoring.

• YES: Enables in-ear monitoring.
• NO: (Default) Disables in-ear monitoring.

Returns

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

Details

This method enables or disables in-ear monitoring.

Parameters

enabled

Enables or disables in-ear monitoring.

• YES: Enables in-ear monitoring.
• NO: (Default) Disables in-ear monitoring.

includeAudioFilters

The audio filter of in-ear monitoring: See AgoraEarMonitoringFilterType.

Returns

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

Details

Since

v4.1.1

Applicable scenarios

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

Returns

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

Details

The audio function is enabled by default when users joining a channel. This method disables or re-enables the local audio function to stop or restart local audio capturing.

This method does not affect receiving or playing the remote audio streams, and enableLocalAudio(NO) is applicable to scenarios where the user wants to receive remote audio streams without sending any audio stream to other users in the channel.

Parameters

enabled

• YES: (Default) Re-enable the local audio function, that is, to start the local audio capturing device (for example, the microphone).
• NO: 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. You can call enableLocalVideo(NO) to disable the local video capture. If you want to re-enable the local video capture, call enableLocalVideo(YES).

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

Parameters

enabled

Whether to enable the local video capture.

• YES: (Default) Enable the local video capture.
• NO: 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 NO, this method does not require a local camera.

Returns

• 0: Success.
• < 0: Failure.

Parameters

Returns

Details

Since

v4.1.0

When using this function, ensure that the system version is 13.0 or later.

Parameters

enabled

Whether to enable multi-camera video capture mode:

• YES: Enable multi-camera capture mode; the SDK uses multiple cameras to capture video.
• NO: Disable multi-camera capture mode; the SDK uses a single camera to capture video.

config

Capture configuration for the second camera. See AgoraCameraCapturerConfiguration.

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:

• YES: Enable stereo panning.
• NO: Disable stereo panning.

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:

• YES: Enable the spatial audio effect.
• NO: Disable the spatial audio effect.

Returns

• 0: Success.
• < 0: Failure.

Details

Call this method either before joining a channel or during a call. If this method is called before joining a channel, the call starts in the video mode; if called during a call, the audio call switches to a video call. Call disableVideo to disable the video mode.

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

Returns

• 0: Success.
• < 0: Failure.

Details

When publishing video streams, you can call this method to replace the current video feeds with custom images.

Once you enable this function, you can select images to replace the video feeds through the AgoraImageTrackOptions parameter. If you disable this function, the remote users see the video feeds that you publish.

Parameters

enable

Whether to replace the current video feeds with custom images:

• YES: Replace the current video feeds with custom images.
• NO: (Default) Do not replace the current video feeds with custom images.

options

Image configurations. See AgoraImageTrackOptions.

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 before calling enableVideo or startPreview.

Parameters

enable

Whether to enable virtual background:

• YES: Enable virtual background.
• NO: Disable virtual background.

backData

The custom background. See AgoraVirtualBackgroundSource. 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.

segData

Processing properties for background images. See AgoraSegmentationProperty.

Returns

• 0: Success.
• < 0: Failure.
  • -1: The custom background image does not exist. Check the value of source in AgoraVirtualBackgroundSource.
  • -2: The color format of the custom background image is invalid. Check the value of color in AgoraVirtualBackgroundSource.
  • -3: The device does not support virtual background.

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:

• YES: Enable interoperability.
• NO: (Default) Disable interoperability.

Returns

• 0: Success.
• < 0: Failure.

Details

Retrieves the playback position (ms) of the audio.

Returns

• ≥ 0: The current playback position (ms) of the audio mixing, if this method call succeeds. 0 represents that the current music file does not start playing.
• < 0: Failure.

Details

Retrieves the total duration (ms) of the audio.

Returns

• ≥ 0: The audio mixing duration, if this method call succeeds.
• < 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

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.

Details

When a user joins a channel on a client, a callId is generated to identify the call from the client. Some methods, such as rate and complain, must be called after the call ends to submit feedback to the SDK. These methods require the callId parameter.

Returns

The current call ID.

Details

Returns

The maximum zoom factor.

Details

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

Returns

The current connection state. See AgoraConnectionState.

Details

Since

v4.2.0

Monotonic Time refers to a monotonically increasing time series whose value increases over time. The unit is milliseconds.

In custom video capture and custom audio capture scenarios, in order to ensure audio and video synchronization, Agora recommends that you call this method to obtain the current Monotonic Time of the SDK, and then pass this value into the timestamp parameter in the captured video frame (AgoraOutputVideoFrame) and audio frame (AgoraAudioFrame).

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:

• iOS or 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

error

The error code or warning code reported by the SDK.

Returns

The specific error or warning description.

Details

Parameters

provider

The name of the extension provider.

extension

The name of the extension.

key

The key of the extension.

Returns

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

Details

Parameters

provider

The name of the extension provider.

extension

The name of the extension.

key

The key of the extension.

sourceType

Source type of the extension. See AgoraMediaSourceType.

Returns

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

Details

When you successfully call this method, the SDK returns a media player cache manager instance. The cache manager is a singleton pattern. Therefore, multiple calls to this method returns the same instance.

Returns

The AgoraRtcMediaPlayerCacheManagerProtocol instance.

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

Since

v4.0.1

You can use this method to get the type of network in use at any stage.

Returns

• ≥ 0: The method call is successful, and the local network connection type is returned.
  • 0: The SDK disconnects from the network.
  • 1: The network type is LAN.
  • 2: The network type is Wi-Fi (including hotspots).
  • 3: The network type is mobile 2G.
  • 4: The network type is mobile 3G.
  • 5: The network type is mobile 4G.
  • 6: The network type is mobile 5G.
• < 0: The method call failed with an error code.
  • -1: The network type is unknown.

Details

Since

v4.2.0

In the real-time chorus scenario, especially when the downlink connections are inconsistent due to network issues among multiple receiving ends, you can call this method to obtain the current NTP time as the reference time, in order to align the lyrics and music of multiple receiving ends and achieve chorus synchronization.

Returns

The Unix timestamp (ms) of the current NTP time.

Details

After a remote user joins the channel, the SDK gets the user ID and account of the remote user, caches them in a mapping table object, and triggers the didUserInfoUpdatedWithUserId callback on the local client. After receiving the callback, you can call this method to get the user account of the remote user from the AgoraUserInfo object by passing in the user ID.

Parameters

uid

The user ID.

error

Error code.

Returns

• A pointer to the AgoraUserInfo instance, if the method call succeeds.
• If the call fails, returns nil.

Details

After a remote user joins the channel, the SDK gets the user ID and account of the remote user, caches them in a mapping table object, and triggers the didUserInfoUpdatedWithUserId callback on the local client. After receiving the callback, you can call this method to get the user account of the remote user from the AgoraUserInfo object by passing in the user ID.

Parameters

userAccount

The user account.

error

Error code.

Returns

• A pointer to the AgoraUserInfo instance, if the method call succeeds.
• If the call fails, returns nil.

Parameters

Returns

The SDK version number. The format is a string.

Parameters

soundId

The ID of the audio effect file.

Returns

• ≥ 0: Returns the volume of the specified audio effect, if the method call is successful. The value ranges between 0 and 100. 100 represents the original volume.
• < 0: Failure.

Details

All called methods provided by the AgoraRtcEngineKit class are executed asynchronously. Agora recommends calling these methods in the same thread.

Parameters

config

Configurations for the AgoraRtcEngineKit instance. See AgoraRtcEngineConfig.

delegate

The event handler for AgoraRtcEngineKit. See AgoraRtcEngineDelegate.

Returns

• The AgoraRtcEngineKit instance, if the method call succeeds.
• < 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

Returns

• YES: The device supports auto exposure.
• NO: The device does not support auto exposure.

Details

Returns

• YES: The device supports the face auto-focus function.
• NO: The device does not support the face auto-focus function.

Details

Returns

• YES: The device supports manual exposure.
• NO: The device does not support manual exposure.

Details

Returns

• YES: The device supports the manual focus function.
• NO: The device does not support the manual focus function.

Details

Returns

• YES: The device supports camera flash.
• NO: The device does not support camera flash.

Details

Returns

• YES: The device supports camera zoom.
• NO: The device does not support camera zoom.

Returns

• YES: The speakerphone is enabled, and the audio plays from the speakerphone.
• NO: The speakerphone is not enabled, and the audio plays from devices other than the speakerphone. For example, the headset or earpiece.

Details

This method enables users to join a channel. Users in the same channel can talk to each other, and multiple users in the same channel can start a group chat. Users with different App IDs cannot call each other.

When the connection between the client and Agora's server is interrupted due to poor network conditions, the SDK tries reconnecting to the server. When the local client successfully rejoins the channel, the SDK triggers the didRejoinChannel callback on the local client.

Parameters

token

The token generated on your server for authentication. See .

channelId

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

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

info

(Optional) Reserved for future use.

uid

The user ID. This parameter is used to identify the user in the channel for real-time audio and video interaction. You need to set and manage user IDs yourself, and ensure that each user ID in the same channel is unique. This parameter is a 32-bit unsigned integer. The value range is 1 to 2³²-1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and returns it in the didJoinChannel callback. Your application must record and maintain the returned user ID, because the SDK does not do so.

joinSuccessBlock

Occurs when a user joins a channel. If you implement both joinSuccessBlock and didJoinChannel, joinSuccessBlock takes higher priority than didJoinChannel. Agora recommends setting joinSuccessBlock as nil to use didJoinChannel.

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 AgoraRtcChannelMediaOptions is invalid. You need to pass in a valid parameter and join the channel again.
  • -3: Failes to initialize the AgoraRtcEngineKit object. You need to reinitialize the AgoraRtcEngineKit object.
  • -7: The AgoraRtcEngineKit object has not been initialized. You need to initialize the AgoraRtcEngineKit object before calling this method.
  • -8: The internal state of the AgoraRtcEngineKit object is wrong. The typical cause is that you call this method to join the channel without calling startEchoTestWithConfig to stop the test after calling stopEchoTest to start a call loop test. You need to call stopEchoTest before calling this method.
  • -17: The request to join the channel is rejected. The typical cause is that the user is in the channel. Agora recommends that you use the connectionChangedToState callback to determine whether the user exists in the channel. Do not call this method to join the channel unless you receive the AgoraConnectionStateDisconnected(1) state.
  • -102: The channel name is invalid. You need to pass in a valid channelname in channelId to rejoin the channel.
  • -121: The user ID is invalid. You need to pass in a valid user ID in uid to rejoin the channel.

Details

This method enables users to join a channel. Users in the same channel can talk to each other, and multiple users in the same channel can start a group chat. Users with different App IDs cannot call each other.

When the connection between the client and Agora's server is interrupted due to poor network conditions, the SDK tries reconnecting to the server. When the local client successfully rejoins the channel, the SDK triggers the didRejoinChannel callback on the local client.

Compared to joinChannelByToken [1/4], this method adds the options parameter to configure whether to automatically subscribe to all remote audio and video streams in the channel when the user joins the channel. By default, the user subscribes to the audio and video streams of all the other users in the channel, giving rise to usage and billings. To unsubscribe, set the options parameter or call the mute methods accordingly.

Parameters

token

The token generated on your server for authentication. See .

channelId

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

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

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 returns it in the didJoinChannel callback. Your application must record and maintain the returned user ID, because the SDK does not do so.

mediaOptions

The channel media options. See AgoraRtcChannelMediaOptions.

joinSuccessBlock

Occurs when a user joins a channel. If you implement both joinSuccessBlock and didJoinChannel, joinSuccessBlock takes higher priority than didJoinChannel. Agora recommends setting joinSuccessBlock as nil to use didJoinChannel.

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 AgoraRtcChannelMediaOptions is invalid. You need to pass in a valid parameter and join the channel again.
  • -3: Failes to initialize the AgoraRtcEngineKit object. You need to reinitialize the AgoraRtcEngineKit object.
  • -7: The AgoraRtcEngineKit object has not been initialized. You need to initialize the AgoraRtcEngineKit object before calling this method.
  • -8: The internal state of the AgoraRtcEngineKit object is wrong. The typical cause is that you call this method to join the channel without calling startEchoTestWithConfig to stop the test after calling stopEchoTest to start a call loop test. You need to call stopEchoTest before calling this method.
  • -17: The request to join the channel is rejected. The typical cause is that the user is in the channel. Agora recommends that you use the connectionChangedToState callback to determine whether the user exists in the channel. Do not call this method to join the channel unless you receive the AgoraConnectionStateDisconnected(1) state.
  • -102: The channel name is invalid. You need to pass in a valid channelname in channelId to rejoin the channel.
  • -121: The user ID is invalid. You need to pass in a valid user ID in uid to rejoin the channel.

Details

Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.

Parameters

token

The token generated on your server for authentication. See .

channelId

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

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

userAccount

The user account. This parameter is used to identify the user in the channel for real-time audio and video engagement. You need to set and manage user accounts yourself and ensure that each user account in the same channel is unique. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as nil. Supported characters are (89 in total):

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

joinSuccessBlock

Occurs when a user joins a channel. If you implement both joinSuccessBlock and didJoinChannel, joinSuccessBlock takes higher priority than didJoinChannel. Agora recommends setting joinSuccessBlock as nil to use didJoinChannel.

Returns

• 0: Success.
• < 0: Failure.
  • -2: The parameter is invalid.
  • -3: The initialization of the SDK fails. You can try to initialize the SDK again.
  • -5: The request is rejected.
  • -17: The request to join the channel is rejected. Since the SDK only supports users to join one AgoraRtcEngineKit channel at a time; this error code will be returned when the user who has joined the AgoraRtcEngineKit channel calls the join channel method in the AgoraRtcEngineKit class again with a valid channel name.

Details

Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.

Compared to joinChannelByToken [3/4], this method adds the options parameter to configure whether to automatically subscribe to all remote audio and video streams in the channel when the user joins the channel. By default, the user subscribes to the audio and video streams of all the other users in the channel, giving rise to usage and billings. To unsubscribe, set the options parameter or call the mute methods accordingly.

Parameters

token

The token generated on your server for authentication. See .

channelId

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

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

userAccount

The user account. This parameter is used to identify the user in the channel for real-time audio and video engagement. You need to set and manage user accounts yourself and ensure that each user account in the same channel is unique. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as nil. Supported characters are (89 in total):

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

mediaOptions

The channel media options. See AgoraRtcChannelMediaOptions.

joinSuccessBlock

Occurs when a user joins a channel. If you implement both joinSuccessBlock and didJoinChannel, joinSuccessBlock takes higher priority than didJoinChannel. Agora recommends setting joinSuccessBlock as nil to use didJoinChannel.

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 AgoraRtcChannelMediaOptions is invalid. You need to pass in a valid parameter and join the channel again.
  • -3: Failes to initialize the AgoraRtcEngineKit object. You need to reinitialize the AgoraRtcEngineKit object.
  • -7: The AgoraRtcEngineKit object has not been initialized. You need to initialize the AgoraRtcEngineKit object before calling this method.
  • -8: The internal state of the AgoraRtcEngineKit object is wrong. The typical cause is that you call this method to join the channel without calling startEchoTestWithConfig to stop the test after calling stopEchoTest to start a call loop test. You need to call stopEchoTest before calling this method.
  • -17: The request to join the channel is rejected. The typical cause is that the user is in the channel. Agora recommends that you use the connectionChangedToState callback to determine whether the user exists in the channel. Do not call this method to join the channel unless you receive the AgoraConnectionStateDisconnected(1) state.
  • -102: The channel name is invalid. You need to pass in a valid channelname in channelId to rejoin the channel.
  • -121: The user ID is invalid. You need to pass in a valid user ID in uid to rejoin the channel.

Details

This method releases all resources related to the session.

This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel.

After joining the channel, you must call this method or leaveChannel [2/2] to end the call, otherwise, the next call cannot be started.

Parameters

leaveChannelBlock

This callback indicates that a user leaves a channel, and provides the statistics of the call in AgoraChannelStats.

Returns

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

Details

This method will release all resources related to the session, leave the channel, that is, hang up or exit the call. This method can be called whether or not a call is currently in progress.

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

This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After actually leaving the channel, the local user triggers the didLeaveChannelWithStats callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the didOfflineOfUid callback.

Parameters

options

The options for leaving the channel. See AgoraLeaveChannelOptions.

leaveChannelBlock

This callback indicates that a user leaves a channel, and provides the statistics of the call in AgoraChannelStats.

Returns

• 0: Success.
• < 0: Failure.

Details

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

Parameters

mute

Whether to stop subscribing to the audio streams of all remote users:

• YES: Stops subscribing to the audio streams of all remote users.
• NO: (Default) Subscribes to the audio streams of all remote users by default.

Returns

• 0: Success.
• < 0: Failure.

Details

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

Parameters

mute

Whether to stop subscribing to the video streams of all remote users.

• YES: Stop subscribing to the video streams of all remote users.
• NO: (Default) Subscribe to the audio streams of all remote users by default.

Returns

• 0: Success.
• < 0: Failure.

Details

Parameters

mute

Whether to stop publishing the local audio stream:

• YES: Stops publishing the local audio stream.
• NO: (Default) Resumes publishing the local audio stream.

Returns

• 0: Success.
• < 0: Failure.

Details

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

Parameters

mute

Whether to stop publishing the local video stream.

• YES: Stop publishing the local video stream.
• NO: (Default) Publish the local video stream.

Returns

• 0: Success.
• < 0: Failure.

Details

Parameters

uid

The user ID of the specified user.

mute

Whether to subscribe to the specified remote user's audio stream.

• YES: Stop subscribing to the audio stream of the specified user.
• NO: (Default) Subscribe to the audio stream of the specified user.

Returns

• 0: Success.
• < 0: Failure.

Details

Parameters

uid

The user ID of the specified user.

mute

Whether to subscribe to the specified remote user's video stream.

• YES: Stop subscribing to the video streams of the specified user.
• NO: (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.

Returns

• 0: Success.
• < 0: Failure.

Details

Call this method after joining a channel.

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

To play multiple audio effect files at the same time, call this method multiple times with different soundId and filePath. To achieve the optimal user experience, Agora recommends that do not playing more than three audio files at the same time. After the playback of an audio effect file completes, the SDK triggers the rtcEngineDidAudioEffectFinish callback.

Parameters

soundId

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

Attention: If you have preloaded an audio effect into memory by calling preloadEffect, ensure that the value of this parameter is the same as that of soundId in preloadEffect.

filePath

The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example, /var/mobile/Containers/Data/audio.mp4. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. See supported audio formats.

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.

Returns

• 0: Success.
• < 0: Failure.

Details

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

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.

• YES: Publish the audio effect to the remote users. Both the local user and remote users can hear the audio effect.
• NO: Do not publish the audio effect to the remote users. Only the local user can hear the audio effect.

Returns

• 0: Success.
• < 0: Failure.

Details

To play multiple audio effect files at the same time, call this method multiple times with different soundId and filePath. To achieve the optimal user experience, Agora recommends that do not playing more than three audio files at the same time. After the playback of an audio effect file completes, the SDK triggers the rtcEngineDidAudioEffectFinish callback.

Parameters

soundId

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

Attention: If you have preloaded an audio effect into memory by calling preloadEffect, ensure that the value of this parameter is the same as that of soundId in preloadEffect.

filePath

The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example, /var/mobile/Containers/Data/audio.mp4. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. See supported audio formats.

Attention: If you have preloaded an audio effect into memory by calling preloadEffect, ensure that the value of this parameter is the same as that of filePath in preloadEffect.

loopCount

The number of times the audio effect loops.

• ≥ 0: The number of playback times. For example, 1 means looping one time, which means playing the audio effect two times in total.
• -1: Play the audio file in an infinite loop.

pitch

The pitch of the audio effect. The value range is 0.5 to 2.0. The default value is 1.0, which means the original pitch. The lower the value, the lower the pitch.

pan

The spatial position of the audio effect. The value ranges between -1.0 and 1.0:

• -1.0: The audio effect is heard on the left of the user.
• 0.0: The audio effect is heard in front of the user.
• 1.0: The audio effect is heard on the right of the user.

gain

The volume of the audio effect. The value range is 0.0 to 100.0. The default value is 100.0, which means the original volume. The smaller the value, the lower the volume.

publish

Whether to publish the audio effect to the remote users:

• YES: Publish the audio effect to the remote users. Both the local user and remote users can hear the audio effect.
• NO: 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.

Details

To ensure smooth communication, It is recommended that you limit the size of the audio effect file. You can call this method to preload the audio effect before calling joinChannelByToken [2/4].

Parameters

soundId

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

filePath

File path:

• iOS or 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

• 0: Success.
• < 0: Failure.

Details

Before calling this method, you need to call enableExternalAudioSink to notify the app to enable and set the external rendering.

After a successful method call, the app pulls the decoded and mixed audio data for playback.

Parameters

data

The remote audio data to be pulled. The data type is byte[].

lengthInByte

The data length (byte). The value of this parameter is related to the audio duration, and the values of the sampleRate and channels parameters that you set in enableExternalAudioSink. lengthInByte = sampleRate/1000 × 2 × channels × audio duration (ms).

Returns

• YES: Success.
• NO: Failure.

Details

Before calling this method, you need to call enableExternalAudioSink to notify the app to enable and set the external rendering.

After a successful method call, the app pulls the decoded and mixed audio data for playback.

Parameters

lengthInByte

The data length (byte). The value of this parameter is related to the audio duration, and the values of the sampleRate and channels parameters that you set in enableExternalAudioSink. lengthInByte = sampleRate/1000 × 2 × channels × audio duration (ms).

Returns

• YES: Success.
• NO: Failure.

Details

Parameters

data

External audio data.

samples

The number of samples.

timestamp

The timestamp (ms) of the external audio frame. It is required. You can use it to restore the order of the captured audio frame, or synchronize audio and video frames in video-related scenarios (including scenarios where external video sources are used).

sampleRate

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

channels

The number of audio channels of the external audio sink:

• 1: Mono.
• 2: Stereo.

trackId

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

Returns

• 0: Success.
• < 0: Failure.

Parameters

sampleBuffer

The sample buffer.

Returns

• 0: Success.
• < 0: Failure.

Details

If you call setExternalVideoSource and set the enabled parameter as YES and the encodedFrame parameter as NO, you can call this method to push the external raw video frame to the SDK.

Parameters

frame

The external raw video frame to be pushed. See AgoraVideoFrame.

Returns

• YES: Pushes the external raw video frame to the SDK successfully.
• NO: Fails to push external raw video frame to the SDK.

Details

Since

v4.2.0

Returns

• One CodecCapAgoraVideoCodecCapInfoInfo array indicating the video encoding capability of the device, if the method call succeeds.
• If the call timeouts, please modify the call logic and do not invoke the method in the main thread.

Details

Since

v4.2.0

Applicable scenarios

To ensure optimal screen sharing performance, particularly in enabling high frame rates like 60 fps, Agora recommends you to query the device's maximum supported frame rate using this method beforehand. This way, if the device cannot support such a high frame rate, you can adjust the screen sharing stream accordingly to avoid any negative impact on the sharing quality. If the device does not support high frame rate, you can reduce the frame rate of the screen sharing stream appropriately when sharing the screen to ensure that the sharing effect meets your expectation.

Returns

• The highest frame rate supported by the device, if the method is called successfully. See AgoraScreenCaptureFrameRateCapability.
• If the call fails, returns nil.

Details

Parameters

callId

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

rating

The rating of the call. The value is between 1 (the lowest score) and 5 (the highest score). If you set a value out of this range, the SDK returns the -2 (ERR_INVALID_ARGUMENT) error.

description

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

Returns

• 0: Success.
• < 0: Failure.
  • -2 (ERR_INVALID_ARGUMENT).
  • -3 (ERR_NOT_READY).

Details

Parameters

config

Observer settings for the encoded audio. See AgoraAudioEncodedFrameDelegateConfig.

delegate

The encoded audio observer. See AgoraAudioEncodedFrameDelegate.

Returns

• 0: Success.
• < 0: Failure.

Details

Call this method to register an audio frame observer object (register a callback). When you need the SDK to trigger onMixedAudioFrame, onRecordAudioFrame, onPlaybackAudioFrame or onEarMonitoringAudioFrame callback, you need to use this method to register the callbacks.

Parameters

delegate

The observer object instance. See AgoraAudioFrameDelegate. Set the value as nil to release the instance. Agora recommends calling this method after receiving didLeaveChannelWithStats to release the audio observer object.

Returns

• YES: Success.
• NO: Failure.

Details

After successfully registering the audio spectrum observer and calling enableAudioSpectrumMonitor to enable the audio spectrum monitoring, the SDK reports the callback that you implement in the AgoraAudioSpectrumDelegate class according to the time interval you set.

Parameters

delegate

The audio spectrum observer. See AgoraAudioSpectrumDelegate.

Returns

• 0: Success.
• < 0: Failure.

Details

Once registered, the user account can be used to identify the local user when the user joins the channel. After the registration is successful, the user account can identify the identity of the local user, and the user can use it to join the channel.

After the user successfully registers a user account, the SDK triggers the didLocalUserRegisteredWithUserId callback on the local client, reporting the user ID and account of the local user.

The difference between the two ways is that the time elapsed between calling the registerLocalUserAccountWithAppID method and joining the channel is shorter than directly calling joinChannelByToken [4/4].

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 nil. 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 AgoraMediaMetadataDelegate class and specify the metadata type in this method. This method enables you to add synchronized metadata in the video stream for more diversified live interactive streaming, such as sending shopping links, digital coupons, and online quizzes.

A successful call of this method triggers the metadataMaxSize callback.

Parameters

observer

The metadata observer. See AgoraMediaMetadataDelegate.

type

The metadata type. The SDK currently only supports AgoraMetadataTypeVideo. See AgoraMetadataType.

Returns

• 0: Success.
• < 0: Failure.

Details

If you only want to observe encoded video frames (such as h.264 format) without decoding and rendering the video, Agora recommends that you implement one AgoraEncodedVideoFrameDelegate class through this method.

Parameters

delegate

The observer object instance. See AgoraEncodedVideoFrameDelegate. Set the value as nil to release the instance.

Returns

• YES: Success.
• NO: Failure.

Details

If you want to observe raw video frames (such as YUV or RGBA format), Agora recommends that you implement one AgoraVideoFrameDelegate class with this method.

When calling this method to register a video observer, you can register callbacks in the AgoraVideoFrameDelegate class as needed. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.

Parameters

delegate

The observer object instance. See AgoraVideoFrameDelegate. To release the instance, set the value as nil.

Returns

• < 0: Failure.

• YES: Success.
• NO: 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 sharedEngineWithConfig to create a new AgoraRtcEngineKit instance.

Details

• The SDK triggers the tokenPrivilegeWillExpire callback.
• The connectionChangedToState callback reports AgoraConnectionChangedReasonTokenExpired(9).

Parameters

token

The new token.

Returns

• 0: Success.
• < 0: Failure.
  • -2: The parameter is invalid. For example, the token is invalid. You need to fill in a valid parameter.
  • -7: The AgoraRtcEngineKit object has not been initialized. You need to initialize the AgoraRtcEngineKit object before calling this method.

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.

Returns

• 0: Success.
• < 0: Failure.

Details

This method resumes playing and mixing the music file. Call this method when you are in a channel.

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 index of the audio track.

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 and discuss the format of customized messages with us.

Details

A successful method call triggers the receiveStreamMessageFromUid callback on the remote client, from which the remote user gets the stream message. A failed method call triggers the didOccurStreamMessageErrorFromUid callback on the remote client.

Parameters

streamId

The data stream ID. You can get the data stream ID by calling createDataStream [2/2].

data

The message to be sent.

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

Returns

• 0: Success.
• < 0: Failure.

Details

Since

v4.2.0

Applicable scenarios

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

Parameters

enabled

Whether to enable the AI noise reduction function:

• YES: Enable the AI noise reduction.
• NO: (Default) Disable the AI noise reduction.

mode

The AI noise reduction modes. See AUDIO_AINS_MODE.

Returns

• 0: Success.
• < 0: Failure.

Details

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

Parameters

preset

The options for SDK preset audio effects:

• AgoraAudioEffectPresetRoomAcous3DVoice, 3D voice effect:
  • Call setAudioProfile [1/2] and set the profile parameter in to AgoraAudioProfileMusicStandardStereo(3) or AgoraAudioProfileMusicHighQualityStereo(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.
• AgoraAudioEffectPresetPitchCorrection, Pitch correction effect: To achieve better audio effect quality, Agora recommends setting the profile parameter in setAudioProfile [1/2] to AgoraAudioProfileMusicHighQuality(4) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator.

param1

• If you set preset to AgoraAudioEffectPresetRoomAcous3DVoice, 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 AgoraAudioEffectPresetPitchCorrection, 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 AgoraAudioEffectPresetRoomAcous3DVoice , you need to set param2 to 0.
• If you set preset to AgoraAudioEffectPresetPitchCorrection, 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.

Details

Call this method to set an SDK preset audio effect for the local user who sends an audio stream. This audio effect does not change the gender characteristics of the original voice. After setting an audio effect, all users in the channel can hear the effect.

To get better audio effect quality, Agora recommends setting the scenario parameter of setAudioProfile [1/2] as AgoraAudioScenarioGameStreaming(3) before calling this method.

Parameters

preset

The options for SDK preset audio effects. See AgoraAudioEffectPreset.

Returns

• 0: Success.
• < 0: Failure.

Details

In a stereo music file, the left and right channels can store different audio data. According to your needs, you can set the channel mode to original mode, left channel mode, right channel mode, or mixed channel mode. For example, in the KTV scenario, the left channel of the music file stores the musical accompaniment, and the right channel stores the singing voice. If you only need to listen to the accompaniment, call this method to set the channel mode of the music file to left channel mode; if you need to listen to the accompaniment and the singing voice at the same time, call this method to set the channel mode to mixed channel mode.

Parameters

mode

The channel mode. See AgoraAudioMixingDualMonoMode.

Returns

• 0: Success.
• < 0: Failure.

Details

When a local music file is mixed with a local human voice, call this method to set the pitch of the local music file only.

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

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

Parameters

pos

Integer. The playback position (ms).

Returns

• 0: Success.
• < 0: Failure.

Details

Deprecated:

This method is deprecated. If you need to set the audio profile, use setAudioProfile [2/2]; if you need to set the audio scenario, use setAudioScenario.

Parameters

profile

The audio profile, including the sampling rate, bitrate, encoding mode, and the number of channels. See AgoraAudioProfile.

scenario

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

Returns

• 0: Success.
• < 0: Failure.

Details

Parameters

profile

The audio profile, including the sampling rate, bitrate, encoding mode, and the number of channels. See AgoraAudioProfile.

Returns

• 0: Success.
• < 0: Failure.

Details

Parameters

scenario

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

Returns

• 0: Success.
• < 0: Failure.

Details

Enables or disables image enhancement, and sets the options.

Parameters

enable

Whether to enable the image enhancement function:

• YES: Enable the image enhancement function.
• NO: (Default) Disable the image enhancement function.

options

The image enhancement options. See AgoraBeautyOptions.

Returns

• 0: Success.
• < 0: Failure.

Details

Parameters

Whether to enable auto exposure:

• YES: Enable auto exposure.
• NO: Disable auto exposure.

Returns

• < 0: Failure.

Details

The SDK enables face autofocus by default. To set face autofocus, call this method.

Parameters

enable

Whether to enable face autofocus:

• YES: Enable the camera auto-face focus function.
• NO: Disable face autofocus.

Returns

• YES: Success.
• NO: Failure.

Details

Parameters

config

The camera capture configuration. See AgoraCameraCapturerConfiguration.

Returns

• 0: Success.
• < 0: Failure.

Details

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

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

Parameters

positionInView

The horizontal coordinate of the touchpoint in the view.

Returns

• 0: Success.
• < 0: Failure.

Details

This method needs to be called after the camera is started (for example, by calling startPreview or joinChannelByToken [2/4]). After a successful method call, the SDK triggers the cameraFocusDidChangedToRect callback.

Parameters

position

The coordinate of the touchpoint in the view.

Returns

• 0: Success.
• < 0: Failure.

Details

Parameters

isOn

Whether to turn on the camera flash:

• YES: Turn on the flash.
• NO: (Default) Turn off the flash.

Returns

• 0: Success.
• < 0: Failure.

Details

Parameters

zoomFactor

The camera zoom ratio. The value ranges between 1.0 and the maximum zoom supported by the device. You can get the maximum zoom ratio supported by the device by calling the getCameraMaxZoomFactor method.

Returns

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

Details

After initializing the SDK, the default channel profile is the live streaming profile. You can call this method to set the usage scenario of the channel. For example, it prioritizes smoothness and low latency for a video call, and prioritizes video quality for the interactive live video streaming.

Parameters

profile

The channel profile. See AgoraChannelProfile.

Returns

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

Details

You can call this method either before or after joining the channel to set the user role as audience or host.

If you call this method to set the user's role as the host before joining the channel and set the local video property through the setupLocalVideo method, the local video preview is automatically enabled when the user joins the channel.

Parameters

role

The user role. See AgoraClientRole.

Returns

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

Details

In the interactive live streaming profile, the SDK sets the user role as audience by default. You can call this method to set the user role as host.

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

If you call this method to set the user's role as the host before joining the channel and set the local video property through the setupLocalVideo method, the local video preview is automatically enabled when the user joins the channel.

Parameters

role

The user role in the interactive live streaming. See AgoraClientRole.

options

The detailed options of a user, including the user level. See AgoraClientRoleOptions.

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

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 connectionChangedToState (AgoraConnectionStateConnecting, AgoraConnectionChangedReasonSettingProxyServer) callback.

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

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

Parameters

proxyType

The type of the cloud proxy. See AgoraCloudProxyType.

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.

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

enable

Whether to enable color enhancement:

• YES Enable color enhancement.
• NO: (Default) Disable color enhancement.

options

The color enhancement options. See AgoraColorEnhanceOptions.

Returns

• 0: Success.
• < 0: Failure.

Details

Most mobile phones have two audio routes: an earpiece at the top, and a speakerphone at the bottom. The earpiece plays at a lower volume, and the speakerphone at a higher volume. When setting the default audio route, you determine whether audio playback comes through the earpiece or speakerphone when no external audio device is connected.

You can call this method to change the default audio route. After a successful method call, the SDK triggers the didAudioRouteChanged callback.

Parameters

defaultToSpeaker

Whether to set the speakerphone as the default audio route:

• YES: Set the speakerphone as the default audio route.
• NO: Set the earpiece as the default audio route.

Returns

• 0: Success.
• < 0: Failure.

Details

Since

v4.0.1

Parameters

mode

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

Returns

• 0: Success.
• < 0: Failure.

Details

Since

v4.0.1

The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to AgoraAutoSimulcastStream. If you want to modify this behavior, you can call this method and modify the mode to AgoraDisableSimulcastStream (never send low-quality video streams) or AgoraEnableSimulcastStream (always send low-quality video streams).

The difference between this method and setDualStreamMode [1/2] is that this method can also configure the low-quality video stream, and the SDK sends the stream according to the configuration in streamConfig.

Parameters

mode

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

streamConfig

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

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

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.

Details

Parameters

volume

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

Returns

• 0: Success.
• < 0: Failure.

Details

If the default audio route of the SDK (see Set the Audio Route) or the setting in setDefaultAudioRouteToSpeakerphone cannot meet your requirements, you can call setEnableSpeakerphone to switch the current audio route. After a successful method call, the SDK triggers the didAudioRouteChanged callback.

This method only sets the audio route in the current channel and does not influence the default audio route. If the user leaves the current channel and joins another channel, the default audio route is used.

Parameters

enableSpeaker

Sets whether to enable the speakerphone or earpiece:

• YES: Enable device state monitoring. The audio route is the speakerphone.
• NO: Disable device state monitoring. The audio route is the earpiece.

Returns

• 0: Success.
• < 0: Failure.

Details

Deprecated:

Use enableEncryption instead.

The SDK supports built-in encryption schemes, AES-128-GCM is supported by default. Call this method to use other encryption modes. All users in the same channel must use the same encryption mode and secret. Refer to the information related to the AES encryption algorithm on the differences between the encryption modes.

Parameters

encryptionMode

The following encryption modes:

• "aes-128-xts": 128-bit AES encryption, XTS mode.
• "aes-128-ecb": 128-bit AES encryption, ECB mode.
• "aes-256-xts": 256-bit AES encryption, XTS mode.
• "sm4-128-ecb": 128-bit SM4 encryption, ECB mode.
• "aes-128-gcm": 128-bit AES encryption, GCM mode.
• "aes-256-gcm": 256-bit AES encryption, GCM mode.
• "": When this parameter is set as null, the encryption mode is set as "aes-128-gcm" by default.

Returns

• 0: Success.
• < 0: Failure.

Details

Deprecated:

Use enableEncryption instead.

Before joining the channel, you need to call this method to set the secret parameter to enable the built-in encryption. All users in the same channel should use the same secret. The secret is automatically cleared once a user leaves the channel. If you do not specify the secret or secret is set as null, the built-in encryption is disabled.

Parameters

secret

The encryption password.

Returns

• 0: Success.
• < 0: Failure.

Details

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

Parameters

provider

The name of the extension provider.

extension

The name of the extension.

key

The key of the extension.

value

The value of the extension key.

Returns

• 0: Success.
• < 0: Failure.

Details

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

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.

Details

This method applies to scenarios where you want to use external audio data for playback. After you set the external audio sink, you can call pullPlaybackAudioFrameRawData to pull remote audio frames. The app can process the remote audio and play it with the audio effects that you want.

Parameters

enabled

Whether to enable or disable the external audio sink:

• YES: Enables the external audio sink.
• NO: (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: Failure.

Details

Call this method before calling joinChannelByToken [1/4] and startPreview.

Parameters

enabled

• YES: Enable the external audio source.
• NO: (Default) Disable the external audio source.

sampleRate

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

channels

The number of audio channels of the external audio source:

• 1: Mono.
• 2: Stereo.

Returns

• 0: Success.
• < 0: Failure.

Details

Parameters

enabled

Whether to enable the external audio source:

• YES: Enable the external audio source.
• NO: (Default) Disable the external audio source.

sampleRate

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

channels

The number of channels of the external audio source, which can be set as 1 (Mono) or 2 (Stereo).

sourceNumber

The number of external audio sources. The value of this parameter should be larger than 0. The SDK creates a corresponding number of custom audio tracks based on this parameter value and names the audio tracks starting from 0. In AgoraRtcChannelMediaOptions, you can set publishCustomAudioSourceId to the audio track ID you want to publish.

localPlayback

Whether to play the external audio source:

• YES: Play the external audio source.
• NO: (Default) Do not play the external source.

publish

Whether to publish audio to the remote users:

• YES: (Default) Publish audio to the remote users.
• NO: Do not publish audio to the remote users.

Returns

• 0: Success.
• < 0: Failure.

Details

Parameters

enable

Whether to use the external video source:

• YES: Use the external video source. The SDK prepares to accept the external video frame.
• NO: (Default) Do not use the external video source.

useTexture

Whether to use the external video frame in the Texture format.

• YES: Use the external video frame in the Texture format.
• NO: (Default) Do not use the external video frame in the Texture format.

sourceType

Whether the external video frame is encoded. See AgoraExternalVideoSourceType.

Details

Since

v4.1.0

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

Parameters

lowGain

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

highGain

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

Returns

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

Details

Since

v4.0.1

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

Parameters

preset

The preset headphone equalization effect. See AgoraHeadphoneEQPreset.

Returns

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

Details

Parameters

volume

The volume of the in-ear monitor. The value ranges between 0 and 100. The default value is 100.

Returns

• 0: Success.
• < 0: Failure.

Details

Deprecated:

This method is deprecated. Use setLocalRenderMode [2/2] instead.

Call this method to set the local video display mode. This method can be called multiple times during a call to change the display mode.

Parameters

mode

The local video display mode. See AgoraVideoRenderMode.

uid

The user ID.

Returns

• 0: Success.
• < 0: Failure.

Details

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

Parameters

mode

The local video display mode. See AgoraVideoRenderMode.

mirror

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

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 [2/2] instead.

Parameters

mode

The local video mirror mode. See AgoraVideoMirrorMode.

Returns

• 0: Success.
• < 0: Failure.

Details

Parameters

bandFrequency

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

gain

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

Returns

• 0: Success.
• < 0: Failure.

Details

Since

v4.2.0

Formant ratio affects the timbre of voice. The smaller the value, the deeper the sound will be, and the larger, the sharper.

Parameters

formantRatio

The formant ratio. The value range is [-1.0, 1.0]. The default value is 0.0, which means do not change the timbre of the voice.

Note: Agora recommends setting this value within the range of [-0.4, 0.6]. Otherwise, the voice may be seriously distorted.

Returns

• 0: Success.
• < 0: Failure.

Details

Parameters

pitch

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

Returns

• 0: Success.
• < 0: Failure.

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

reverbType

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

value

The value of the reverberation key.

Returns

• 0: Success.
• < 0: Failure.

Details

Deprecated:

Use the mLogConfig parameter in sharedEngineWithConfig method instead.

Specifies an SDK output log file. The log file records all log data for the SDK’s operation. Ensure that the directory for the log file exists and is writable.

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 sharedEngineWithConfig 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 for each SDK log file is 1,024 KB; the default size for each API call log file is 2,048 KB. These log files are encoded in UTF-8.
• The SDK writes the latest logs in agorasdk.log 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 1,024 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 sharedEngineWithConfig 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 AgoraLogFilterOff, AgoraLogFilterCritical, AgoraLogFilterError, AgoraLogFilterWarning, AgoraLogFilterInfo, and AgoraLogFilterDebug. Choose a level to see the logs preceding that level.

If, for example, you set the log level to AgoraLogFilterWarning, you see the logs within levels AgoraLogFilterCritical, AgoraLogFilterError and AgoraLogFilterWarning.

Parameters

filter

The output log level of the SDK. See AgoraLogFilter.

Returns

• 0: Success.
• < 0: Failure.

Details

Deprecated:

This method is deprecated. Use AgoraRtcEngineConfig instead to set the log output level.

Choose a level to see the logs preceding that level.

Parameters

level

The log level: AgoraLogLevel.

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

enable

Whether to enable low-light enhancement function:

• YES: Enable low-light enhancement function.
• NO: (Default) Disable low-light enhancement function.

options

The low-light enhancement options. See AgoraLowlightEnhanceOptions.

Returns

• 0: Success.
• < 0: Failure.

- (BOOL)setMediaMetadataDataSource:(id<AgoraMediaMetadataDataSource> _Nullable)metadataDataSource withType:(AgoraMetadataType)type;

Details

You need to implement the AgoraMediaMetadataDataSource protocol in this method and specify the data format of the metadata. After a successful method call, the SDK triggers the metadataMaxSize callback.

This method can be used with setMediaMetadataDelegate to add synchronized metadata in the video stream for more diversified live interactions, such as sending shopping links, digital coupons, and online quizzes.

Parameters

metadataDataSource

The AgoraMediaMetadataDataSource protocol.

type

The metadata type. The SDK currently only supports AgoraMetadataTypeVideo. See AgoraMetadataType.

Returns

• YES: Success.
• NO: Failure.

Parameters

sampleRate

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

channel

The number of channels of the audio data, which can be set as 1(Mono) or 2(Stereo).

samplesPerCall

Sets the number of samples. In Media Push scenarios, set it as 1024.

Returns

• 0: Success.
• < 0: Failure.

Parameters

options

Pointer to the set parameters in a JSON string.

Returns

• 0: Success.
• < 0: Failure.

Parameters

sampleRate

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

channel

The number of channels of the external audio source, which can be set as 1(Mono) or 2(Stereo).

Returns

• 0: Success.
• < 0: Failure.

Details

Sets the data format for the onPlaybackAudioFrame callback.

Parameters

sampleRate

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

channel

The number of channels returned in the onPlaybackAudioFrame callback:

• 1: Mono.
• 2: Stereo.

mode

The use mode of the audio frame. See AgoraAudioRawFrameOperationMode.

samplesPerCall

The number of data samples returned in the onPlaybackAudioFrame callback, such as 1024 for the Media Push.

Returns

• 0: Success.
• < 0: Failure.

Details

Sets the audio format for the onRecordAudioFrame callback.

Parameters

sampleRate

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

channel

The number of channels returned in the onRecordAudioFrame callback:

• 1: Mono.
• 2: Stereo.

mode

The use mode of the audio frame. See AgoraAudioRawFrameOperationMode.

samplesPerCall

The number of data samples returned in the onRecordAudioFrame callback, such as 1024 for the Media Push.

Returns

• 0: Success.
• < 0: Failure.

Details

Under limited network conditions, if the publisher has not disabled the dual-stream mode using enableDualStreamMode [2/2] (NO), the receiver can choose to receive either the high-quality video stream or the low-quality video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate.

By default, users receive the high-quality video stream. Call this method if you want to switch to the low-quality video stream. This method allows the app to adjust the corresponding video stream type based on the size of the video window to reduce the bandwidth and resources. The aspect ratio of the low-quality video stream is the same as the high-quality video stream. Once the resolution of the high-quality video stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-quality video stream.

The SDK enables the low-quality video stream auto mode on the sender by default (not actively sending low-quality video streams). The host at the receiving end can call this method to initiate a low-quality video stream stream request on the receiving end, and the sender automatically switches to the low-quality video stream mode after receiving the request.

Parameters

streamType

The default video-stream type. See AgoraVideoStreamType.

Returns

• 0: Success.
• < 0: Failure.

Details

Deprecated:

This method is deprecated. Use setRemoteRenderMode [2/2] instead.

Call this method to set the video display mode of a specified remote user. This method can be called multiple times during a call to change the display mode.

Parameters

userId

The user ID of the remote user.

renderMode

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

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.

mode

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

mirror

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

Returns

• 0: Success.
• < 0: Failure.

Details

Under limited network conditions, if the publisher has not disabled the dual-stream mode using enableDualStreamMode [2/2](NO), the receiver can choose to receive either the high-quality video stream or the low-quality video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate.

By default, users receive the high-quality video stream. Call this method if you want to switch to the low-quality video stream. This method allows the app to adjust the corresponding video stream type based on the size of the video window to reduce the bandwidth and resources. The aspect ratio of the low-quality video stream is the same as the high-quality video stream. Once the resolution of the high-quality video stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-quality video stream.

The SDK enables the low-quality video stream auto mode on the sender by default (not actively sending low-quality video streams). The host at the receiving end can call this method to initiate a low-quality video stream stream request on the receiving end, and the sender automatically switches to the low-quality video stream mode after receiving the request.

Parameters

uid

The user ID.

streamType

The video stream type: AgoraVideoStreamType.

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

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

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

scenarioType

The screen sharing scenario. See AgoraScreenScenarioType.

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

allowlist

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.

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

blocklist

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.

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

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.

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

blocklist

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.

Returns

• 0: Success.
• < 0: Failure.

Details

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

After initialization, call this method to set the local video and then join the channel. The local video still binds to the view after you leave the channel. To unbind the local video from the view, set the view parameter as nil.

Parameters

local

The local video view and settings. See AgoraRtcVideoCanvas.

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

remote

The remote video view and settings. See AgoraRtcVideoCanvas.

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

enable

Whether to enable video noise reduction:

• YES: Enable video noise reduction.
• NO: (Default) Disable video noise reduction.

options

The video noise reduction options. See AgoraVideoDenoiserOptions.

Returns

• 0: Success.
• < 0: Failure.

Details

Sets the encoder configuration for the local video.

Parameters

config

Video profile. See AgoraVideoEncoderConfiguration.

Returns

• 0: Success.
• < 0: Failure.

Details

Sets the encoder configuration for the local video.

Parameters

config

Video profile. See AgoraVideoEncoderConfiguration.

Returns

• 0: Success.
• < 0: Failure.

Details

Deprecated:

This method is deprecated. Use setVideoEncoderConfiguration instead.

This method sets the video encoder configuration. 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.

Parameters

profile

Video profile. See AgoraVideoProfile.

swapWidthAndHeight

The SDK outputs video with a fixed width and height according to the video profile (profile) you selected. This parameter sets whether to swap width and height of the video:

• YES: Swap the width and height.
• NO: (Default) Do not swap the width and height.

Returns

• 0: Success.
• < 0: Failure.

Details

Deprecated:

This method is deprecated. Use setVideoEncoderConfiguration instead.

This method sets the video encoder configuration. 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.

Parameters

width

The width of the video. The maximum value of width × height is 1280 × 720.

height

The height of the video. The maximum value of width × height is 1280 × 720.

frameRate

The frame rate of the video. The highest value is 30. You can set the parameter as 5, 10, 15, 24, and 30.

bitrate

The bitrate of the video. You need to manually work out the bitrate according to the width, height, and frame rate. With the same width and height, the bitrate varies with the frame rate:

• If the frame rate is 5 fps, divide the recommended bitrate by 2.
• If the frame rate is 15 fps, use the recommended bitrate.
• If the frame rate is 30 fps, multiply the recommended bitrate by 1.5.
• Calculate the bitrate according to the ratio if you choose other frame rates.
• If you set a bitrate beyond the proper range, the SDK automatically adjusts the bitrate to a value within the proper range.

Details

Deprecated:

This method is deprecated. Agora recommends using the degradationPreference parameter in the AgoraVideoEncoderConfiguration class to set the video quality preference.

Parameters

preferFrameRateOverImageQuality

Whether to prioritize smoothness or image quality.

• YES: Prioritizes smoothness.
• NO: (Default) Prioritizes the image quality.

Returns

• 0: Success.
• < 0: Failure.