Agora Java API Reference for Android

Creates an RtcEngine instance.

Unless otherwise specified, all the methods provided by the RtcEngine class are executed asynchronously. Agora recommends calling these methods in the same thread.

Note

• You must create an RtcEngine instance before calling any other method.
• You can create an RtcEngine instance either by calling this method or by calling create2. The difference between create2 and this method is that create2 enables you to specify the connection area.
• The Agora RTC Native SDK supports creating only one RtcEngine instance for an app for now.

Parameters

context	The context of Android Activity.
appId	The App ID issued to you by Agora. See How to get the App ID. Only users in apps with the same App ID can join the same channel and communicate with each other. Use an App ID to create only one RtcEngine instance. To change your App ID, call destroy to destroy the current RtcEngine instance, and after destroy returns 0, call create to create an RtcEngine instance with the new App ID.
handler	IRtcEngineEventHandler is an abstract class providing default implementation. The SDK uses this class to report to the app on SDK runtime events.

Returns

• The RtcEngine instance, if the method call succeeds.
• < 0, if the method call fails.
  • ERR_INVALID_APP_ID(101): The app ID is invalid. Check if it is in the correct format.

Exceptions

Exception

Fails to create an RtcEngine instance.

Creates an RtcEngine instance.

Since

3.0.0.2

Unless otherwise specified, all the methods provided by the RtcEngine class are executed asynchronously. Agora recommends calling these methods in the same thread.

Note

• You must create an RtcEngine instance before calling any other method.
• You can create an RtcEngine instance either by calling this method or by calling create1. The difference between create1 and this method is that this method enables you to specify the connection area.
• The Agora RTC Native SDK supports creating only one RtcEngine instance for an app for now.

Parameters

config

Configurations for the RtcEngine instance. For details, see RtcEngineConfig.

Returns

• The RtcEngine instance, if the method call succeeds.
• < 0, if the method call fails.
  • ERR_INVALID_APP_ID(101): The app ID is invalid. Check if it is in the correct format.

Exceptions

Exception

Fails to create an RtcEngine instance.

Destroys the RtcEngine instance and releases all resources used by the Agora SDK.

This method is useful for apps that occasionally make voice or video calls, to free up resources for other operations when not making calls.

Note

• Call this method in the subthread.
• Once the app calls destroy to destroy the created RtcEngine instance, you cannot use any method or callback in the SDK.
• If you want to create a new RtcEngine instance after destroying the current one, ensure that you wait till the destroy method is executed and returns 0.

Sets the channel profile of the Agora RtcEngine.

The Agora RtcEngine differentiates channel profiles and applies different optimization algorithms accordingly. For example, it prioritizes smoothness and low latency for a video call, and prioritizes video quality for a video broadcast.

Parameters

profile

The channel profile of the Agora RtcEngine: CHANNEL_PROFILE_COMMUNICATION(0): (Default) The Communication profile. Use this profile in one-on-one calls or group calls, where all users can talk freely. CHANNEL_PROFILE_LIVE_BROADCASTING(1): The Live-Broadcast profile. Users in a live-broadcast channel have a role as either broadcaster or audience. A broadcaster can both send and receive streams; an audience can only receive streams. CHANNEL_PROFILE_GAME(2): The Gaming profile. This profile uses a codec with a lower bitrate and consumes less power. Applies to the gaming scenario, where all game players can talk freely. Agora does not recommend using this profile.

Returns

• 0: Success.
• < 0: Failure.

Note

• To ensure the quality of real-time communication, we recommend that all users in a chanel use the same channel profile.
• Call this method before calling joinChannel. You cannot set the channel profile once you have joined the channel.

Sets the role of a user (Live Broadcast only).

This method sets the role of a user, such as a host or an audience (default), before joining a channel.

This method can be used to switch the user role after a user joins a channel. In the Live Broadcast profile, when a user switches user roles after joining a channel, a successful setClientRole method call triggers the following callbacks:

• The local client: onClientRoleChanged.
• The remote client: onUserJoined or onUserOffline(USER_OFFLINE_BECOME_AUDIENCE).

Parameters

role	Sets the role of a user: CLIENT_ROLE_BROADCASTER(1): Broadcaster. A broadcaster can both send and receive streams. CLIENT_ROLE_AUDIENCE(2): Audience, the default role. An audience can only receive streams.

Returns

• 0: Success.
• < 0: Failure.

Allows a user 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.

You must call the leaveChannel method to exit the current call before joining another channel.

A successful joinChannel method call triggers the following callbacks:

• The local client: onJoinChannelSuccess.
• The remote client: onUserJoined, if the user joining the channel is in the Communication profile, or is a BROADCASTER in the Live Broadcast profile.

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

Parameters

token	The token for authentication: In situations not requiring high security: You can use the temporary token generated at Console. For details, see Get a temporary token. In situations requiring high security: Set it as the token generated at your server. For details, see Get a token.
channelName	The unique channel name for the AgoraRTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are: All lowercase English letters: a to z. All uppercase English letters: A to Z. All numeric characters: 0 to 9. The space character. Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".
optionalInfo	Additional information about the channel. This parameter can be set as null or contain channel related information. Other users in the channel do not receive this message.
optionalUid	(Optional) User ID. A 32-bit unsigned integer with a value ranging from 1 to (2^32-1). optionalUid must be unique. If optionalUid is not assigned (or set to 0), the SDK assigns and returns uid in the onJoinChannelSuccess callback. Your app must record and maintain the returned uid since the SDK does not do so.

The uid is represented as a 32-bit unsigned integer in the SDK. Since unsigned integers are not supported by Java, the uid is handled as a 32-bit signed integer and larger numbers are interpreted as negative numbers in Java. If necessary, the uid can be converted to a 64-bit integer through “uid&0xffffffffL”.

Note

A channel does not accept duplicate uids, such as two users with the same uid. If you set uid as 0, the system automatically assigns a uid.

Warning

Ensure that the App ID used for creating the token is the same App ID used in the create method for creating an RtcEngine object. Otherwise, CDN live streaming may fail.

Returns

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

Switches to a different channel.

Since

v2.9.0.

This method allows the audience of a Live-broadcast channel to switch to a different channel.

After the user successfully switches to another channel, the onLeaveChannel and onJoinChannelSuccess callbacks are triggered to indicate that the user has left the original channel and joined a new one.

Note

This method applies to the audience role in a Live-broadcast channel only.

Parameters

token

The token for authentication: In situations not requiring high security: You can use the temporary token generated at Console. For details, see Get a temporary token. In situations requiring high security: Set it as the token generated at your server. For details, see Get a token.

channelName

Unique channel name for the AgoraRTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are: All lowercase English letters: a to z. All uppercase English letters: A to Z. All numeric characters: 0 to 9. The space character. Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".

Returns

• 0: Success.
• < 0: Failure.

Allows a user to leave a channel.

After joining a channel, the user must call the leaveChannel method to end the call before joining another channel. This method returns 0 if the user leaves the channel and releases all resources related to the call. This method call is asynchronous, and the user has not exited the channel when the method call returns. Once the user leaves the channel, the SDK triggers the onLeaveChannel callback.

A successful leaveChannel method call triggers the following callbacks:

• The local client: onLeaveChannel.
• The remote client: onUserOffline, if the user leaving the channel is in the Communication channel, or is a BROADCASTER in the Live Broadcast profile.

  Note

  • If you call the destroy method immediately after calling the leaveChannel method, the leaveChannel process interrupts, and the SDK does not trigger the onLeaveChannel callback.
  • If you call the leaveChannel method during CDN live streaming, the SDK triggers the removeInjectStreamUrl method.

  Returns

  • 0: Success.
  • < 0: Failure.

Renews the token when the current token expires.

The token expires after a period of time once the token schema is enabled when:

• The SDK triggers the onTokenPrivilegeWillExpire callback, or
• The onConnectionStateChanged callback reports the CONNECTION_CHANGED_TOKEN_EXPIRED(9) error,

The app should retrieve a new token from the server and call this method to renew it. Failure to do so results in the SDK disconnecting from the server.

Parameters

token

The new token.

Returns

• 0: Success.
• < 0: Failure.

Registers a user account.

Since

v2.8.0.

Once registered, the user account can be used to identify the local user when the user joins the channel. After the user successfully registers a user account, the SDK triggers the onLocalUserRegistered callback on the local client, reporting the user ID and user account of the local user.

To join a channel with a user account, you can choose either of the following:

• Call the registerLocalUserAccount method to create a user account, and then the joinChannelWithUserAccount method to join the channel.
• Call the joinChannelWithUserAccount method to join the channel.

The difference between the two is that for the former, the time elapsed between calling the joinChannelWithUserAccount method and joining the channel is shorter than the latter.

Note

• Ensure that you set the userAccount parameter. Otherwise, this method does not take effect.
• Ensure that the value of the userAccount parameter is unique in the channel.
• To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the uid of the user is set to the same parameter type.

Parameters

appId

The App ID of your project.

userAccount

The user account. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as null. Supported character scopes are: All lowercase English letters: a to z. All uppercase English letters: A to Z. All numeric characters: 0 to 9. The space character. Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".

Returns

• 0: Success.
• < 0: Failure.

Joins the channel with a user account.

Since

v2.8.0.

After the user successfully joins the channel, the SDK triggers the following callbacks:

• The local client: onLocalUserRegistered and onJoinChannelSuccess.
• The remote client: onUserJoined and onUserInfoUpdated, if the user joining the channel is in the Communication profile, or is a BROADCASTER in the Live Broadcast profile.

Note

To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the uid of the user is set to the same parameter type.

Parameters

token	The token generated at your server: In situations not requiring high security: You can use the temporary token generated at Console. For details, see Get a temporary token. In situations requiring high security: Set it as the token generated at your server. For details, see Get a token.
channelName	The channel name. The maximum length of this parameter is 64 bytes. Supported character scopes are: All lowercase English letters: a to z. All uppercase English letters: A to Z. All numeric characters: 0 to 9. The space character. Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".
userAccount	The user account. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as null. All lowercase English letters: a to z. All uppercase English letters: A to Z. All numeric characters: 0 to 9. The space character. Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".

