IRtcEngine

The basic interface of the Agora SDK that implements the core functions of real-time communication.

IRtcEngine provides the main methods that your app can call.

Before calling other APIs, you must call createAgoraRtcEngine to create an IRtcEngine object.

addListener

Adds one IRtcEngineEvent listener.

addListener?<EventType extends keyof IRtcEngineEvent>(
      eventType: EventType,
      listener: IRtcEngineEvent[EventType]
    ): void;

Details

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

Parameters

eventType
The name of the target event to listen for. See IRtcEngineEvent.
listener
The callback function for eventType. Take adding a listener for onJoinChannelSuccess as an example:
const onJoinChannelSuccess = (connection: RtcConnection, elapsed: number) => {};
engine.addListener('onJoinChannelSuccess', onJoinChannelSuccess);

addVideoWatermark

Adds a watermark image to the local video.

abstract addVideoWatermark(
    watermarkUrl: string,
    options: WatermarkOptions
  ): number;

Details

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

The watermark coordinates are dependent on the settings in the setVideoEncoderConfiguration method:
  • If the orientation mode of the encoding video (OrientationMode) is fixed landscape mode or the adaptive landscape mode, the watermark uses the landscape orientation.
  • If the orientation mode of the encoding video (OrientationMode) is fixed portrait mode or the adaptive portrait mode, the watermark uses the portrait orientation.
  • When setting the watermark position, the region must be less than the dimensions set in the setVideoEncoderConfiguration method; otherwise, the watermark image will be cropped.
Attention:
  • Ensure that calling this method after enableVideo.
  • If you only want to add a watermark to the media push, you can call this method or the method.
  • This method supports adding a watermark image in the PNG file format only. Supported pixel formats of the PNG image are RGBA, RGB, Palette, Gray, and Alpha_gray.
  • If the dimensions of the PNG image differ from your settings in this method, the image will be cropped or zoomed to conform to your settings.
  • If you have enabled the local video preview by calling the startPreview method, you can use the visibleInPreview member to set whether or not the watermark is visible in the preview.
  • If you have enabled the mirror mode for the local video, the watermark on the local video is also mirrored. To avoid mirroring the watermark, Agora recommends that you do not use the mirror and watermark functions for the local video at the same time. You can implement the watermark function in your application layer.

Parameters

watermarkUrl
The local file path of the watermark image to be added. This method supports adding a watermark image from the local absolute or relative file path.
options
The options of the watermark image to be added. See WatermarkOptions.

Returns

  • 0: Success.
  • < 0: Failure.

adjustAudioMixingPlayoutVolume

Adjusts the volume of audio mixing for local playback.

abstract adjustAudioMixingPlayoutVolume(volume: number): number;

Details

Attention: Call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying) callback.

Parameters

volume
The volume of audio mixing for local playback. The value ranges between 0 and 100 (default). 100 represents the original volume.

Returns

  • 0: Success.
  • < 0: Failure.

adjustAudioMixingPublishVolume

Adjusts the volume of audio mixing for publishing.

abstract adjustAudioMixingPublishVolume(volume: number): number;

Details

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

Attention:

Call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying) callback.

Parameters

volume
The volume of audio mixing for local playback. The value ranges between 0 and 100 (default). 100 represents the original volume.

Returns

  • 0: Success.
  • < 0: Failure.

adjustAudioMixingVolume

Adjusts the volume during audio mixing.

abstract adjustAudioMixingVolume(volume: number): number;

Details

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

Attention:

Parameters

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

Returns

  • 0: Success.
  • < 0: Failure.

adjustCustomAudioPlayoutVolume

Adjusts the volume of the custom audio track played locally.

abstract adjustCustomAudioPlayoutVolume(
    trackId: number,
    volume: number
  ): number;

Details

Attention: Ensure you have called the createCustomAudioTrack method to create a custom audio track before calling this method.

If you want to change the volume of the audio to be played locally, you need to call this method again.

Parameters

trackId
The audio track ID. Set this parameter to the custom audio track ID returned in createCustomAudioTrack.
volume
The volume of the audio source. The value can range from 0 to 100. 0 means mute; 100 means the original volume.

Returns

  • 0: Success.
  • < 0: Failure.

adjustCustomAudioPublishVolume

Adjusts the volume of the custom audio track played remotely.

abstract adjustCustomAudioPublishVolume(
    trackId: number,
    volume: number
  ): number;

Details

Attention: Ensure you have called the createCustomAudioTrack method to create a custom audio track before calling this method.

If you want to change the volume of the audio to be published, you need to call this method again.

Parameters

trackId
The audio track ID. Set this parameter to the custom audio track ID returned in createCustomAudioTrack.
volume
The volume of the audio source. The value can range from 0 to 100. 0 means mute; 100 means the original volume.

Returns

  • 0: Success.
  • < 0: Failure.

adjustPlaybackSignalVolume

Adjusts the playback signal volume of all remote users.

abstract adjustPlaybackSignalVolume(volume: number): number;

Details

Attention:
  • This method adjusts the playback volume that is the mixed volume of all remote users.
  • You can call this method either before or after joining a channel.

Parameters

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

Returns

  • 0: Success.
  • < 0: Failure.

adjustRecordingSignalVolume

Adjusts the capturing signal volume.

abstract adjustRecordingSignalVolume(volume: number): number;

Details

Attention:

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

Parameters

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

Returns

  • 0: Success.
  • < 0: Failure.

adjustUserPlaybackSignalVolume

Adjusts the playback signal volume of a specified remote user.

abstract adjustUserPlaybackSignalVolume(uid: number, volume: number): number;

Details

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

Attention:
  • Call this method after joining a channel.
  • The playback volume here refers to the mixed volume of a specified remote user.

Parameters

uid
The user ID of the remote user.
volume
Audio mixing volume. The value ranges between 0 and 100. The default value is 100, which means the original volume.

Returns

  • 0: Success.
  • < 0: Failure.

clearVideoWatermarks

Removes the watermark image from the video stream.

abstract clearVideoWatermarks(): number;

Returns

  • 0: Success.
  • < 0: Failure.

complain

Allows a user to complain about the call quality after a call ends.

abstract complain(callId: string, description: string): number;

Details

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

Parameters

callId
The current call ID. You can get the call ID by calling getCallId.
description
A description of the call. The string length should be less than 800 bytes.

Returns

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

configRhythmPlayer

Configures the virtual metronome.

abstract configRhythmPlayer(config: AgoraRhythmPlayerConfig): number;

Details

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

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

Attention:
  • After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning, and controls the playback duration of each file according to beatsPerMinute you set in AgoraRhythmPlayerConfig. For example, if you set beatsPerMinute as 60, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration.
  • By default, the sound of the virtual metronome is published in the channel. If you do not want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in ChannelMediaOptions as false.

Parameters

config
The metronome configuration. See AgoraRhythmPlayerConfig.

Returns

  • 0: Success.
  • < 0: Failure.

initialize

abstract initialize(context: RtcEngineContext): number;

Details

Attention:
  • Before calling other APIs, you must call createAgoraRtcEngine and initialize to create and initialize the IRtcEngine object.
  • The SDK supports creating only one IRtcEngine instance for an app.

Parameters

context

Configurations for the IRtcEngine instance. See RtcEngineContext.

Returns

  • 0: Success.
  • < 0: Failure.
    • -1: A general error occurs (no specified reason).
    • -2: The parameter is invalid.
    • -7: The SDK is not initialized.
    • -22: The resource request failed. The SDK fails to allocate resources because your app consumes too much system resource or the system resources are insufficient.
    • -101: The App ID is invalid.

createAgoraRtcEngine

Creates one IRtcEngine object.

export function createAgoraRtcEngine(): IRtcEngine {
  return instance;
}

Details

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

Returns

One IRtcEngine object.

createDataStream

Creates a data stream.

abstract createDataStream(config: DataStreamConfig): number;

Details

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

Parameters

config
The configurations for the data stream. See DataStreamConfig.

Returns

  • ID of the created data stream, if the method call succeeds.
  • < 0: Failure.

createMediaPlayer

Creates a media player instance.

abstract createMediaPlayer(): IMediaPlayer;

Returns

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

createCustomVideoTrack

Creates a customized video track.

abstract createCustomVideoTrack(): number;

Details

When you need to publish multiple custom captured videos in the channel, you can refer to the following steps:
  1. Call this method to create a video track and get the video track ID.
  2. In each channel's ChannelMediaOptions, set the customVideoTrackId parameter to the ID of the video track you want to publish, and set publishCustomVideoTrack to true.
  3. If you call pushVideoFrame, and specify customVideoTrackId as the videoTrackId set in step 2, you can publish the corresponding custom video source in multiple channels.

Returns

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

destroyCustomVideoTrack

Destroys the specified video track.

abstract destroyCustomVideoTrack(videoTrackId: number): number;

Parameters

videoTrackId
The video track ID returned by calling the createCustomVideoTrack method.

Returns

  • 0: Success.
  • < 0: Failure.

destroyMediaPlayer

Destroys the media player instance.

abstract destroyMediaPlayer(mediaPlayer: IMediaPlayer): number;

Parameters

mediaPlayer

One IMediaPlayer object.

Returns

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

disableAudio

Disables the audio module.

abstract disableAudio(): number;

Details

Attention:
  • This method disables the internal engine and can be called anytime after initialization. It is still valid after one leaves channel.
  • This method resets the internal engine and takes some time to take effect. Agora recommends using the following API methods to control the audio modules separately:

Returns

  • 0: Success.
  • < 0: Failure.

disableAudioSpectrumMonitor

Disables audio spectrum monitoring.

abstract disableAudioSpectrumMonitor(): number;

Details

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

Attention:

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

Returns

  • 0: Success.
  • < 0: Failure.

disableVideo

Disables the video module.

abstract disableVideo(): number;

Details

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

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

Attention:
  • This method affects the internal engine and can be called after leaving the channel.
  • This method resets the internal engine and thus might takes some time to take effect. Agora recommends using the following APIs to control the video modules separately:

Returns

  • 0: Success.
  • < 0: Failure.

enableAudio

Enables the audio module.

abstract enableAudio(): number;

Details

The audio mode is enabled by default.

Attention:
  • This method enables the internal engine and can be called anytime after initialization. It is still valid after one leaves channel.
  • Calling this method will reset the entire engine, resulting in a slow response time. Instead of callling this method, you can independently control a specific audio module based on your actual needs using the following methods:
  • A successful call of this method resets enableLocalAudio, muteRemoteAudioStream, and muteAllRemoteAudioStreams. Proceed it with caution.

Returns

  • 0: Success.
  • < 0: Failure.

enableAudioSpectrumMonitor

Turns on audio spectrum monitoring.

abstract enableAudioSpectrumMonitor(intervalInMS?: number): number;

Details

If you want to obtain the audio spectrum data of local or remote users, you can register the audio spectrum observer and enable audio spectrum monitoring.

Attention:

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

Parameters

intervalInMS

The interval (in milliseconds) at which the SDK triggers the onLocalAudioSpectrum and onRemoteAudioSpectrum callbacks. The default value is 100. Do not set this parameter to a value less than 10, otherwise calling this method would fail.

Returns

  • 0: Success.
  • < 0: Failure.
    • -2: Invalid parameters.

enableAudioVolumeIndication

Enables the reporting of users' volume indication.

abstract enableAudioVolumeIndication(
    interval: number,
    smooth: number,
    reportVad: boolean
  ): number;

Details

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

Attention: You can call this method either before or after joining a 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. The lowest value is 50.
smooth
The smoothing factor that sets the sensitivity of the audio volume indicator. The value ranges between 0 and 10. The recommended value is 3. The greater the value, the more sensitive the indicator.
reportVad
  • true: Enables the voice activity detection of the local user. Once it is enabled, the vad parameter of the onAudioVolumeIndication callback reports the voice activity status of the local user.
  • false: (Default) Disables the voice activity detection of the local user. Once it is disabled, the vad parameter of the onAudioVolumeIndication callback does not report the voice activity status of the local user, except for the scenario where the engine automatically detects the voice activity of the local user.

Returns

  • 0: Success.
  • < 0: Failure.

enableContentInspect

Enables or disables video screenshot and upload.

abstract enableContentInspect(
    enabled: boolean,
    config: ContentInspectConfig
  ): number;

Details

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

Note: Before calling this method, ensure that you have contacted technical support to activate the video screenshot upload service.

Parameters

enabled
Whether to enable video screenshot and upload:
  • true: Enables video screenshot and upload.
  • false: Disables video screenshot and upload.
config
Configuration of video screenshot and upload. See ContentInspectConfig.
Note: When the video moderation module is set to video moderation via Agora self-developed extension(ContentInspectSupervision), the video screenshot and upload dynamic library libagora_content_inspect_extension.dll is required. Deleting this library disables the screenshot and upload feature.

Returns

  • 0: Success.
  • < 0: Failure.

enableDualStreamMode

Enables or disables the dual-stream mode on the sender and sets the low-quality video stream.

abstract enableDualStreamMode(
    enabled: boolean,
    streamConfig?: SimulcastStreamConfig
  ): number;

Details

Deprecated:
This method is deprecated as of v4.2.0. Use setDualStreamMode instead.
You can call this method to enable or disable the dual-stream mode on the publisher side. Dual streams are a pairing of a high-quality video stream and a low-quality video stream:
  • High-quality video stream: High bitrate, high resolution.
  • Low-quality video stream: Low bitrate, low resolution.

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

Note:
  • This method is applicable to all types of streams from the sender, including but not limited to video streams collected from cameras, screen sharing streams, and custom-collected video streams.
  • If you need to enable dual video streams in a multi-channel scenario, you can call the enableDualStreamModeEx method.
  • You can call this method either before or after joining a channel.

Parameters

enabled
Whether to enable dual-stream mode:
  • true: Enable dual-stream mode.
  • false: (Default) Disable dual-stream mode.
streamConfig

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

Returns

  • 0: Success.
  • < 0: Failure.

enableEncryption

Enables or disables the built-in encryption.

abstract enableEncryption(enabled: boolean, config: EncryptionConfig): number;

Details

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

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

Attention: If you enable the built-in encryption, you cannot use the Media Push function.

Parameters

enabled
Whether to enable built-in encryption:
  • true: Enable the built-in encryption.
  • false: Disable the built-in encryption.
config
Built-in encryption configurations. See EncryptionConfig.

Returns

  • 0: Success.
  • < 0: Failure.
    • -2: An invalid parameter is used. Set the parameter with a valid value.
    • -4: The built-in encryption mode is incorrect or the SDK fails to load the external encryption library. Check the enumeration or reload the external encryption library.
    • -7: The SDK is not initialized. Initialize the IRtcEngine instance before calling this method.

enableExtension

Enables or disables extensions.

abstract enableExtension(
    provider: string,
    extension: string,
    enable?: boolean,
    type?: MediaSourceType
  ): number;

Details

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

Note:
  • If you want to enable multiple extensions, you need to call this method multiple times.
  • The data processing order of different extensions in the SDK is determined by the order in which the extensions are enabled. That is, the extension that is enabled first will process the data first.

Parameters