Returns

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

Gets the user information by passing in the user account.

Since

v2.8.0.

After a remote user joins the channel, the SDK gets the user ID and user account of the remote user, caches them in a mapping table object (UserInfo), and triggers the onUserInfoUpdated callback on the local client.

After receiving the onUserInfoUpdated callback, you can call this method to get the user ID of the remote user from the userInfo object by passing in the user account.

Parameters

userAccount	The user account of the user. Ensure that you set this parameter.
userInfo	[in/out] A userInfo object that identifies the user. For details, see UserInfo. Input: A UserInfo object. Output: A UserInfo object that contains the user account and user ID of the user.

Returns

• 0: Success.
• < 0: Failure.

Gets the user information by passing in the user ID.

Since

v2.8.0.

After a remote user joins the channel, the SDK gets the user ID and user account of the remote user, caches them in a mapping table object (UserInfo), and triggers the onUserInfoUpdated callback on the local client.

After receiving the onUserInfoUpdated callback, you can call this method to get the user ID of the remote user from the userInfo object by passing in the user account.

Parameters

uid	The user ID of the user. Ensure that you set this parameter.
userInfo	[in/out] A userInfo object that identifies the user. For details, see UserInfo. Input: A UserInfo object. Output: A UserInfo object that contains the user account and user ID of the user.

Returns

• 0: Success.
• < 0: Failure.

Enables interoperability with the Agora Web SDK (Live Broadcast only).

Deprecated:

v3.0.0. As of v3.0.0, the Native SDK automatically enables interoperability with the Web SDK, so you no longer need to call this method.

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

Use this method when the channel profile is Live Broadcast. Interoperability with the Agora Web SDK is enabled by default when the channel profile is Communication.

Parameters

enabled

Sets whether to enable/disable interoperability with the Agora Web SDK: true: Enable. false: (Default) Disable.

Returns

• 0: Success.
• < 0: Failure.

Gets the connection state of the SDK.

Since

v2.3.2.

Returns

The connection state:

• CONNECTION_STATE_DISCONNECTED(1): The SDK is disconnected from Agora edge server.
• CONNECTION_STATE_CONNECTING(2): The SDK is connecting to Agora edge server.
• CONNECTION_STATE_CONNECTED(3): The SDK joined a channel and is connected to Agora edge server. You can now publish or subscribe to a media stream in the channel.
• CONNECTION_STATE_RECONNECTING(4): The SDK keeps rejoining the channel after being disconnected from a joined channel because of network issues.
• CONNECTION_STATE_FAILED(5): The SDK fails to join the channel.

Enables the audio module.

The audio module is enabled by default.

Note

• This method affects the internal engine and can be called after calling the leaveChannel method. You can call this method either before or after joining a channel.
• This method resets the internal engine and takes some time to take effect. We recommend using the following API methods to control the audio engine modules separately:
  • enableLocalAudio: Whether to enable the microphone to create the local audio stream.
  • muteLocalAudioStream: Whether to publish the local audio stream.
  • muteRemoteAudioStream: Whether to subscribe to and play the remote audio stream.
  • muteAllRemoteAudioStreams: Whether to subscribe to and play all remote audio streams.

Returns

• 0: Success.
• < 0: Failure.

Disables the audio module.

Note

• This method affects the internal engine and can be called after calling the leaveChannel method. You can call this method either before or after joining a channel.
• This method resets the engine and takes some time to take effect. We recommend using the following API methods to control the audio engine modules separately:
  • enableLocalAudio: Whether to enable the microphone to create the local audio stream.
  • muteLocalAudioStream: Whether to publish the local audio stream.
  • muteRemoteAudioStream: Whether to subscribe to and play the remote audio stream.
  • muteAllRemoteAudioStreams: Whether to subscribe to and play all remote audio streams.

Returns

• 0: Success.
• < 0: Failure.

Disables the audio function in the channel.

Deprecated:

This method is deprecated. We recommend using the enableAudio method instead.

Returns

• 0: Success.
• < 0: Failure.

Resumes the audio playback in the channel.

Deprecated:

This method is deprecated. We recommend using the disableAudio method instead.

Returns

• 0: Success.
• < 0: Failure.

Sets the audio parameters and application scenarios.

Parameters

profile	Sets the sample rate, bitrate, encoding mode, and the number of channels. See Audio Profile.
scenario	Sets the audio application scenarios. See Audio Scenario. Under different audio scenarios, the device uses different volume tracks, i.e. either the in-call volume or the media volume. For details, see What is the difference between the in-call volume and the media volume?.

Note

• You must call this method before calling the joinChannel method.
• In the Communication and Live Broadcast profiles, the bitrate may be different from your settings due to network self-adaptation.
• In scenarios requiring high-quality audio, we recommend setting profile as AUDIO_SCENARIO_SHOWROOM(4) and scenario as AUDIO_SCENARIO_GAME_STREAMING(3). For example, for music education scenarios.

Sets the high-quality audio preferences.

Deprecated:

This method is deprecated. Agora does not recommend using this method. If you want to set the audio profile, use the setAudioProfile method. Call this method and set all parameters before joining a channel. Do not call this method again after joining a channel.

Parameters

fullband	Sets whether to enable/disable full-band codec (48-kHz sample rate), not compatible with versions earlier than v1.7.4: true: Enable full-band codec. false: Disable full-band codec.
stereo	Sets whether to enable/disable stereo codec, not compatible with versions earlier than v1.7.4: true: Enable stereo codec. false: Disable stereo codec.
fullBitrate	Sets whether to enable/disable high-bitrate mode. Recommended in voice-only mode: true: Enable high-bitrate mode. false: Disable high-bitrate mode.

Returns

• 0: Success.
• < 0: Failure.

Adjusts the recording volume.

Parameters

volume

Recording volume. The value ranges between 0 and 400: 0: Mute. 100: Original volume. 400: (Maximum) Four times the original volume with signal-clipping protection. To avoid echoes and improve call quality, Agora recommends setting the value of volume between 0 and 100. If you need to set the value higher than 100, contact suppo.nosp@m.rt@a.nosp@m.gora..nosp@m.io first.

Returns

• 0: Success.
• < 0: Failure.

Adjusts the playback volume of all remote users.

Note

• This method adjusts the playback volume which is mixed volume of all remote users.
• Since v2.3.2, to mute the local audio playback, call both adjustPlaybackSignalVolume and adjustAudioMixingVolume, and set volume as 0.

Parameters

volume

The playback volume of all remote users. The value ranges from 0 to 400: 0: Mute. 100: The original volume. 400: (Maximum) Four times the original volume with signal clipping protection. To avoid echoes and improve call quality, Agora recommends setting the value of volume between 0 and 100. If you need to set the value higher than 100, contact suppo.nosp@m.rt@a.nosp@m.gora..nosp@m.io first.

Returns

• 0: Success.
• < 0: Failure.

Enables the onAudioVolumeIndication callback at a set time interval to report on which users are speaking and the speakers' volume.

Once this method is enabled, the SDK returns the volume indication in the onAudioVolumeIndication callback at the set time interval, regardless of whether any user is speaking in the channel.

Parameters

interval	Sets the time interval between two consecutive volume indications: ≤ 0: Disables the volume indication. > 0: Time interval (ms) between two consecutive volume indications. We recommend setting interval ≥ 200 ms.
smooth	The smoothing factor sets the sensitivity of the audio volume indicator. The value ranges between 0 and 10. The greater the value, the more sensitive the indicator. The recommended value is 3.
report_vad	true: Enable the voice activity detection of the local user. Once it is enabled, the vad parameter of the onAudioVolumeIndication callback reports the voice activity status of the local user. false: (Default) Disable the voice activity detection of the local user. Once it is enabled, the vad parameter of the onAudioVolumeIndication callback does not report the voice activity status of the local user, except for scenarios where the engine automatically detects the voice activity of the local user.

Returns

• 0: Success.
• < 0: Failure.

Enables the audio quality callbacks.

Deprecated:

From v2.4.1.

The SDK triggers the onAudioQuality callback after this method is enabled.

Parameters

enabled

Sets whether to enable/disable the audio quality callback: true: Enable the audio quality notification callback. false: (Default) Disable the audio quality notification callback.

Returns

• 0: Success.
• < 0: Failure.

Enables/Disables the local audio capture.

The audio function is enabled by default. This method disables/re-enables the local audio function, that is, to stop or restart local audio capture and processing.

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

The SDK triggers the onMicrophoneEnabled callback once the local audio function is disabled or re-enabled.

Parameters

enabled

Sets whether to disable/re-enable the local audio function: true: (Default) Re-enable the local audio function, that is, to start local audio capture and processing. false: Disable the local audio function, that is, to stop local audio capture and processing.

Note

• After you disable local audio recording using the enableLocalAudio(false) method, the system volume switches to the media volume. Re-enabling local audio recording using the enableLocalAudio(true) method switches the system volume back to the in-call volume.
• This method is different from the muteLocalAudioStream method:
  • enableLocalAudio: Disables/Re-enables the local audio capture and processing. If you disable or re-enable local audio recording using the enableLocalAudio method, the local user may hear a pause in the remote audio playback.
  • muteLocalAudioStream: Stops/Continues sending the local audio streams.

Returns

• 0: Success.
• < 0: Failure.

Stops/Resumes sending the local audio stream.

A successful muteLocalAudioStream method call triggers the onUserMuteAudio callback on the remote client.

Parameters

muted

Sets whether to send/stop sending the local audio stream: true: Stop sending the local audio stream. false: (Default) Send the local audio stream.

Note

• When muted is set as true, this method does not disable the microphone and thus does not affect any ongoing recording.
• If you call setChannelProfile after this method, the SDK resets whether or not to mute the local audio according to the channel profile and user role. Therefore, we recommend calling this method after the setChannelProfile method.

Returns

• 0: Success.
• < 0: Failure.

Stops/Resumes receiving a specified audio stream.

Parameters

uid	ID of the specified remote user.
muted	Sets whether to receive/stop receiving the specified remote user's audio stream: true: Stop receiving the specified remote user’s audio stream. false: (Default) Receive the specified remote user’s audio stream.

Note

If you called the muteAllRemoteAudioStreams method and set muted as true to stop receiving all remote video streams, ensure that the muteAllRemoteAudioStreams method is called and set muted as false before calling this method. The muteAllRemoteAudioStreams method sets all remote audio streams, while the muteRemoteAudioStream method sets a specified remote user's audio stream.

Returns

• 0: Success.
• < 0: Failure.

Adjusts the playback volume of a specified remote user.

Since

v3.0.0.

You can all this method as many times as necessary to adjust the playback volume of different remote users, or to repeatedly adjust the playback volume of the same remote user.

Note

• Call this method after joining a channel.
• The playback volume here refers to the mixed volume of a specified remote user.
• This method can only adjust the playback volume of one specified remote user at a time. To adjust the playback volume of different remote users, call the method as many times, once for each remote user.

Parameters

uid	ID of the remote user.
volume	The playback volume of the specified remote user. The value ranges from 0 to 100: 0: Mute. 100: The original volume.

Returns

• 0: Success.
• < 0: Failure.

Stops/Resumes receiving all remote audio streams.

Parameters

muted

Sets whether to receive/stop receiving all remote audio streams: true: Stop receiving all remote audio streams. false: (Default) Receive all remote audio streams.

Returns

• 0: Success.
• < 0: Failure.

Sets whether to receive all remote video streams by default.

You can call this method either before or after joining a channel. If you call setDefaultMuteAllRemoteVideoStreams(true) after joining a channel, you will not receive the video stream of any subsequent user.

Note

If you want to resume receiving video streams, call muteRemoteVideoStream(false), and specify the ID of the remote user that you want to subscribe to. To resume receiving video streams of multiple users, call muteRemoteVideoStream as many times. Calling setDefaultMuteAllRemoteVideoStreams(false) resumes receiving video streams of the subsequent users only.

Parameters

muted

Sets whether to receive/stop receiving all remote video streams by default: true: Stop receiving any remote video stream by default. false: (Default) Receive all remote video streams by default.

Returns

• 0: Success.
• < 0: Failure.

Enables the video module.

You can call this method either before joining a channel or during a call. If you call this method before joining a channel, the service starts in the video mode. If you call this method during an audio call, the audio mode switches to the video mode.

A successful enableVideo method call triggers the onUserEnableVideo(true) callback on the remote client.

To disable the video, call the disableVideo method.

Note

• This method affects the internal engine and can be called after calling the leaveChannel method. You can call this method either before or after joining a channel.
• This method resets the internal engine and takes some time to take effect. We recommend using the following API methods to control the video engine modules separately:
  • enableLocalVideo: Whether to enable the camera to create the local video stream.
  • muteLocalVideoStream: Whether to publish the local video stream.
  • muteRemoteVideoStream: Whether to subscribe to and play the remote video stream.
  • muteAllRemoteVideoStreams: Whether to subscribe to and play all remote video streams.

Returns

• 0: Success.
• < 0: Failure.

Disables the video module.

You can call this method before joining a channel or during a call. If you call this method before joining a channel, the service starts in audio mode. If you call this method during a video call, the video mode switches to the audio mode.

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

To enable the video mode, call the enableVideo method.

Note

• This method affects the internal engine and can be called after calling the leaveChannel method. You can call this method either before or after joining a channel.
• This method resets the internal engine and takes some time to take effect. We recommend using the following API methods to control the video engine modules separately:
  • enableLocalVideo: Whether to enable the camera to create the local video stream.
  • muteLocalVideoStream: Whether to publish the local video stream.
  • muteRemoteVideoStream: Whether to subscribe to and play the remote video stream.
  • muteAllRemoteVideoStreams: Whether to subscribe to and play all remote video streams.

Returns

• 0: Success.
• < 0: Failure.

Sets the video encoding profile.

Deprecated:

From v2.3.0. We recommend using the setVideoEncoderConfiguration method to set the video profile.

If you do not need to change the video encoding profile after joining a channel, call this method before calling the enableVideo method to reduce the render time of the first video frame.

Each video encoding profile includes a set of parameters, such as the resolution, frame rate, and bitrate. When the camera does not support the specified resolution, the SDK chooses a suitable camera resolution, while the encoder resolution is specified by this method.

Parameters

profile	Sets the video encoding profile. See VideoProfile.
swapWidthAndHeight	The width and height of the output video is consistent with the set video profile. swapWidthAndHeight sets whether or not to swap the width and height of the stream: true: Swap the width and height. The video is in portrait mode (width < height). false: (Default) Do not swap the width and height. The video is in landscape mode (width > height).

Returns

• 0: Success.
• < 0: Failure.

Manually sets the video encoding profile.

Deprecated:

From v2.3.0. We recommend using the setVideoEncoderConfiguration method to set the video profile.

Each video encoding profile includes a set of parameters, such as the resolution, frame rate, and bitrate. If the camera device does not support the specified resolution, the SDK automatically chooses a suitable camera resolution, keeping the encoder resolution specified by this method. If the user does not set the video encoding profile after joining a channel, We recommend calling this method before calling the enableVideo method to minimize the time delay in receiving the first video frame.

Parameters

width	Sets the width of the video. The maximum value of width &times height is 1280 &times 720.
height	Sets the height of the video. The maximum value of width &times height is 1280 &times 720.
frameRate	Sets the frame rate of the video. The highest value is 30. You can set frameRate as 5, 10, 15, 24, and 30.
bitrate	Sets the bitrate of the video. You need to manually work out the bitrate according to the width, height, and frame rate. For the correlation between the width, height, and frame rate. See the table in Bitrate.

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.

Sets the video encoder configuration.

Since

v2.3.0. This method replaces the setVideoProfile method.

Each video encoder configuration corresponds to a set of video parameters, including the resolution, frame rate, bitrate, and video orientation. The parameters specified in this method are the maximum values under ideal network conditions. If the video engine cannot render the video using the specified parameters due to poor network conditions, the parameters further down the list are considered until a successful configuration is found.

If you do not set the video encoder configuration after joining the channel, you can call this method before calling the enableVideo method to reduce the render time of the first video frame.

Parameters

config

The local video encoder configuration. See VideoEncoderConfiguration.

Returns

• 0: Success.
• < 0: Failure.

Sets the camera capturer configuration.

Since

v2.4.0.

For a video call or live broadcast, generally the SDK controls the camera output parameters. When the default camera capture settings do not meet special requirements or cause performance problems, we recommend using this method to set the camera capturer configuration:

• If the resolution or frame rate of the captured raw video data are higher than those set by setVideoEncoderConfiguration, processing video frames requires extra CPU and RAM usage and degrades performance. We recommend setting config as CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE(1) to avoid such problems.
• If you do not need local video preview or are willing to sacrifice preview quality, we recommend setting config as CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE(1) to optimize CPU and RAM usage.
• If you want better quality for the local video preview, we recommend setting config as CAPTURER_OUTPUT_PREFERENCE_PREVIEW(2).

Parameters

config

The camera capturer configuration. For details, see CameraCapturerConfiguration.

Note

Call this method before enabling the local camera. That said, you can call this method before calling joinChannel, enableVideo, or enableLocalVideo, depending on which method you use to turn on your local camera.

Returns

• 0: Success.
• < 0: Failure.

Initializes the local video view.

This method initializes the video view of the 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 loca video stream to a video view and to set the rendering and mirror modes of the video view.

Note

• Call this method in the main thread.
• To update the rendering or mirror mode of the local video view during a call, use setLocalRenderMode.

Parameters

local

Sets the local video view and settings. See VideoCanvas.

Returns

• 0: Success.
• < 0: Failure.

Initializes the video view of a remote user.

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.

Typically, the app specifies the uid of the remote user sending the video in the method call before the remote user joins a channel. If the uid of the remote user is unknown to the app, set the uid when the app receives the onUserJoined callback.

If the Video Recording function is enabled, the Video Recording Service joins the channel as a dummy client, causing other clients to also receive the onUserJoined callback. Do not bind the dummy client to the app view because the dummy client does not send any video streams. If your app does not recognize the dummy client, bind the remote user to the view when the SDK triggers the onFirstRemoteVideoDecoded callback.

To unbind the remote user from the view, set view in Video Canvas as null. Once the remote user leaves the channel, the SDK unbinds the remote user.

Note

• Ensure that you call this method in the UI thread.
• To update the rendering or mirror mode of the remote video view during a call, use setRemoteRenderMode.

Parameters

remote

Sets the remote video view and settings. See Video Canvas.

Returns

• 0: Success.
• < 0: Failure.

Sets the local video display mode.

Deprecated:

v3.0.0. Use setLocalRenderMode2 instead.

Parameters

renderMode

Sets the local video display mode: RENDER_MODE_HIDDEN(1): Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents. RENDER_MODE_FIT(2): Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio are filled with black. RENDER_MODE_ADAPTIVE(3): This mode is deprecated and Agora does not recommend using this mode.

Returns

• 0: Success.
• < 0: Failure.

Updates the display mode of the local video view.

Since

v3.0.0.

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.

Note

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

Parameters

renderMode

Sets the local video display mode: RENDER_MODE_HIDDEN(1): Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents. RENDER_MODE_FIT(2): Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio are filled with black. RENDER_MODE_ADAPTIVE(3): This mode is deprecated and Agora does not recommend using this mode. RENDER_MODE_FILL(4): The fill mode. In this mode, the SDK stretches or zooms the video to fill the display window.

mirrorMode

Sets the local video mirror mode: VIDEO_MIRROR_MODE_AUTO(0): (Default) The mirror mode determined by the SDK. 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. VIDEO_MIRROR_MODE_ENABLED(1): Enable the mirror mode. VIDEO_MIRROR_MODE_DISABLED(2): Disable the mirror mode.

Returns

• 0: Success.
• < 0: Failure.

Sets the remote video display mode.

Deprecated:

v3.0.0. Use setRemoteRenderMode2 instead.

This method can be invoked multiple times during a call to change the display mode.

Parameters

uid