provider
The name of the extension provider.
extension
The name of the extension.
enable
Whether to enable the extension:
  • true: Enable the extension.
  • false: Disable the extension.
type
Type of media source. See MediaSourceType.
Attention: In this method, this parameter supports only the following two settings:
  • The default value is UnknownMediaSource.
  • If you want to use the second camera to capture video, set this parameter to SecondaryCameraSource.

Returns

  • 0: Success.
  • < 0: Failure.
    • -3: The extension library is not loaded. Agora recommends that you check the storage location or the name of the dynamic library.

enableFaceDetection

Enables or disables face detection for the local user.

abstract enableFaceDetection(enabled: boolean): number;

Details

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

Once face detection is enabled, the SDK triggers the onFacePositionChanged callback to report the face information of the local user, which includes the following:
  • The width and height of the local video.
  • The position of the human face in the local view.
  • The distance between the human face and the screen.

This method needs to be called after the camera is started (for example, by calling startPreview orenableVideo ).

Parameters

enabled
Whether to enable face detection for the local user:
  • true: Enable face detection.
  • false: (Default) Disable face detection.

Returns

  • 0: Success.
  • < 0: Failure.

enableInEarMonitoring

Enables in-ear monitoring.

abstract enableInEarMonitoring(
    enabled: boolean,
    includeAudioFilters: EarMonitoringFilterType
  ): number;

Details

This method enables or disables in-ear monitoring.

Attention:
  • Users must use earphones (wired or Bluetooth) to hear the in-ear monitoring effect.
  • You can call this method either before or after joining a channel.

Parameters

enabled
Enables or disables in-ear monitoring.
  • true: Enables in-ear monitoring.
  • false: (Default) Disables in-ear monitoring.
includeAudioFilters
The audio filter of in-ear monitoring: See EarMonitoringFilterType.

Returns

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

enableLocalAudio

Enables or disables the local audio capture.

abstract enableLocalAudio(enabled: boolean): number;

Details

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

This method does not affect receiving 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.

Once the local audio function is disabled or re-enabled, the SDK triggers the onLocalAudioStateChanged callback, which reports LocalAudioStreamStateStopped(0) or LocalAudioStreamStateRecording(1).
Attention:
  • The difference between this method and muteLocalAudioStream are as follow:
    • enableLocalAudio: Disables or re-enables the local audio capturing and processing. If you disable or re-enable local audio capturing using the enableLocalAudio method, the local user might hear a pause in the remote audio playback.
    • muteLocalAudioStream: Sends or stops sending the local audio streams.
  • You can call this method either before or after joining a channel. Calling it before joining a channel only sets the device state, and it takes effect immediately after you join the channel.

Parameters

enabled
  • true: (Default) Re-enable the local audio function, that is, to start the local audio capturing device (for example, the microphone).
  • false: Disable the local audio function, that is, to stop local audio capturing.

Returns

  • 0: Success.
  • < 0: Failure.

enableLocalVideo

Enables/Disables the local video capture.

abstract enableLocalVideo(enabled: boolean): number;

Details

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

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

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

Attention:
  • You can call this method either before or after joining a channel.
  • This method enables the internal engine and is valid after leaving the channel.

Parameters

enabled

Whether to enable the local video capture.

  • true: (Default) Enable the local video capture.
  • false: Disable the local video capture. Once the local video is disabled, the remote users cannot receive the video stream of the local user, while the local user can still receive the video streams of remote users. When set to false, this method does not require a local camera.

Returns

  • 0: Success.
  • < 0: Failure.

enableMultiCamera

Enables or disables multi-camera capture.

abstract enableMultiCamera(
    enabled: boolean,
    config: CameraCapturerConfiguration
  ): number;

Details

In scenarios where there are existing cameras to capture video, Agora recommends that you use the following steps to capture and publish video with multiple cameras:
  1. Call this method to enable multi-channel camera capture.
  2. Call startPreview to start the local video preview.
  3. Call startCameraCapture, and set sourceType to start video capture with the second camera.
  4. Call joinChannelEx, and set publishSecondaryCameraTrack to true to publish the video stream captured by the second camera in the channel.
If you want to disable multi-channel camera capture, use the following steps:
  1. Call stopCameraCapture.
  2. Call this method with enabled set to false.
Note:
You can call this method before and after startPreview to enable multi-camera capture:
  • If it is enabled before startPreview, the local video preview shows the image captured by the two cameras at the same time.
  • If it is enabled after startPreview, the SDK stops the current camera capture first, and then enables the primary camera and the second camera. The local video preview appears black for a short time, and then automatically returns to normal.

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

The minimum iOS device types that support multi-camera capture are as follows:
  • iPhone XR
  • iPhone XS
  • iPhone XS Max
  • iPad Pro 3rd generation and later

Parameters

enabled
Whether to enable multi-camera video capture mode:
  • true: Enable multi-camera capture mode; the SDK uses multiple cameras to capture video.
  • false: Disable multi-camera capture mode; the SDK uses a single camera to capture video.
config
Capture configuration for the second camera. See CameraCapturerConfiguration.

Returns

  • 0: Success.
  • < 0: Failure.

enableSpatialAudio

Enables or disables the spatial audio effect.

abstract enableSpatialAudio(enabled: boolean): number;

Details

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

Note:
  • You can call this method either before or after joining a channel.
  • This method relies on the spatial audio dynamic library libagora_spatial_audio_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.

Parameters

enabled
Whether to enable the spatial audio effect:
  • true: Enable the spatial audio effect.
  • false: Disable the spatial audio effect.

Returns

  • 0: Success.
  • < 0: Failure.

enableSoundPositionIndication

Enables or disables stereo panning for remote users.

abstract enableSoundPositionIndication(enabled: boolean): number;

Details

Ensure that you call this method before joining a channel to enable stereo panning for remote users so that the local user can track the position of a remote user by calling setRemoteVoicePosition.

Parameters

enabled
Whether to enable stereo panning for remote users:
  • true: Enable stereo panning.
  • false: Disable stereo panning.

Returns

  • 0: Success.
  • < 0: Failure.

enableVideo

Enables the video module.

abstract enableVideo(): number;

Details

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

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

Attention:
  • This method enables the internal engine and is valid after leaving the channel.
  • Calling this method will reset the entire engine, resulting in a slow response time. Instead of callling this method, you can independently control a specific video module based on your actual needs using the following methods:
  • A successful call of this method resets enableLocalVideo, muteRemoteVideoStream, and muteAllRemoteVideoStreams. Proceed it with caution.

Returns

  • 0: Success.
  • < 0: Failure.

enableVideoImageSource

Sets whether to replace the current video feeds with images when publishing video streams.

abstract enableVideoImageSource(
    enable: boolean,
    options: ImageTrackOptions
  ): number;

Details

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

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

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

Parameters

enable
Whether to replace the current video feeds with custom images:
  • true: Replace the current video feeds with custom images.
  • false: (Default) Do not replace the current video feeds with custom images.
options
Image configurations. See ImageTrackOptions.

Returns

  • 0: Success.
  • < 0: Failure.

enableVirtualBackground

Enables/Disables the virtual background.

abstract enableVirtualBackground(
    enabled: boolean,
    backgroundSource: VirtualBackgroundSource,
    segproperty: SegmentationProperty,
    type?: MediaSourceType
  ): number;

Details

The virtual background feature enables the local user to replace their original background with a static image, dynamic video, blurred background, or portrait-background segmentation to achieve picture-in-picture effect. Once the virtual background feature is enabled, all users in the channel can see the custom background.

Call this method before calling enableVideo or startPreview.

Attention:
  • This feature has high requirements on device performance. When calling this method, the SDK automatically checks the capabilities of the current device. Agora recommends you use virtual background on devices with the following processors:
    • Snapdragon 700 series 750G and later
    • Snapdragon 800 series 835 and later
    • Dimensity 700 series 720 and later
    • Kirin 800 series 810 and later
    • Kirin 900 series 980 and later
    • Devices with an A9 chip and better, as follows:
      • iPhone 6S and later
      • iPad Air 3rd generation and later
      • iPad 5th generation and later
      • iPad Pro 1st generation and later
      • iPad mini 5th generation and later
  • Agora recommends that you use this feature in scenarios that meet the following conditions:
    • A high-definition camera device is used, and the environment is uniformly lit.
    • There are few objects in the captured video. Portraits are half-length and unobstructed. Ensure that the background is a solid color that is different from the color of the user's clothing.
  • This method relies on the virtual background dynamic library libagora_segmentation_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.

Parameters

enabled
Whether to enable virtual background:
  • true: Enable virtual background.
  • false: Disable virtual background.
backgroundSource
The custom background. See VirtualBackgroundSource. To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted.
segproperty
Processing properties for background images. See SegmentationProperty.
type
The type of the video source. See MediaSourceType.
Attention: In this method, this parameter supports only the following two settings:
  • The default value is PrimaryCameraSource.
  • If you want to use the second camera to capture video, set this parameter to SecondaryCameraSource.

Returns

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

enableWebSdkInteroperability

Enables interoperability with the Agora Web SDK (applicable only in the live streaming scenarios).

abstract enableWebSdkInteroperability(enabled: boolean): number;

Details

Deprecated:
The SDK automatically enables interoperability with the Web SDK, so you no longer need to call this method.

You can call this method to enable or disable interoperability with the Agora Web SDK. If a channel has Web SDK users, ensure that you call this method, or the video of the Native user will be a black screen for the Web user.

This method is only applicable in live streaming scenarios, and interoperability is enabled by default in communication scenarios.

Parameters

enabled
Whether to enable interoperability:
  • true: Enable interoperability.
  • false: (Default) Disable interoperability.

Returns

  • 0: Success.
  • < 0: Failure.

getAudioDeviceInfo

Gets the audio device information.

abstract getAudioDeviceInfo(): DeviceInfo;

Details

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

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

Returns

The DeviceInfo object that identifies the audio device information.
  • Not null: Success.
  • Null: Failure.

getAudioMixingCurrentPosition

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

abstract getAudioMixingCurrentPosition(): number;

Details

Retrieves the playback position (ms) of the audio.

Attention:
  • You need to call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying) callback.
  • If you need to call getAudioMixingCurrentPosition multiple times, ensure that the time interval between calling this method is more than 500 ms.

Returns

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

getAudioMixingDuration

Retrieves the duration (ms) of the music file.

abstract getAudioMixingDuration(): number;

Details

Retrieves the total duration (ms) of the audio.

Attention:

You need to call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying) callback.

Returns

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

getAudioMixingPlayoutVolume

Retrieves the audio mixing volume for local playback.

abstract getAudioMixingPlayoutVolume(): number;

Details

This method helps troubleshoot audio volume‑related issues.

Attention:

You need to call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying) callback.

Returns

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

getAudioMixingPublishVolume

Retrieves the audio mixing volume for publishing.

abstract getAudioMixingPublishVolume(): number;

Details

This method helps troubleshoot audio volume‑related issues.

Attention: You need to call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying) callback.

Returns

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

getAudioTrackCount

Gets the index of audio tracks of the current music file.

abstract getAudioTrackCount(): number;

Details

Note:
  • You need to call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying) callback.

Returns

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

getCallId

Retrieves the call ID.

abstract getCallId(): string;

Details

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

Attention: Call this method after joining a channel.

Returns

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

getCameraMaxZoomFactor

Gets the maximum zoom ratio supported by the camera.

abstract getCameraMaxZoomFactor(): number;

Details

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

Returns

The maximum zoom factor.

getConnectionState

Gets the current connection state of the SDK.

abstract getConnectionState(): ConnectionStateType;

Details

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

Returns

The current connection state. See ConnectionStateType.

getEffectCurrentPosition

Retrieves the playback position of the audio effect file.

abstract getEffectCurrentPosition(soundId: number): number;

Details

Attention: Call this method after playEffect.

Parameters

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

Returns

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

getEffectDuration

Retrieves the duration of the audio effect file.

abstract getEffectDuration(filePath: string): number;

Details

Attention: Call this method after joining a channel.

Parameters

filePath
File path:
  • Android: The file path, which needs to be accurate to the file name and suffix. Agora supports URL addresses, absolute paths, or file paths that start with /assets/. You might encounter permission issues if you use an absolute path to access a local file, so Agora recommends using a URI address instead. For example: content://com.android.providers.media.documents/document/audio%3A14441
  • iOS: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example: /var/mobile/Containers/Data/audio.mp4.

Returns

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

getEffectsVolume

Retrieves the volume of the audio effects.

abstract getEffectsVolume(): number;

Details

The volume is an integer ranging from 0 to 100. The default value is 100, which means the original volume.

Attention: Call this method after playEffect.

Returns

  • Volume of the audio effects, if this method call succeeds.
  • < 0: Failure.

getErrorDescription

Gets the warning or error description.

abstract getErrorDescription(code: number): string;

Parameters

code
The error code or warning code reported by the SDK.

Returns

The specific error or warning description.

getExtensionProperty

Gets detailed information on the extensions.

abstract getExtensionProperty(
    provider: string,
    extension: string,
    key: string,
    bufLen: number,
    type?: MediaSourceType
  ): string;

Details

Parameters

provider
The name of the extension provider.
extension
The name of the extension.
key
The key of the extension.
type
Source type of the extension. See MediaSourceType.
bufLen
Maximum length of the JSON string indicating the extension property. The maximum value is 512 bytes.

Returns

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

getNativeHandle

Gets the C++ handle of the Native SDK.

abstract getNativeHandle(): number;

Details

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

Returns

The native handle of the SDK.

getNetworkType

Gets the type of the local network connection.

abstract getNetworkType(): number;

Details

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

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

Returns

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

getVolumeOfEffect

Gets the volume of a specified audio effect file.

abstract getVolumeOfEffect(soundId: number): number;

Parameters

soundId
The ID of the audio effect file.

Returns

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

getVersion

Gets the SDK version.

abstract getVersion(): SDKBuildInfo;

Parameters

Returns

One SDKBuildInfo object.

getUserInfoByUid

Gets the user information by passing in the user ID.

abstract getUserInfoByUid(uid: number): UserInfo;

Details

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

Parameters

uid
The user ID.

Returns

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

getUserInfoByUserAccount

Gets the user information by passing in the user account.

abstract getUserInfoByUserAccount(userAccount: string): UserInfo;

Details

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

Parameters

userAccount
The user account.

Returns

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

isCameraAutoExposureFaceModeSupported

Checks whether the device supports auto exposure.

abstract isCameraAutoExposureFaceModeSupported(): boolean;

Details

Attention:
  • This method applies to iOS only.
  • This method must be called after the camera is successfully enabled, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LocalVideoStreamStateCapturing (1).

Returns

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

isCameraAutoFocusFaceModeSupported

Checks whether the device supports the face auto-focus function.

abstract isCameraAutoFocusFaceModeSupported(): boolean;

Details

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

Returns

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

isCameraExposurePositionSupported

Checks whether the device supports manual exposure.

abstract isCameraExposurePositionSupported(): boolean;

Details

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

Returns

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

isCameraExposureSupported

Queries whether the current camera supports adjusting exposure value.

abstract isCameraExposureSupported(): boolean;

Details

Attention:
  • This method must be called after the camera is successfully enabled, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LocalVideoStreamStateCapturing (1).
  • Before calling setCameraExposureFactor, Agora recoomends that you call this method to query whether the current camera supports adjusting the exposure value.
  • By calling this method, you adjust the exposure value of the currently active camera, that is, the camera specified when calling setCameraCapturerConfiguration.

Returns

  • true: Success.
  • false: Failure.

isCameraFaceDetectSupported

Checks whether the device camera supports face detection.

abstract isCameraFaceDetectSupported(): boolean;
Attention:
  • This method is for Android and iOS only.
  • This method must be called after the camera is successfully enabled, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LocalVideoStreamStateCapturing (1).

Returns

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

isCameraFocusSupported

Check whether the device supports the manual focus function.

abstract isCameraFocusSupported(): boolean;

Details

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

Returns

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

isCameraTorchSupported

Checks whether the device supports camera flash.

abstract isCameraTorchSupported(): boolean;

Details

Attention:
  • This method must be called after the camera is successfully enabled, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LocalVideoStreamStateCapturing (1).
  • The app enables the front camera by default. If your front camera does not support enabling the flash, this method returns false. If you want to check whether the rear camera supports the flash function, call switchCamera before this method.
  • On iPads with system version 15, even if isCameraTorchSupported returns true, you might fail to successfully enable the flash by calling setCameraTorchOn due to system issues.

Returns

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

isCameraZoomSupported

Checks whether the device supports camera zoom.

abstract isCameraZoomSupported(): boolean;

Details

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

Returns

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

isFeatureAvailableOnDevice

Checks whether the device supports the specified advanced feature.

abstract isFeatureAvailableOnDevice(type: FeatureType): boolean;

Details

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

Applicable scenarios

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

Parameters

type
The type of the advanced feature, see FeatureType.

Returns

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

isSpeakerphoneEnabled

Checks whether the speakerphone is enabled.

abstract isSpeakerphoneEnabled(): boolean;

Returns

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

joinChannel

Joins a channel with media options.

abstract joinChannel(
    token: string,
    channelId: string,
    uid: number,
    options: ChannelMediaOptions
  ): number;

Details

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

A successful call of this method triggers the following callbacks:

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

Attention:
  • This method allows users to join only one channel at a time.
  • Ensure that the app ID you use to generate the token is the same app ID that you pass in the initialize method; otherwise, you may fail to join the channel by token.

Parameters

token
The token generated on your server for authentication. See .
Note: If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See Secure authentication with tokens.
channelId
The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters:
  • All lowercase English letters: a to z.
  • All uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
  • Space
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
uid
The user ID. This parameter is used to identify the user in the channel for real-time audio and video interaction. You need to set and manage user IDs yourself, and ensure that each user ID in the same channel is unique. This parameter is a 32-bit unsigned integer. The value range is 1 to 232-1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and returns it in the onJoinChannelSuccess callback. Your application must record and maintain the returned user ID, because the SDK does not do so.
options
The channel media options. See ChannelMediaOptions.

Returns

  • 0: Success.
  • < 0: Failure.
    • -2: The parameter is invalid. For example, the token is invalid, the uid parameter is not set to an integer, or the value of a member in ChannelMediaOptions is invalid. You need to pass in a valid parameter and join the channel again.
    • -3: Failes to initialize the IRtcEngine object. You need to reinitialize the IRtcEngine object.
    • -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
    • -8: The internal state of the IRtcEngine object is wrong. The typical cause is that you call this method to join the channel without calling startEchoTest to stop the test after calling stopEchoTest to start a call loop test. You need to call stopEchoTest before calling this method.
    • -17: The request to join the channel is rejected. The typical cause is that the user is in the channel. Agora recommends that you use the onConnectionStateChanged callback to determine whether the user exists in the channel. Do not call this method to join the channel unless you receive the ConnectionStateDisconnected(1) state.
    • -102: The channel name is invalid. You need to pass in a valid channelname in channelId to rejoin the channel.
    • -121: The user ID is invalid. You need to pass in a valid user ID in uid to rejoin the channel.

joinChannelWithUserAccount

Joins the channel with a user account, and configures whether to automatically subscribe to audio or video streams after joining the channel.

abstract joinChannelWithUserAccount(
    token: string,
    channelId: string,
    userAccount: string,
    options?: ChannelMediaOptions
  ): number;

Details

This method allows a user to join the channel with the user account. After the user successfully joins the channel, the SDK triggers the following callbacks:

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

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

Parameters

token
The token generated on your server for authentication. See .
Note: If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See Secure authentication with tokens.
channelId
The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters:
  • All lowercase English letters: a to z.
  • All uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
  • Space
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
userAccount
The user account. This parameter is used to identify the user in the channel for real-time audio and video engagement. You need to set and manage user accounts yourself and ensure that each user account in the same channel is unique. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as NULL. Supported characters are (89 in total):
  • The 26 lowercase English letters: a to z.
  • The 26 uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
  • Space
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
options
The channel media options. See ChannelMediaOptions.

Returns

  • 0: Success.
  • < 0: Failure.
    • -2: The parameter is invalid. For example, the token is invalid, the uid parameter is not set to an integer, or the value of a member in ChannelMediaOptions is invalid. You need to pass in a valid parameter and join the channel again.
    • -3: Failes to initialize the IRtcEngine object. You need to reinitialize the IRtcEngine object.
    • -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
    • -8: The internal state of the IRtcEngine object is wrong. The typical cause is that you call this method to join the channel without calling startEchoTest to stop the test after calling stopEchoTest to start a call loop test. You need to call stopEchoTest before calling this method.
    • -17: The request to join the channel is rejected. The typical cause is that the user is in the channel. Agora recommends that you use the onConnectionStateChanged callback to determine whether the user exists in the channel. Do not call this method to join the channel unless you receive the ConnectionStateDisconnected(1) state.
    • -102: The channel name is invalid. You need to pass in a valid channelname in channelId to rejoin the channel.
    • -121: The user ID is invalid. You need to pass in a valid user ID in uid to rejoin the channel.

leaveChannel

Sets channel options and leaves the channel.

abstract leaveChannel(options?: LeaveChannelOptions): number;

Details

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

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

Calling this method does not necessarily mean that the user has left the channel. After actually leaving the channel, the local user triggers the onLeaveChannel callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the onUserOffline callback.

Attention:
  • If you call release immediately after calling this method, the SDK does not trigger the onLeaveChannel callback.
  • If you have called joinChannelEx to join multiple channels, calling this method will leave the channels when calling joinChannel and joinChannelEx at the same time.

Parameters

options
The options for leaving the channel. See LeaveChannelOptions.

Returns

  • 0: Success.
  • < 0: Failure.

loadExtensionProvider

Adds an extension to the SDK.

abstract loadExtensionProvider(
    path: string,
    unloadAfterUse?: boolean
  ): number;

Details

Attention: This method is for Android only.

Parameters

path
The extension library path and name. For example: /library/libagora_segmentation_extension.dll.
unloadAfterUse
Whether to uninstall the current extension when you no longer using it:
  • true: Uninstall the extension when the IRtcEngine is destroyed.
  • false: (Rcommended) Do not uninstall the extension until the process terminates.

Returns

  • 0: Success.
  • < 0: Failure.

muteAllRemoteAudioStreams

Stops or resumes subscribing to the audio streams of all remote users.

abstract muteAllRemoteAudioStreams(mute: boolean): number;

Details

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

Attention:
  • Call this method after joining a channel.
  • If you do not want to subscribe the audio streams of remote users before joining a channel, you can set autoSubscribeAudio as false when calling joinChannel.

Parameters

mute
Whether to stop subscribing to the audio streams of all remote users:
  • true: Stops subscribing to the audio streams of all remote users.
  • false: (Default) Subscribes to the audio streams of all remote users by default.

Returns

  • 0: Success.
  • < 0: Failure.

muteAllRemoteVideoStreams

Stops or resumes subscribing to the video streams of all remote users.

abstract muteAllRemoteVideoStreams(mute: boolean): number;

Details

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

Attention:
  • Call this method after joining a channel.
  • If you do not want to subscribe the video streams of remote users before joining a channel, you can call joinChannel and set autoSubscribeVideo as false.

Parameters

mute
Whether to stop subscribing to the video streams of all remote users.
  • true: Stop subscribing to the video streams of all remote users.
  • false: (Default) Subscribe to the audio streams of all remote users by default.

Returns

  • 0: Success.
  • < 0: Failure.

muteLocalAudioStream

Stops or resumes publishing the local audio stream.

abstract muteLocalAudioStream(mute: boolean): number;

Details

Attention: This method does not affect any ongoing audio recording, because it does not disable the audio capture device.

A successful call of this method triggers the onUserMuteAudio and onRemoteAudioStateChanged callbacks on the remote client.

Parameters

mute
Whether to stop publishing the local audio stream:
  • true: Stops publishing the local audio stream.
  • false: (Default) Resumes publishing the local audio stream.

Returns

  • 0: Success.
  • < 0: Failure.

muteLocalVideoStream

Stops or resumes publishing the local video stream.

abstract muteLocalVideoStream(mute: boolean): number;

Details

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

Attention:
  • This method executes faster than the enableLocalVideo(false) method, which controls the sending of the local video stream.
  • This method does not affect any ongoing video recording, because it does not disable the camera.

Parameters

mute
Whether to stop publishing the local video stream.
  • true: Stop publishing the local video stream.
  • false: (Default) Publish the local video stream.

Returns

  • 0: Success.
  • < 0: Failure.

muteRecordingSignal

Whether to mute the recording signal.

abstract muteRecordingSignal(mute: boolean): number;

Parameters

mute
  • true: The media file is muted.
  • false: (Default) Do not mute the recording signal.
Note: If you have already called adjustRecordingSignalVolume to adjust the volume, then when you call this method and set it to true, the SDK will record the current volume and mute it. To restore the previous volume, call this method again and set it to false.

Returns

  • 0: Success.
  • < 0: Failure.

muteRemoteAudioStream

Stops or resumes subscribing to the audio stream of a specified user.

abstract muteRemoteAudioStream(uid: number, mute: boolean): number;

Details

Attention:
  • Call this method after joining a channel.

Parameters

uid
The user ID of the specified user.
mute
Whether to subscribe to the specified remote user's audio stream.
  • true: Stop subscribing to the audio stream of the specified user.
  • false: (Default) Subscribe to the audio stream of the specified user.

Returns

  • 0: Success.
  • < 0: Failure.

muteRemoteVideoStream

Stops or resumes subscribing to the video stream of a specified user.

abstract muteRemoteVideoStream(uid: number, mute: boolean): number;

Details

Attention:
  • Call this method after joining a channel.

Parameters

uid
The user ID of the specified user.
mute
Whether to subscribe to the specified remote user's video stream.
  • true: Stop subscribing to the video streams of the specified user.
  • false: (Default) Subscribe to the video stream of the specified user.

Returns

  • 0: Success.
  • < 0: Failure.

pauseAllChannelMediaRelay

Pauses the media stream relay to all target channels.

abstract pauseAllChannelMediaRelay(): number;

Details

After the cross-channel media stream relay starts, you can call this method to pause relaying media streams to all target channels; after the pause, if you want to resume the relay, call resumeAllChannelMediaRelay.

Attention: Call this method after startOrUpdateChannelMediaRelay.

Returns

  • 0: Success.
  • < 0: Failure.

pauseAllEffects

Pauses all audio effects.

abstract pauseAllEffects(): number;

Returns

  • 0: Success.
  • < 0: Failure.

pauseAudioMixing

Pauses playing and mixing the music file.

abstract pauseAudioMixing(): number;

Details

Call this method after joining a channel.

Returns

  • 0: Success.
  • < 0: Failure.

pauseEffect

Pauses a specified audio effect file.

abstract pauseEffect(soundId: number): number;

Parameters

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

Returns

  • 0: Success.
  • < 0: Failure.

playAllEffects

Plays all audio effect files.

abstract playAllEffects(
    loopCount: number,
    pitch: number,
    pan: number,
    gain: number,
    publish?: boolean
  ): number;

Details

After calling preloadEffect multiple times to preload multiple audio effects into the memory, you can call this method to play all the specified audio effects for all users in the channel.

Parameters

loopCount
The number of times the audio effect loops:
  • -1: Play the audio effect files in an indefinite loop until you call stopEffect or stopAllEffects.
  • 0: Play the audio effect once.
  • 1: Play the audio effect twice.
pitch

The pitch of the audio effect. The value ranges between 0.5 and 2.0. The default value is 1.0 (original pitch). The lower the value, the lower the pitch.

pan
The spatial position of the audio effect. The value ranges between -1.0 and 1.0:
  • -1.0: The audio effect shows on the left.
  • 0: The audio effect shows ahead.
  • 1.0: The audio effect shows on the right.
gain

The volume of the audio effect. The value range is [0, 100]. The default value is 100 (original volume). The smaller the value, the lower the volume.

publish
Whether to publish the audio effect to the remote users:
  • true: Publish the audio effect to the remote users. Both the local user and remote users can hear the audio effect.
  • false: (Default) Do not publish the audio effect to the remote users. Only the local user can hear the audio effect.

Returns

  • 0: Success.
  • < 0: Failure.

playEffect

Plays the specified local or online audio effect file.

abstract playEffect(
    soundId: number,
    filePath: string,
    loopCount: number,
    pitch: number,
    pan: number,
    gain: number,
    publish?: boolean,
    startPos?: number
  ): number;

Details

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

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

Parameters

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

The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example, C:\music\audio.mp4. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. See supported audio formats.

Attention: If you have preloaded an audio effect into memory by calling preloadEffect, ensure that the value of this parameter is the same as that of filePath in preloadEffect.
loopCount
The number of times the audio effect loops.
  • ≥ 0: The number of playback times. For example, 1 means looping one time, which means playing the audio effect two times in total.
  • -1: Play the audio file in an infinite loop.
pitch
The pitch of the audio effect. The value range is 0.5 to 2.0. The default value is 1.0, which means the original pitch. The lower the value, the lower the pitch.
pan
The spatial position of the audio effect. The value ranges between -1.0 and 1.0:
  • -1.0: The audio effect is heard on the left of the user.
  • 0.0: The audio effect is heard in front of the user.
  • 1.0: The audio effect is heard on the right of the user.
gain
The volume of the audio effect. The value range is 0.0 to 100.0. The default value is 100.0, which means the original volume. The smaller the value, the lower the volume.
publish
Whether to publish the audio effect to the remote users:
  • true: Publish the audio effect to the remote users. Both the local user and remote users can hear the audio effect.
  • false: Do not publish the audio effect to the remote users. Only the local user can hear the audio effect.
startPos

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

Returns

  • 0: Success.
  • < 0: Failure.

preloadChannel

Preloads a channel with token, channelId, and uid.

abstract preloadChannel(
    token: string,
    channelId: string,
    uid: number
  ): number;

Details

When audience members need to switch between different channels frequently, calling the method can help shortening the time of joining a channel, thus reducing the time it takes for audience members to hear and see the host. As it may take a while for the SDK to preload a channel, Agora recommends that you call this method as soon as possible after obtaining the channel name and user ID to join a channel.