User ID of the remote user.

renderMode

Sets the remote video display mode: RENDER_MODE_HIDDEN(1): Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents. RENDER_MODE_FIT(2): Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio are filled with black. RENDER_MODE_ADAPTIVE(3): This mode is deprecated and Agora does not recommend using this mode.

Returns

• 0: Success.
• < 0: Failure.

Updates the display mode of the video view of a remote user.

Since

v3.0.0.

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.

Note

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

Parameters

uid	User ID of the remote user.
renderMode	Sets the remote video display mode: RENDER_MODE_HIDDEN(1): Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents. RENDER_MODE_FIT(2): Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio are filled with black. RENDER_MODE_ADAPTIVE(3): This mode is deprecated and Agora does not recommend using this mode. RENDER_MODE_FILL(4): The fill mode. In this mode, the SDK stretches or zooms the video to fill the display window.
mirrorMode	Sets the remote video mirror mode: VIDEO_MIRROR_MODE_AUTO(0): (Default) The mirror mode determined by the SDK. By default, the SDK disables the mirror mode for the remote video. VIDEO_MIRROR_MODE_ENABLED(1): Enable the mirror mode. VIDEO_MIRROR_MODE_DISABLED(2): Disable the mirror mode.

Returns

• 0: Success.
• < 0: Failure.

Creates the video renderer view.

CreateRendererView returns the SurfaceView type. The operation and layout of the view are managed by the app, and the Agora SDK renders the view provided by the app. The video display view must be created using this method instead of directly calling SurfaceView.

Note

Ensure that you call this method in the UI thread.

Parameters

context

The context of the Android Activity.

Returns

SurfaceView.

Starts the local video preview before joining a channel.

Before calling this method, you must:

• Call the setupLocalVideo method to set the local preview window and configure the attributes.
• Call the enableVideo method to enable the video.

Note

• By default, the local preview enables the mirror mode.
• Once you call this method to start the local video preview, if you leave the channel by calling the leaveChannel method, the local video preview remains until you call the stopPreview method to disable it.

Returns

• 0: Success.
• < 0: Failure.

Stops the local video preview and the video.

Returns

• 0: Success.
• < 0: Failure.

Disables/Re-enables the local video capture.

This method disables or re-enables the local video capturer, and does not affect receiving the remote video stream.

After you call the enableVideo method, the local video capturer is enabled by default. You can call enableLocalVideo(false) to disable the local video capturer. If you want to re-enable it, call enableLocalVideo(true).

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

Parameters

enabled

Sets whether to disable/re-enable the local video, including the capturer, renderer, and sender: true: (Default) Re-enable the local video. false: Disable the local video. Once the local video is disabled, the remote users can no longer receive the video stream of this user, while this user can still receive the video streams of other remote users. When you set enabled as false, this method does not require a local camera.

Note

This method affects the internal engine and can be called after calling the leaveChannel method.

Returns

• 0: Success.
• < 0: Failure.

Stops/Resumes sending the local video stream.

A successful muteLocalVideoStream method call triggers the onUserMuteVideo callback on the remote client.

Parameters

muted

Sets whether to send/stop sending the local video stream: true: Stop sending the local video stream. false: (Default) Send the local video stream.

Note

• When you set muted as true, this method does not disable the camera and thus does not affect the retrieval of the local video streams. This method responds faster than calling the enableLocalVideo method and set muted as false, which controls sending the local video stream.
• If you call setChannelProfile after this method, the SDK resets whether or not to mute the local video according to the channel profile and user role. Therefore, we recommend calling this method after the setChannelProfile method.

Returns

• 0: Success.
• < 0: Failure.

Stops/Resumes receiving a specified remote user's video stream.

Parameters

uid	User ID of the specified remote user.
muted	Sets whether to receive/stop receiving a specified remote user's video stream: true: Stop receiving a specified remote user’s video stream. false: (Default) Receive a specified remote user’s video stream.

Note

If you call the muteAllRemoteVideoStreams method and set set muted as true to stop receiving all remote video streams, ensure that the muteAllRemoteVideoStreams method is called and set muted as false before calling this method. The muteAllRemoteVideoStreams method sets all remote streams, while this method sets a specified remote user's stream.

Returns

• 0: Success.
• < 0: Failure.

Stops/Resumes receiving all remote video streams.

Parameters

muted

Sets whether to receive/stop receiving all remote video streams: true: Stop receiving all remote video streams. false: (Default) Receive all remote video streams.

Returns

• 0: Success.
• < 0: Failure.

Sets whether to receive all remote video streams by default.

You can call this method either before or after joining a channel. If you call setDefaultMuteAllRemoteVideoStreams(true) after joining a channel, you will not receive the video stream of any subsequent user.

Note

If you want to resume receiving video streams, call muteRemoteVideoStream(false), and specify the ID of the remote user that you want to subscribe to. To resume receiving video streams of multiple users, call muteRemoteVideoStream as many times. Calling setDefaultMuteAllRemoteVideoStreams(false) resumes receiving video streams of the subsequent users only.

Parameters

muted

Sets whether to receive/stop receiving all remote video streams by default: true: Stop receiving any remote video stream by default. false: (Default) Receive all remote video streams by default.

Returns

• 0: Success.
• < 0: Failure.

Enables/Disables image enhancement and sets the options.

Since

v2.4.0.

Note

• Call this method after calling enableVideo.
• This method applies to Android 4.4 or later.

Parameters

enabled	Sets whether or not to enable image enhancement: enables image enhancement. disables image enhancement.
options	The image enhancement options. See BeautyOptions.

Returns

• 0: Success.
• < 0: Failure.
  • ERR_NOT_SUPPORTED(4): The system version is earlier than Android 4.4, which does not support this function.

Sets the default audio playback route.

This method sets whether the received audio is routed to the earpiece or speakerphone by default before joining a channel. If a user does not call this method, the audio is routed to the earpiece by default. If you need to change the default audio route after joining a channel, call the setEnableSpeakerphone method.

The default audio route for each scenario:

• In the Communication profile:
  • For a voice call, the default audio route is the earpiece.
  • For a video call, the default audio route is the speaker. If the user disables the video using disableVideo, or muteLocalVideoStreamand muteAllRemoteVideoStreams, the default audio route automatically switches back to the earpiece.
• In the Live Broadcast profile: The default audio route is the speaker.

Note

• This method applies to the Communication profile only.
• Call this method before the user joins a channel.

Parameters

defaultToSpeaker

Sets the default audio route: true: Route the audio to the speaker. If the playback device connects to the earpiece or Bluetooth, the audio cannot be routed to the earpiece. false: (Default) Route the audio to the earpiece. If a headset is plugged in, the audio is routed to the headset.

Returns

• 0: Success.
• < 0: Failure.

Enables/Disables the audio playback route to the speakerphone.

This method sets whether the audio is routed to the speakerphone or earpiece. After calling this method, the SDK triggers the onAudioRouteChanged callback to indicate the changes.

Note

• Ensure that you have successfully called the joinChannel method before calling this method.
• This method is invalid for audience users in the Live Broadcast profile.
• Settings of setAudioProfile and setChannelProfile affect the call result of setEnableSpeakerphone. The following are scenarios where setEnableSpeakerphone does not take effect:
  • If you set scenario as AUDIO_SCENARIO_GAME_STREAMING, no user can change the audio playback route.
  • If you set scenario as AUDIO_SCENARIO_DEFAULT or AUDIO_SCENARIO_SHOWROOM, the audience cannot change the audio playback route. If there is only one broadcaster is in the channel, the broadcaster cannot change the audio playback route either.
  • If you set scenario as AUDIO_SCENARIO_EDUCATION, the audience cannot change the audio playback route.

Parameters

enabled

Whether to route the audio to the speakerphone or earpiece: true: Route the audio to the speakerphone. false: Route the audio to the earpiece. If the headset is plugged in, the audio is routed to the headset.

Returns

• 0: Success.
• < 0: Failure.

Checks whether the speakerphone is enabled.

Returns

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

Enables in-ear monitoring.

Parameters

enabled

Sets whether to enable/disable in-ear monitoring: true: Enable. false: (Default) Disable.

Returns

• 0: Success.
• < 0: Failure.

Sets the volume of the in-ear monitor.

Parameters

volume

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

Returns

• 0: Success.
• < 0: Failure.

Uses an external audio device.

Deprecated:

This method is deprecated.

Returns

• 0: Success.
• < 0: Failure.

Changes the voice pitch of the local speaker.

Parameters

pitch

Sets the voice pitch. The value ranges between 0.5 and 2.0. The lower the value, the lower the voice pitch. The default value is 1.0 (no change to the local voice pitch).

Returns

• 0: Success.
• < 0: Failure.

Sets the local voice equalization effect.

Parameters

bandFrequency	Sets 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, 500, 1k, 2k, 4k, 8k, and 16k Hz.
bandGain	Sets the gain of each band (dB). The value ranges between -15 and 15. The default value is 0.

Returns

• 0: Success.
• < 0: Failure.

Sets the local voice reverberation.

Note

v2.4.0 adds the setLocalVoiceReverbPreset method, a more user-friendly method for setting the local voice reverberation. You can use this method to set the local reverberation effect, such as Popular, R&B, Rock, Hip-hop, and more.

Parameters

reverbKey

Sets the reverberation key. This method contains five reverberation keys. For details, see the description of each @ value.

value

Sets the local voice reverberation value: AUDIO_REVERB_DRY_LEVEL(0): Level of the dry signal (-20 to 10 dB). AUDIO_REVERB_WET_LEVEL(1): Level of the early reflection signal (wet signal) (-20 to 10 dB). AUDIO_REVERB_ROOM_SIZE(2): Room size of the reflection (0 to 100 dB). AUDIO_REVERB_WET_DELAY(3): Length of the initial delay of the wet signal (0 to 200 ms). AUDIO_REVERB_STRENGTH(4): Strength of the late reverberation (0 to 100).

Returns

• 0: Success.
• < 0: Failure.

Sets the local voice changer option.

Since

v2.4.0.