Note:
  • When calling this method, ensure you set the user role as audience and do not set the audio scenario as AudioScenarioChorus, otherwise, this method does not take effect.
  • You also need to make sure that the channel name, user ID and token passed in for preloading are the same as the values passed in when joinning the channel, otherwise, this method does not take effect.
  • One IRtcEngine instance supports preloading 20 channels at most. When exceeding this limit, the latest 20 preloaded channels take effect.
  • Failing to preload a channel does not mean that you can't join a channel, nor will it increase the time of joining a channel.

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

Parameters

token
The token generated on your server for authentication. See .
When the token for preloading channels expires, you can update the token based on the number of channels you preload.
  • When preloading one channel, calling this method to pass in the new token.
  • When preloading more than one channels:
    • If you use a wildcard token for all preloaded channels, call updatePreloadChannelToken to update the token.
      Note: When generating a wildcard token, ensure the user ID is not set as 0. See Secure authentication with tokens.
    • If you use different tokens to preload different channels, call this method to pass in your user ID, channel name and the new token.
channelId
The channel name that you want to preload. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):
  • All lowercase English letters: a to z.
  • All uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
  • Space
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
uid
The user ID. This parameter is used to identify the user in the channel for real-time audio and video interaction. You need to set and manage user IDs yourself, and ensure that each user ID in the same channel is unique. This parameter is a 32-bit unsigned integer. The value range is 1 to 232-1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and returns it in the onJoinChannelSuccess callback. Your application must record and maintain the returned user ID, because the SDK does not do so.

Returns

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

preloadChannelWithUserAccount

Preloads a channel with token, channelId, and userAccount.

abstract preloadChannelWithUserAccount(
    token: string,
    channelId: string,
    userAccount: string
  ): number;

Details

When audience members need to switch between different channels frequently, calling the method can help shortening the time of joining a channel, thus reducing the time it takes for audience members to hear and see the host. As it may take a while for the SDK to preload a channel, Agora recommends that you call this method as soon as possible after obtaining the channel name and user ID to join a channel.

Note:
  • When calling this method, ensure you set the user role as audience and do not set the audio scenario as AudioScenarioChorus, otherwise, this method does not take effect.
  • You also need to make sure that the User Account, channel ID and token passed in for preloading are the same as the values passed in when joining the channel, otherwise, this method does not take effect.
  • One IRtcEngine instance supports preloading 20 channels at most. When exceeding this limit, the latest 20 preloaded channels take effect.
  • Failing to preload a channel does not mean that you can't join a channel, nor will it increase the time of joining a channel.

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

Parameters

token
The token generated on your server for authentication. See .
When the token for preloading channels expires, you can update the token based on the number of channels you preload.
  • When preloading one channel, calling this method to pass in the new token.
  • When preloading more than one channels:
    • If you use a wildcard token for all preloaded channels, call updatePreloadChannelToken to update the token.
      Note: When generating a wildcard token, ensure the user ID is not set as 0. See Secure authentication with tokens.
    • If you use different tokens to preload different channels, call this method to pass in your user ID, channel name and the new token.
channelId
The channel name that you want to preload. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):
  • All lowercase English letters: a to z.
  • All uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
  • Space
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
userAccount
The user account. This parameter is used to identify the user in the channel for real-time audio and video engagement. You need to set and manage user accounts yourself and ensure that each user account in the same channel is unique. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as NULL. Supported characters are (89 in total):
  • The 26 lowercase English letters: a to z.
  • The 26 uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
  • Space
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

Returns

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

preloadEffect

Preloads a specified audio effect file into the memory.

abstract preloadEffect(
    soundId: number,
    filePath: string,
    startPos?: number
  ): number;

Details

To ensure smooth communication, It is recommended that you limit the size of the audio effect file. You can call this method to preload the audio effect before calling joinChannel.

Attention:

Parameters

soundId
The audio effect ID. The ID of each audio effect file is unique.
filePath
File path:
  • Android: The file path, which needs to be accurate to the file name and suffix. Agora supports URL addresses, absolute paths, or file paths that start with /assets/. You might encounter permission issues if you use an absolute path to access a local file, so Agora recommends using a URI address instead. For example: content://com.android.providers.media.documents/document/audio%3A14441
  • iOS: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example: /var/mobile/Containers/Data/audio.mp4.
startPos
The playback position (ms) of the audio effect file.

Returns

  • 0: Success.
  • < 0: Failure.

rate

Allows a user to rate a call after the call ends.

abstract rate(callId: string, rating: number, description: string): number;

Details

Attention: Ensure that you call this method after leaving a channel.

Parameters

callId
The current call ID. You can get the call ID by calling getCallId.
rating
The rating of the call. The value is between 1 (the lowest score) and 5 (the highest score). If you set a value out of this range, the SDK returns the -2 (ERR_INVALID_ARGUMENT) error.
description
A description of the call. The string length should be less than 800 bytes.

Returns

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

registerAudioEncodedFrameObserver

Registers an encoded audio observer.

abstract registerAudioEncodedFrameObserver(
    config: AudioEncodedFrameObserverConfig,
    observer: IAudioEncodedFrameObserver
  ): number;

Details

Attention:
  • Call this method after joining a channel.
  • You can call this method or startAudioRecording to set the recording type and quality of audio files, but Agora does not recommend using this method and startAudioRecording at the same time. Only the method called later will take effect.

Parameters

config
Observer settings for the encoded audio. See AudioEncodedFrameObserverConfig.
The encoded audio observer. See IAudioEncodedFrameObserver.

Returns

One IAudioEncodedFrameObserver object.

registerAudioSpectrumObserver

Register an audio spectrum observer.

abstract registerAudioSpectrumObserver(
    observer: IAudioSpectrumObserver
  ): number;

Details

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

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

Parameters

observer

The audio spectrum observer. See IAudioSpectrumObserver.

Returns

One IAudioSpectrumObserver object.

registerEventHandler

Adds event handlers

abstract registerEventHandler(eventHandler: IRtcEngineEventHandler): boolean;

Details

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

Parameters

eventHandler
Callback events to be added. See IRtcEngineEventHandler.

Returns

  • true: Success.
  • false: Failure.

unregisterEventHandler

Removes the specified callback handler.

abstract unregisterEventHandler(
                eventHandler: IRtcEngineEventHandler
              ): boolean;

Details

This method removes the specified callback handler. For callback events that you want to listen for only once, call this method to remove the relevant callback handler after you have received them.

Parameters

eventHandler
The callback handler to be deleted. See IRtcEngineEventHandler.

Returns

  • true: Success.
  • false: Failure.

registerLocalUserAccount

Registers a user account.

abstract registerLocalUserAccount(appId: string, userAccount: string): number;

Details

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

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

This method is optional. To join a channel with a user account, you can choose either of the following ways:
  • Call registerLocalUserAccount to create a user account, and then call joinChannelWithUserAccount to join the channel.
  • Call the joinChannelWithUserAccount method to join the channel.

The difference between the two ways is that the time elapsed between calling the registerLocalUserAccount method and joining the channel is shorter than directly calling joinChannelWithUserAccount.

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

Parameters

appId
The App ID of your project on Agora Console.
userAccount
The user account. This parameter is used to identify the user in the channel for real-time audio and video engagement. You need to set and manage user accounts yourself and ensure that each user account in the same channel is unique. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as NULL. Supported characters are as follow(89 in total):
  • The 26 lowercase English letters: a to z.
  • The 26 uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
  • Space
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

Returns

  • 0: Success.
  • < 0: Failure.

registerMediaMetadataObserver

Registers the metadata observer.

abstract registerMediaMetadataObserver(
    observer: IMetadataObserver,
    type: MetadataType
  ): number;

Details

You need to implement the IMetadataObserver class and specify the metadata type in this method. This method enables you to add synchronized metadata in the video stream for more diversified live interactive streaming, such as sending shopping links, digital coupons, and online quizzes.

Attention: Call this method before joinChannel.

Parameters

observer
The metadata observer. See IMetadataObserver.
type

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

Returns

  • 0: Success.
  • < 0: Failure.

release

Releases the IRtcEngine instance.

abstract release(sync?: boolean): void;

Details

This method releases all resources used by the Agora SDK. Use this method for apps in which users occasionally make voice or video calls. When users do not make calls, you can free up resources for other operations.

After a successful method call, you can no longer use any method or callback in the SDK anymore. If you want to use the real-time communication functions again, you must call createAgoraRtcEngine and initialize to create a new IRtcEngine instance.

Attention:
  • This method can be called synchronously. You need to wait for the resource of IRtcEngine to be released before performing other operations (for example, create a new IRtcEngine object). Therefore, Agora recommends calling this method in the child thread to avoid blocking the main thread.
  • Besides, Agora does not recommend you calling release in any callback of the SDK. Otherwise, the SDK cannot release the resources until the callbacks return results, which may result in a deadlock.

Parameters

sync

Whether the method is called synchronously:

  • true: Synchronous call.
  • false: Asynchronous call. Currently this method only supports synchronous calls. Do not set this parameter to this value.

renewToken

Renews the token.

abstract renewToken(token: string): number;

Details

You can call this method to pass a new token to the SDK. A token expires after a certain period of time. In the following two cases, the app should call this method to pass in a new token. Failure to do so will result in the SDK disconnecting from the server.

Parameters

token
The new token.

Returns

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

removeAllListeners

Removes all listeners for the specified event.

removeAllListeners?<EventType extends keyof IMediaEngineEvent>(
      eventType?: EventType
    ): void;

Details

Parameters

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

removeListener

Removes the specified IRtcEngineEvent listener.

removeListener?<EventType extends keyof IRtcEngineEvent>(
      eventType: EventType,
      listener: IRtcEngineEvent[EventType]
    ): void;

Details

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

Parameters

eventType
The name of the target event to listen for. See IRtcEngineEvent.
listener
The callback function for eventType. Must pass in the same function object in addListener. Take removing the listener for onJoinChannelSuccess as an example:
// Create an onJoinChannelSuccess object
const onJoinChannelSuccess = (connection: RtcConnection, elapsed: number) => {};
// Add one onJoinChannelSuccess listener
engine.addListener('onJoinChannelSuccess', onJoinChannelSuccess);
// Remove the onJoinChannelSuccess listener
engine.removeListener('onJoinChannelSuccess', onJoinChannelSuccess);

resumeAllEffects

Resumes playing all audio effect files.

abstract resumeAllEffects(): number;

Returns

  • 0: Success.
  • < 0: Failure.

resumeAudioMixing

Resumes playing and mixing the music file.

abstract resumeAudioMixing(): number;

Details

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

Returns

  • 0: Success.
  • < 0: Failure.

resumeEffect

Resumes playing a specified audio effect.

abstract resumeEffect(soundId: number): number;

Parameters

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

Returns

  • 0: Success.
  • < 0: Failure.

selectAudioTrack

Selects the audio track used during playback.

abstract selectAudioTrack(index: number): number;

Details

After getting the track index of the audio file, you can call this method to specify any track to play. For example, if different tracks of a multi-track file store songs in different languages, you can call this method to set the playback language.

Note:

Parameters

index
The audio track you want to specify. The value range is [0, getAudioTrackCount()].

Returns

  • 0: Success.
  • < 0: Failure.

sendCustomReportMessage

Reports customized messages.

abstract sendCustomReportMessage(
    id: string,
    category: string,
    event: string,
    label: string,
    value: number
  ): number;

Details

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

sendMetaData

Sends media metadata.

abstract sendMetaData(metadata: Metadata, sourceType: VideoSourceType): number;

Details

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

Parameters

metadata
Media metadata. See Metadata.
sourceType
The type of the video source. See VideoSourceType.

Returns

  • 0: Success.
  • < 0: Failure.

sendStreamMessage

Sends data stream messages.

abstract sendStreamMessage(
  streamId: number,
  data: Uint8Array,
  length: number
): number;

Details

Sends data stream messages to all users in a channel. 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 streams simultaneously.

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

Attention:
  • Ensure that you call createDataStream to create a data channel before calling this method.
  • In live streaming scenarios, this method only applies to hosts.

Parameters

streamId
The data stream ID. You can get the data stream ID by calling createDataStream.
data
The message to be sent.
length
The length of the data.

Returns

  • 0: Success.
  • < 0: Failure.

setAdvancedAudioOptions

Sets audio advanced options.

abstract setAdvancedAudioOptions(options: AdvancedAudioOptions): number;

Details

If you have advanced audio processing requirements, such as capturing and sending stereo audio, you can call this method to set advanced audio options.

Attention: Call this method after calling joinChannel, enableAudio and enableLocalAudio.

Parameters

options
The advanced options for audio. See AdvancedAudioOptions.

Returns

  • 0: Success.
  • < 0: Failure.

setAudioEffectParameters

Sets parameters for SDK preset audio effects.

abstract setAudioEffectParameters(
  preset: AudioEffectPreset,
  param1: number,
  param2: number
): number;

Details

Call this method to set the following parameters for the local user who sends an audio stream:
  • 3D voice effect: Sets the cycle period of the 3D voice effect.
  • Pitch correction effect: Sets the basic mode and tonic pitch of the pitch correction effect. Different songs have different modes and tonic pitches. Agora recommends bounding this method with interface elements to enable users to adjust the pitch correction interactively.

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

Attention:

Parameters

preset
The options for SDK preset audio effects:
  • RoomAcoustics3dVoice, 3D voice effect:
    • Call setAudioProfile and set the profile parameter in to AudioProfileMusicStandardStereo(3) or AudioProfileMusicHighQualityStereo(5) before setting this enumerator; otherwise, the enumerator setting does not take effect.
    • If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect.
  • PitchCorrection, Pitch correction effect: To achieve better audio effect quality, Agora recommends setting the profile parameter in setAudioProfile to AudioProfileMusicHighQuality(4) or AudioProfileMusicHighQualityStereo(5) before setting this enumerator.
param1
  • If you set preset to RoomAcoustics3dVoice, param1 sets the cycle period of the 3D voice effect. The value range is [1,60] and the unit is seconds. The default value is 10, indicating that the voice moves around you every 10 seconds.
  • If you set preset to PitchCorrection, param1 indicates the basic mode of the pitch correction effect:
    • 1: (Default) Natural major scale.
    • 2: Natural minor scale.
    • 3: Japanese pentatonic scale.
param2
  • If you set preset to RoomAcoustics3dVoice , you need to set param2 to 0.
  • If you set preset to PitchCorrection, param2 indicates the tonic pitch of the pitch correction effect:
    • 1: A
    • 2: A#
    • 3: B
    • 4: (Default) C
    • 5: C#
    • 6: D
    • 7: D#
    • 8: E
    • 9: F
    • 10: F#
    • 11: G
    • 12: G#

Returns

  • 0: Success.
  • < 0: Failure.

setAudioEffectPreset

Sets an SDK preset audio effect.

abstract setAudioEffectPreset(preset: AudioEffectPreset): number;

Details

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

To get better audio effect quality, Agora recommends setting the scenario parameter of setAudioProfile as AudioScenarioGameStreaming(3) before calling this method.

Attention:
  • You can call this method either before or after joining a channel.
  • Do not set the profile parameter in setAudioProfile to AudioProfileSpeechStandard(1)AudioProfileIot or (6), or the method does not take effect.
  • This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
  • If you call setAudioEffectPreset and set enumerators except for RoomAcoustics3dVoice or PitchCorrection, do not call setAudioEffectParameters; otherwise, setAudioEffectPreset is overridden.
  • After calling setAudioEffectPreset, Agora does not recommend you to call the following methods, otherwise the effect set by setAudioEffectPreset will be overwritten:
  • This method relies on the voice beautifier dynamic library libagora_audio_beauty_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.

Parameters

preset
The options for SDK preset audio effects. See AudioEffectPreset.

Returns

  • 0: Success.
  • < 0: Failure.

setAudioMixingDualMonoMode

Sets the channel mode of the current audio file.

abstract setAudioMixingDualMonoMode(mode: AudioMixingDualMonoMode): number;

Details

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

Attention:

Parameters

mode
The channel mode. See AudioMixingDualMonoMode.

Returns

  • 0: Success.
  • < 0: Failure.

setAudioMixingPitch

Sets the pitch of the local music file.

abstract setAudioMixingPitch(pitch: number): number;

Details

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

Attention: You need to call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying) callback.

Parameters

pitch
Sets the pitch of the local music file by the chromatic scale. The default value is 0, which means keeping the original pitch. The value ranges from -12 to 12, and the pitch value between consecutive values is a chromatic value. The greater the absolute value of this parameter, the higher or lower the pitch of the local music file.

Returns

  • 0: Success.
  • < 0: Failure.

setAudioMixingPosition

Sets the audio mixing position.

abstract setAudioMixingPosition(pos: number): number;

Details

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

Attention: You need to call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying) callback.

Parameters

pos
Integer. The playback position (ms).

Returns

  • 0: Success.
  • < 0: Failure.

setAudioProfile

Sets the audio profile and audio scenario.

abstract setAudioProfile(
    profile: AudioProfileType,
    scenario?: AudioScenarioType
  ): number;

Details

Attention:
  • You can call this method either before or after joining a channel.
  • In scenarios requiring high-quality audio, such as online music tutoring, Agora recommends you set profile as AudioProfileMusicHighQuality(4)and scenario as AudioScenarioGameStreaming(3).

Parameters

profile

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

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

Returns

  • 0: Success.
  • < 0: Failure.

setAudioScenario

Sets audio scenarios.

abstract setAudioScenario(scenario: AudioScenarioType): number;

Details

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

Parameters

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

Returns

  • 0: Success.
  • < 0: Failure.

setBeautyEffectOptions

Sets the image enhancement options.

abstract setBeautyEffectOptions(
    enabled: boolean,
    options: BeautyOptions,
    type?: MediaSourceType
  ): number;

Details

Enables or disables image enhancement, and sets the options.

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

Parameters

enabled
Whether to enable the image enhancement function:
  • true: Enable the image enhancement function.
  • false: (Default) Disable the image enhancement function.
options
The image enhancement options. See BeautyOptions.
type
Type of media source. See MediaSourceType.
Attention: In this method, this parameter supports only the following two settings:
  • The default value is UnknownMediaSource.
  • If you want to use the second camera to capture video, set this parameter to SecondaryCameraSource.

Returns

  • 0: Success.
  • < 0: Failure.
    • -4: The current device does not support this feature. Possible reasons include:
      • The current device capabilities do not meet the requirements for image enhancement. Agora recommends you replace it with a high-performance device.
      • The current device version is lower than Android 5.0 and does not support this feature. Agora recommends you replace the device or upgrade the operating system.

setCameraAutoFocusFaceModeEnabled

Enables the camera auto-face focus function.

abstract setCameraAutoFocusFaceModeEnabled(enabled: boolean): number;

Details

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

Attention:
  • You must call this method after enableVideo. The setting result will take effect after the camera is successfully turned on, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LocalVideoStreamStateCapturing (1).

Parameters

enabled
Whether to enable face autofocus:
  • true: Enable the camera auto-face focus function.
  • false: Disable face autofocus.

Returns

  • 0: Success.
  • < 0: Failure.

setCameraAutoExposureFaceModeEnabled

Sets whether to enable auto exposure.

abstract setCameraAutoExposureFaceModeEnabled(enabled: boolean): number;

Details

Attention:
  • This method applies to iOS only.
  • You must call this method after enableVideo. The setting result will take effect after the camera is successfully turned on, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LocalVideoStreamStateCapturing (1).

Parameters

enabled
Whether to enable auto exposure:
  • true: Enable auto exposure.
  • false: Disable auto exposure.

Returns

  • 0: Success.
  • < 0: Failure.

setCameraCapturerConfiguration

Sets the camera capture configuration.

abstract setCameraCapturerConfiguration(
    config: CameraCapturerConfiguration
  ): number;

Details

Attention:

Parameters

config
The camera capture configuration. See CameraCapturerConfiguration.

Returns

  • 0: Success.
  • < 0: Failure.

setCameraDeviceOrientation

Sets the rotation angle of the captured video.

abstract setCameraDeviceOrientation(
    type: VideoSourceType,
    orientation: VideoOrientation
  ): number;

Details

Attention:
  • You must call this method after enableVideo. The setting result will take effect after the camera is successfully turned on, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LocalVideoStreamStateCapturing (1).
  • When the video capture device does not have the gravity sensing function, you can call this method to manually adjust the rotation angle of the captured video.

Parameters

type
The video source type. See VideoSourceType.
orientation
The clockwise rotation angle. See VideoOrientation.

Returns

  • 0: Success.
  • < 0: Failure.

setCameraExposureFactor

Sets the camera exposure value.

abstract setCameraExposureFactor(factor: number): number;

Details

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

Attention:
  • You must call this method after enableVideo. The setting result will take effect after the camera is successfully turned on, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LocalVideoStreamStateCapturing (1).
  • Before calling this method, Agora recommends calling isCameraExposureSupported to check whether the current camera supports adjusting the exposure value.
  • By calling this method, you adjust the exposure value of the currently active camera, that is, the camera specified when calling setCameraCapturerConfiguration.

Parameters

factor

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

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

Returns

  • 0: Success.
  • < 0: Failure.

setCameraExposurePosition

Sets the camera exposure position.

abstract setCameraExposurePosition(
    positionXinView: number,
    positionYinView: number
  ): number;

Details

Attention:
  • You must call this method after enableVideo. The setting result will take effect after the camera is successfully turned on, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LocalVideoStreamStateCapturing (1).
  • After a successful method call, the SDK triggers the onCameraExposureAreaChanged callback.

Parameters

positionXinView
The horizontal coordinate of the touchpoint in the view.
positionYinView
The vertical coordinate of the touchpoint in the view.

Returns

  • 0: Success.
  • < 0: Failure.

setCameraFocusPositionInPreview

Sets the camera manual focus position.

abstract setCameraFocusPositionInPreview(
    positionX: number,
    positionY: number
  ): number;

Details

Attention:
  • You must call this method after enableVideo. The setting result will take effect after the camera is successfully turned on, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LocalVideoStreamStateCapturing (1).
  • After a successful method call, the SDK triggers the onCameraFocusAreaChanged callback.

Parameters

positionX
The horizontal coordinate of the touchpoint in the view.
positionY
The vertical coordinate of the touchpoint in the view.

Returns

  • 0: Success.
  • < 0: Failure.

setCameraTorchOn

Enables the camera flash.

abstract setCameraTorchOn(isOn: boolean): number;

Details

Attention:
  • This method is for Android and iOS only.
  • You must call this method after enableVideo. The setting result will take effect after the camera is successfully turned on, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LocalVideoStreamStateCapturing (1).

Parameters

isOn
Whether to turn on the camera flash:
  • true: Turn on the flash.
  • false: (Default) Turn off the flash.

Returns

  • 0: Success.
  • < 0: Failure.

setCameraZoomFactor

Sets the camera zoom ratio.

abstract setCameraZoomFactor(factor: number): number;

Details

Attention:
  • You must call this method after enableVideo. The setting result will take effect after the camera is successfully turned on, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LocalVideoStreamStateCapturing (1).

Parameters

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

Returns

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

setChannelProfile

Sets the channel profile.

abstract setChannelProfile(profile: ChannelProfileType): number;

Details

After initializing the SDK, the default channel profile is the live streaming profile. You can call this method to set the channel profile. The Agora SDK differentiates channel profiles and applies optimization algorithms accordingly. For example, it prioritizes smoothness and low latency for a video call and prioritizes video quality for interactive live video streaming.

Attention:
  • To ensure the quality of real-time communication, Agora recommends that all users in a channel use the same channel profile.
  • This method must be called and set before joinChannel, and cannot be set again after joining the channel.
  • The default audio route and video encoding bitrate are different in different channel profiles. See setDefaultAudioRouteToSpeakerphone and setVideoEncoderConfiguration.

Parameters

profile

The channel profile. See ChannelProfileType.

Returns

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

setCloudProxy

Sets up cloud proxy service.

abstract setCloudProxy(proxyType: CloudProxyType): number;

Details

When users' network access is restricted by a firewall, configure the firewall to allow specific IP addresses and ports provided by Agora; then, call this method to enable the cloud proxyType and set the cloud proxy type with the proxyType parameter.

After successfully connecting to the cloud proxy, the SDK triggers the onConnectionStateChanged (ConnectionStateConnecting, ConnectionChangedSettingProxyServer) callback.

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

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

Attention:
  • Agora recommends that you call this method after joining a channel.
  • When a user is behind a firewall and uses the Force UDP cloud proxy, the services for Media Push and cohosting across channels are not available.
  • When you use the Force TCP cloud proxy, note that an error would occur when calling the startAudioMixing method to play online music files in the HTTP protocol. The services for Media Push and cohosting across channels use the cloud proxy with the TCP protocol.

Parameters

proxyType

The type of the cloud proxy. See CloudProxyType.

This parameter is mandatory. The SDK reports an error if you do not pass in a value.

Returns

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

setClientRole

Sets the user role and level in an interactive live streaming channel.

abstract setClientRole(
    role: ClientRoleType,
    options?: ClientRoleOptions
  ): number;

Details

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

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

If you call this method to switch the user role after joining a channel, the SDK automatically does the following:
Attention: This method applies to the interactive live streaming profile (the profile parameter of setChannelProfile is set as ChannelProfileLiveBroadcasting) only.

Parameters

role
The user role in the interactive live streaming. See ClientRoleType.
options
The detailed options of a user, including the user level. See ClientRoleOptions.

Returns

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

setColorEnhanceOptions

Sets color enhancement.

abstract setColorEnhanceOptions(
    enabled: boolean,
    options: ColorEnhanceOptions,
    type?: MediaSourceType
  ): number;

Details

The video images captured by the camera can have color distortion. The color enhancement feature intelligently adjusts video characteristics such as saturation and contrast to enhance the video color richness and color reproduction, making the video more vivid.

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

Attention:
  • Call this method after calling enableVideo.
  • The color enhancement feature has certain performance requirements on devices. With color enhancement turned on, Agora recommends that you change the color enhancement level to one that consumes less performance or turn off color enhancement if your device is experiencing severe heat problems.
  • Both this method and setExtensionProperty can enable color enhancement:
    • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
    • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using setExtensionProperty.
  • This method relies on the image enhancement dynamic library libagora_clear_vision_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.

Parameters

enabled
Whether to enable color enhancement:
  • true Enable color enhancement.
  • false: (Default) Disable color enhancement.
options
The color enhancement options. See ColorEnhanceOptions.
type
The type of the video source. See MediaSourceType.

Returns

  • 0: Success.
  • < 0: Failure.

setDefaultAudioRouteToSpeakerphone

Sets the default audio playback route.

abstract setDefaultAudioRouteToSpeakerphone(
    defaultToSpeaker: boolean
  ): number;

Details

Note:
  • Ensure that you call this method before joining a channel. If you need to change the audio route after joining a channel, call setEnableSpeakerphone.

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

In different scenarios, the default audio routing of the system is also different. See the following:
  • Voice call: Earpiece.
  • Audio broadcast: Speakerphone.
  • Video call: Speakerphone.
  • Video broadcast: Speakerphone.

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

Note:

The system audio route changes when an external audio device, such as a headphone or a Bluetooth audio device, is connected. See Audio Route for detailed change principles.

Parameters

defaultToSpeaker
Whether to set the speakerphone as the default audio route:
  • true: Set the speakerphone as the default audio route.
  • false: Set the earpiece as the default audio route.

Returns

  • 0: Success.
  • < 0: Failure.

setDualStreamMode

Sets dual-stream mode configuration on the sender, and sets the low-quality video stream.

abstract setDualStreamMode(
    mode: SimulcastStreamMode,
    streamConfig?: SimulcastStreamConfig
  ): number;

Details

The SDK enables the low-quality video stream auto mode on the sender side by default (it does not actively sending low-quality video streams). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling setRemoteVideoStreamType. After receiving the application, the sending end automatically switches to the low-quality video stream mode.
  • If you want to modify this behavior, you can call this method and modify the mode to DisableSimulcastStream (never send low-quality video streams) or EnableSimulcastStream (always send low-quality video streams).
  • If you want to restore the default behavior after making changes, you can call this method again with mode set to AutoSimulcastStream.
Note: The difference and connection between this method and enableDualStreamMode is as follows:
  • When calling this method and setting mode to DisableSimulcastStream, it has the same effect as calling and setting enabled to false.
  • When calling this method and setting mode to EnableSimulcastStream, it has the same effect as calling and setting enabled to true.
  • Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.

Parameters

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

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

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

Returns

  • 0: Success.
  • < 0: Failure.

setEarMonitoringAudioFrameParameters

Sets the format of the in-ear monitoring raw audio data.

abstract setEarMonitoringAudioFrameParameters(
    sampleRate: number,
    channel: number,
    mode: RawAudioFrameOpModeType,
    samplesPerCall: number
  ): number;

Details

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