This method can be used to set the local voice effect for users in a communication channel or broadcasters in a live broadcast channel. Voice changer options include the following voice effects:

• VOICE_CHANGER_XXX: Changes the local voice to an old man, a little boy, or the Hulk. Applies to the voice talk scenario.
• VOICE_BEAUTY_XXX: Beautifies the local voice by making it sound more vigorous, resounding, or adding spacial resonance. Applies to the voice talk and singing scenario.
• GENERAL_VOICE_BEAUTY_XXX: Adds gender-based beautification effect to the local voice. Applies to the voice talk scenario.
  • For a male voice: Adds magnetism to the voice.
  • For a female voice: Adds freshness or vitality to the voice.

Note

• To achieve better voice effect quality, Agora recommends setting the profile parameter in setAudioProfile as AUDIO_PROFILE_MUSIC_HIGH_QUALITY or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO.
• This method works best with the human voice, and Agora does not recommend using it for audio containing music and a human voice.
• Do not use this method with setLocalVoiceReverbPreset, because the method called later overrides the one called earlier. For detailed considerations, see the advanced guide Voice Changer and Reverberation.

Parameters

voiceChanger

The local voice changer option: VOICE_CHANGER_OFF: (Default) Turn off the local voice changer, that is, to use the original voice. VOICE_CHANGER_OLDMAN: The voice of an old man. VOICE_CHANGER_BABYBOY: The voice of a little boy. VOICE_CHANGER_BABYGILR: The voice of a little girl. VOICE_CHANGER_ZHUBAJIE: The voice of Zhu Bajie, a character in Journey to the West who has a voice like that of a growling bear. VOICE_CHANGER_ETHEREAL: The ethereal voice. VOICE_CHANGER_HULK: The voice of Hulk. VOICE_BEAUTY_VIGOROUS: A more vigorous voice. VOICE_BEAUTY_DEEP: A deeper voice. VOICE_BEAUTY_MELLOW: A mellower voice. VOICE_BEAUTY_FALSETTO: Falsetto. VOICE_BEAUTY_FULL: A fuller voice. VOICE_BEAUTY_CLEAR: A clearer voice. VOICE_BEAUTY_RESOUNDING: A more resounding voice. VOICE_BEAUTY_RINGING: A more ringing voice. VOICE_BEAUTY_SPACIAL: A more spatially resonant voice. GENERAL_BEAUTY_VOICE_MALE_MAGNETIC: (For male only) A more magnetic voice. Do not use it when the speaker is a female; otherwise, voice distortion occurs. GENERAL_BEAUTY_VOICE_FEMALE_FRESH: (For female only) A fresher voice. Do not use it when the speaker is a male; otherwise, voice distortion occurs. GENERAL_BEAUTY_VOICE_FEMALE_VITALITY: (For female only) A more vital voice. Do not use it when the speaker is a male; otherwise, voice distortion occurs.

Returns

• 0: Success.
• < 0: Failure. Check if the enumeration is properly set.

Sets the local voice reverberation option, including the virtual stereo.

Since

v2.4.0.

This method sets the local voice reverberation for users in a communication channel or broadcasters in a live-broadcast channel. After successfully calling this method, all users in the channel can hear the voice with reverberation.

Note

• When calling this method with enumerations that begin with AUDIO_REVERB_FX, ensure that you set profile in setAudioProfile as AUDIO_PROFILE_MUSIC_HIGH_QUALITY or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO, otherwise, this methods cannot set the corresponding voice reverb.
• When calling this method with AUDIO_VIRTUAL_STEREO, Agora recommends setting the profile parameter in setAudioProfile as AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO.
• This method works best with the human voice, and Agora does not recommend using it for audio containing music and a human voice.
• Do not use this method with setLocalVoiceChanger, because the method called later overrides the one called earlier. For detailed considerations, see the advanced guide Voice Changer and Reverberation.

Parameters

preset

The local voice reverberation option. To achieve better voice effects, Agora recommends the enumeration whose name begins with AUDIO_REVERB_FX. AUDIO_REVERB_OFF: (Default) Turn off local voice reverberation, that is, to use the original voice. AUDIO_REVERB_POPULAR: The reverberation style typical of popular music. AUDIO_REVERB_RNB: The reverberation style typical of R&B music. AUDIO_REVERB_ROCK: The reverberation style typical of rock music. AUDIO_REVERB_HIPHOP: The reverberation style typical of hip-hop music. AUDIO_REVERB_VOCAL_CONCERT: The reverberation style typical of a concert hall. AUDIO_REVERB_KTV: The reverberation style typical of a KTV venue. AUDIO_REVERB_STUDIO: The reverberation style typical of a recording studio. AUDIO_REVERB_FX_KTV: The reverberation style typical of a KTV venue (enhanced). AUDIO_REVERB_FX_VOCAL_CONCERT: The reverberation style typical of a concert hall (enhanced). AUDIO_REVERB_FX_UNCLE: The reverberation style typical of an uncle's voice. AUDIO_REVERB_FX_SISTER: The reverberation style typical of a little sister's voice. AUDIO_REVERB_FX_STUDIO: The reverberation style typical of a recording studio (enhanced). AUDIO_REVERB_FX_POPULAR: The reverberation style typical of popular music (enhanced). AUDIO_REVERB_FX_RNB: The reverberation style typical of R&B music (enhanced). AUDIO_REVERB_FX_PHONOGRAPH: The reverberation style typical of the vintage phonograph. AUDIO_VIRTUAL_STEREO: The reverberation of the virtual stereo. The virtual stereo is an effect that renders the monophonic audio as the stereo audio, so that all users in the channel can hear the stereo voice effect. To achieve better virtual stereo reverberation, Agora recommends setting profile in setAudioProfile as AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO.

Returns

• 0: Success.
• < 0: Failure. Check if the enumeration is properly set.

Enables/Disables stereo panning for remote users.

Since

v2.4.0.

Ensure that you call this method before joinChannel 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

Sets whether or not to enable stereo panning for remote users: true: enables stereo panning. false: disables stereo panning.

Returns

• 0: Success.
• < 0: Failure.

Sets the sound position of a remote user.

Since

v2.4.0.

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

Note

• For this method to work, enable stereo panning for remote users by calling the enableSoundPositionIndication method before joining a channel.
• This method requires hardware support. For the best sound positioning, we recommend using a stereo headset.

Parameters

uid	The ID of the remote user.
pan	The sound position of the remote user. The value ranges from -1.0 to 1.0: 0.0: the remote sound comes from the front. -1.0: the remote sound comes from the left. 1.0: the remote sound comes from the right.
gain	Gain of the remote user. The value ranges from 0.0 to 100.0. The default value is 100.0 (the original gain of the remote user). The smaller the value, the less the gain.

Returns

• 0: Success.
• < 0: Failure.

Starts playing and mixing the music file.

This method mixes the specified local or online audio file with the audio stream from the microphone, or replaces the microphone’s audio stream with the specified local or remote audio file. You can choose whether the other user can hear the local audio playback and specify the number of playback loops. When the audio mixing file playback finishes after calling this method, the SDK triggers the onAudioMixingFinished callback.

A successful startAudioMixing method call triggers the onAudioMixingStateChanged(MEDIA_ENGINE_AUDIO_EVENT_MIXING_PLAY) callback on the local client.

When the audio mixing file playback finishes, the SDK triggers the onAudioMixingStateChanged(MEDIA_ENGINE_AUDIO_EVENT_MIXING_STOPPED) callback on the local client.

Parameters

filePath	Specifies the absolute path of the local or online audio file to be mixed. For example, /sdcard/emulated/0/audio.mp4. Agora recommends entering the file suffix. If you cannot determine the file suffix type, then leave it blank. Supported audio formats: mp3, mp4, m4a, aac, 3gp, mkv, and wav. If the path begins with /assets/, the audio file is in the /assets/ directory. Otherwise, the audio file is in the absolute path.
loopback	Sets which user can hear the audio mixing: true: Only the local user can hear the audio mixing. false: Both users can hear the audio mixing.
replace	Sets the audio mixing content: true: Only publish the specified audio file; the audio stream from the microphone is not published. false: The local audio file is mixed with the audio stream from the microphone.
cycle	Sets the number of playback loops: Positive integer: Number of playback loops -1: Infinite playback loops

Note

• To use this method, ensure that the Android device is v4.2 or later, and the API version is v16 or later.
• Call this method when you are in the channel, otherwise it may cause issues.
• If you want to play an online music file, ensure that the time interval between calling this method is more than 100 ms, or the AUDIO_FILE_OPEN_TOO_FREQUENT = 702 warning occurs.
• If you want to play an online music file, Agora does not recommend using the redirected URL address. Some Android devices may fail to open a redirected URL address.
• If the local audio mixing file does not exist, or if the SDK does not support the file format or cannot access the music file URL, the SDK returns WARN_AUDIO_MIXING_OPEN_ERROR = 701.
• If you call this method on an emulator, only the MP3 file format is supported.

Returns

• 0: Success.
• < 0: Failure.
  • WARN_AUDIO_MIXING_OPEN_ERROR (701): If the local audio file does not exist, or the online audio packet is not received within five seconds after it is opened, the SDK assumes that the media file cannot be used and returns this warning.

Stops playing or mixing the music file.

Call this method when you are in a channel.

Returns

• 0: Success.
• < 0: Failure.

Pauses playing and mixing the music file.

Call this method when you are in a channel.

Returns

• 0: Success.
• < 0: Failure.

Resumes playing and mixing the music file.

Call this method when you are in a channel.

Returns

• 0: Success.
• < 0: Failure.

Adjusts the volume of audio mixing.

Call this method when you are in a channel.

Note

Calling this method does not affect the volume of the audio effect file playback invoked by the playEffect method.

Parameters

volume

Audio mixing volume. The value ranges between 0 and 100 (default).

Returns

• 0: Success.
• < 0: Failure.

Adjusts the volume of audio mixing for local playback.

Since

v2.3.2. Call this method when you are in a channel.

Parameters

volume

Audio mixing volume for local playback. The value ranges between 0 and 100 (default).

Returns

• 0: Success.
• < 0: Failure.