Attention:
  • Before calling this method, you need to call enableInEarMonitoring, and set includeAudioFilters to EarMonitoringFilterBuiltInAudioFilters or EarMonitoringFilterNoiseSuppression.
  • The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method.Sample interval (sec) = samplePerCall/(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the onEarMonitoringAudioFrame callback according to the sampling interval.

Parameters

sampleRate
The sample rate of the audio data reported in the onEarMonitoringAudioFrame callback, which can be set as 8,000, 16,000, 32,000, 44,100, or 48,000 Hz.
channel
The number of audio channels reported in the onEarMonitoringAudioFrame callback.
  • 1: Mono.
  • 2: Stereo.
mode

The use mode of the audio frame. See RawAudioFrameOpModeType.

samplesPerCall
The number of data samples reported in the onEarMonitoringAudioFrame callback, such as 1,024 for the Media Push.

Returns

  • 0: Success.
  • < 0: Failure.

setEffectPosition

Sets the playback position of an audio effect file.

abstract setEffectPosition(soundId: number, pos: number): number;

Details

After a successful setting, the local audio effect file starts playing at the specified position.

Attention: Call this method after playEffect.

Parameters

soundId
The audio effect ID. The ID of each audio effect file is unique.
pos
The playback position (ms) of the audio effect file.

Returns

  • 0: Success.
  • < 0: Failure.

setEffectsVolume

Sets the volume of the audio effects.

abstract setEffectsVolume(volume: number): number;

Details

Attention: Call this method after playEffect.

Parameters

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

Returns

  • 0: Success.
  • < 0: Failure.

setEnableSpeakerphone

Enables/Disables the audio route to the speakerphone.

abstract setEnableSpeakerphone(speakerOn: boolean): number;

Details

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

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

Attention:
  • Call this method after joining a channel.
  • If the user uses an external audio playback device such as a Bluetooth or wired headset, this method does not take effect, and the SDK plays audio through the external device. When the user uses multiple external devices, the SDK plays audio through the last connected device.

Parameters

speakerOn
Sets whether to enable the speakerphone or earpiece:
  • true: Enable device state monitoring. The audio route is the speakerphone.
  • false: Disable device state monitoring. The audio route is the earpiece.

Returns

  • 0: Success.
  • < 0: Failure.

setEncryptionMode

Sets the built-in encryption mode.

abstract setEncryptionMode(encryptionMode: string): number;

Details

Deprecated:
Use enableEncryption instead.

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

Attention: Before calling this method, please call setEncryptionSecret to enable the built-in encryption function.

Parameters

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

Returns

  • 0: Success.
  • < 0: Failure.

setEncryptionSecret

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

abstract setEncryptionSecret(secret: string): number;

Details

Deprecated:
Use enableEncryption instead.

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

Attention:
  • Do not use this method for Media Push.
  • For optimal transmission, ensure that the encrypted data size does not exceed the original data size + 16 bytes. 16 bytes is the maximum padding size for AES encryption.

Parameters

secret
The encryption password.

Returns

  • 0: Success.
  • < 0: Failure.

setExtensionProperty

Sets the properties of the extension.

abstract setExtensionProperty(
    provider: string,
    extension: string,
    key: string,
    value: string,
    type?: MediaSourceType
  ): number;

Details

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

Parameters

provider
The name of the extension provider.
extension
The name of the extension.
key
The key of the extension.
value
The value of the extension key.
type
Type of media source. See MediaSourceType.
Attention: In this method, this parameter supports only the following two settings:
  • The default value is UnknownMediaSource.
  • If you want to use the second camera to capture video, set this parameter to SecondaryCameraSource.

Returns

  • 0: Success.
  • < 0: Failure.

setExtensionProviderProperty

Sets the properties of the extension provider.

abstract setExtensionProviderProperty(
    provider: string,
    key: string,
    value: string
  ): number;

Details

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

Attention:

Call this method after enableExtension, and before enabling the audio (enableAudio/enableLocalAudio) or the video (enableVideo/enableLocalVideo).

Parameters

provider
The name of the extension provider.
key
The key of the extension.
value
The value of the extension key.

Returns

  • 0: Success.
  • < 0: Failure.

setExternalAudioSink

Sets the external audio sink.

abstract setExternalAudioSink(
    enabled: boolean,
    sampleRate: number,
    channels: number
  ): number;

Details

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

Parameters

enabled
Whether to enable or disable the external audio sink:
  • true: Enables the external audio sink.
  • false: (Default) Disables the external audio sink.
sampleRate

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

channels
The number of audio channels of the external audio sink:
  • 1: Mono.
  • 2: Stereo.

Returns

  • 0: Success.
  • < 0: Failure.

setHeadphoneEQPreset

Sets the preset headphone equalization effect.

abstract setHeadphoneEQPreset(preset: HeadphoneEqualizerPreset): number;

Details

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

Note: If the headphones you use already have a good equalization effect, you may not get a significant improvement when you call this method, and could even diminish the experience.

Parameters

preset
The preset headphone equalization effect. See HeadphoneEqualizerPreset.

Returns

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

setHeadphoneEQParameters

Sets the low- and high-frequency parameters of the headphone equalizer.

abstract setHeadphoneEQParameters(lowGain: number, highGain: number): number;

Details

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

Parameters

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

Returns

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

setInEarMonitoringVolume

Sets the volume of the in-ear monitor.

abstract setInEarMonitoringVolume(volume: number): number;

Details

Attention:
  • Users must use wired earphones to hear their own voices.
  • You can call this method either before or after joining a channel.

Parameters

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

Returns

  • 0: Success.
  • < 0: Failure.

setLocalRenderMode

Updates the display mode of the local video view.

abstract setLocalRenderMode(
    renderMode: RenderModeType,
    mirrorMode?: VideoMirrorModeType
  ): number;

Details

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

Attention:
  • During a call, you can call this method as many times as necessary to update the display mode of the local video view.

Parameters

renderMode

The local video display mode. See RenderModeType.

mirrorMode

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

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

Returns

  • 0: Success.
  • < 0: Failure.

setLocalVideoMirrorMode

Sets the local video mirror mode.

abstract setLocalVideoMirrorMode(mirrorMode: VideoMirrorModeType): number;

Details

Deprecated:
This method is deprecated.
Use setLocalRenderMode instead.

Parameters

mirrorMode

The local video mirror mode. See VideoMirrorModeType.

Returns

  • 0: Success.
  • < 0: Failure.

setLocalVoiceEqualization

Sets the local voice equalization effect.

abstract setLocalVoiceEqualization(
    bandFrequency: AudioEqualizationBandFrequency,
    bandGain: number
  ): number;

Details

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

Parameters

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

Returns

  • 0: Success.
  • < 0: Failure.

setLocalVoicePitch

Changes the voice pitch of the local speaker.

abstract setLocalVoicePitch(pitch: number): number;

Details

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

Parameters

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

Returns

  • 0: Success.
  • < 0: Failure.

setLocalVoiceReverb

Sets the local voice reverberation.

abstract setLocalVoiceReverb(
    reverbKey: AudioReverbType,
    value: number
  ): number;

Details

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

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

Parameters

reverbKey
The reverberation key. Agora provides five reverberation keys, see AudioReverbType.
value
The value of the reverberation key.

Returns

  • 0: Success.
  • < 0: Failure.

setLogFile

Sets the log file.

abstract setLogFile(filePath: string): number;

Details

Deprecated:
Use the mLogConfig parameter in initialize method instead.

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

Note:

Ensure that you call initialize immediately after calling the IRtcEngine method, or the output log may not be complete.

Parameters

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

Returns

  • 0: Success.
  • < 0: Failure.

setLogFileSize

Sets the log file size.

abstract setLogFileSize(fileSizeInKBytes: number): number;

Details

Deprecated:
Use the logConfig parameter in initialize instead.

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

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

This method is used to set the size of the agorasdk.log file only and does not effect the agoraapi.log file.

Parameters

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

Returns

  • 0: Success.
  • < 0: Failure.

setLogFilter

Sets the log output level of the SDK.

abstract setLogFilter(filter: LogFilterType): number;

Details

Deprecated:
Use logConfig in initialize instead.

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

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

Parameters

filter

The output log level of the SDK. See LogFilterType.

Returns

  • 0: Success.
  • < 0: Failure.

setLogLevel

Sets the output log level of the SDK.

abstract setLogLevel(level: LogLevel): number;

Details

Deprecated:
This method is deprecated. Use RtcEngineContext instead to set the log output level.

Choose a level to see the logs preceding that level.

Parameters

level
The log level: LogLevel.

Returns

  • 0: Success.
  • < 0: Failure.

setMaxMetadataSize

Sets the maximum size of the media metadata.

abstract setMaxMetadataSize(size: number): number;

Details

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

Parameters

size
The maximum size of media metadata.

Returns

  • 0: Success.
  • < 0: Failure.

setLowlightEnhanceOptions

Sets low-light enhancement.

abstract setLowlightEnhanceOptions(
    enabled: boolean,
    options: LowlightEnhanceOptions,
    type?: MediaSourceType
  ): number;

Details

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

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

Attention:
  • Call this method after calling enableVideo.
  • Dark light enhancement has certain requirements for equipment performance. The low-light enhancement feature has certain performance requirements on devices. If your device overheats after you enable low-light enhancement, Agora recommends modifying the low-light enhancement options to a less performance-consuming level or disabling low-light enhancement entirely.
  • Both this method and setExtensionProperty can turn on low-light enhancement:
    • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
    • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using setExtensionProperty.
  • This method relies on the image enhancement dynamic library libagora_clear_vision_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.

Parameters

enabled
Whether to enable low-light enhancement function:
  • true: Enable low-light enhancement function.
  • false: (Default) Disable low-light enhancement function.
options
The low-light enhancement options. See LowlightEnhanceOptions.
type
The type of the video source. See MediaSourceType.

Returns

  • 0: Success.
  • < 0: Failure.

setMixedAudioFrameParameters

Sets the audio data format reported by onMixedAudioFrame.

abstract setMixedAudioFrameParameters(
    sampleRate: number,
    channel: number,
    samplesPerCall: number
  ): number;

Parameters

sampleRate

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

channel

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

samplesPerCall

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

Note:

The SDK triggers the onMixedAudioFrame callback according to the sample interval. Sampleinterval (sec) = samplePerCall/(sampleRate × channel) Ensure that the value of sample interval more than or equal to 0.01.

Returns

  • 0: Success.
  • < 0: Failure.

setPlaybackAudioFrameBeforeMixingParameters

Sets the audio data format reported by onPlaybackAudioFrameBeforeMixing.

abstract setPlaybackAudioFrameBeforeMixingParameters(
    sampleRate: number,
    channel: number
  ): number;

Parameters

sampleRate

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

channel

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

Returns

  • 0: Success.
  • < 0: Failure.

setPlaybackAudioFrameParameters

Sets the audio data format for playback.

abstract setPlaybackAudioFrameParameters(
    sampleRate: number,
    channel: number,
    mode: RawAudioFrameOpModeType,
    samplesPerCall: number
  ): number;

Details

Sets the data format for the onPlaybackAudioFrame callback.

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

Parameters

sampleRate
The sample rate returned in the onPlaybackAudioFrame callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
channel
The number of channels returned in the onPlaybackAudioFrame callback:
  • 1: Mono.
  • 2: Stereo.
mode

The use mode of the audio frame. See RawAudioFrameOpModeType.

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

Returns

  • 0: Success.
  • < 0: Failure.

setRecordingAudioFrameParameters

Sets the format of the captured raw audio data.

abstract setRecordingAudioFrameParameters(
    sampleRate: number,
    channel: number,
    mode: RawAudioFrameOpModeType,
    samplesPerCall: number
  ): number;

Details

Sets the audio format for the onRecordAudioFrame callback.

Attention:
  • Ensure that you call this method before joining a channel.
  • The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method.Sample interval (sec) = samplePerCall/(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s).

Parameters

sampleRate
The sample rate returned in the onRecordAudioFrame callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
channel
The number of channels returned in the onRecordAudioFrame callback:
  • 1: Mono.
  • 2: Stereo.
mode

The use mode of the audio frame. See RawAudioFrameOpModeType.

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

Returns

  • 0: Success.
  • < 0: Failure.

setParameters

Provides technical preview functionalities or special customizations by configuring the SDK with JSON options.

abstract setParameters(parameters: string): number;

Parameters

parameters
Pointer to the set parameters in a JSON string.

Returns

  • 0: Success.
  • < 0: Failure.

setRemoteDefaultVideoStreamType

Sets the default stream type of subscrption for remote video streams.

abstract setRemoteDefaultVideoStreamType(streamType: VideoStreamType): number;

Details

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 or the low-video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate.

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

By default, the SDK enables the low-quality video stream auto mode on the sending end (it does not actively send the low-quality video stream). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling this method (the call to this method by the audience receiver does not take effect). After receiving the application, the sending end automatically switches to the low-quality video stream mode.

Attention:
  • Call this method before joining a channel. The SDK does not support changing the default subscribed video stream type after joining a channel.
  • If you call both this method and setRemoteVideoStreamType, the SDK applies the settings in the setRemoteVideoStreamType method.

Parameters

streamType

The default video-stream type. See VideoStreamType.

Returns

  • 0: Success.
  • < 0: Failure.

setRemoteUserSpatialAudioParams

Sets the spatial audio effect parameters of the remote user.

abstract setRemoteUserSpatialAudioParams(
    uid: number,
    params: SpatialAudioParams
  ): number;

Details

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

Parameters

uid
The user ID. This parameter must be the same as the user ID passed in when the user joined the channel.
The spatial audio parameters. See SpatialAudioParams.

Returns

  • 0: Success.
  • < 0: Failure.

setRouteInCommunicationMode

Selects the audio playback route in communication audio mode.

abstract setRouteInCommunicationMode(route: number): number;

Details

This method is used to switch the audio route from Bluetooth headphones to earpiece, wired headphones or speakers in communication audio mode (). After the method is called successfully, the SDK will trigger the onAudioRoutingChanged callback to report the modified route.

Attention:

Parameters

route
The audio playback route you want to use:
  • -1: The default audio route.
  • 0: Headphones with microphone.
  • 1: Handset.
  • 2: Headphones without microphone.
  • 3: Device's built-in speaker.
  • 4: (Not supported yet) External speakers.
  • 5: Bluetooth headphones.
  • 6: USB device.

Returns

Without practical meaning.

setRemoteRenderMode

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

abstract setRemoteRenderMode(
    uid: number,
    renderMode: RenderModeType,
    mirrorMode: VideoMirrorModeType
  ): number;

Details

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

Attention:
  • 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
The user ID of the remote user.
renderMode

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

mirrorMode

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

Returns

  • 0: Success.
  • < 0: Failure.

setRemoteVideoStreamType

Sets the stream type of the remote video.

abstract setRemoteVideoStreamType(
    uid: number,
    streamType: VideoStreamType
  ): number;

Details

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 or the low-quality video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate.

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

By default, the SDK enables the low-quality video stream auto mode on the sending end (it does not actively send the low-quality video stream). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling this method (the call to this method by the audience receiver does not take effect). After receiving the application, the sending end automatically switches to the low-quality video stream mode.

Attention: You can call this method either before or after joining a channel. If you call both setRemoteVideoStreamType and setRemoteDefaultVideoStreamType, the setting of setRemoteVideoStreamType takes effect.

Parameters

uid
The user ID.
streamType

The video stream type: VideoStreamType.

Returns

  • 0: Success.
  • < 0: Failure.

setRemoteVideoSubscriptionOptions

Options for subscribing to remote video streams.

abstract setRemoteVideoSubscriptionOptions(
    uid: number,
    options: VideoSubscriptionOptions
  ): number;

Details

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

  • If you only register one IVideoFrameObserver object, the SDK subscribes to the raw video data and encoded video data by default (the effect is equivalent to setting encodedFrameOnly to false).
  • If you only register one IVideoEncodedFrameObserver object, the SDK only subscribes to the encoded video data by default (the effect is equivalent to setting encodedFrameOnly to true).
  • If you register one IVideoFrameObserver object and one IVideoEncodedFrameObserver object successively, the SDK subscribes to the encoded video data by default (the effect is equivalent to setting encodedFrameOnly to false).
  • If you call this method first with the options parameter set, and then register one IVideoFrameObserver or IVideoEncodedFrameObserver object, you need to call this method again and set the options parameter as described in the above two items to get the desired results.
Note: Agora recommends the following steps:
  1. Set autoSubscribeVideo to false when calling joinChannel to join a channel.
  2. Call this method after receiving the onUserJoined callback to set the subscription options for the specified remote user's video stream.
  3. Call the muteRemoteVideoStream method to resume subscribing to the video stream of the specified remote user. If you set encodedFrameOnly to true in the previous step, the SDK triggers the onEncodedVideoFrameReceived callback locally to report the received encoded video frame information.

Parameters

uid
The user ID of the remote user.
options
The video subscription options. See VideoSubscriptionOptions.

Returns

  • 0: Success.
  • < 0: Failure.

setRemoteVoicePosition

Sets the 2D position (the position on the horizontal plane) of the remote user's voice.

abstract setRemoteVoicePosition(
    uid: number,
    pan: number,
    gain: number
  ): number;

Details

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

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

Attention:
  • For this method to work, enable stereo panning for remote users by calling the enableSoundPositionIndication method before joining a channel.
  • For the best voice positioning, Agora recommends using a wired headset.
  • Call this method after joining a channel.

Parameters

uid
The user ID of the remote user.
pan
The voice position of the remote user. The value ranges from -1.0 to 1.0:
  • 0.0: (Default) The remote voice comes from the front.
  • -1.0: The remote voice comes from the left.
  • 1.0: The remote voice comes from the right.
gain
The volume of the remote user. The value ranges from 0.0 to 100.0. The default value is 100.0 (the original volume of the remote user). The smaller the value, the lower the volume.

Returns

  • 0: Success.
  • < 0: Failure.

setScreenCaptureContentHint

Sets the content hint for screen sharing.

abstract setScreenCaptureContentHint(contentHint: VideoContentHint): number;

Details

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

Attention: You can call this method either before or after you start screen sharing.

Parameters

contentHint
The content hint for screen sharing. See VideoContentHint.

Returns

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

setScreenCaptureScenario

Sets the screen sharing scenario.

abstract setScreenCaptureScenario(screenScenario: ScreenScenarioType): number;

Details

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

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

Parameters

screenScenario
The screen sharing scenario. See ScreenScenarioType.

Returns

  • 0: Success.
  • < 0: Failure.

setSubscribeAudioBlocklist

Set the blocklist of subscriptions for audio streams.

abstract setSubscribeAudioBlocklist(
    uidList: number[],
    uidNumber: number
  ): number;

Details

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

Attention:
  • You can call this method either before or after joining a channel.
  • The blocklist is not affected by the setting in muteRemoteAudioStream,muteAllRemoteAudioStreams, and autoSubscribeAudio in ChannelMediaOptions.
  • Once the blocklist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
  • If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.

Parameters

uidList

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

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

uidNumber
The number of users in the user ID list.

Returns

  • 0: Success.
  • < 0: Failure.

setSubscribeAudioAllowlist

Sets the allowlist of subscriptions for audio streams.

abstract setSubscribeAudioAllowlist(
    uidList: number[],
    uidNumber: number
  ): number;

Details

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

Note:
  • You can call this method either before or after joining a channel.
  • The allowlist is not affected by the setting in muteRemoteAudioStream, muteAllRemoteAudioStreams and autoSubscribeAudio in ChannelMediaOptions.
  • Once the allowlist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
  • If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.

Parameters

uidList

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

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

uidNumber
The number of users in the user ID list.

Returns

  • 0: Success.
  • < 0: Failure.

setSubscribeVideoBlocklist

Set the blocklist of subscriptions for video streams.

abstract setSubscribeVideoBlocklist(
    uidList: number[],
    uidNumber: number
  ): number;

Details

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

Note:
  • You can call this method either before or after joining a channel.
  • The blocklist is not affected by the setting in muteRemoteVideoStream, muteAllRemoteVideoStreams and autoSubscribeAudio in ChannelMediaOptions.
  • Once the blocklist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
  • If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.

Parameters

uidList

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

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

uidNumber
The number of users in the user ID list.

Returns

  • 0: Success.
  • < 0: Failure.

setSubscribeVideoAllowlist

Set the allowlist of subscriptions for video streams.

abstract setSubscribeVideoAllowlist(
    uidList: number[],
    uidNumber: number
  ): number;

Details

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

Note:
  • You can call this method either before or after joining a channel.
  • The allowlist is not affected by the setting in muteRemoteVideoStream, muteAllRemoteVideoStreams and autoSubscribeAudio in ChannelMediaOptions.
  • Once the allowlist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
  • If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.

Parameters

uidList

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

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

uidNumber
The number of users in the user ID list.

Returns

  • 0: Success.
  • < 0: Failure.

setVideoDenoiserOptions

Sets video noise reduction.

abstract setVideoDenoiserOptions(
    enabled: boolean,
    options: VideoDenoiserOptions,
    type?: MediaSourceType
  ): number;

Details

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

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

Attention:
  • Call this method after calling enableVideo.
  • Video noise reduction has certain requirements for equipment performance. If your device overheats after you enable video noise reduction, Agora recommends modifying the video noise reduction options to a less performance-consuming level or disabling video noise reduction entirely.
  • Both this method and setExtensionProperty can turn on video noise reduction function:
    • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
    • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using setExtensionProperty.
  • This method relies on the image enhancement dynamic library libagora_clear_vision_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.

Parameters

enabled
Whether to enable video noise reduction:
  • true: Enable video noise reduction.
  • false: (Default) Disable video noise reduction.
options
The video noise reduction options. See VideoDenoiserOptions.
type
The type of the video source. See MediaSourceType.

Returns

  • 0: Success.
  • < 0: Failure.

setVideoEncoderConfiguration

Sets the video encoder configuration.

abstract setVideoEncoderConfiguration(
    config: VideoEncoderConfiguration
  ): number;

Details

Sets the encoder configuration for the local video.

Attention: Call this method before joining a channel. Agora recommends calling this method before enableVideo to reduce the time to render the first video frame.

Parameters

config
Video profile. See VideoEncoderConfiguration.

Returns

  • 0: Success.
  • < 0: Failure.

setVoiceBeautifierParameters

Sets parameters for the preset voice beautifier effects.

abstract setVoiceBeautifierParameters(
  preset: VoiceBeautifierPreset,
  param1: number,
  param2: number
): number;

Details

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

For better voice effects, Agora recommends that you call setAudioProfile and set scenario to AudioScenarioGameStreaming(3) and profile to AudioProfileMusicHighQuality(4) or AudioProfileMusicHighQualityStereo(5) before calling this method.

Attention:

Parameters

preset
The option for the preset audio effect:
  • SINGING_BEAUTIFIER: The singing beautifier effect.
param1
The gender characteristics options for the singing voice:
  • 1: A male-sounding voice.
  • 2: A female-sounding voice.
param2
The reverberation effect options for the singing voice:
  • 1: The reverberation effect sounds like singing in a small room.
  • 2: The reverberation effect sounds like singing in a large room.
  • 3: The reverberation effect sounds like singing in a hall.

Returns

  • 0: Success.
  • < 0: Failure.

setVoiceBeautifierPreset

Sets a preset voice beautifier effect.

abstract setVoiceBeautifierPreset(preset: VoiceBeautifierPreset): number;

Details

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

For better voice effects, Agora recommends that you call setAudioProfile and set scenario to AudioScenarioGameStreaming(3) and profile to AudioProfileMusicHighQuality(4) or AudioProfileMusicHighQualityStereo(5) before calling this method.

Attention:
  • You can call this method either before or after joining a channel.
  • Do not set the profile parameter in setAudioProfile to AudioProfileSpeechStandard(1) or AudioProfileIot(6), or the method does not take effect.
  • This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
  • After calling setVoiceBeautifierPreset, Agora does not recommend calling the following methods, otherwise the effect set by setVoiceBeautifierPreset will be overwritten:
  • This method relies on the voice beautifier dynamic library libagora_audio_beauty_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.

Parameters

preset

The preset voice beautifier effect options: VoiceBeautifierPreset.

Returns

  • 0: Success.
  • < 0: Failure.

setVoiceConversionPreset

Sets a preset voice beautifier effect.

abstract setVoiceConversionPreset(preset: VoiceConversionPreset): number;

Details

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

To achieve better audio effect quality, Agora recommends that you call setAudioProfile and set the profile to AudioProfileMusicHighQuality(4) or AudioProfileMusicHighQualityStereo(5) and scenario to AudioScenarioGameStreaming(3) before calling this method.

Attention:
  • You can call this method either before or after joining a channel.
  • Do not set the profile parameter in setAudioProfile to AudioProfileSpeechStandard(1) or AudioProfileIot(6), or the method does not take effect.
  • This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
  • After calling setVoiceConversionPreset, Agora does not recommend you to call the following methods, otherwise the effect set by setVoiceConversionPreset will be overwritten:
  • This method relies on the voice beautifier dynamic library libagora_audio_beauty_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.

Parameters

preset

The options for the preset voice beautifier effects: VoiceConversionPreset.

Returns

  • 0: Success.
  • < 0: Failure.

setVolumeOfEffect

Sets the volume of a specified audio effect.

abstract setVolumeOfEffect(soundId: number, volume: number): number;

Parameters

soundId
The ID of the audio effect. The ID of each audio effect file is unique.
volume
The playback volume. The value range is [0, 100]. The default value is 100, which represents the original volume.

Returns

  • 0: Success.
  • < 0: Failure.

startAudioMixing

Starts playing the music file.

abstract startAudioMixing(
    filePath: string,
    loopback: boolean,
    cycle: number,
    startPos?: number
  ): number;

Details

This method mixes the specified local or online audio file with the audio from the microphone, or replaces the microphone's audio with the specified local or remote audio file. A successful method call triggers the onAudioMixingStateChanged(AudioMixingStatePlaying) callback. When the audio mixing file playback finishes, the SDK triggers the onAudioMixingStateChanged(AudioMixingStateStopped) callback on the local client.

Attention:
  • You can call this method either before or after joining a channel. If you need to call startAudioMixing multiple times, ensure that the time interval between calling this method is more than 500 ms.
  • If the local music file does not exist, the SDK does not support the file format, or the the SDK cannot access the music file URL, the SDK reports 701.
  • For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support.
  • On Android, there are following considerations:
    • To use this method, ensure that the Android device is v4.2 or later, and the API version is v16 or later.
    • If you need to play an online music file, Agora does not recommend using the redirected URL address. Some Android devices may fail to open a redirected URL address.
    • If you call this method on an emulator, ensure that the music file is in the /sdcard/ directory and the format is MP3.

Parameters

filePath
File path:
  • Android: The file path, which needs to be accurate to the file name and suffix. Agora supports URL addresses, absolute paths, or file paths that start with /assets/. You might encounter permission issues if you use an absolute path to access a local file, so Agora recommends using a URI address instead. For example: content://com.android.providers.media.documents/document/audio%3A14441
  • iOS: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example: /var/mobile/Containers/Data/audio.mp4.
loopback
Whether to only play music files on the local client:
  • true: Only play music files on the local client so that only the local user can hear the music.
  • false: Publish music files to remote clients so that both the local user and remote users can hear the music.
cycle
The number of times the music file plays.
  • ≥ 0: The number of playback times. For example, 0 means that the SDK does not play the music file while 1 means that the SDK plays once.
  • -1: Play the audio file in an infinite loop.
startPos
The playback position (ms) of the music file.

Returns

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

startAudioRecording

Starts audio recording on the client and sets recording configurations.

abstract startAudioRecording(config: AudioRecordingConfiguration): number;

Details

The Agora SDK allows recording during a call. After successfully calling this method, you can record the audio of users in the channel and get an audio recording file. Supported formats of the recording file are as follows:
  • WAV: High-fidelity files with typically larger file sizes. For example, if the sample rate is 32,000 Hz, the file size for 10-minute recording is approximately 73 MB.
  • AAC: Low-fidelity files with typically smaller file sizes. For example, if the sample rate is 32,000 Hz and the recording quality is AudioRecordingQualityMedium, the file size for 10-minute recording is approximately 2 MB.

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

Attention: Call this method after joining a channel.

Parameters

config
Recording configurations. See AudioRecordingConfiguration.

Returns

  • 0: Success.
  • < 0: Failure.

startChannelMediaRelay

Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels.

abstract startChannelMediaRelay(
    configuration: ChannelMediaRelayConfiguration
  ): number;

Details

Deprecated:
This method is deprecated. Use startOrUpdateChannelMediaRelay instead.
After a successful method call, the SDK triggers the onChannelMediaRelayStateChanged and onChannelMediaRelayEvent callbacks, and these callbacks return the state and events of the media stream relay.
  • If the onChannelMediaRelayStateChanged callback returns RelayStateRunning (2) and RelayOk (0), and the onChannelMediaRelayEvent callback returns RelayEventPacketSentToDestChannel (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
  • If the onChannelMediaRelayStateChanged callback returns RelayStateFailure (3), an exception occurs during the media stream relay.
Attention:
  • Call this method after joining the channel.
  • This method takes effect only when you are a host in a live streaming channel.
  • After a successful method call, if you want to call this method again, ensure that you call the stopChannelMediaRelay method to quit the current relay.
  • The relaying media streams across channels function needs to be enabled by contacting technical support.
  • Agora does not support string user accounts in this API.

Parameters

configuration
The configuration of the media stream relay. See ChannelMediaRelayConfiguration.

Returns

  • 0: Success.
  • < 0: Failure.
    • -1: A general error occurs (no specified reason).
    • -2: The parameter is invalid.
    • -7: The method call was rejected. It may be because the SDK has not been initialized successfully, or the user role is not a host.
    • -8: Internal state error. Probably because the user is not a broadcaster.

startLastmileProbeTest

Starts the last mile network probe test.

abstract startLastmileProbeTest(config: LastmileProbeConfig): number;

Details

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

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 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.
This method applies to the following scenarios:
  • Before a user joins a channel, call this method to check the uplink network quality.
  • In a live streaming channel, call this method to check the uplink network quality before an audience member switches to a host.
Attention:
  • Do not call other methods before receiving the onLastmileQuality and onLastmileProbeResult callbacks. Otherwise, the callbacks may be interrupted.
  • A host should not call this method after joining a channel (when in a call).

Parameters

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

Returns

  • 0: Success.
  • < 0: Failure.

startLocalVideoTranscoder

Starts the local video mixing.

abstract startLocalVideoTranscoder(
    config: LocalTranscoderConfiguration
  ): number;

Details

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

Note:
  • Local video mixing requires more CPU resources. Therefore, Agora recommends enabling this function on devices with higher performance.
  • If you need to mix locally captured video streams, the SDK supports the following capture combinations:
    • On Android and iOS platforms, it supports video streams captured by up to 2 cameras (the device itself needs to support dual cameras or supports external cameras) + 1 screen sharing stream.
  • If you need to mix the locally collected video streams, you need to call this method after startCameraCapture or startScreenCapture.
  • If you want to publish the mixed video stream to the channel, you need to set publishTranscodedVideoTrack in ChannelMediaOptions to true when calling joinChannel or updateChannelMediaOptions.

Applicable scenarios

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

The following is a typical use case for implementing the portrait-in-picture effect:
  1. Call enableVirtualBackground, and set the custom background image to BackgroundNone, that is, separate the portrait and the background in the video captured by the camera.
  2. Call startScreenCapture to start capturing the screen sharing video stream.
  3. Call this method and set the video source for capturing portraits as one of the video sources participating in the local video mixing, and the portrait picture-invideo mixing can be added in the mixed image video.
    Note: When configuring the local video mixing, it is necessary to ensure that the layer number of the video stream capturing the portrait is greater than the layer number of the screen sharing stream. Otherwise, the portrait will be covered by the screen sharing and will not be displayed in the final mixed video stream.

Parameters

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

Returns

  • 0: Success.
  • < 0: Failure.

startPreview

Enables the local video preview and specifies the video source for the preview.

abstract startPreview(sourceType?: VideoSourceType): number;

Details

You can call this method to enable local video preview. Call this method after the following:
Attention:
  • The local preview enables the mirror mode by default.
  • After the local video preview is enabled, if you call leaveChannel to exit the channel, the local preview remains until you call stopPreview to disable it.

Parameters

sourceType
The type of the video source. See VideoSourceType.

Returns

  • 0: Success.
  • < 0: Failure.

startRhythmPlayer

Enables the virtual metronome.

abstract startRhythmPlayer(
  sound1: string,
  sound2: string,
  config: AgoraRhythmPlayerConfig
): number;

Details

In music education, physical education and other scenarios, teachers usually need to use a metronome so that students can practice with the correct beat. The meter is composed of a downbeat and upbeats. The first beat of each measure is called a downbeat, and the rest are called upbeats.

In this method, you need to set the file path of the upbeat and downbeat, the number of beats per measure, the beat speed, and whether to send the sound of the metronome to remote users.

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

Attention:
  • After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning, and controls the playback duration of each file according to beatsPerMinute you set in AgoraRhythmPlayerConfig. For example, if you set beatsPerMinute as 60, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration.
  • By default, the sound of the virtual metronome is published in the channel. If you do not want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in ChannelMediaOptions as false.

Parameters

sound1
The absolute path or URL address (including the filename extensions) of the file for the downbeat. For example, C:\music\audio.mp4. For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support.
sound2
The absolute path or URL address (including the filename extensions) of the file for the upbeats. For example, C:\music\audio.mp4. For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support.
config
The metronome configuration. See AgoraRhythmPlayerConfig.

Returns

  • 0: Success.
  • < 0: Failure.
    • -22: Cannot find audio effect files. Please set the correct paths for sound1 and sound2.

startRtmpStreamWithoutTranscoding

Starts pushing media streams to a CDN without transcoding.

abstract startRtmpStreamWithoutTranscoding(url: string): number;

Details

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

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

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

Attention:
  • Call this method after joining a channel.
  • Only hosts in the LIVE_BROADCASTING profile can call this method.
  • If you want to retry pushing streams after a failed push, make sure to call stopRtmpStream first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push.

Parameters

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

Returns

  • 0: Success.
  • < 0: Failure.
    • -2: The URL is null or the string length is 0.
    • -7: The SDK is not initialized before calling this method.
    • -19: The Media Push URL is already in use, use another URL instead.

startRtmpStreamWithTranscoding

Starts Media Push and sets the transcoding configuration.

abstract startRtmpStreamWithTranscoding(
    url: string,
    transcoding: LiveTranscoding
  ): number;

Details

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

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

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

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

Attention:
  • Call this method after joining a channel.
  • Only hosts in the LIVE_BROADCASTING profile can call this method.
  • If you want to retry pushing streams after a failed push, make sure to call stopRtmpStream first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push.

Parameters

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

The transcoding configuration for Media Push. See LiveTranscoding.

Returns

  • 0: Success.
  • < 0: Failure.
    • -2: The URL is null or the string length is 0.
    • -7: The SDK is not initialized before calling this method.
    • -19: The Media Push URL is already in use, use another URL instead.

startScreenCapture

Starts screen capture.

abstract startScreenCapture(captureParams: ScreenCaptureParameters2): number;

Details

Attention:
  • This method applies to Android and iOS only.
  • On the iOS platform, screen sharing is only available on iOS 12.0 and later.
  • The billing for the screen sharing stream is based on the dimensions in ScreenVideoParameters. When you do not pass in a value, Agora bills you at 1280 × 720; when you pass a value in, Agora bills you at that value. For billing details, see Pricing.
  • If you are using the custom audio source instead of the SDK to capture audio, Agora recommends you add the keep-alive processing logic to your application to avoid screen sharing stopping when the application goes to the background.
  • This feature requires high-performance device, and Agora recommends that you use it on iPhone X and later models.
  • This method relies on the iOS screen sharing dynamic library AgoraReplayKitExtension.xcframework. If the dynamic library is deleted, screen sharing cannot be enabled normally.
  • On the Android platform, make sure the user has granted the app screen capture permission.
  • On Android 9 and later, to avoid the application being killed by the system after going to the background, Agora recommends you add the foreground service android.permission.FOREGROUND_SERVICE to the /app/Manifests/AndroidManifest.xml file.
  • Due to performance limitations, screen sharing is not supported on Android TV.
  • Due to system limitations, if you are using Huawei phones, do not adjust the video encoding resolution of the screen sharing stream during the screen sharing, or you could experience crashes.
  • Due to system limitations, some Xiaomi devices do not support capturing system audio during screen sharing.
  • To avoid system audio capture failure when screen sharing, Agora recommends that you set the audio application scenario to AudioScenarioGameStreaming by using the setAudioScenario method before joining the channel.

Parameters

captureParams
The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See ScreenCaptureParameters2.

Returns

  • 0: Success.
  • < 0: Failure.
    • -2: The parameter is null.

stopAllEffects

Stops playing all audio effects.

abstract stopAllEffects(): number;

Returns

  • 0: Success.
  • < 0: Failure.

stopAudioMixing

Stops playing and mixing the music file.

abstract stopAudioMixing(): number;

Details

This method stops the audio mixing. Call this method when you are in a channel.

Returns

  • 0: Success.
  • < 0: Failure.

stopAudioRecording

Stops the audio recording on the client.

abstract stopAudioRecording(): number;

Returns

  • 0: Success.
  • < 0: Failure.

stopChannelMediaRelay

Stops the media stream relay. Once the relay stops, the host quits all the target channels.

abstract stopChannelMediaRelay(): number;

Details

After a successful method call, the SDK triggers the onChannelMediaRelayStateChanged callback. If the callback reports RelayStateIdle (0) and RelayOk (0), the host successfully stops the relay.

Attention: If the method call fails, the SDK triggers the onChannelMediaRelayStateChanged callback with the RelayErrorServerNoResponse (2) or RelayErrorServerConnectionLost (8) status code. You can call the leaveChannel method to leave the channel, and the media stream relay automatically stops.

Returns

  • 0: Success.
  • < 0: Failure.

stopEchoTest

Stops the audio call test.

abstract stopEchoTest(): number;

Returns

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

stopEffect

Stops playing a specified audio effect.

abstract stopEffect(soundId: number): number;

Parameters

soundId
The ID of the audio effect. Each audio effect has a unique ID.

Returns

  • 0: Success.
  • < 0: Failure.

stopLastmileProbeTest

Stops the last mile network probe test.

abstract stopLastmileProbeTest(): number;

Returns

  • 0: Success.
  • < 0: Failure.

stopLocalVideoTranscoder

Stops the local video mixing.

abstract stopLocalVideoTranscoder(): number;

Details

After calling startLocalVideoTranscoder, call this method if you want to stop the local video mixing.

Returns

  • 0: Success.
  • < 0: Failure.

stopPreview

Stops the local video preview.

abstract stopPreview(sourceType?: VideoSourceType): number;

Details

After calling startPreview to start the preview, if you want to close the local video preview, call this method.

Note: Call this method before joining a channel or after leaving a channel.

Parameters

sourceType
The type of the video source. See VideoSourceType.

Returns

  • 0: Success.
  • < 0: Failure.

stopRhythmPlayer

Disables the virtual metronome.

abstract stopRhythmPlayer(): number;

Details

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

Returns

  • 0: Success.
  • < 0: Failure.

stopRtmpStream

Stops pushing media streams to a CDN.

abstract stopRtmpStream(url: string): number;

Details

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

You can call this method to stop the live stream on the specified CDN address. This method can stop pushing media streams to only one CDN address at a time, so if you need to stop pushing streams to multiple addresses, call this method multiple times.

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

Parameters

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

Returns

  • 0: Success.
  • < 0: Failure.

stopScreenCapture

Stops screen capture.

abstract stopScreenCapture(): number;

Returns

  • 0: Success.
  • < 0: Failure.

switchCamera

Switches between front and rear cameras.

abstract switchCamera(): number;

Details

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

Returns

  • 0: Success.
  • < 0: Failure.

takeSnapshot

Takes a snapshot of a video stream.

abstract takeSnapshot(uid: number, filePath: string): number;

Details

This method takes a snapshot of a video stream from the specified user, generates a JPG image, and saves it to the specified path.

The SDK has not taken the snapshot when the method call returns. After a successful method call, the SDK triggers the onSnapshotTaken callback to report whether the snapshot is successfully taken, as well as the details for that snapshot.

Attention:
  • Call this method after joining a channel.
  • When used for local video snapshots, this method takes a snapshot for the video streams specified in ChannelMediaOptions.
  • If the user's video has been preprocessed, for example, watermarked or beautified, the resulting snapshot includes the pre-processing effect.

Parameters

uid
The user ID. Set uid as 0 if you want to take a snapshot of the local user's video.
filePath
The local path (including filename extensions) of the snapshot. For example:
  • iOS: /App Sandbox/Library/Caches/example.jpg
  • Android: /storage/emulated/0/Android/data/<package name>/files/example.jpg
Ensure that the path you specify exists and is writable.

Returns

  • 0: Success.
  • < 0: Failure.

unloadAllEffects

Releases a specified preloaded audio effect from the memory.

abstract unloadAllEffects(): number;

Returns

  • 0: Success.
  • < 0: Failure.

unloadEffect

Releases a specified preloaded audio effect from the memory.

abstract unloadEffect(soundId: number): number;

Parameters

soundId
The ID of the audio effect. Each audio effect has a unique ID.

Returns

  • 0: Success.
  • < 0: Failure.

unregisterAudioSpectrumObserver

Unregisters the audio spectrum observer.

abstract unregisterAudioSpectrumObserver(
    observer: IAudioSpectrumObserver
  ): number;

Details

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

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

Returns

  • 0: Success.
  • < 0: Failure.

unregisterMediaMetadataObserver

Unregisters the specified metadata observer.

abstract unregisterMediaMetadataObserver(
    observer: IMetadataObserver,
    type: MetadataType
  ): number;

Parameters

observer
The metadata observer. See IMetadataObserver.
type

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

Returns

  • 0: Success.
  • < 0: Failure.

updateChannelMediaOptions

Updates the channel media options after joining the channel.

abstract updateChannelMediaOptions(options: ChannelMediaOptions): number;

Parameters

options
The channel media options. See ChannelMediaOptions.

Returns

  • 0: Success.
  • < 0: Failure.
    • -2: The value of a member in the ChannelMediaOptions structure is invalid. For example, the token or the user ID is invalid. You need to fill in a valid parameter.
    • -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
    • -8: The internal state of the IRtcEngine object is wrong. The possible reason is that the user is not in the channel. Agora recommends that you use the onConnectionStateChanged callback to determine whether the user exists in the channel. If you receive the ConnectionStateDisconnected (1) or ConnectionStateFailed (5) state, the user is not in the channel. You need to call joinChannel to join a channel before calling this method.

updateChannelMediaRelay

Updates the channels for media stream relay.

abstract updateChannelMediaRelay(
    configuration: ChannelMediaRelayConfiguration
  ): number;

Details

Deprecated:
This method is deprecated. Use startOrUpdateChannelMediaRelay instead.

After the media relay starts, if you want to relay the media stream to more channels, or leave the current relay channel, you can call this method.

After a successful method call, the SDK triggers the onChannelMediaRelayEvent callback with the RelayEventPacketUpdateDestChannel (7) state code.

Attention: Call the method after successfully calling the startChannelMediaRelay method and receiving onChannelMediaRelayStateChanged(RelayStateRunning, RelayOk); otherwise, the method call fails.

Parameters

configuration
The configuration of the media stream relay. See ChannelMediaRelayConfiguration.

Returns

  • 0: Success.
  • < 0: Failure.

updateLocalTranscoderConfiguration

Updates the local video mixing configuration.

abstract updateLocalTranscoderConfiguration(
    config: LocalTranscoderConfiguration
  ): number;

Details

After calling startLocalVideoTranscoder, call this method if you want to update the local video mixing configuration.

Note: If you want to update the video source type used for local video mixing, such as adding a second camera or screen to capture video, you need to call this method after startCameraCapture or startScreenCapture.

Parameters

config
Configuration of the local video mixing, see LocalTranscoderConfiguration.

Returns

  • 0: Success.
  • < 0: Failure.

updatePreloadChannelToken

Updates the wildcard token for preloading channels.

abstract updatePreloadChannelToken(token: string): number;

Details

You need to maintain the life cycle of the wildcard token by yourself. When the token expires, you need to generate a new wildcard token and then call this method to pass in the new token.

Applicable scenarios

In scenarios involving multiple channels, such as switching between different channels, using a wildcard token means users do not need to apply for a new token every time joinning a new channel, which can save users time for switching channels and reduce the pressure on your token server.

Parameters

token
The new token.

Returns

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

updateRtmpTranscoding

Updates the transcoding configuration.

abstract updateRtmpTranscoding(transcoding: LiveTranscoding): number;

Details

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

After you start pushing media streams to CDN with transcoding, you can dynamically update the transcoding configuration according to the scenario. The SDK triggers the onTranscodingUpdated callback after the transcoding configuration is updated.

Parameters

transcoding

The transcoding configuration for Media Push. See LiveTranscoding.

Returns

  • 0: Success.
  • < 0: Failure.

updateScreenCapture

Updates the screen capturing parameters.

abstract updateScreenCapture(captureParams: ScreenCaptureParameters2): number;

Details

If the system audio is not captured when screen sharing is enabled, and then you want to update the parameter configuration and publish the system audio, you can refer to the following steps:
  1. Call this method, and set captureAudio to true.
  2. Call updateChannelMediaOptions, and set publishScreenCaptureAudio to true to publish the audio captured by the screen.
Attention:
  • This method applies to Android and iOS only.
  • On the iOS platform, screen sharing is only available on iOS 12.0 and later.

Parameters

captureParams
The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See ScreenCaptureParameters2.

Returns

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

updateScreenCaptureParameters

Updates the screen capturing parameters.

abstract updateScreenCaptureParameters(
    captureParams: ScreenCaptureParameters
  ): number;

Details

Attention:
  • Call this method after starting screen sharing or window sharing.

Parameters

captureParams
The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See .

Returns

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

updateScreenCaptureRegion

Updates the screen capturing region.

abstract updateScreenCaptureRegion(regionRect: Rectangle): number;

Details

Attention: Call this method after starting screen sharing or window sharing.

Parameters

Returns

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