Adjusts the volume of audio mixing for publishing (sending to other users).

Since

v2.3.2. Call this method when you are in a channel.

Parameters

volume

Audio mixing volume for publishing. The value ranges between 0 and 100 (default).

Returns

• 0: Success.
• < 0: Failure.

Gets the audio mixing volume for local playback.

Since

v2.4.1.

This method helps troubleshoot audio volume related issues.

Returns

• Returns the audio mixing volume for local playback, if the method call is successful. The value range is [0,100].
• < 0: Failure.

Gets the audio mixing volume for publishing.

Since

v2.4.1.

This method helps troubleshoot audio volume related issues.

Returns

• Returns the audio mixing volume for publishing, if the method call is successful. The value range is [0,100].
• < 0: Failure.

Gets the duration (ms) of the music file.

Call this method when you are in a channel.

Returns

• Returns the audio mixing duration, if the method call is successful.
• < 0: Failure.

Gets the playback position (ms) of the music file.

Call this method when you are in a channel.

Returns

• Returns the current playback position of the audio mixing, if the method call is successful.
• < 0: Failure.

Sets the playback position (ms) of the music file to a different starting position (the default plays from the beginning).

Parameters

pos	The playback starting position (ms) of the audio mixing file.

Returns

• 0: Success.
• < 0: Failure.

Sets the pitch of the local music file.

Since

3.0.1

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.

Note

Call this method after calling startAudioMixing.

Parameters

pitch

Sets the pitch of the local music file by chromatic scale. The default value is 0, which means keep 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.

Retrieves the IAudioEffectManager object associated with the current RtcEngine instance.

Returns

IAudioEffectManager

Starts an audio recording on the client.

Deprecated:

From v2.9.1. Use startAudioRecording2 instead.

The SDK allows recording during a call. Supported formats of the recording file are as follows:

• .wav: Large file size with high fidelity.
• .aac: Small file size with low fidelity.

This method has a fixed sample rate of 32 kHz.

Note

• Ensure that the directory to save the recording file exists and is writable.
• This method is usually called after calling the joinChannel method. The recording automatically stops when you call the leaveChannel method.

Parameters

filePath	Full file path of the recording file. The string of the file name is in UTF-8. For example, /sdcard/emulated/0/audio/aac.
quality	Sets the audio recording quality: AUDIO_RECORDING_QUALITY_LOW(0): Low audio-recording quality. AUDIO_RECORDING_QUALITY_MEDIUM(1): Medium audio-recording quality. AUDIO_RECORDING_QUALITY_HIGH(2): High audio-recording quality.

Returns

• 0: Success.
• < 0: Failure.

Starts an audio recording on the client.

Since

v2.9.1 to replace startAudioRecording1.

The SDK allows recording during a call. After successfully calling this method, you can record the audio of all the users in the channel and get an audio recording file.

Supported formats of the recording file are as follows:

• .wav: Large file size with high fidelity.
• .aac: Small file size with low fidelity.

Note

• Ensure that the directory to save the recording file exists and is writable.
• This method is usually called after calling the joinChannel method. The recording automatically stops when you call the leaveChannel method.
• For better recording effects, set quality as AUDIO_RECORDING_QUALITY_MEDIUM or AUDIO_RECORDING_QUALITY_HIGH when sampleRate is 44.1 kHz or 48 kHz.

Parameters

filePath	Absolute file path of the recording file. The string of the file name is in UTF-8. For example, /sdcard/emulated/0/audio/aac.
sampleRate	Sample rate (Hz) of the recording file. Supported values are as follows: 16000 (Default) 32000 44100 48000
quality	The audio recording quality: AUDIO_RECORDING_QUALITY_LOW(0): Low audio-recording quality. AUDIO_RECORDING_QUALITY_MEDIUM(1): Medium audio-recording quality. AUDIO_RECORDING_QUALITY_HIGH(2): High audio-recording quality.

Returns

• 0: Success.
• < 0: Failure.

Stops the audio recording on the client.

Note

You can call this method before calling the leaveChannel method; else, the recording automatically stops when you call the leaveChannel method.

Returns

• 0: Success.
• < 0: Failure.

Starts an audio call test.

Deprecated:

Since v2.4.0. We recommend using startEchoTest to start an audio call test.

This method launches an audio call test to determine whether the audio devices (for example, headset and speaker) and the network connection are working properly.

To conduct the test:

• The user speaks, and the recording is played back within 10 seconds.
• If the user can hear the recording within 10 seconds, the audio devices and network connection are working properly.

Note

• After calling this method, call the stopEchoTest method to end the test. Otherwise, the app cannot run the next echo test, nor can it call the joinChannel method to start a new call.
• In the Live Broadcast profile, only hosts can call this method. If a user switches from the Communication to Live Broadcast profile, the user must call the setClientRole method to change the user role from an audience (default) to a host before calling this method.

Returns

• 0: Success.
• < 0: Failure.

Starts an audio call test.

Since

v2.4.0.

In the audio call test, you record your voice. If the recording plays back within the set time interval, the audio devices and the network connection are working properly.

Note

• Call this method before joining a channel.
• After calling this method, call the stopEchoTest method to end the test. Otherwise, the app cannot run the next echo test, or call the joinchannel method.
• In the Live Broadcast profile, only a host can call this method.

Parameters

intervalInSeconds

The time interval (s) between when you speak and when the recording plays back.

Returns

• 0: Success.
• < 0: Failure.

Stops the audio call test.

Returns

• 0: Success.
• < 0: Failure.
  • ERR_REFUSED(-5). Failed to stop the echo test. The echo test may not be running.

Enables the network connection quality test.

This method tests the quality of the users' network connections and is disabled by default.

Before users join a channel or before an audience switches to a host, call this method to check the uplink network quality. This method consumes additional network traffic, which may affect the communication quality. Call the disableLastmileTest method to disable this test after receiving the onLastmileQuality callback, and before the user joins a channel or switches the user role.

Note

• Do not use this method with the startLastmileProbeTest method.
• Do not call any other methods before receiving the onLastmileQuality callback. Otherwise, the callback may be interrupted by other methods and may not execute.
• In the Live Broadcast profile, a host should not call this method after joining a channel.
• If you call this method to test the last-mile quality, the SDK consumes the bandwidth of a video stream, whose bitrate corresponds to the bitrate you set in the setVideoEncoderConfiguration method. After you join the channel, whether you have called the disableLastmileTest method or not, the SDK automatically stops consuming the bandwidth.

Returns

• 0: Success.
• < 0: Failure.

Disables the network connection quality test.

Returns

• 0: Success.
• < 0: Failure.

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

Since

v2.4.0.

Once this method is enabled, the SDK returns the following callbacks:

• onLastmileQuality: the SDK triggers this callback within two seconds depending on the network conditions. This callback rates the network conditions with a score and is more closely linked to the user experience.
• onLastmileProbeResult: the SDK triggers this callback within 30 seconds depending on the network conditions. This callback returns the real-time statistics of the network conditions and is more objective.

Call this method to check the uplink network quality before users join a channel or before an audience switches to a host.

Note

• This method consumes extra network traffic and may affect communication quality. We do not recommend calling this method together with enableLastmileTest.
• Do not call other methods before receiving the onLastmileQuality and onLastmileProbeResult callbacks. Otherwise, the callbacks may be interrupted by other methods.
• In the Live Broadcast profile, a host should not call this method after joining a channel.

Parameters

config

The configurations of the last-mile network probe test. For details, see LastmileProbeConfig.

Returns

• 0: Success.
• < 0: Failure.

Stops the last-mile network probe test.

Since

v2.4.0.

Returns

• 0: Success.
• < 0: Failure.

Customizes the video source.

Call this method to add an external video source to the SDK.

Parameters

source

Sets the video source. See IVideoSource.

Customizes the local video renderer.

Call this method to add an external local video renderer to the SDK.

Parameters

render

Sets the local video renderer. See IVideoSink.

Customizes the remote video renderer.

Call this method to add an external remote video renderer to the SDK.

Parameters

uid	The ID of the remote user.
render	Sets the remote video renderer. See IVideoSink.

Sets the external audio sink.

Since

v2.9.0.

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

Note

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

Parameters

enabled	Sets whether to enable or disable the external audio sink: true: Enables the external audio sink. false: (Default) Disables the external audio sink.
sampleRate	Sets the sample rate (Hz) of the external audio sink. You can set this parameter as 16000, 32000, 44100, or 48000.
channels	Sets the number of audio channels of the external audio sink: 1: Mono. 2: Stereo.

Returns

• 0: Success.
• < 0: Failure.

Pulls the remote audio frame.

Since

v2.9.0.

Before calling this method, call the setExternalAudioSink(enabled: true) method to enable and set the external audio sink.

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

Note

• Once you call the pullPlaybackAudioFrame method successfully, the app will not retrieve any audio data from the onPlaybackFrame callback.
• The difference between the onPlaybackFrame callback and the pullPlaybackAudioFrame method is as follows:
  • onPlaybackFrame: The SDK sends the audio data to the app once every 10 ms. Any delay in processing the audio frames may result in audio jitter.
  • pullPlaybackAudioFrame: The app pulls the remote audio data. After setting the audio data parameters, the SDK adjusts the frame buffer and avoids problems caused by jitter in the external audio playback.

Parameters

data	The audio data that you want to pull. The data format is in byte[].
lengthInByte	The data length (byte) of the external audio data. The value of this parameter is related to the value of the sampleRate parameter that you set in the setExternalAudioSink method: lengthInByte = sampleRate / 100 × 2 × number of channels × time (ms).

Returns

• 0: Success.
• < 0: Failure.

Sets the external audio source.

Note

Ensure that you call this method before the joinChannel method.

Parameters

enabled	Sets whether to enable/disable the external audio source: true: Enable the external audio source. false: (Default) Disable the external audio source.
sampleRate	Sets the sample rate (Hz) of the external audio source, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
channels	Sets the number of channels of the external audio source: 1: Mono. 2: Stereo.

Returns

• 0: Success.
• < 0: Failure.

Pushes the external audio frame to the Agora SDK for encoding.

Parameters

data	External audio data to be pushed.
timestamp	Timestamp of the external audio frame. It is mandatory. You can use this parameter for the following purposes: Restore the order of the captured audio frame. Synchronize audio and video frames in video-related scenarios, including scenarios where external video sources are used.

Returns

• 0: Success.
• < 0: Failure.

Configures the external video source.

Parameters

enable	Sets whether or not to use the external video source: true: Use the external video source. false: Do not use the external video source.
useTexture	Sets whether or not to use texture as an input: true: Use texture as an input. false: (Default) Do not use texture as an input.
pushMode	Sets whether or not the external video source needs to call the PushExternalVideoFrame method to send the video frame to the Agora SDK: true: Use the push mode. false: Use the pull mode (not supported).

Pushes the video frame using the AgoraVideoFrame class and passes the video frame to the Agora SDK.

Call the setExternalVideoSource method and set pushMode as true before calling this method. Otherwise, a failure returns after calling this method.

Parameters

frame

Video frame to be pushed. See AgoraVideoFrame.

Note

In the Communication profile, the SDK does not support textured video frames.

Returns

• true: The frame is pushed successfully.
• false: Failed to push the frame.

Checks whether texture encoding is supported.

Returns

• true: Texture encoding is supported.
• false: Texture encoding is not supported.

Registers the audio observer object.

Parameters

observer

Audio observer object to be registered. See IAudioFrameObserver. Set the value as null to cancel registering, if necessary.

Returns

• 0: Success.
• < 0: Failure.

Sets the audio recording format for the onRecordFrame callback.

Parameters

sampleRate	Sets the sample rate (samplesPerSec) returned in the onRecordFrame callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
channel	Sets the number of audio channels (channels) returned in the onRecordFrame callback: 1: Mono 2: Stereo
mode	Sets the use mode of the onRecordFrame callback: RAW_AUDIO_FRAME_OP_MODE_READ_ONLY(0): Read-only mode: Users only read the AudioFrame data without modifying anything. For example, when users acquire the data with the Agora SDK then push the RTMP streams. RAW_AUDIO_FRAME_OP_MODE_WRITE_ONLY(1): Write-only mode: Users replace the AudioFrame data with their own data and pass the data to the SDK for encoding. For example, when users acquire the data. RAW_AUDIO_FRAME_OP_MODE_READ_WRITE(2): Read and write mode: Users read the data from AudioFrame, modify it, and then play it. For example, when users have their own sound-effect processing module and perform some voice pre-processing, such as a voice change.
samplesPerCall	Sets the number of samples the onRecordFrame callback returns. In RTMP streaming scenarios, set it as 1024.

Returns

• 0: Success.
• < 0: Failure.

Note

The SDK calculates the sample interval according to the value of the sampleRate, channel, and samplesPerCall parameters you set in this method. Sample interval (s) = samplePerCall/(sampleRate × channel). Ensure that the value of sample interval ≥ 0.01. The SDK triggers the onRecordFrame callback according to the sample interval.

Sets the audio playback format for the onPlaybackFrame callback.

Parameters

sampleRate	Sets the sample rate (samplesPerSec) returned in the onPlaybackFrame callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
channel	Sets the number of channels (channels) returned in the onPlaybackFrame callback: 1: Mono 2: Stereo
mode	Sets the use mode of the onPlaybackFrame callback: RAW_AUDIO_FRAME_OP_MODE_READ_ONLY(0): Read-only mode: Users only read the AudioFrame data without modifying anything. For example, when users acquire the data with the Agora SDK then push the RTMP streams. RAW_AUDIO_FRAME_OP_MODE_WRITE_ONLY(1): Write-only mode: Users replace the AudioFrame data with their own data. For example, users can use this mode when they acquire data by themselves. RAW_AUDIO_FRAME_OP_MODE_READ_WRITE(2): Read and write mode: Users read the data from AudioFrame, modify it, and then play it. For example, users can use this mode when they have their own sound-effect processing module, and want to do some voice post-processing, such as a voice change.
samplesPerCall	Sets the number of samples the onPlaybackFrame callback returns. In RTMP streaming scenarios, set it as 1024.

Returns

• 0: Success.
• < 0: Failure.

Note

The SDK calculates the sample interval according to the value of the sampleRate, channel, and samplesPerCall parameters you set in this method. Sample interval (s) = samplePerCall/(sampleRate × channel). Ensure that the value of sample interval ≥ 0.01. The SDK triggers the onPlaybackFrame callback according to the sample interval.

Sets the mixed audio format for the onMixedAudioFrame callback.

Parameters

sampleRate	Sets the sample rate (samplesPerSec) returned in the onMixedAudioFrame callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
samplesPerCall	Sets the number of samples the onMixedAudioFrame callback returns. In RTMP streaming scenarios, set it as 1024.

Returns

• 0: Success.
• < 0: Failure.

Note

The SDK calculates the sample interval according to the value of the sampleRate and samplesPerCall parameters you set in this method， and channels in AudioFrame. Sample interval (s) = samplePerCall/(sampleRate × channel). Ensure that the value of sample interval ≥ 0.01. The SDK triggers the onMixedAudioFrame callback according to the sample interval.

Adds a watermark image to the local video.

Deprecated:

From v2.9.1. We recommend using the addVideoWatermark2 method instead.

This method adds a PNG watermark image to the local video stream for the recording device, channel audience, or CDN live audience to see and capture. To add the PNG file to a CDN live publishing stream, see the setLiveTranscoding method.

Parameters

watermark

Watermark image to be added to the local video stream. See Agora Image.

Note

• The URL descriptions are different for the local video and CDN live streams:
  • In a local video stream, url in Agora Image refers to the absolute path of the added watermark image file in the local video stream.
  • In a CDN live stream, url in Agora Image refers to the address of the added watermark image in the CDN live broadcast.
• The source file of the watermark image must be in the PNG file format. If the width and height of the PNG file differ from your settings in this method, the PNG file is cropped to conform to your settings.
• The Agora SDK supports adding only one watermark image onto a local video or CDN live stream. The newly added watermark image replaces the previous one.
• If you set orientationMode as Adaptive in the setVideoEncoderConfiguration method, the watermark image rotates with the video frame around the upper left corner of the watermark image.

Returns

• 0: Success.
• < 0: Failure.

Adds a watermark image to the local video.

Since

v2.9.1 to replace addVideoWatermark1.

This method adds a PNG watermark image to the local video stream in a live broadcast. Once the watermark image is added, all the audience in the channel (CDN audience included), and the recording device can see and capture it.

Agora supports adding only one watermark image onto the local video, and the newly watermark image replaces the previous one.

The watermark position depends on the settings in the setVideoEncoderConfiguration method:

• If the orientation mode of the encoding video is ORIENTATION_MODE_FIXED_LANDSCAPE, or the landscape mode in ORIENTATION_MODE_ADAPTIVE, the watermark uses the landscape orientation.
• If the orientation mode of the encoding video is ORIENTATION_MODE_FIXED_PORTRAIT, or the portrait mode in ORIENTATION_MODE_ADAPTIVE, the watermark uses the portrait orientation.
• When setting the watermark position, the region must be less than the dimensions set in the setVideoEncoderConfiguration method. Otherwise, the watermark image will be cropped.

Note

• Ensure that you have called the enableVideo method to enable the video module before calling this method.
• If you only want to add a watermark image to the local video for the audience in the CDN live broadcast channel to see and capture, you can call this method or the setLiveTranscoding method.
• This method supports adding a watermark image in the PNG file format only. Supported pixel formats of the PNG image are RGBA, RGB, Palette, Gray, and Alpha_gray.
• If the dimensions the PNG image differ from your settings in this method, the image will be cropped or zoomed to conform to your settings.
• If you have enabled the local video preview by calling the startPreview method, you can use the visibleInPreview member in the WatermarkOptions class to set whether or not the watermark is visible in preview.
• If you have enabled the mirror mode for the local video, the watermark on the local video is also mirrored. To avoid mirroring the watermark, Agora recommends that you do not use the mirror and watermark functions for the local video at the same time. You can implement the watermark function in your application layer.

Parameters

watermarkUrl	The local file path of the watermark image to be added. This method supports adding a watermark image from either the local file path or the assets file path. If you use the assets file path, you need to start with /assets/ when filling in this parameter.
options	The options of the watermark image to be added. See Watermark Options.

Returns

• 0: Success.
• < 0: Failure.

Removes the watermark image from the video stream added by addVideoWatermark.

Returns

• 0: Success.
• < 0: Failure.

Sets the priority of a remote user's media stream.

Since

v2.4.0.

Use this method with the setRemoteSubscribeFallbackOption method. If the fallback function is enabled for a subscribed stream, the SDK ensures the high-priority user gets the best possible stream quality.

Note

The Agora SDK supports setting userPriority as high for one user only.

Parameters

uid	The ID of the remote user.
userPriority	The priority of the remote user: USER_PRIORITY_HIGH(50): the user's priority is high. USER_PRIORITY_NORANL(100): (default) the user's priority is normal.

Returns

• 0: Success.
• <0: Failure.

Sets the fallback option for the locally published video stream based on the network conditions.

If option is set as STREAM_FALLBACK_OPTION_AUDIO_ONLY(2), the SDK will:

• Disable the upstream video but enable audio only when the network conditions deteriorate and cannot support both video and audio.
• Re-enable the video when the network conditions improve.

When the locally published video stream falls back to audio only or when the audio-only stream switches back to the video, the SDK triggers the onLocalPublishFallbackToAudioOnly.

Parameters

option

Sets the fallback option for the locally published video stream: STREAM_FALLBACK_OPTION_DISABLED(0): (Default) No fallback behavior for the locally published video stream when the uplink network condition is poor. The stream quality is not guaranteed. STREAM_FALLBACK_OPTION_AUDIO_ONLY(2): The locally published video stream falls back to audio only when the uplink network condition is poor.

Note

Agora does not recommend using this method for CDN live streaming, because the remote CDN live user will have a noticeable lag when the locally published video stream falls back to audio only.

Returns

• 0: Success.
• < 0: Failure.

Sets the fallback option for the remotely subscribed video stream based on the network conditions.

If option is set as STREAM_FALLBACK_OPTION_AUDIO_ONLY(2), the SDK automatically switches the video from a high-stream to a low-stream, or disables the video when the downlink network condition cannot support both audio and video to guarantee the quality of the audio. The SDK monitors the network quality and restores the video stream when the network conditions improve. When the remotely subscribed video stream falls back to audio only, or the audio-only stream switches back to the video, the SDK triggers the onRemoteSubscribeFallbackToAudioOnly callback.

Parameters

option

Sets the fallback option for the remotely subscribed video stream: STREAM_FALLBACK_OPTION_DISABLED(0): No fallback behavior for the remotely subscribed video stream when the downlink network condition is poor. The quality of the video stream is not guaranteed. STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW(1): (Default) The remotely subscribed video stream falls back to the low-stream video when the downlink network condition worsens. This option works only for this method and not for the setLocalPublishFallbackOption method. STREAM_FALLBACK_OPTION_AUDIO_ONLY(2): Under poor downlink network conditions, the remotely subscribed video stream first falls back to the low-stream video; and then to an audio-only stream if the network condition worsens.

Returns

• 0: Success.
• < 0: Failure.

Enables/Disables the dual video stream mode.

If dual-stream mode is enabled, the receiver can choose to receive the high stream (high-resolution high-bitrate video stream) or low stream (low-resolution low-bitrate video stream) video.

Parameters

enabled

Sets the stream mode: true: Dual-stream mode. false: (Default) Single-stream mode.

Returns

• 0: Success.
• < 0: Failure.

Sets the stream type of the remote video.

Under limited network conditions, if the publisher has not disabled the dual-stream mode using enableDualStreamMode(false), the receiver can choose to receive either the high-quality video stream (the high resolution, and high bitrate video stream) or the low-quality video stream (the low resolution, and low bitrate video stream).

By default, users receive the high-quality video stream. Call this method if you want to switch the remote stream type 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 reports the result of calling this method in the onApiCallExecuted callback.

Parameters

uid	ID of the remote user sending the video stream.
streamType	Sets the video-stream type: High-resolution, high-bitrate video: High-stream video(0) Low-resolution, low-bitrate video: Low-stream video(1)

Returns

• 0: Success.
• < 0: Failure.

Sets the default video-stream type of the remotely subscribed video stream when the remote user sends dual streams.

Parameters

streamType

Sets the default video-stream type: High-resolution, high-bitrate video: High-stream video(0) Low-resolution, low-bitrate video: Low-stream video(1)

Returns

• 0: Success.
• < 0: Failure.

Enables built-in encryption with an encryption password before joining a channel.

All users in a channel must set the same encryption password. The encryption password is automatically cleared once a user leaves the channel. If the encryption password is not specified or set to empty, the encryption functionality is disabled.

Note

For optimal transmission, ensure that the encrypted data size does not exceed the original data size + 16 bytes. 16 bytes is the maximum padding size for AES encryption.

Parameters

secret

Encryption password.

Note

Do not use this method for CDN live streaming.

Returns

• 0: Success.
• < 0: Failure.

Sets the built-in encryption mode.

The Agora SDK supports built-in encryption, which is set to aes-128-xts mode by default. Call this method to set the encryption mode to use other encryption modes. All users in the same channel must use the same encryption mode and password.

Refer to the information related to the AES encryption algorithm on the differences between the encryption modes.

Parameters

encryptionMode

Sets the encryption mode: "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. "": When encryptionMode is set as null, the encryption is in “aes-128-xts” by default.

Note

Call the setEncryptionSecret method before calling this method.

Returns

• 0: Success.
• < 0: Failure.

Injects an online media stream to a live broadcast.

If this method call is successful, the server pulls the voice or video stream and injects it into a live channel. This is applicable to scenarios where all audience members in the channel can watch a live show and interact with each other.

Note

• This method applies to the Live-Broadcast profile only.
• Ensure that you enable the RTMP Converter service before using this function. See Prerequisites in Push Streams to CDN.
• You can inject only one media stream into the channel at the same time.

The addInjectStreamUrl method call triggers the following callbacks:

• The local client:
  • onStreamInjectedStatus, with the state of the injecting the online stream.
  • onUserJoined(uid: 666), if the method call is successful and the online media stream is injected into the channel.
• The remote client:
  • onUserJoined(uid: 666), if the method call is successful and the online media stream is injected into the channel.

Parameters

url	The URL address to be added to the ongoing live broadcast. Valid protocols are RTMP, HLS, and HTTP-FLV. Supported FLV audio codec type: AAC. Supported FLV video codec type: H264(AVC).
config	The LiveInjectStreamConfig object which contains the configuration information for the added voice or video stream.

Returns

• 0: Success.
• < 0: Failure.
  • ERR_INVALID_ARGUMENT(2): The injected URL does not exist. Call this method again to inject the stream and ensure that the URL is valid.
  • ERR_NOT_READY(3): The user is not in the channel.
  • ERR_NOT_SUPPORTED(4): The channel profile is not Live Broadcast. Call the setChannelProfile method and set the channel profile to Live Broadcast before calling this method.
  • ERR_NOT_INITIALIZED(7): The SDK is not initialized. Ensure that the RtcEngine object is initialized before using this method.

Removes the injected online media stream from a live broadcast.

This method removes the URL address (added by addInjectStreamUrl) from a live broadcast.

If this method call is successful, the SDK triggers the onUserOffline callback and returns a stream uid of 666.

Parameters

url	HTTP/HTTPS URL address of the added stream to be removed.

Returns

• 0: Success.
• < 0: Failure.

Publishes the local stream to the CDN.

The addPublishStreamUrl method call triggers the onRtmpStreamingStateChanged callback on the local client to report the state of adding a local stream to the CDN.

Parameters

url	The CDN streaming URL in the RTMP format. The maximum length of this parameter is 1024 bytes. The URL address must not contain special characters, such as Chinese language characters.
transcodingEnabled	Sets whether transcoding is enabled/disabled. If you set this parameter as true, ensure that you call the setLiveTranscoding method before this method. true: Enable transcoding. To transcode the audio or video streams when publishing them to CDN live, often used for combining the audio and video streams of multiple hosts in CDN live. false: Disable transcoding.

Note

• Ensure that you enable the RTMP Converter service before using this function. See Prerequisites in Push Streams to CDN.
• This method applies to Live Broadcast only.
• Ensure that the user joins a channel before calling this method.
• This method adds only one stream HTTP/HTTPS URL address each time it is called.

Returns

• 0: Success.
• < 0: Failure.
  • ERR_INVALID_ARGUMENT(2): Invalid parameter, usually because the URL address is null or the string length is 0.
  • ERR_NOT_INITIALIZED(7): You have not initialized RtcEngine when publishing the stream.

Removes an RTMP stream from the CDN.

This method removes the RTMP URL address (added by addPublishStreamUrl) from a CDN live stream. The SDK reports the result of this method call in the onRtmpStreamingStateChanged callback.

Parameters

url	The RTMP URL address to be removed. The maximum length of this parameter is 1024 bytes. The URL address must not contain special characters, such as Chinese language characters.

Note

• Ensure that you enable the RTMP Converter service before using this function. See Prerequisites in Push Streams to CDN.
• Ensure that the user joins a channel before calling this method.
• This method applies to Live Broadcast only.
• This method removes only one stream RTMP URL address each time it is called.

Returns

• 0: Success.
• < 0: Failure.

Sets the video layout and audio settings for CDN live.

The SDK triggers the onTranscodingUpdated callback when you call this method to update the LiveTranscodingclass. If you call this method to set the LiveTranscoding class for the first time, the SDK does not trigger the onTranscodingUpdated callback.

Note

Before calling the methods listed in this section:

• This method applies to Live Broadcast only.
• Ensure that you enable the RTMP Converter service before using this function. See Prerequisites in Push Streams to CDN.
• Ensure that you call the setClientRole method and set the user role as the host.
• Ensure that you call the setLiveTranscoding method before calling the addPublishStreamUrl method.

Parameters

transcoding

Sets the CDN live audio/video transcoding settings. See LiveTranscoding.

Returns

• 0: Success.
• < 0: Failure.

Creates a data stream.

Each user can create up to five data streams during the lifecycle of the RtcEngine.

Parameters

reliable

Sets whether or not the recipients are guaranteed to receive the data stream from the sender within five seconds: true: The recipients receive the data from the sender within five seconds. If the recipient does not receive the data within five seconds, the SDK triggers the onStreamMessageError callback and returns an error code. false: There is no guarantee that the recipients receive the data stream within five seconds and no error message is reported for any delay or missing data stream.

ordered

Sets whether or not the recipients receive the data stream in the sent order: true: The recipients receive the data in the sent order. false: The recipients do not receive the data in the sent order.

Note

Set both the reliable and ordered parameters to true or false. Do not set one as true and the other as false.

Returns

• Returns the stream ID, if the method call is successful.
• < 0: Failure.

The error code is related to the integer displayed in Error Codes. For example, if it returns -2, then it indicates ERR_INVALID_ARGUMENT(-2) in Error Codes.

Sends data stream messages.

The SDK has the following restrictions on this method:

• Up to 30 packets can be sent per second in a channel with each packet having a maximum size of 1 kB.
• Each client can send up to 6 kB of data per second.
• Each user can have up to five data channels simultaneously.

A successful sendStreamMessage method call triggers the onStreamMessage callback on the remote client, from which the remote user gets the stream message.

A failed sendStreamMessage method call triggers the onStreamMessageError callback on the remote client.

Note

• Ensure that you have created the data stream using createDateStream before calling this method.
• This method applies only to the Communication profile or to hosts in the Live Broadcast profile.

Parameters

streamId	ID of the sent data stream returned by the createDataStream method.
message	Sent data.

Note

This method applies only to the Communication profile or to hosts in the Live Broadcast profile. If an audience in the Live Broadcast profile calls this method, the audience role may be changed to a host.

Returns

• 0: Success.
• < 0: Failure.