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.
- 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.
- 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 startRtmpStreamWithTranscoding 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 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;
Call timing
You need to call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying)
callback.
Restrictions
None.
Parameters
- volume
- The volume of audio mixing for local playback. The value ranges between 0 and 100 (default). 100 represents the original volume.
Returns
- 0: Success.
- < 0: Failure.
adjustAudioMixingPublishVolume
Adjusts the volume of audio mixing for publishing.
abstract adjustAudioMixingPublishVolume(volume: number): number;
This method adjusts the volume of audio mixing for publishing (sending to other users).
Call timing
Call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying)
callback.
Restrictions
None.
Parameters
- volume
- The volume of audio mixing for local playback. The value ranges between 0 and 100 (default). 100 represents the original volume.
Returns
- 0: Success.
- < 0: Failure.
adjustAudioMixingVolume
Adjusts the volume during audio mixing.
abstract adjustAudioMixingVolume(volume: number): number;
This method adjusts the audio mixing volume on both the local client and remote clients.
Call timing
Call this method after startAudioMixing.
Restrictions
None.
Parameters
- volume
- Audio mixing volume. The value ranges between 0 and 100. The default value is 100, which means the original volume.
Returns
- 0: Success.
- < 0: Failure.
adjustCustomAudioPlayoutVolume
Adjusts the volume of the custom audio track played locally.
abstract adjustCustomAudioPlayoutVolume( trackId: number, volume: number ): number;
Details
If you want to change the volume of the audio to be played locally, you need to call this method again.
Parameters
- trackId
- The audio track ID. Set this parameter to the custom audio track ID returned in createCustomAudioTrack.
- volume
- The volume of the audio source. The value can range from 0 to 100. 0 means mute; 100 means the original volume.
Returns
- 0: Success.
- < 0: Failure.
adjustCustomAudioPublishVolume
Adjusts the volume of the custom audio track played remotely.
abstract adjustCustomAudioPublishVolume( trackId: number, volume: number ): number;
Details
If you want to change the volume of the audio played remotely, you need to call this method again.
Parameters
- trackId
- The audio track ID. Set this parameter to the custom audio track ID returned in createCustomAudioTrack.
- volume
- The volume of the audio source. The value can range from 0 to 100. 0 means mute; 100 means the original volume.
Returns
- 0: Success.
- < 0: Failure.
adjustPlaybackSignalVolume
Adjusts the playback signal volume of all remote users.
abstract adjustPlaybackSignalVolume(volume: number): number;
This method is used to adjust the signal volume of all remote users mixed and played locally. If you need to adjust the signal volume of a specified remote user played locally, it is recommended that you call adjustUserPlaybackSignalVolume instead.
Call timing
This method can be called either before or after joining the channel.
Restrictions
None.
Parameters
- volume
-
The volume of the user. The value range is [0,400].
- 0: Mute.
- 100: (Default) The original volume.
- 400: Four times the original volume (amplifying the audio signals by four times).
Returns
- 0: Success.
- < 0: Failure.
adjustLoopbackSignalVolume
Adjusts the volume of the signal captured by the sound card.
abstract adjustLoopbackSignalVolume(volume: number): number;
Details
After calling enableLoopbackRecording to enable loopback audio capturing, you can call this method to adjust the volume of the signal captured by the sound card.
Parameters
- volume
- Audio mixing volume. The value ranges between 0 and 100. The default value is 100, which means the original volume.
Returns
- 0: Success.
- < 0: Failure.
adjustRecordingSignalVolume
Adjusts the capturing signal volume.
abstract adjustRecordingSignalVolume(volume: number): number;
If you only need to mute the audio signal, Agora recommends that you use muteRecordingSignal instead.
Call timing
This method can be called either before or after joining the channel.
Restrictions
None.
Parameters
- volume
-
The volume of the user. The value range is [0,400].
- 0: Mute.
- 100: (Default) The original volume.
- 400: Four times the original volume (amplifying the audio signals by four times).
Returns
- 0: Success.
- < 0: Failure.
adjustUserPlaybackSignalVolume
Adjusts the playback signal volume of a specified remote user.
abstract adjustUserPlaybackSignalVolume(uid: number, volume: number): number;
You can call this method to adjust the playback volume of a specified remote user. To adjust the playback volume of different remote users, call the method as many times, once for each remote user.
Call timing
Call this method after joining a channel.
Restrictions
None.
Parameters
- uid
- The user ID of the remote user.
- volume
-
The volume of the user. The value range is [0,400].
- 0: Mute.
- 100: (Default) The original volume.
- 400: Four times the original volume (amplifying the audio signals by four times).
Returns
- 0: Success.
- < 0: Failure.
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.
- -1: A general error occurs (no specified reason).
- -2: The parameter is invalid.
- -7: The method is called before IRtcEngine is initialized.
initialize
Creates and initializes IRtcEngine.
abstract initialize(context: RtcEngineContext): number;
Call timing
Before calling other APIs, you must call createAgoraRtcEngine and initialize to create and initialize the IRtcEngine object.
Restrictions
The SDK supports creating only one IRtcEngine instance for an app.
Parameters
- context
-
Configurations for the IRtcEngine instance. See RtcEngineContext.
Returns
- 0: Success.
- < 0: Failure.
- -1: A general error occurs (no specified reason).
- -2: The parameter is invalid.
- -7: The SDK is not initialized.
- -22: The resource request failed. The SDK fails to allocate resources because your app consumes too much system resource or the system resources are insufficient.
- -101: The App ID is invalid.
createAgoraRtcEngine
Creates one IRtcEngineEx object.
export function createAgoraRtcEngine(): IRtcEngineEx { return instance; }
Details
Currently, the Agora RTC SDK v4.x supports creating only one IRtcEngineEx object for each app.
Returns
One IRtcEngineEx object.
createDataStream
Creates a data stream.
abstract createDataStream(config: DataStreamConfig): number;
Call timing
You can call this method either before or after joining a channel.
Restrictions
Each user can create up to five data streams during the lifecycle of IRtcEngine. The data stream will be destroyed when leaving the channel, and the data stream needs to be recreated if needed.
Parameters
- config
- The configurations for the data stream. See DataStreamConfig.
Returns
- ID of the created data stream, if the method call succeeds.
- < 0: Failure.
createMediaPlayer
Creates a media player object.
abstract createMediaPlayer(): IMediaPlayer;
Before calling any APIs in the IMediaPlayer class, you need to call this method to create an instance of the media player. If you need to create multiple instances, you can call this method multiple times.
Call timing
You can call this method either before or after joining a channel.
Restrictions
None.
Returns
- An IMediaPlayer object, if the method call succeeds.
- An empty pointer, if the method call fails.
createCustomAudioTrack
Creates a custom audio track.
abstract createCustomAudioTrack( trackType: AudioTrackType, config: AudioTrackConfig ): number;
Details
- Call this method to create a custom audio track and get the audio track ID.
- Call joinChannel to join the channel. In ChannelMediaOptions, set publishCustomAudioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to
true
. - Call pushAudioFrame and specify trackId as the audio track ID set in step 2. You can then publish the corresponding custom audio source in the channel.
Parameters
- trackType
- The type of the custom audio track. See AudioTrackType.Attention: If AudioTrackDirect is specified for this parameter, you must set
publishMicrophoneTrack
tofalse
in ChannelMediaOptions when calling joinChannel to join the channel; otherwise, joining the channel fails and returns the error code -2. - config
- The configuration of the custom audio track. See AudioTrackConfig.
Returns
- If the method call is successful, the audio track ID is returned as the unique identifier of the audio track.
- If the method call fails, 0xffffffff is returned.
createCustomVideoTrack
Creates a custom video track.
abstract createCustomVideoTrack(): number;
Details
- Call this method to create a video track and get the video track ID.
- Call joinChannel to join the channel. In ChannelMediaOptions, set customVideoTrackId to the video track ID that you want to publish, and set publishCustomVideoTrack to
true
. - Call pushVideoFrame and specify videoTrackId as the video track ID set in step 2. You can then publish the corresponding custom video source in the channel.
Returns
- If the method call is successful, the video track ID is returned as the unique identifier of the video track.
- If the method call fails, 0xffffffff is returned.
destroyCustomAudioTrack
Destroys the specified audio track.
abstract destroyCustomAudioTrack(trackId: number): number;
Details
Parameters
- trackId
- The custom audio track ID returned in createCustomAudioTrack.
Returns
- 0: Success.
- < 0: Failure.
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.
destroyRendererByConfig
Destroys multiple video renderer objects at one time.
abstract destroyRendererByConfig(sourceType: VideoSourceType, channelId?: string, uid?: number): void;
Details
Parameters
- sourceType
- The type of the video source. See VideoSourceType.
- channelId
-
The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):
- All lowercase English letters: a to z.
- All uppercase English letters: A to Z.
- All numeric characters: 0 to 9.
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
- uid
- The user ID of the remote user.
destroyRendererByView
Destroys a video renderer object.
abstract destroyRendererByView(view: any): void;
Details
Parameters
- view
- The HTMLElement object to be destroyed.
disableAudio
Disables the audio module.
abstract disableAudio(): number;
The audio module is enabled by default, and you can call this method to disable the audio module.
Call timing
This method can be called either before or after joining the channel. It is still valid after one leaves channel.
Restrictions
- enableLocalAudio: Whether to enable the microphone to create the local audio stream.
- enableLoopbackRecording: Whether to enable loopback audio capturing.
- muteLocalAudioStream: Whether to publish the local audio stream.
- muteRemoteAudioStream: Whether to subscribe and play the remote audio stream.
- muteAllRemoteAudioStreams: Whether to subscribe to and play all remote audio streams.
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.
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;
This method is used to disable the video module.
Call timing
- If it is called before joining the channel, the audio-only mode is enabled.
- If it is called after joining the channel, it switches from video mode to audio-only mode. Then, calling enableVideo can swithch to video mode again.
Restrictions
- This method affects the internal engine and can be called after leaving the channel.
- Calling this method will reset the entire engine, resulting in a slow response time. You can use the following methods to independently control a specific function of the video module based on your actual needs:
- enableLocalVideo: Whether to enable the camera to create the local video stream.
- muteLocalVideoStream: Whether to publish the local video stream.
- muteRemoteVideoStream: Whether to subscribe to and play the remote video stream.
- muteAllRemoteVideoStreams: Whether to subscribe to and play all remote video streams.
Returns
- 0: Success.
- < 0: Failure.
enableAudio
Enables the audio module.
abstract enableAudio(): number;
The audio module is enabled by default After calling disableAudio to disable the audio module, you can call this method to re-enable it.
Call timing
This method can be called either before or after joining the channel. It is still valid after one leaves channel.
Restrictions
- Calling this method will reset the entire engine, resulting in a slow response time. You can use the following methods to independently control a specific function of the audio module based on your actual needs:
- enableLocalAudio: Whether to enable the microphone to create the local audio stream.
- muteLocalAudioStream: Whether to publish the local audio stream.
- muteRemoteAudioStream: Whether to subscribe and play the remote audio stream.
- muteAllRemoteAudioStreams: Whether to subscribe to and play all remote audio streams.
- A successful call of this method resets enableLocalAudio, muteRemoteAudioStream, and muteAllRemoteAudioStreams. Proceed it with caution.
Returns
- 0: Success.
- < 0: Failure.
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.
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;
This method enables the SDK to regularly report the volume information to the app of the local user who sends a stream and remote users (three users at most) whose instantaneous volumes are the highest.
Call timing
This method can be called either before or after joining the channel.
Restrictions
None.
Parameters
- interval
- Sets the time interval between two consecutive volume indications:
- ≤ 0: Disables the volume indication.
- > 0: Time interval (ms) between two consecutive volume indications. Ensure this parameter is set to a value greater than 10, otherwise you will not receive the onAudioVolumeIndication callback. Agora recommends that this value is set as greater than 100.
- smooth
- The smoothing factor that sets the sensitivity of the audio volume indicator. The value ranges between 0 and 10. The recommended value is 3. The greater the value, the more sensitive the indicator.
- reportVad
-
true
: Enables the voice activity detection of the local user. Once it is enabled, the vad parameter of the onAudioVolumeIndication callback reports the voice activity status of the local user.false
: (Default) Disables the voice activity detection of the local user. Once it is disabled, the vad parameter of the onAudioVolumeIndication callback does not report the voice activity status of the local user, except for the scenario where the engine automatically detects the voice activity of the local user.
Returns
- 0: Success.
- < 0: Failure.
enableCameraCenterStage
Enables or disables portrait center stage.
abstract enableCameraCenterStage(enabled: boolean): number;
The portrait center stage feature is off by default. You need to call this method to turn it on. If you need to disable this feature, you need to call this method again and set enabled to false
.
Applicable scenarios
The portrait center stage feature can be widely used in scenarios such as online meetings, shows, online education, etc. The host can use this feature to ensure that they are always in the center of the screen, whether they move or not, in order to achieve a good display effect.
Call timing
This method must be called after the camera is successfully enabled, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LocalVideoStreamStateCapturing (1).
Restrictions
- iPad:
- 12.9-inch iPad Pro (5th generation)
- 11-inch iPad Pro (3rd generation)
- iPad (9th generation)
- iPad mini (6th generation)
- iPad Air (5th generation)
- 2020 M1 MacBook Pro 13-inch + iPhone 11 (using iPhone as external camera for the MacBook)
Agora recommends that you call isCameraCenterStageSupported to check whether the current device supports portrait center stage before enabling this feature.
Parameters
- enabled
- Whether to enable the portrait center stage:
true
: Enable portrait center stage.false
: Disable portrait center stage.
Returns
- 0: Success.
- < 0: Failure.
enableContentInspect
Enables or disables video screenshot and upload.
abstract enableContentInspect( enabled: boolean, config: ContentInspectConfig ): number;
When video screenshot and upload function is enabled, the SDK takes screenshots and uploads videos sent by local users based on the type and frequency of the module you set in ContentInspectConfig. After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.
Call timing
This method can be called either before or after joining the channel.
Restrictions
Before calling this method, ensure that you have contacted technical support to activate the video screenshot upload service.
Parameters
- enabled
- Whether to enalbe video screenshot and upload:
true
: Enables video screenshot and upload.false
: Disables video screenshot and upload.
- config
- Screenshot and upload configuration. See ContentInspectConfig.Note: When the video moderation module is set to video moderation via Agora self-developed extension(ContentInspectSupervision), the video screenshot and upload dynamic library
libagora_content_inspect_extension.dll
is required. Deleting this library disables the screenshot and upload feature.
Returns
- 0: Success.
- < 0: Failure.
enableCustomAudioLocalPlayback
Sets whether to enable the local playback of external audio source.
abstract enableCustomAudioLocalPlayback( trackId: number, enabled: boolean ): number;
Details
After calling this method to enable the local playback of external audio source, if you need to stop local playback, you can call this method again and set enabled to false
.
You can call adjustCustomAudioPlayoutVolume to adjust the local playback volume of the custom audio track.
Parameters
- trackId
- The audio track ID. Set this parameter to the custom audio track ID returned in createCustomAudioTrack.
- enabled
- Whether to play the external audio source:
true
: Play the external audio source.false
: (Default) Do not play the external source.
Returns
- 0: Success.
- < 0: Failure.
enableDualStreamMode
Sets the dual-stream mode on the sender side and 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.
- 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.
- 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.Note: When setting mode to DisableSimulcastStream, setting streamConfig will not take effect.
Returns
- 0: Success.
- < 0: Failure.
enableEncryption
Enables or disables the built-in encryption.
abstract enableEncryption(enabled: boolean, config: EncryptionConfig): number;
After the user leaves the channel, the SDK automatically disables the built-in encryption. To enable the built-in encryption, call this method before the user joins the channel again.
Applicable scenarios
Scenarios with higher security requirements.
Call timing
Call this method before joining a channel.
Restrictions
- All users within the same channel must set the same encryption configurations when calling this method.
- If you enable the built-in encryption, you cannot use the Media Push function.
Parameters
- enabled
-
Whether to enable built-in encryption:
- true: Enable the built-in encryption.
- false: (Default) Disable the built-in encryption.
- config
- Built-in encryption configurations. See EncryptionConfig.
Returns
- 0: Success.
- < 0: Failure.
- -2: An invalid parameter is used. Set the parameter with a valid value.
- -4: The built-in encryption mode is incorrect or the SDK fails to load the external encryption library. Check the enumeration or reload the external encryption library.
- -7: The SDK is not initialized. Initialize the IRtcEngine instance before calling this method.
enableExtension
Enables or disables extensions.
abstract enableExtension( provider: string, extension: string, enable?: boolean, type?: MediaSourceType ): number;
Call timing
Agora recommends that you call this method after joining a channel.
Restrictions
- If you want to enable multiple extensions, you need to call this method multiple times.
- After a successful call of this method, you cannot load other extensions.
Parameters
- provider
- The name of the extension provider.
- extension
- The name of the extension.
- enable
-
Whether to enable the extension:
true
: Enable the extension.false
: Disable the extension.
- type
- Source type of the extension. See MediaSourceType.
Returns
- 0: Success.
- < 0: Failure.
- -3: The extension library is not loaded. Agora recommends that you check the storage location or the name of the dynamic library.
enableInEarMonitoring
Enables in-ear monitoring.
abstract enableInEarMonitoring( enabled: boolean, includeAudioFilters: EarMonitoringFilterType ): number;
This method enables or disables in-ear monitoring.
Call timing
This method can be called either before or after joining the channel.
Restrictions
Users must use earphones (wired or Bluetooth) to hear the in-ear monitoring effect.
Parameters
- enabled
- Enables or disables in-ear monitoring.
true
: Enables in-ear monitoring.false
: (Default) Disables in-ear monitoring.
- includeAudioFilters
- The audio filter types of in-ear monitoring. See EarMonitoringFilterType.
Returns
- 0: Success.
- < 0: Failure.
- - 8: Make sure the current audio routing is Bluetooth or headset.
enableLocalAudio
Enables or disables the local audio capture.
abstract enableLocalAudio(enabled: boolean): number;
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.
- 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 without affecting the audio capture status.
Applicable scenarios
This method does not affect receiving the remote audio streams, and enableLocalAudio(false)
is applicable to scenarios where the user wants to receive remote audio streams without sending any audio stream to other users in the channel.
Call timing
You can call this method either before or after joining a channel. Calling it before joining a channel only sets the device state, and it takes effect immediately after you join the channel.
Restrictions
None.
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.
If you call enableLocalVideo(false
) to disable local video capture within the channel, it also simultaneously stops publishing the video stream within the channel. If you want to restart video catpure, you can call enableLocalVideo(true
) and then call updateChannelMediaOptions to set the options parameter to publish the locally captured video stream in the channel.
After the local video capturer is successfully disabled or re-enabled, the SDK triggers the onRemoteVideoStateChanged callback on the remote client.
- 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 tofalse
, this method does not require a local camera.
Returns
- 0: Success.
- < 0: Failure.
enableLoopbackRecording
Enables loopback audio capturing.
abstract enableLoopbackRecording( enabled: boolean, deviceName?: string ): number;
Details
If you enable loopback audio capturing, the output of the sound card is mixed into the audio stream sent to the other end.
- macOS does not support loopback audio capture of the default sound card. If you need to use this function, use a virtual sound card and pass its name to the deviceName parameter. Agora recommends using AgoraALD as the virtual sound card for audio capturing.
- You can call this method either before or after joining a channel.
- If you call the disableAudio method to disable the audio module, audio capturing will be disabled as well. If you need to enable audio capturing, call the enableAudio method to enable the audio module and then call the enableLoopbackRecording method.
Parameters
- enabled
- Sets whether to enable loopback audio capturing.
true
: Enable loopback audio capturing.false
: (Default) Disable loopback audio capturing.
- deviceName
-
- macOS: The device name of the virtual sound card. The default value is set to NULL, which means using AgoraALD for loopback audio capturing.
- Windows: The device name of the sound card. The default is set to NULL, which means the SDK uses the sound card of your device for loopback audio capturing.
Returns
- 0: Success.
- < 0: Failure.
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.
- 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;
The video module is disabled by default, call this method to enable it. If you need to disable the video module later, you need to call disableVideo.
Call timing
- If called before joining a channel, it enables the video module.
- If called during an audio-only call, the audio call automatically switches to a video call.
Restrictions
- This method enables the internal engine and is valid after leaving the channel.
- Calling this method will reset the entire engine, resulting in a slow response time. You can use the following methods to independently control a specific function of the video module based on your actual needs:
- enableLocalVideo: Whether to enable the camera to create the local video stream.
- muteLocalVideoStream: Whether to publish the local video stream.
- muteRemoteVideoStream: Whether to subscribe to and play the remote video stream.
- muteAllRemoteVideoStreams: Whether to subscribe to and play all remote video streams.
- A successful call of this method resets enableLocalVideo, muteRemoteVideoStream, and muteAllRemoteVideoStreams. Proceed it with caution.
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;
When publishing video streams, you can call this method to replace the current video feeds with custom images.
Once you enable this function, you can select images to replace the video feeds through the ImageTrackOptions parameter. If you disable this function, the remote users see the video feeds that you publish.
Call timing
Call this method after joining a channel.
Restrictions
None.
Parameters
- enable
- Whether to replace the current video feeds with custom images:
true
: Replace the current video feeds with custom images.false
: (Default) Do not replace the current video feeds with custom images.
- options
- Image configurations. See ImageTrackOptions.
Returns
- 0: Success.
- < 0: Failure.
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 after calling enableVideo or startPreview.
- 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:
- Devices with an i5 CPU and better
- 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.
enableVoiceAITuner
Enables or disables the voice AI tuner.
abstract enableVoiceAITuner(enabled: boolean, type: VoiceAiTunerType): number;
The voice AI tuner supports enhancing sound quality and adjusting tone style.
Applicable scenarios
Social entertainment scenes including online KTV, online podcast and live streaming in showrooms, where high sound quality is required.
Call timing
This method can be called either before or after joining the channel.
Restrictions
None.
Parameters
- enabled
- Whether to enable the voice AI tuner:
true
: Enables the voice AI tuner.false
: (Default) Disable the voice AI tuner.
- type
- Voice AI tuner sound types, see VoiceAiTunerType.
Returns
- 0: Success.
- < 0: Failure.
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.
getAudioDeviceManager
Gets the IAudioDeviceManager object to manage audio devices.
abstract getAudioDeviceManager(): IAudioDeviceManager;
Returns
One IAudioDeviceManager object.
getVideoDeviceManager
Gets the IVideoDeviceManager object to manage video devices.
abstract getVideoDeviceManager(): IVideoDeviceManager;
Returns
One IVideoDeviceManager object.
getAudioMixingCurrentPosition
Retrieves the playback position (ms) of the music file.
abstract getAudioMixingCurrentPosition(): number;
Details
Retrieves the playback position (ms) of the audio.
- 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;
Retrieves the total duration (ms) of the audio.
Call timing
Call this method after startAudioMixing and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying)
callback.
Restrictions
None.
Returns
- ≥ 0: The audio mixing duration, if this method call succeeds.
- < 0: Failure.
getAudioMixingPlayoutVolume
Retrieves the audio mixing volume for local playback.
abstract getAudioMixingPlayoutVolume(): number;
You can call this method to get the local playback volume of the mixed audio file, which helps in troubleshooting volume‑related issues.
Call timing
Call this method after startAudioMixing and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying)
callback.
Restrictions
None.
Returns
- ≥ 0: The audio mixing volume, if this method call succeeds. The value range is [0,100].
- < 0: Failure.
getAudioMixingPublishVolume
Retrieves the audio mixing volume for publishing.
abstract getAudioMixingPublishVolume(): number;
Details
This method helps troubleshoot audio volume‑related issues.
(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
- 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;
When a user joins a channel on a client, a callId is generated to identify the call from the client. You can call this method to get the callId parameter, and pass it in when calling methods such as rate and complain.
Call timing
Call this method after joining a channel.
Restrictions
None.
Parameters
- callId
- Output parameter, the current call ID.
Returns
- The current call ID, if the method succeeds.
- An empty string, if the method call fails.
getConnectionState
Gets the current connection state of the SDK.
abstract getConnectionState(): ConnectionStateType;
Call timing
This method can be called either before or after joining the channel.
Restrictions
None.
Returns
The current connection state. See ConnectionStateType.
getCurrentMonotonicTimeInMs
Gets the current Monotonic Time of the SDK.
abstract getCurrentMonotonicTimeInMs(): number;
Monotonic Time refers to a monotonically increasing time series whose value increases over time. The unit is milliseconds.
In custom video capture and custom audio capture scenarios, in order to ensure audio and video synchronization, Agora recommends that you call this method to obtain the current Monotonic Time of the SDK, and then pass this value into the timestamp parameter in the captured video frame (VideoFrame) and audio frame (AudioFrame).
Call timing
This method can be called either before or after joining the channel.
Restrictions
None.
Returns
- ≥0: The method call is successful, and returns the current Monotonic Time of the SDK (in milliseconds).
- < 0: Failure.
getEffectCurrentPosition
Retrieves the playback position of the audio effect file.
abstract getEffectCurrentPosition(soundId: number): number;
Details
Parameters
- soundId
- The audio effect ID. The ID of each audio effect file is unique.
Returns
- The playback position (ms) of the specified audio effect file, if the method call succeeds.
- < 0: Failure.
getEffectDuration
Retrieves the duration of the audio effect file.
abstract getEffectDuration(filePath: string): number;
Details
Parameters
- filePath
- File path:
- Windows: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example
: C:\music\audio.mp4
. - macOS: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example:
/var/mobile/Containers/Data/audio.mp4
.
- Windows: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example
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.
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;
Call timing
This method can be called either before or after joining the channel.
Restrictions
None.
Parameters
- provider
- The name of the extension provider.
- extension
- The name of the extension.
- key
- The key of the extension.
- type
- Source type of the extension. See MediaSourceType.
- bufLen
- Maximum length of the JSON string indicating the extension property. The maximum value is 512 bytes.
Returns
- The extension information, if the method call succeeds.
- An empty string, if the method call fails.
getLocalSpatialAudioEngine
Gets one ILocalSpatialAudioEngine object.
abstract getLocalSpatialAudioEngine(): ILocalSpatialAudioEngine;
Details
Returns
One ILocalSpatialAudioEngine object.
getMediaEngine
Gets one IMediaEngine object.
abstract getMediaEngine(): IMediaEngine;
Details
Returns
One IMediaEngine object.
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.
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.
getNtpWallTimeInMs
Gets the current NTP (Network Time Protocol) time.
abstract getNtpWallTimeInMs(): number;
Details
In the real-time chorus scenario, especially when the downlink connections are inconsistent due to network issues among multiple receiving ends, you can call this method to obtain the current NTP time as the reference time, in order to align the lyrics and music of multiple receiving ends and achieve chorus synchronization.
Returns
The Unix timestamp (ms) of the current NTP time.
getScreenCaptureSources
Gets a list of shareable screens and windows.
abstract getScreenCaptureSources( thumbSize: Size, iconSize: Size, includeScreen: boolean ): ScreenCaptureSourceInfo[];
Details
You can call this method before sharing a screen or window to get a list of shareable screens and windows, which enables a user to use thumbnails in the list to easily choose a particular screen or window to share. This list also contains important information such as window ID and screen ID, with which you can call startScreenCaptureByWindowId or startScreenCaptureByDisplayId to start the sharing.
Parameters
- thumbSize
- The target size of the screen or window thumbnail (the width and height are in pixels). The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and thumbSize is 100 × 100, the actual size of the thumbnail is 100 × 75. If the target size is larger than the original size, the thumbnail is the original image and the SDK does not scale it.
- iconSize
- The target size of the icon corresponding to the application program (the width and height are in pixels). The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and iconSize is 100 × 100, the actual size of the icon is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it.
- includeScreen
- Whether the SDK returns the screen information in addition to the window information:
true
: The SDK returns screen and window information.false
: The SDK returns window information only.
Returns
The ScreenCaptureSourceInfo array.
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;
After a remote user joins the channel, the SDK gets the UID and user account of the remote user, caches them in a mapping table object, and triggers the onUserInfoUpdated callback on the local client. After receiving the callback, you can call this method and passi in the UID.to get the user account of the specified user from the UserInfo object.
Call timing
Call this method after receiving the onUserInfoUpdated callback.
Restrictions
None.
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;
After a remote user joins the channel, the SDK gets the UID and user account of the remote user, caches them in a mapping table object, and triggers the onUserInfoUpdated callback on the local client. After receiving the callback, you can call this method and pass in the user account to get the UID of the remote user from the UserInfo object.
Call timing
Call this method after receiving the onUserInfoUpdated callback.
Restrictions
None.
Parameters
- userAccount
- The user account.
Returns
- A pointer to the UserInfo instance, if the method call succeeds.
- If the call fails, returns null.
isCameraCenterStageSupported
Check if the camera supports portrait center stage.
abstract isCameraCenterStageSupported(): boolean;
Before calling enableCameraCenterStage to enable portrait center stage, it is recommended to call this method to check if the current device supports the feature.
Call timing
This method must be called after the camera is successfully enabled, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LocalVideoStreamStateCapturing (1).
Restrictions
None.
Returns
true
: The current camera supports the portrait center stage.false
: The current camera supports the portrait center stage.
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.
joinChannel
Joins a channel with media options.
abstract joinChannel( token: string, channelId: string, uid: number, options: ChannelMediaOptions ): number;
This method supports setting the media options when joining a channel, such as whether to publish audio and video streams within the channel. or whether to automatically subscribe to the audio and video streams of all remote users when joining a channel. By default, the user subscribes to the audio and video streams of all the other users in the channel, giving rise to usage and billings. To stop subscribing to other streams, set the options parameter or call the corresponding mute methods.
Call timing
Call this method after initialize.
Restrictions
- This method only supports users joining one channel at a time.
- Users with different App IDs cannot call each other.
- Before joining a channel, ensure that the App ID you use to generate a token is the same as that you pass in the initialize method; otherwise, you may fail to join the channel with the token.
Parameters
- token
- The token generated on your server for authentication. See .Note:
- (Recommended) If your project has enabled the security mode (using APP ID and Token for authentication), this parameter is required.
- If you have only enabled the testing mode (using APP ID for authentication), this parameter is optional. You will automatically exit the channel 24 hours after successfully joining in.
- If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See Secure authentication with tokens.
- channelId
-
The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):
- All lowercase English letters: a to z.
- All uppercase English letters: A to Z.
- All numeric characters: 0 to 9.
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
- uid
- The user ID. This parameter is used to identify the user in the channel for real-time audio and video interaction. You need to set and manage user IDs yourself, and ensure that each user ID in the same channel is unique. This parameter is a 32-bit unsigned integer. The value range is 1 to 232-1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and onJoinChannelSuccess returns it in the callback. Your application must record and maintain the returned user ID, because the SDK does not do so.
- options
- The channel media options. See ChannelMediaOptions.
Returns
- 0: Success.
- < 0: Failure.
- -2: The parameter is invalid. For example, the token is invalid, the uid parameter is not set to an integer, or the value of a member in ChannelMediaOptions is invalid. You need to pass in a valid parameter and join the channel again.
- -3: Fails to initialize the IRtcEngine object. You need to reinitialize the IRtcEngine object.
- -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
- -8: The internal state of the IRtcEngine object is wrong. The typical cause is that after calling startEchoTest to start a call loop test, you call this method to join the channel without calling stopEchoTest to stop the test. You need to call stopEchoTest before calling this method.
- -17: The request to join the channel is rejected. The typical cause is that the user is already in the channel. Agora recommends that you use the onConnectionStateChanged callback to see whether the user is in the channel. Do not call this method to join the channel unless you receive the ConnectionStateDisconnected(1) state.
- -102: The channel name is invalid. You need to pass in a valid channel name in channelId to rejoin the channel.
- -121: The user ID is invalid. You need to pass in a valid user ID in uid to rejoin the channel.
joinChannelWithUserAccount
Join a channel using a user account and token, and set the media options.
abstract joinChannelWithUserAccount( token: string, channelId: string, userAccount: string, options?: ChannelMediaOptions ): number;
Before calling this method, if you have not called registerLocalUserAccount to register a user account, when you call this method to join a channel, the SDK automatically creates a user account for you. Calling the registerLocalUserAccount method to register a user account, and then calling this method to join a channel can shorten the time it takes to enter the channel.
Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billings. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.
Call timing
Call this method after initialize.
Restrictions
- This method only supports users joining one channel at a time.
- Users with different App IDs cannot call each other.
- Before joining a channel, ensure that the App ID you use to generate a token is the same as that you pass in the initialize method; otherwise, you may fail to join the channel with the token.
Parameters
- token
- The token generated on your server for authentication. See .Note:
- (Recommended) If your project has enabled the security mode (using APP ID and Token for authentication), this parameter is required.
- If you have only enabled the testing mode (using APP ID for authentication), this parameter is optional. You will automatically exit the channel 24 hours after successfully joining in.
- If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See Secure authentication with tokens.
- channelId
-
The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):
- All lowercase English letters: a to z.
- All uppercase English letters: A to Z.
- All numeric characters: 0 to 9.
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
- userAccount
-
The user account. This parameter is used to identify the user in the channel for real-time audio and video engagement. You need to set and manage user accounts yourself and ensure that each user account in the same channel is unique. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as null. Supported characters are as follows(89 in total):
- The 26 lowercase English letters: a to z.
- The 26 uppercase English letters: A to Z.
- All numeric characters: 0 to 9.
- Space
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
- options
- The channel media options. See ChannelMediaOptions.
Returns
- 0: Success.
- < 0: Failure.
- -2: The parameter is invalid. For example, the token is invalid, the uid parameter is not set to an integer, or the value of a member in ChannelMediaOptions is invalid. You need to pass in a valid parameter and join the channel again.
- -3: Fails to initialize the IRtcEngine object. You need to reinitialize the IRtcEngine object.
- -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
- -8: The internal state of the IRtcEngine object is wrong. The typical cause is that after calling startEchoTest to start a call loop test, you call this method to join the channel without calling stopEchoTest to stop the test. You need to call stopEchoTest before calling this method.
- -17: The request to join the channel is rejected. The typical cause is that the user is already in the channel. Agora recommends that you use the onConnectionStateChanged callback to see whether the user is in the channel. Do not call this method to join the channel unless you receive the ConnectionStateDisconnected(1) state.
- -102: The channel name is invalid. You need to pass in a valid channel name in channelId to rejoin the channel.
- -121: The user ID is invalid. You need to pass in a valid user ID in uid to rejoin the channel.
leaveChannel
Sets channel options and leaves the channel.
abstract leaveChannel(options?: LeaveChannelOptions): number;
After calling this method, the SDK terminates the audio and video interaction, leaves the current channel, and releases all resources related to the session.
After joining the channel, you must call this method to end the call; otherwise, the next call cannot be started. If you have called joinChannelEx to join multiple channels, calling this method will leave all the channels you joined.
Call timing
Call this method after joining a channel.
Restrictions
If you call release immediately after calling this method, the SDK does not trigger the onLeaveChannel callback.
Parameters
- options
- The options for leaving the channel. See LeaveChannelOptions.
Returns
- 0: Success.
- < 0: Failure.
loadExtensionProvider
Loads an extension.
abstract loadExtensionProvider( path: string, unloadAfterUse?: boolean ): number;
This method is used to add extensions external to the SDK (such as those from Extensions Marketplace and SDK extensions) to the SDK.
Call timing
Make sure the IRtcEngine is initialized before you call this method.
Restrictions
If you want to load multiple extensions, you need to call this method multiple times.
Parameters
- path
- The extension library path and name. For example:
/library/libagora_segmentation_extension.dll
. - unloadAfterUse
- Whether to uninstall the current extension when you no longer using it:
true
: Uninstall the extension when the IRtcEngine is destroyed.false
: (Rcommended) Do not uninstall the extension until the process terminates.
Returns
- 0: Success.
- < 0: Failure.
muteAllRemoteAudioStreams
Stops or resumes subscribing to the audio streams of all remote users.
abstract muteAllRemoteAudioStreams(mute: boolean): number;
After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.
By default, the SDK subscribes to the audio streams of all remote users when joining a channel. To modify this behavior, you can set autoSubscribeAudio to false
when calling joinChannel to join the channel, which will cancel the subscription to the audio streams of all users upon joining the channel.
Call timing
Call this method after joining a channel.
Restrictions
If you call this method and then call enableAudio or disableAudio, the latest call will prevail.
Parameters
- mute
-
Whether to stop subscribing to the audio streams of all remote users:
true
: Stops subscribing to the audio streams of all remote users.false
: (Default) Subscribes to the audio streams of all remote users by default.
Returns
- 0: Success.
- < 0: Failure.
muteAllRemoteVideoStreams
Stops or resumes subscribing to the video streams of all remote users.
abstract muteAllRemoteVideoStreams(mute: boolean): number;
After successfully calling this method, the local user stops or resumes subscribing to the video streams of all remote users, including all subsequent users.
By default, the SDK subscribes to the video streams of all remote users when joining a channel. To modify this behavior, you can set autoSubscribeVideo tofalse
when calling joinChannel to join the channel, which will cancel the subscription to the video streams of all users upon joining the channel.
Call timing
Call this method after joining a channel.
Restrictions
If you call this method and then call enableVideo or disableVideo, the latest call will prevail.
Parameters
- mute
-
Whether to stop subscribing to the video streams of all remote users.
true
: Stop subscribing to the video streams of all remote users.false
: (Default) Subscribe to the video streams of all remote users by default.
Returns
- 0: Success.
- < 0: Failure.
muteLocalAudioStream
Stops or resumes publishing the local audio stream.
abstract muteLocalAudioStream(mute: boolean): number;
This method is used to control whether to publish the locally captured audio stream. If you call this method to stop publishing locally captured audio streams, the audio capturing device will still work and won't be affected.
Call timing
This method can be called either before or after joining the channel.
Restrictions
None.
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;
This method is used to control whether to publish the locally captured video stream. If you call this method to stop publishing locally captured video streams, the video capturing device will still work and won't be affected.
Compared to enableLocalVideo(false
), which can also cancel the publishing of local video stream by turning off the local video stream capture, this method responds faster.
Call timing
This method can be called either before or after joining the channel.
Restrictions
None.
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;
true
, the SDK behaves as follows:- Records the adjusted volume.
- Mutes the recording signal.
false
, the recording signal volume will be restored to the volume recorded by the SDK before muting.Call timing
This method can be called either before or after joining the channel.
Restrictions
None.
Parameters
- mute
-
true
: Mute the recording signal.false
: (Default) Do not mute the recording signal.
Returns
- 0: Success.
- < 0: Failure.
muteRemoteAudioStream
Stops or resumes subscribing to the audio stream of a specified user.
abstract muteRemoteAudioStream(uid: number, mute: boolean): number;
Call timing
Call this method after joining a channel.
Restrictions
None.
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;
Call timing
Call this method after joining a channel.
Restrictions
None.
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.
Returns
- 0: Success.
- < 0: Failure.
- -5: The method call was rejected. There is no ongoing channel media relay.
pauseAllEffects
Pauses all audio effects.
abstract pauseAllEffects(): number;
Returns
- 0: Success.
- < 0: Failure.
pauseAudioMixing
Pauses playing and mixing the music file.
abstract pauseAudioMixing(): number;
After calling startAudioMixing to play a music file, you can call this method to pause the playing. If you need to stop the playback, call stopAudioMixing.
Call timing
Call this method after joining a channel.
Restrictions
None.
Returns
- 0: Success.
- < 0: Failure.
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;
To play multiple audio effect files at the same time, call this method multiple times with different soundId and filePath. To achieve the optimal user experience, Agora recommends that you do not playing more than three audio files at the same time.
Call timing
You can call this method either before or after joining a channel.
Restrictions
If you need to play an online audio effect file, Agora recommends that you cache the online audio effect file to your local device, call preloadEffect to preload the file into memory, and then call this method to play the audio effect. Otherwise, you might encounter playback failures or no sound during playback due to loading timeouts or failures.
Parameters
- soundId
- The audio effect ID. The ID of each audio effect file is unique.Attention: If you have preloaded an audio effect into memory by calling preloadEffect, ensure that the value of this parameter is the same as that of soundId in preloadEffect.
- filePath
-
The file path. The SDK supports URLs and absolute path of local files. The absolute path needs to be accurate to the file name and extension. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP.
Attention: If you have preloaded an audio effect into memory by calling preloadEffect, ensure that the value of this parameter is the same as that of filePath in preloadEffect. - loopCount
-
The number of times the audio effect loops.
- ≥ 0: The number of playback times. For example, 1 means looping one time, which means playing the audio effect two times in total.
- -1: Play the audio file in an infinite loop.
- pitch
- The pitch of the audio effect. The value range is 0.5 to 2.0. The default value is 1.0, which means the original pitch. The lower the value, the lower the pitch.
- pan
-
The spatial position of the audio effect. The value ranges between -1.0 and 1.0:
- -1.0: The audio effect is heard on the left of the user.
- 0.0: The audio effect is heard in front of the user.
- 1.0: The audio effect is heard on the right of the user.
- gain
- The volume of the audio effect. The value range is 0.0 to 100.0. The default value is 100.0, which means the original volume. The smaller the value, the lower the volume.
- publish
-
Whether to publish the audio effect to the remote users:
true
: Publish the audio effect to the remote users. Both the local user and remote users can hear the audio effect.false
: Do not publish the audio effect to the remote users. Only the local user can hear the audio effect.
- startPos
-
The playback position (ms) of the audio effect file.
Returns
- 0: Success.
- < 0: Failure.
preloadChannel
Preloads a channel with token, channelId, and uid.
abstract preloadChannel( token: string, channelId: string, uid: number ): number;
When audience members need to switch between different channels frequently, calling the method can help shortening the time of joining a channel, thus reducing the time it takes for audience members to hear and see the host.
If you join a preloaded channel, leave it and want to rejoin the same channel, you do not need to call this method unless the token for preloading the channel expires.
Call timing
To improve the user experience of preloading channels, Agora recommends that before joining the channel, calling this method as early as possible once confirming the channel name and user information.
Restrictions
- When calling this method, ensure you set the user role as audience and do not set the audio scenario as AudioScenarioChorus, otherwise, this method does not take effect.
- You also need to make sure that the channel name, user ID and token passed in for preloading are the same as the values passed in when joinning the channel, otherwise, this method does not take effect.
- One IRtcEngine instance supports preloading 20 channels at most. When exceeding this limit, the latest 20 preloaded channels take effect.
Parameters
- token
- The token generated on your server for authentication. See .When the token for preloading channels expires, you can update the token based on the number of channels you preload.
- When preloading one channel, calling this method to pass in the new token.
- When preloading more than one channels:
- If you use a wildcard token for all preloaded channels, call updatePreloadChannelToken to update the token.Note: When generating a wildcard token, ensure the user ID is not set as 0. See Secure authentication with tokens.
- If you use different tokens to preload different channels, call this method to pass in your user ID, channel name and the new token.
- If you use a wildcard token for all preloaded channels, call updatePreloadChannelToken to update the token.
- channelId
- The channel name that you want to preload. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):
- All lowercase English letters: a to z.
- All uppercase English letters: A to Z.
- All numeric characters: 0 to 9.
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
- uid
- The user ID. This parameter is used to identify the user in the channel for real-time audio and video interaction. You need to set and manage user IDs yourself, and ensure that each user ID in the same channel is unique. This parameter is a 32-bit unsigned integer. The value range is 1 to 232-1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and onJoinChannelSuccess returns it in the callback. Your application must record and maintain the returned user ID, because the SDK does not do so.
Returns
- 0: Success.
- < 0: Failure.
- -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
- -102: The channel name is invalid. You need to pass in a valid channel name and join the channel again.
preloadChannelWithUserAccount
Preloads a channel with token, channelId, and userAccount.
abstract preloadChannelWithUserAccount( token: string, channelId: string, userAccount: string ): number;
When audience members need to switch between different channels frequently, calling the method can help shortening the time of joining a channel, thus reducing the time it takes for audience members to hear and see the host.
If you join a preloaded channel, leave it and want to rejoin the same channel, you do not need to call this method unless the token for preloading the channel expires.
Call timing
To improve the user experience of preloading channels, Agora recommends that before joining the channel, calling this method as early as possible once confirming the channel name and user information.
Restrictions
- When calling this method, ensure you set the user role as audience and do not set the audio scenario as AudioScenarioChorus, otherwise, this method does not take effect.
- You also need to make sure that the 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.
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.
- If you use a wildcard token for all preloaded channels, call updatePreloadChannelToken to update the token.
- channelId
- The channel name that you want to preload. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):
- All lowercase English letters: a to z.
- All uppercase English letters: A to Z.
- All numeric characters: 0 to 9.
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
- userAccount
-
The user account. This parameter is used to identify the user in the channel for real-time audio and video engagement. You need to set and manage user accounts yourself and ensure that each user account in the same channel is unique. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as null. Supported characters are as follows(89 in total):
- The 26 lowercase English letters: a to z.
- The 26 uppercase English letters: A to Z.
- All numeric characters: 0 to 9.
- Space
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
Returns
- 0: Success.
- < 0: Failure.
- -2: The parameter is invalid. For example, the User Account is empty. You need to pass in a valid parameter and join the channel again.
- -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
- -102: The channel name is invalid. You need to pass in a valid channel name and join the channel again.
preloadEffect
Preloads a specified audio effect file into the memory.
abstract preloadEffect( soundId: number, filePath: string, startPos?: number ): number;
Ensure the size of all preloaded files does not exceed the limit.
For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support.
Call timing
Agora recommends that you call this method before joining a channel.
Restrictions
None.
Parameters
- soundId
- The audio effect ID. The ID of each audio effect file is unique.
- filePath
- File path:
- Windows: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example
: C:\music\audio.mp4
. - macOS: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example:
/var/mobile/Containers/Data/audio.mp4
.
- Windows: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example
- startPos
- The playback position (ms) of the audio effect file.
Returns
- 0: Success.
- < 0: Failure.
queryDeviceScore
Queries device score.
abstract queryDeviceScore(): number;
Details
Applicable scenarios
In high-definition or ultra-high-definition video scenarios, you can first call this method to query the device's score. If the returned score is low (for example, below 60), you need to lower the video resolution to avoid affecting the video experience. The minimum device score required for different business scenarios is varied. For specific score recommendations, please technical support.
Returns
- >0: The method call succeeeds, the value is the current device's score, the range is [0,100], the larger the value, the stronger the device capability. Most devices are rated between 60 and 100.
- < 0: Failure.
rate
Allows a user to rate a call after the call ends.
abstract rate(callId: string, rating: number, description: string): number;
Details
Parameters
- callId
- The current call ID. You can get the call ID by calling getCallId.
- rating
- The value is between 1 (the lowest score) and 5 (the highest score).
- description
- A description of the call. The string length should be less than 800 bytes.
Returns
- 0: Success.
- < 0: Failure.
- -1: A general error occurs (no specified reason).
- -2: The parameter is invalid.
registerAudioEncodedFrameObserver
Registers an encoded audio observer.
abstract registerAudioEncodedFrameObserver( config: AudioEncodedFrameObserverConfig, observer: IAudioEncodedFrameObserver ): number;
Details
- 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.
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 events.
abstract unregisterEventHandler(eventHandler: IRtcEngineEventHandler): boolean;
Details
You can call this method too remove all added callback events.
Parameters
- eventHandler
- Callback events to be removed. See IRtcEngineEventHandler.
Returns
true
: Success.false
: Failure.
registerExtension
Registers an extension.
abstract registerExtension( provider: string, extension: string, type?: MediaSourceType ): number;
For extensions external to the SDK (such as those from Extensions Marketplace and SDK Extensions), you need to load them before calling this method. Extensions internal to the SDK (those included in the full SDK package) are automatically loaded and registered after the initialization of IRtcEngine.
Call timing
- Agora recommends you call this method after the initialization of IRtcEngine and before joining a channel.
- For video extensions (such as the image enhancement extension), you need to call this method after enabling the video module by calling enableVideo or enableLocalVideo.
- Before calling this method, you need to call loadExtensionProvider to load the extension first.
Restrictions
- If you want to register multiple extensions, you need to call this method multiple times.
- The data processing order of different extensions in the SDK is determined by the order in which the extensions are registered. That is, the extension that is registered first will process the data first.
Parameters
- provider
- The name of the extension provider.
- extension
- The name of the extension.
- type
- Source type of the extension. See MediaSourceType.
Returns
- 0: Success.
- < 0: Failure.
- -3: The extension library is not loaded. Agora recommends that you check the storage location or the name of the dynamic library.
registerLocalUserAccount
Registers a user account.
abstract registerLocalUserAccount(appId: string, userAccount: string): number;
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.
- Call the registerLocalUserAccount method to register a user account, and then call the joinChannelWithUserAccount method to join a channel, which can shorten the time it takes to enter the channel.
- Call the joinChannelWithUserAccount method to join a channel.
- 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 UID, then ensure all the other users use the UID 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.
Restrictions
None.
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.
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.
- 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;
You can call this method to pass a new token to the SDK. A token will expire after a certain period of time, at which point the SDK will be unable to establish a connection with the server.
Call timing
- Receiving the onTokenPrivilegeWillExpire callback reporting the token is about to expire.
- Receiving the onRequestToken callback reporting the token has expired.
- Receiving the onConnectionStateChanged callback reporting ConnectionChangedTokenExpired(9).
Restrictions
None.
Parameters
- token
- The new token.
Returns
- 0: Success.
- < 0: Failure.
- -2: The parameter is invalid. For example, the token is empty.
- -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
- 110: Invalid token. Ensure the following:
- The user ID specified when generating the token is consistent with the user ID used when joining the channel.
- The generated token is the same as the token passed in to join the channel.
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);
resumeAllChannelMediaRelay
Resumes the media stream relay to all target channels.
abstract resumeAllChannelMediaRelay(): number;
Details
After calling the pauseAllChannelMediaRelay method, you can call this method to resume relaying media streams to all destination channels.
Returns
- 0: Success.
- < 0: Failure.
- -5: The method call was rejected. There is no paused channel media relay.
resumeAllEffects
Resumes playing all audio effect files.
abstract resumeAllEffects(): number;
After you call pauseAllEffects to pause the playback, you can call this method to resume the playback.
Call timing
Call this method after pauseAllEffects.
Restrictions
None.
Returns
- 0: Success.
- < 0: Failure.
resumeAudioMixing
Resumes playing and mixing the music file.
abstract resumeAudioMixing(): number;
After calling pauseAudioMixing to pause the playback, you can call this method to resume the playback.
Call timing
Call this method after joining a channel.
Restrictions
None.
Returns
- 0: Success.
- < 0: Failure.
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.
- For the supported formats of audio files, see https://docs.agora.io/en/help/general-product-inquiry/audio_format#extended-audio-file-formats.
- You need to call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged
(AudioMixingStatePlaying)
callback.
Parameters
- index
- The audio track you want to specify. The value should be greater than 0 and less than that of returned by getAudioTrackCount.
Returns
- 0: Success.
- < 0: Failure.
selectMultiAudioTrack
Selects the audio tracks that you want to play on your local device and publish to the channel respectively.
abstract selectMultiAudioTrack( playoutTrackIndex: number, publishTrackIndex: number ): number;
Details
You can call this method to determine the audio track to be played on your local device and published to the channel.
Before calling this method, you need to open the media file with the openWithMediaSource method and set enableMultiAudioTrack in MediaSource as true
.
Applicable scenarios
For example, in KTV scenarios, the host can choose to play the original sound locally and publish the accompaniment track to the channel.
Parameters
- playoutTrackIndex
- The index of audio tracks for local playback. You can obtain the index through getStreamInfo.
- publishTrackIndex
- The index of audio tracks to be published in the channel. You can obtain the index through getStreamInfo.
Returns
- 0: Success.
- < 0: Failure.
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
After calling createDataStream, you can call this method to send data stream messages to all users in the channel.
- Each user can have up to five data streams simultaneously.
- Up to 60 packets can be sent per second in a data stream with each packet having a maximum size of 1 KB.
- Up to 30 KB of data can be sent per second in a data stream.
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.
- This method needs to be called after createDataStream and joining the channel.
- 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.
Parameters
- options
- The advanced options for audio. See AdvancedAudioOptions.
Returns
- 0: Success.
- < 0: Failure.
setAINSMode
Sets whether to enable the AI noise suppression function and set the noise suppression mode.
abstract setAINSMode(enabled: boolean, mode: AudioAinsMode): number;
- Television;
- Air conditioner;
- Machinery, etc.
- Thunder;
- Explosion;
- Cracking, etc.
Applicable scenarios
In scenarios such as co-streaming, online education and video meeting, this function can detect and reduce background noises to improve experience.
Call timing
You can call this method either before or after joining a channel.
Restrictions
Parameters
- enabled
- Whether to enable the AI noise suppression function:
true
: Enable the AI noise suppression.false
: (Default) Disable the AI noise suppression.
- mode
-
The AI noise suppression modes. See AudioAinsMode.
Returns
- 0: Success.
- < 0: Failure.
setAudioEffectParameters
Sets parameters for SDK preset audio effects.
abstract setAudioEffectParameters(preset: AudioEffectPreset, param1: number, param2: number): number;
Details
- 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.
- Call setAudioScenario to set the audio scenario to high-quality audio scenario, namely AudioScenarioGameStreaming(3).
- Call setAudioProfile to set the profile parameter to AudioProfileMusicHighQuality(4) or AudioProfileMusicHighQualityStereo(5).
- 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 setAudioEffectParameters, Agora does not recommend you to call the following methods, otherwise the effect set by setAudioEffectParameters 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:
- RoomAcoustics3dVoice, 3D voice effect:
- You need to set the profile parameter in setAudioProfile to AudioProfileMusicStandardStereo(3) or AudioProfileMusicHighQualityStereo(5) before setting this enumerator; otherwise, the enumerator setting does not take effect.
- If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect.
- PitchCorrection, Pitch correction effect:
- RoomAcoustics3dVoice, 3D voice effect:
- param1
-
- If you set preset to RoomAcoustics3dVoice, param1 sets the cycle period of the 3D voice effect. The value range is [1,60] and the unit is seconds. The default value is 10, indicating that the voice moves around you every 10 seconds.
- If you set preset to PitchCorrection, param1 indicates the basic mode of the pitch correction effect:
1
: (Default) Natural major scale.2
: Natural minor scale.3
: Japanese pentatonic scale.
- param2
-
- If you set preset to RoomAcoustics3dVoice , you need to set param2 to
0
. - If you set preset to PitchCorrection, param2 indicates the tonic pitch of the pitch correction effect:
1
: A2
: A#3
: B4
: (Default) C5
: C#6
: D7
: D#8
: E9
: F10
: F#11
: G12
: G#
- If you set preset to RoomAcoustics3dVoice , you need to set param2 to
Returns
- 0: Success.
- < 0: Failure.
setAudioEffectPreset
Sets an SDK preset audio effect.
abstract setAudioEffectPreset(preset: AudioEffectPreset): number;
Call this method to set an SDK preset audio effect for the local user who sends an audio stream. This audio effect does not change the gender characteristics of the original voice. After setting an audio effect, all users in the channel can hear the effect.
Call timing
This method can be called either before or after joining the channel.
- Call setAudioScenario to set the audio scenario to high-quality audio scenario, namely AudioScenarioGameStreaming(3).
- Call setAudioProfile to set the profile parameter to AudioProfileMusicHighQuality(4) or AudioProfileMusicHighQualityStereo(5).
Restrictions
- Do not set the profile parameter in setAudioProfile to AudioProfileSpeechStandard(1) or AudioProfileIot(6), or the method does not take effect.
- If you call setAudioEffectPreset and set enumerators except for RoomAcoustics3dVoice or PitchCorrection, do not call setAudioEffectParameters; otherwise, setAudioEffectPreset is overridden.
- After calling setAudioEffectPreset, Agora does not recommend you to call the following methods, otherwise the effect set by setAudioEffectPreset will be overwritten:
- 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;
In a stereo music file, the left and right channels can store different audio data. According to your needs, you can set the channel mode to original mode, left channel mode, right channel mode, or mixed channel mode.
Applicable scenarios
- If you only want to hear the accompaniment, use this method to set the audio file's channel mode to left channel mode.
- If you need to hear both the accompaniment and the original vocals simultaneously, call this method to set the channel mode to mixed mode.
Call timing
Call this method after startAudioMixing and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying)
callback.
Restrictions
This method only applies to stereo audio files.
Parameters
- mode
- The channel mode. See AudioMixingDualMonoMode.
Returns
- 0: Success.
- < 0: Failure.
setAudioMixingPitch
Sets the pitch of the local music file.
abstract setAudioMixingPitch(pitch: number): number;
When a local music file is mixed with a local human voice, call this method to set the pitch of the local music file only.
Call timing
You need to call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying)
callback.
Restrictions
None.
Parameters
- pitch
- Sets the pitch of the local music file by the chromatic scale. The default value is 0, which means keeping the original pitch. The value ranges from -12 to 12, and the pitch value between consecutive values is a chromatic value. The greater the absolute value of this parameter, the higher or lower the pitch of the local music file.
Returns
- 0: Success.
- < 0: Failure.
setAudioMixingPlaybackSpeed
Sets the playback speed of the current audio file.
abstract setAudioMixingPlaybackSpeed(speed: number): number;
Details
Ensure you call this method after calling startAudioMixing receiving the onAudioMixingStateChanged callback reporting the state as AudioMixingStatePlaying.
Parameters
- speed
- The playback speed. Agora recommends that you set this to a value between 50 and 400, defined as follows:
- 50: Half the original speed.
- 100: The original speed.
- 400: 4 times the original speed.
Returns
- 0: Success.
- < 0: Failure.
setAudioMixingPosition
Sets the audio mixing position.
abstract setAudioMixingPosition(pos: number): number;
Call this method to set the playback position of the music file to a different starting position (the default plays from the beginning).
Call timing
Call this method after startAudioMixing and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying)
callback.
Restrictions
None.
Parameters
- pos
- Integer. The playback position (ms).
Returns
- 0: Success.
- < 0: Failure.
setAudioProfile
Sets the audio profile and audio scenario.
abstract setAudioProfile( profile: AudioProfileType, scenario?: AudioScenarioType ): number;
Applicable scenarios
This method is suitable for various audio scenarios. You can choose as needed. For example, in scenarios with high audio quality requirements such as music teaching, it is recommended to set profile to AudioProfileMusicHighQuality
(4) and scenario to AudioScenarioGameStreaming
(3).
Call timing
You can call this method either before or after joining a channel.
Restrictions
None.
Parameters
- profile
-
The audio profile, including the sampling rate, bitrate, encoding mode, and the number of channels. See AudioProfileType.
- scenario
- The audio scenarios. Under different audio scenarios, the device uses different volume types. See AudioScenarioType.
Returns
- 0: Success.
- < 0: Failure.
setAudioScenario
Sets audio scenarios.
abstract setAudioScenario(scenario: AudioScenarioType): number;
Applicable scenarios
This method is suitable for various audio scenarios. You can choose as needed. For example, in scenarios such as music teaching that require high sound quality, it is recommended to set scenario to AudioScenarioGameStreaming
(3).
Call timing
You can call this method either before or after joining a channel.
Restrictions
None.
Parameters
- scenario
- The audio scenarios. Under different audio scenarios, the device uses different volume types. See AudioScenarioType.
Returns
- 0: Success.
- < 0: Failure.
setBeautyEffectOptions
Sets the image enhancement options.
abstract setBeautyEffectOptions( enabled: boolean, options: BeautyOptions, type?: MediaSourceType ): number;
Enables or disables image enhancement, and sets the options.
Call timing
Call this method after calling enableVideo or startPreview.
Restrictions
- This method relies on the image enhancement dynamic library
libagora_clear_vision_extension.dll
. If the dynamic library is deleted, the function cannot be enabled normally. - This feature has high requirements on device performance. When calling this method, the SDK automatically checks the capabilities of the current device.
Parameters
- enabled
- Whether to enable the image enhancement function:
true
: Enable the image enhancement function.false
: (Default) Disable the image enhancement function.
- options
- The image enhancement options. See BeautyOptions.
- type
- Source type of the extension. See MediaSourceType.
Returns
- 0: Success.
- < 0: Failure.
- -4: The current device does not support this feature. Possible reasons include:
- The current device capabilities do not meet the requirements for image enhancement. Agora recommends you replace it with a high-performance device.
- -4: The current device does not support this feature. Possible reasons include:
setCameraCapturerConfiguration
Sets the camera capture configuration.
abstract setCameraCapturerConfiguration( config: CameraCapturerConfiguration ): number;
Call timing
Call this method before enabling local camera capture, such as before calling startPreview and joinChannel.
Restrictions
None.
Parameters
- config
- The camera capture configuration. See CameraCapturerConfiguration.
Returns
- < 0: Failure.
setCameraDeviceOrientation
Sets the rotation angle of the captured video.
abstract setCameraDeviceOrientation( type: VideoSourceType, orientation: VideoOrientation ): number;
Details
- This method applies to Windows 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).
- 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.
setChannelProfile
Sets the channel profile.
abstract setChannelProfile(profile: ChannelProfileType): number;
You can call this method to set the channel profile. The SDK adopts different optimization strategies for different channel profiles. For example, in a live streaming scenario, the SDK prioritizes video quality. After initializing the SDK, the default channel profile is the live streaming profile.
Call timing
Call this method before joining a channel.
Restrictions
To ensure the quality of real-time communication, Agora recommends that all users in a channel use the same channel profile.
Parameters
- profile
-
The channel profile. See ChannelProfileType.
Returns
- 0: Success.
- < 0: Failure.
- -2: The parameter is invalid.
- -7: The SDK is not initialized.
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.
- 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
Set the user role and the audience latency level in a live streaming scenario.
abstract setClientRole( role: ClientRoleType, options?: ClientRoleOptions ): number;
By default,the SDK sets the user role as audience. You can call this method to set the user role as host. The user role (roles) determines the users' permissions at the SDK level, including whether they can publish audio and video streams in a channel.
Call timing
You can call this method either before or after joining a channel.
If you call this method to set the user role as the host before joining the channel and set the local video property through the setupLocalVideo method, the local video preview is automatically enabled when the user joins the channel.
If you call this method to set the user role after joining a channel, the SDK will automatically call the muteLocalAudioStream and muteLocalVideoStream method to change the state for publishing audio and video streams.
Restrictions
When the user role is set to host, the audience latency level can only be set to AudienceLatencyLevelUltraLowLatency.
When calling this method before joining a channel and setting the role to BROADCASTER, the onClientRoleChanged callback will not be triggered on the local client.
Parameters
- role
- The user role. See ClientRoleType.
Note: If you set the user role as an audience member, you cannot publish audio and video streams in the channel. If you want to publish media streams in a channel during live streaming, ensure you set the user role as broadcaster.
- options
- The detailed options of a user, including the user level. See ClientRoleOptions.
Returns
- 0: Success.
- < 0: Failure.
- -1: A general error occurs (no specified reason).
- -2: The parameter is invalid.
- -5: The request is rejected.
- -7: The SDK is not initialized.
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.
- 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.
setDualStreamMode
Sets dual-stream mode configuration on the sender side.
abstract setDualStreamMode( mode: SimulcastStreamMode, streamConfig?: SimulcastStreamConfig ): number;
Details
- If you want to modify this behavior, you can call this method and set 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.
- When calling this method and setting mode to DisableSimulcastStream, it has the same effect as calling enableDualStreamMode and setting enabled to
false
. - When calling this method and setting mode to EnableSimulcastStream, it has the same effect as calling enableDualStreamMode 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.
- 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.
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;
Call timing
Call this method after playEffect.
Restrictions
None.
Parameters
- volume
- The playback volume. The value range is [0, 100]. The default value is 100, which represents the original volume.
Returns
- 0: Success.
- < 0: Failure.
setExtensionProperty
Sets the properties of the extension.
abstract setExtensionProperty( provider: string, extension: string, key: string, value: string, type?: MediaSourceType ): number;
After enabling the extension, you can call this method to set the properties of the extension.
Call timing
Call this mehtod after calling enableExtension.
Restrictions
If you want to set properties for multiple extensions, you need to call this method multiple times.
Parameters
- provider
- The name of the extension provider.
- extension
- The name of the extension.
- key
- The key of the extension.
- value
- The value of the extension key.
- type
- Source type of the extension. See MediaSourceType.
Returns
- 0: Success.
- < 0: Failure.
setExtensionProviderProperty
Sets the properties of the extension provider.
abstract setExtensionProviderProperty( provider: string, key: string, value: string ): number;
You can call this method to set the attributes of the extension provider and initialize the relevant parameters according to the type of the provider.
Call timing
Call this method before enableExtension and after registerExtension.
Restrictions
If you want to set the properties of the extension provider for multiple extensions, you need to call this method multiple times.
Parameters
- provider
- The name of the extension provider.
- key
- The key of the extension.
- value
- The value of the extension key.
Returns
- 0: Success.
- < 0: Failure.
setExternalAudioSink
Sets the external audio sink.
abstract setExternalAudioSink( enabled: boolean, sampleRate: number, channels: number ): number;
After enabling the external audio sink, you can call pullAudioFrame to pull remote audio frames. The app can process the remote audio and play it with the audio effects that you want.
Applicable scenarios
This method applies to scenarios where you want to use external audio data for playback.
Call timing
Call this method before joining a channel.
Restrictions
Once you enable the external audio sink, the app will not retrieve any audio data from the onPlaybackAudioFrame callback.
Parameters
- enabled
- Whether to enable or disable the external audio sink:
true
: Enables the external audio sink.false
: (Default) Disables the external audio sink.
- sampleRate
- The sample rate (Hz) of the external audio sink, which can be set as 16000, 32000, 44100, or 48000.
- channels
- The number of audio channels of the external audio sink:
- 1: Mono.
- 2: Stereo.
Returns
- 0: Success.
- < 0: Failure.
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.
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;
Call timing
This method can be called either before or after joining the channel.
Restrictions
None.
Parameters
- volume
-
The volume of the user. The value range is [0,400].
- 0: Mute.
- 100: (Default) The original volume.
- 400: Four times the original volume (amplifying the audio signals by four times).
Returns
setLocalRenderMode
Updates the display mode of the local video view.
abstract setLocalRenderMode( renderMode: RenderModeType, mirrorMode?: VideoMirrorModeType ): number;
After initializing the local video view, you can call this method to update its rendering and mirror modes. It affects only the video view that the local user sees and does not impact the publishing of the local video.
Call timing
- Ensure that you have called the setupLocalVideo method to initialize the local video view before calling this method.
- During a call, you can call this method as many times as necessary to update the display mode of the local video view.
Restrictions
This method only takes effect on the primary camera (PrimaryCameraSource)
. In scenarios involving custom video capture or the use of alternative video sources, you need to use setupLocalVideo instead of this method.
Parameters
- renderMode
-
The local video display mode. See RenderModeType.
- mirrorMode
-
The mirror mode of the local video view. See VideoMirrorModeType.
Attention: If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default.
Returns
- 0: Success.
- < 0: Failure.
setLocalVideoMirrorMode
Sets the local video mirror mode.
abstract setLocalVideoMirrorMode(mirrorMode: VideoMirrorModeType): number;
Details
- Deprecated:
- This method is deprecated.
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;
Call timing
This method can be called either before or after joining the channel.
Restrictions
None.
Parameters
- bandFrequency
- The band frequency. The value ranges between 0 and 9; representing the respective 10-band center frequencies of the voice effects, including 31, 62, 125, 250, 500, 1k, 2k, 4k, 8k, and 16k Hz. See AudioEqualizationBandFrequency.
- bandGain
- The gain of each band in dB. The value ranges between -15 and 15. The default value is 0.
Returns
- 0: Success.
- < 0: Failure.
setLocalVoicePitch
Changes the voice pitch of the local speaker.
abstract setLocalVoicePitch(pitch: number): number;
Call timing
This method can be called either before or after joining the channel.
Restrictions
None.
Parameters
- pitch
- The local voice pitch. The value range is [0.5,2.0]. The lower the value, the lower the pitch. The default value is 1.0 (no change to the pitch).
Returns
- 0: Success.
- < 0: Failure.
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.
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;
- Deprecated:
- This method is deprecated. Set the log file path by configuring the context parameter when calling initialize.
Specifies an SDK output log file. The log file records all log data for the SDK’s operation.
Call timing
This method needs to be called immediately after initialize, otherwise the output log may be incomplete.
Restrictions
Ensure that the directory for the log file exists and is writable.
Parameters
- filePath
- The complete path of the log files. These log files are encoded in UTF-8.
Returns
- 0: Success.
- < 0: Failure.
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
, andagorasdk.4.log
. - The API call log files are:
agoraapi.log
,agoraapi.1.log
,agoraapi.2.log
,agoraapi.3.log
, andagoraapi.4.log
. - The default size of each SDK log file and API log file is 2,048 KB. These log files are encoded in UTF-8.
- The SDK writes the latest logs in
agorasdk.log
oragoraapi.log
. - When
agorasdk.log
is full, the SDK processes the log files in the following order:- Delete the
agorasdk.4.log
file (if any). - Rename
agorasdk.3.log
toagorasdk.4.log
. - Rename
agorasdk.2.log
toagorasdk.3.log
. - Rename
agorasdk.1.log
toagorasdk.2.log
. - Create a new
agorasdk.log
file.
- Delete the
- The overwrite rules for the
agoraapi.log
file are the same as foragorasdk.log
.
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 setfileSizeInKByte
smaller than 128 KB, the SDK automatically adjusts it to 128 KB; if you setfileSizeInKByte
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;
- Deprecated:
- This method is deprecated. Set the log file level by configuring the context parameter when calling initialize.
Choose a level to see the logs preceding that level.
Parameters
- level
- The log level. See LogLevel.
Returns
- 0: Success.
- < 0: Failure.
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.
- 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:
true
: Enable low-light enhancement.false
: (Default) Disable low-light enhancement.
- options
- The low-light enhancement options. See LowlightEnhanceOptions.
- type
- The type of the video source. See MediaSourceType.
Returns
- 0: Success.
- < 0: Failure.
setMixedAudioFrameParameters
Set the format of the raw audio data after mixing for audio capture and playback.
abstract setMixedAudioFrameParameters( sampleRate: number, channel: number, samplesPerCall: number ): number;
The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method.Sample interval (sec) = samplePerCall/(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the onMixedAudioFrame callback according to the sampling interval.
Call timing
Call this method before joining a channel.
Restrictions
None.
Parameters
- sampleRate
- The sample rate returned in the callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
- channel
- The number of audio channels. You can set the value as 1 or 2.
- 1: Mono.
- 2: Stereo.
- samplesPerCall
- The number of data samples, such as 1024 for the Media Push.
Returns
- 0: Success.
- < 0: Failure.
setPlaybackAudioFrameBeforeMixingParameters
Sets the format of the raw audio playback data before mixing.
abstract setPlaybackAudioFrameBeforeMixingParameters( sampleRate: number, channel: number ): number;
The SDK triggers the onPlaybackAudioFrameBeforeMixing callback according to the sampling interval.
Call timing
Call this method before joining a channel.
Restrictions
None.
Parameters
- sampleRate
- The sample rate returned in the callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
- channel
- The number of audio channels. You can set the value as 1 or 2.
- 1: Mono.
- 2: Stereo.
Returns
- 0: Success.
- < 0: Failure.
setPlaybackAudioFrameParameters
Sets the format of the raw audio playback data.
abstract setPlaybackAudioFrameParameters( sampleRate: number, channel: number, mode: RawAudioFrameOpModeType, samplesPerCall: number ): number;
The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method.Sample interval (sec) = samplePerCall/(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the onPlaybackAudioFrame callback according to the sampling interval.
Call timing
Call this method before joining a channel.
Restrictions
None.
Parameters
- sampleRate
- The sample rate returned in the callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
- channel
- The number of audio channels. You can set the value as 1 or 2.
- 1: Mono.
- 2: Stereo.
- mode
-
The use mode of the audio frame. See RawAudioFrameOpModeType.
- samplesPerCall
- The number of data samples, such as 1024 for the Media Push.
Returns
- 0: Success.
- < 0: Failure.
setRecordingAudioFrameParameters
Sets the format of the captured raw audio data.
abstract setRecordingAudioFrameParameters( sampleRate: number, channel: number, mode: RawAudioFrameOpModeType, samplesPerCall: number ): number;
The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method.Sample interval (sec) = samplePerCall/(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the onRecordAudioFrame callback according to the sampling interval.
Call timing
Call this method before joining a channel.
Restrictions
None.
Parameters
- sampleRate
- The sample rate returned in the callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
- channel
- The number of audio channels. You can set the value as 1 or 2.
- 1: Mono.
- 2: Stereo.
- mode
-
The use mode of the audio frame. See RawAudioFrameOpModeType.
- samplesPerCall
- The number of data samples, such as 1024 for the Media Push.
Returns
- 0: Success.
- < 0: Failure.
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 video stream type to subscribe to.
abstract setRemoteDefaultVideoStreamType(streamType: VideoStreamType): number;
- The SDK enables low-quality video stream adaptive mode (AutoSimulcastStream) on the sender side by default, meaning only the high-quality video stream is transmitted. Only the receiver with the role of the host can call this method to initiate a low-quality video stream request. Once the sender receives the request, it starts automatically sending the low-quality video stream. At this point, all users in the channel can call this method to switch to low-quality video stream subscription mode.
- If the sender calls setDualStreamMode and sets mode to DisableSimulcastStream (never send low-quality video stream), then calling this method will have no effect.
- If the sender calls setDualStreamMode and sets mode to EnableSimulcastStream (always send low-quality video stream), both the host and audience receivers can call this method to switch to low-quality video stream subscription mode.
The SDK will dynamically adjust the size of the corresponding video stream based on the size of the video window to save bandwidth and computing resources. The default aspect ratio of the low-quality video stream is the same as that of the high-quality video stream. According to the current aspect ratio of the high-quality video stream, the system will automatically allocate the resolution, frame rate, and bitrate of the low-quality video stream.
Call timing
Call this method before joining a channel. The SDK does not support changing the default subscribed video stream type after joining a channel.
Restrictions
If you call both this method and setRemoteVideoStreamType, the setting of setRemoteVideoStreamType takes effect.
Parameters
- streamType
-
The default video-stream type. See VideoStreamType.
Returns
- 0: Success.
- < 0: Failure.
setRemoteSubscribeFallbackOption
Sets the fallback option for the subscribed video stream based on the network conditions.
abstract setRemoteSubscribeFallbackOption( option: StreamFallbackOptions ): number;
Details
An unstable network affects the audio and video quality in a video call or interactive live video streaming. If option is set as StreamFallbackOptionVideoStreamLow or StreamFallbackOptionAudioOnly, the SDK automatically switches the video from a high-quality stream to a low-quality stream or disables the video when the downlink network conditions cannot support both audio and video to guarantee the quality of the audio. Meanwhile, the SDK continuously monitors network quality and resumes subscribing to audio and video streams when the network quality improves.
When the subscribed video stream falls back to an audio-only stream, or recovers from an audio-only stream to an audio-video stream, the SDK triggers the onRemoteSubscribeFallbackToAudioOnly callback.
Parameters
- option
- Fallback options for the subscribed stream. See STREAM_FALLBACK_OPTIONS.
Returns
- 0: Success.
- < 0: Failure.
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.
setupRemoteVideo
Initializes the video view of a remote user.
abstract setupRemoteVideo(canvas: VideoCanvas): number;
Details
This method initializes the video view of a remote stream on the local device. It affects only the video view that the local user sees. Call this method to bind the remote video stream to a video view and to set the rendering and mirror modes of the video view.
You need to specify the ID of the remote user in this method. If the remote user ID is unknown to the application, set it after the app receives the onUserJoined callback.
To unbind the remote user from the view, set the view parameter to NULL.
Once the remote user leaves the channel, the SDK unbinds the remote user.
- When using the recording service, the app does not need to bind a view, as it does not send a video stream. If your app does not recognize the recording service, bind the remote user to the view when the SDK triggers the onFirstRemoteVideoDecoded callback.
- If you want to stop rendering the view, set view to null and then call this method again to stop rendering and clear the rendering cache.
Parameters
- canvas
-
The remote video view and settings. See VideoCanvas.
Returns
- 0: Success.
- < 0: Failure.
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.
- Call this method after initializing the remote view by calling the setupRemoteVideo method.
- During a call, you can call this method as many times as necessary to update the display mode of the video view of a remote user.
Parameters
- uid
- 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 video stream type to subscribe to.
abstract setRemoteVideoStreamType( uid: number, streamType: VideoStreamType ): number;
Details
- The SDK enables low-quality video stream adaptive mode (AutoSimulcastStream) on the sender side by default, meaning only the high-quality video stream is transmitted. Only the receiver with the role of the host can call this method to initiate a low-quality video stream request. Once the sender receives the request, it starts automatically sending the low-quality video stream. At this point, all users in the channel can call this method to switch to low-quality video stream subscription mode.
- If the sender calls setDualStreamMode and sets mode to DisableSimulcastStream (never send low-quality video stream), then calling this method will have no effect.
- If the sender calls setDualStreamMode and sets mode to EnableSimulcastStream (always send low-quality video stream), both the host and audience receivers can call this method to switch to low-quality video stream subscription mode.
The SDK will dynamically adjust the size of the corresponding video stream based on the size of the video window to save bandwidth and computing resources. The default aspect ratio of the low-quality video stream is the same as that of the high-quality video stream. According to the current aspect ratio of the high-quality video stream, the system will automatically allocate the resolution, frame rate, and bitrate of the low-quality video stream.
- You can call this method either before or after joining a channel.
- If you call both this method and setRemoteDefaultVideoStreamType, the setting of this method takes effect.
Parameters
- uid
- The user ID.
- streamType
-
The video stream type, see 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.
- Set autoSubscribeVideo to
false
when calling joinChannel to join a channel. - Call this method after receiving the onUserJoined callback to set the subscription options for the specified remote user's video stream.
- 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.
- 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.
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.
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.
- 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.
- 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.
- 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.
- 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.
- 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;
Sets the encoder configuration for the local video. Each configuration profile corresponds to a set of video parameters, including the resolution, frame rate, and bitrate.
Call timing
You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before enableVideo to reduce the time to render the first video frame.
Restrictions
- The config specified in this method is the maximum value under ideal network conditions. If the video engine cannot render the video using the specified config due to unreliable network conditions, the parameters further down the list are considered until a successful configuration is found.
Parameters
- config
- Video profile. See VideoEncoderConfiguration.
Returns
- 0: Success.
- < 0: Failure.
setVideoScenario
Sets video application scenarios.
abstract setVideoScenario(scenarioType: VideoApplicationScenarioType): number;
Details
After successfully calling this method, the SDK will automatically enable the best practice strategies and adjust key performance metrics based on the specified scenario, to optimize the video experience.
Parameters
- scenarioType
- The type of video application scenario. See VideoApplicationScenarioType.ApplicationScenarioMeeting (1) is suitable for meeting scenarios. The SDK automatically enables the following strategies:
- In meeting scenarios where low-quality video streams are required to have a high bitrate, the SDK automatically enables multiple technologies used to deal with network congestions, to enhance the performance of the low-quality streams and to ensure the smooth reception by subscribers.
- The SDK monitors the number of subscribers to the high-quality video stream in real time and dynamically adjusts its configuration based on the number of subscribers.
- If nobody subscribers to the high-quality stream, the SDK automatically reduces its bitrate and frame rate to save upstream bandwidth.
- If someone subscribes to the high-quality stream, the SDK resets the high-quality stream to the VideoEncoderConfiguration configuration used in the most recent calling of setVideoEncoderConfiguration. If no configuration has been set by the user previously, the following values are used:
- Resolution: 1280 × 720
- Frame rate: 15 fps
- Bitrate: 1600 Kbps
- The SDK monitors the number of subscribers to the low-quality video stream in real time and dynamically enables or disables it based on the number of subscribers.Note: If the user has called setDualStreamMode to set that never send low-quality video stream (DisableSimulcastStream), the dynamic adjustment of the low-quality stream in meeting scenarios will not take effect.
- If nobody subscribes to the low-quality stream, the SDK automatically disables it to save upstream bandwidth.
- If someone subscribes to the low-quality stream, the SDK enables the low-quality stream and resets it to the SimulcastStreamConfig configuration used in the most recent calling of setDualStreamMode. If no configuration has been set by the user previously, the following values are used:
- Resolution: 480 × 272
- Frame rate: 15 fps
- Bitrate: 500 Kbps
ApplicationScenario1v1 (2) is suitable for 1v1 video call scenarios. To meet the requirements for low latency and high-quality video in this scenario, the SDK optimizes its strategies, improving performance in terms of video quality, first frame rendering, latency on mid-to-low-end devices, and smoothness under weak network conditions.
Returns
- 0: Success.
- < 0: Failure.
- -1: A general error occurs (no specified reason).
- -4: Video application scenarios are not supported. Possible reasons include that you use the Voice SDK instead of the Video SDK.
- -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
setupLocalVideo
Initializes the local video view.
abstract setupLocalVideo(canvas: VideoCanvas): number;
This method initializes the video view of a local stream on the local device. It only affects the video seen by the local user and does not impact the publishing of the local video. Call this method to bind the local video stream to a video view (view) and to set the rendering and mirror modes of the video view.
The binding remains valid after leaving the channel. To stop rendering or unbind the local video from the view, set view as null.
Applicable scenarios
After initialization, call this method to set the local video and then join the channel.
In real-time interactive scenarios, if you need to simultaneously view multiple preview frames in the local video preview, and each frame is at a different observation position along the video link, you can repeatedly call this method to set different views and set different observation positions for each view. For example, by setting the video source to the camera and then configuring two views with position setting to PositionPostCapturerOrigin and PositionPostCapturer, you can simultaneously preview the raw, unprocessed video frame and the video frame that has undergone preprocessing (image enhancement effects, virtual background, watermark) in the local video preview.
Call timing
You can call this method either before or after joining a channel.
Restrictions
None.
Parameters
- canvas
- The local video view and settings. See VideoCanvas.
Returns
- 0: Success.
- < 0: Failure.
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.
- Call setAudioScenario to set the audio scenario to high-quality audio scenario, namely AudioScenarioGameStreaming(3).
- Call setAudioProfile to set the profile parameter to AudioProfileMusicHighQuality(4) or AudioProfileMusicHighQualityStereo(5).
- 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 setVoiceBeautifierParameters, Agora does not recommend calling the following methods, otherwise the effect set by setVoiceBeautifierParameters 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 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;
Call this method to set a preset voice beautifier effect for the local user who sends an audio stream. After setting a voice beautifier effect, all users in the channel can hear the effect. You can set different voice beautifier effects for different scenarios.
Call timing
This method can be called either before or after joining the channel.
- Call setAudioScenario to set the audio scenario to high-quality audio scenario, namely AudioScenarioGameStreaming(3).
- Call setAudioProfile to set the profile parameter to AudioProfileMusicHighQuality(4) or AudioProfileMusicHighQualityStereo(5).
Restrictions
- Do not set the profile parameter in setAudioProfile to AudioProfileSpeechStandard(1) or AudioProfileIot(6), or the method does not take effect.
- This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
- After calling setVoiceBeautifierPreset, Agora does not recommend calling the following methods, otherwise the effect set by setVoiceBeautifierPreset will be overwritten:
- 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;
Call this method to set a preset voice changing effect for the local user who publishes an audio stream in a channel. After setting the voice changing effect, all users in the channel can hear the effect. You can set different voice changing effects for the user depending on different scenarios.
Call timing
This method can be called either before or after joining the channel.
- Call setAudioScenario to set the audio scenario to high-quality audio scenario, namely AudioScenarioGameStreaming(3).
- Call setAudioProfile to set the profile parameter to AudioProfileMusicHighQuality(4) or AudioProfileMusicHighQualityStereo(5).
Restrictions
- Do not set the profile parameter in setAudioProfile to AudioProfileSpeechStandard(1) or AudioProfileIot(6), or the method does not take effect.
- This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
- After calling setVoiceConversionPreset, Agora does not recommend you to call the following methods, otherwise the effect set by setVoiceConversionPreset will be overwritten:
- 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
Gets the volume of a specified audio effect file.
abstract setVolumeOfEffect(soundId: number, volume: number): number;
Call timing
Call this method after playEffect.
Restrictions
None.
Parameters
- soundId
- The ID of the audio effect. The ID of each audio effect file is unique.
- volume
- The playback volume. The value range is [0, 100]. The default value is 100, which represents the original volume.
Returns
- 0: Success.
- < 0: Failure.
startAudioMixing
Starts playing the music file.
abstract startAudioMixing( filePath: string, loopback: boolean, cycle: number, startPos?: number ): number;
For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. If the local music file does not exist, the SDK does not support the file format, or the the SDK cannot access the music file URL, the SDK reports AudioMixingReasonCanNotOpen.
Call timing
You can call this method either before or after joining a channel.
Restrictions
- If you call this method to play short sound effect files, you may encounter playback failure. Agora recommends using playEffect instead to play such files.
- If you need to call this method multiple times, ensure that the time interval between calling this method is more than 500 ms.
Parameters
- filePath
- File path:
- Windows: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example
: C:\music\audio.mp4
. - macOS: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example:
/var/mobile/Containers/Data/audio.mp4
.
- Windows: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example
- loopback
-
Whether to only play music files on the local client:
true
: Only play music files on the local client so that only the local user can hear the music.false
: Publish music files to remote clients so that both the local user and remote users can hear the music.
- cycle
-
The number of times the music file plays.
- >0: The number of times for playback. For example, 1 represents playing 1 time.
- -1: Play the audio file in an infinite loop.
- startPos
- The playback position (ms) of the music file.
Returns
- 0: Success.
- < 0: Failure.
- -1: A general error occurs (no specified reason).
- -2: The parameter is invalid.
- -3: The SDK is not ready.
- The audio module is disabled.
- The program is not complete.
- The initialization of IRtcEngine fails. Reinitialize the IRtcEngine.
startAudioRecording
Starts audio recording on the client and sets recording configurations.
abstract startAudioRecording(config: AudioRecordingConfiguration): number;
- 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.
Call timing
Call this method after joining a channel.
Restrictions
None.
Parameters
- config
- Recording configurations. See AudioRecordingConfiguration.
Returns
- 0: Success.
- < 0: Failure.
startCameraCapture
Starts camera capture.
abstract startCameraCapture( sourceType: VideoSourceType, config: CameraCapturerConfiguration ): number;
Details
You can call this method to start capturing video from one or more cameras by specifying sourceType.
Parameters
- sourceType
-
The type of the video source. See VideoSourceType.
Note:- On the desktop platforms, you can capture video from up to 4 cameras.
- config
-
The configuration of the video capture. See CameraCapturerConfiguration.
Returns
- 0: Success.
- < 0: Failure.
stopCameraCapture
Stops camera capture.
abstract stopCameraCapture(sourceType: VideoSourceType): number;
Details
After calling startCameraCapture to start capturing video through one or more cameras, you can call this method and set the sourceType parameter to stop the capture from the specified cameras.
Parameters
- sourceType
- The type of the video source. See VideoSourceType.
Returns
- 0: Success.
- < 0: Failure.
startLastmileProbeTest
Starts the last mile network probe test.
abstract startLastmileProbeTest(config: LastmileProbeConfig): number;
This method starts the last-mile network probe test before joining a channel to get the uplink and downlink last mile network statistics, including the bandwidth, packet loss, jitter, and round-trip time (RTT).
Call timing
Do not call other methods before receiving the onLastmileQuality and onLastmileProbeResult callbacks. Otherwise, the callbacks may be interrupted.
Restrictions
None.
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;
After calling this method, you can merge multiple video streams into one video stream locally. For example, you can merge the video streams captured by the camera, screen sharing, media player, remote video, video files, images, etc. into one video stream, and then publish the mixed video stream to the channel.
Applicable scenarios
You can enable the local video mixing function in scenarios such as remote conferences, live streaming, and online education, which allows users to view and manage multiple videos more conveniently, and supports portrait-in-picture effect and other functions.
- Call enableVirtualBackground, and set the custom background image to BackgroundNone, that is, separate the portrait and the background in the video captured by the camera.
- Call startScreenCaptureBySourceType to start capturing the screen sharing video stream.
- Call this method and set the video source for capturing portraits as one of the video sources participating in the local video mixing, picture-in-picture of the portrait can be achived in the mixed video.
Call timing
- If you need to mix the locally collected video streams, you need to call this method after startCameraCapture or startScreenCaptureBySourceType.
- If you want to publish the mixed video stream to the channel, you need to set publishTranscodedVideoTrack in ChannelMediaOptions to
true
when calling joinChannel or updateChannelMediaOptions.
Restrictions
- Local video mixing requires more CPU resources. Therefore, Agora recommends enabling this function on devices with higher performance.
- If you need to mix locally captured video streams, the SDK supports the following capture combinations:
- On the Windows platform, it supports up to 4 video streams captured by cameras + 4 screen sharing streams.
- On the macOS platform, it supports up to 4 video streams captured by cameras + 1 screen sharing stream.
- When configuring the local video mixing, it is necessary to ensure that the layer number of the video stream capturing the portrait is greater than the layer number of the screen sharing stream. Otherwise, the portrait will be covered by the screen sharing and will not be displayed in the final mixed video stream.
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.
startOrUpdateChannelMediaRelay
Starts relaying media streams across channels or updates channels for media relay.
abstract startOrUpdateChannelMediaRelay( configuration: ChannelMediaRelayConfiguration ): number;
Details
The first successful call to this method starts relaying media streams from the source channel to the destination channels. To relay the media stream to other channels, or exit one of the current media relays, you can call this method again to update the destination channels. This feature supports relaying media streams to a maximum of six destination channels.
- If the onChannelMediaRelayStateChanged callback returns RelayStateRunning (2) and RelayOk (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
- If the onChannelMediaRelayStateChanged callback returns RelayStateFailure (3), an exception occurs during the media stream relay.
- Call this method after joining the channel.
- This method takes effect only when you are a host in a live streaming channel.
- 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.
- -8: Internal state error. Probably because the user is not a broadcaster.
startPreviewWithoutSourceType
Enables the local video preview.
abstract startPreviewWithoutSourceType(): number;
You can call this method to enable local video preview.
Call timing
This method must be called after enableVideo.
Restrictions
- The local preview enables the mirror mode by default.
- After leaving the channel, local preview remains enabled. You need to call stopPreview to disable local preview.
Returns
- 0: Success.
- < 0: Failure.
startPreview
Enables the local video preview and specifies the video source for the preview.
abstract startPreview(sourceType?: VideoSourceType): number;
This method is used to start local video preview and specify the video source that appears in the preview screen.
Call timing
This method must be called after enableVideo.
Restrictions
- The local preview enables the mirror mode by default.
- After leaving the channel, local preview remains enabled. You need to call stopPreview to disable local preview.
Parameters
- sourceType
- The type of the video source. See VideoSourceType.
Returns
- 0: Success.
- < 0: Failure.
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.
- 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 or configuration of transcoding is invalid; check your URL and transcoding configurations.
- -7: The SDK is not initialized before calling this method.
- -19: The Media Push URL is already in use; use another URL instead.
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.
- 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 or configuration of transcoding is invalid; check your URL and transcoding configurations.
- -7: The SDK is not initialized before calling this method.
- -19: The Media Push URL is already in use; use another URL instead.
startScreenCaptureByDisplayId
Captures the screen by specifying the display ID.
abstract startScreenCaptureByDisplayId( displayId: number, regionRect: Rectangle, captureParams: ScreenCaptureParameters ): number;
Captures the video stream of a screen or a part of the screen area.
Applicable scenarios
In the screen sharing scenario, you need to call this method to start capturing the screen video stream. For implementation guidance of screen sharing, please refer to .
Call timing
- Call this method before joining a channel, and then call joinChannel to join a channel and set publishScreenTrack or publishSecondaryScreenTrack to
true
to start screen sharing. - Call this method after joining a channel, and then call updateChannelMediaOptions to join a channel and set publishScreenTrack or publishSecondaryScreenTrack to
true
to start screen sharing.
Restrictions
None.
Parameters
- displayId
- The display ID of the screen to be shared.Note: For the Windows platform, if you need to simultaneously share two screens (main screen and secondary screen), you can set displayId to
-1
when calling this method. - regionRect
- (Optional) Sets the relative location of the region to the screen. Pass in
nil
to share the entire screen. - captureParams
- Screen sharing configurations. 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 ScreenCaptureParameters.Attention: The video properties of the screen sharing stream only need to be set through this parameter, and are unrelated to setVideoEncoderConfiguration.
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.
startScreenCaptureByWindowId
Captures the whole or part of a window by specifying the window ID.
abstract startScreenCaptureByWindowId( windowId: any, regionRect: Rectangle, captureParams: ScreenCaptureParameters ): number;
This method captures a window or part of the window. You need to specify the ID of the window to be captured.
This method supports window sharing of UWP (Universal Windows Platform) applications. Agora tests the mainstream UWP applications by using the lastest SDK, see details as follows:
System version | Software | Compatible versions | Support |
---|---|---|---|
win10 | Chrome | 76.0.3809.100 | No |
Office Word | 18.1903.1152.0 | Yes | |
Office Excel | No | ||
Office PPT | Yes | ||
WPS Word | 11.1.0.9145 | Yes | |
WPS Excel | |||
WPS PPT | |||
Media Player (comes with the system) | All | Yes | |
win8 | Chrome | All | Yes |
Office Word | All | Yes | |
Office Excel | |||
Office PPT | |||
WPS Word | 11.1.0.9098 | Yes | |
WPS Excel | |||
WPS PPT | |||
Media Player (comes with the system) | All | Yes | |
win7 | Chrome | 73.0.3683.103 | No |
Office Word | All | Yes | |
Office Excel | |||
Office PPT | |||
WPS Word | 11.1.0.9098 | No | |
WPS Excel | |||
WPS PPT | 11.1.0.9098 | Yes | |
Media Player (comes with the system) | All | No |
Applicable scenarios
In the screen sharing scenario, you need to call this method to start capturing the screen video stream. For implementation guidance of screen sharing, please refer to .
Call timing
- Call this method before joining a channel, and then call joinChannel to join a channel and set publishScreenTrack or publishSecondaryScreenTrack to
true
to start screen sharing. - Call this method after joining a channel, and then call updateChannelMediaOptions to join a channel and set publishScreenTrack or publishSecondaryScreenTrack to
true
to start screen sharing.
Restrictions
The window sharing feature of the Agora SDK relies on WGC (Windows Graphics Capture) or GDI (Graphics Device Interface) capture, and WGC cannot be set to disable mouse capture on systems earlier than Windows 10 2004. Therefore, captureMouseCursor(false)
might not work when you start window sharing on a device with a system earlier than Windows 10 2004. See ScreenCaptureParameters.
Parameters
- windowId
- The ID of the window to be shared.
- regionRect
- (Optional) Sets the relative location of the region to the screen. If you do not set this parameter, the SDK shares the whole screen. See Rectangle. If the specified region overruns the window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole window.
- captureParams
- Screen sharing configurations. 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 ScreenCaptureParameters.
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.
startScreenCaptureByScreenRect
Captures the whole or part of a screen by specifying the screen rect.
abstract startScreenCaptureByScreenRect( screenRect: Rectangle, regionRect: Rectangle, captureParams: ScreenCaptureParameters ): number;
Details
- Deprecated:
- This method is deprecated. Use startScreenCaptureByDisplayId instead. Agora strongly recommends using startScreenCaptureByDisplayId if you need to start screen sharing on a device connected to another display.
This method shares a screen or part of the screen. You need to specify the area of the screen to be shared.
- Call this method before joining a channel, and then call joinChannel to join a channel and set publishScreenTrack or publishSecondaryScreenTrack to
true
to start screen sharing. - Call this method after joining a channel, and then call updateChannelMediaOptions to join a channel and set publishScreenTrack or publishSecondaryScreenTrack to
true
to start screen sharing.
Parameters
- screenRect
- Sets the relative location of the screen to the virtual screen.
- regionRect
- Sets the relative location of the region to the screen. If you do not set this parameter, the SDK shares the whole screen. See Rectangle. If the specified region overruns the screen, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen.
- 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 ScreenCaptureParameters.
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.
stopAllEffects
Stops playing all audio effects.
abstract stopAllEffects(): number;
When you no longer need to play the audio effect, you can call this method to stop the playback. If you only need to pause the playback, call pauseAllEffects.
Call timing
Call this method after playEffect.
Restrictions
None.
Returns
- 0: Success.
- < 0: Failure.
stopAudioMixing
Stops playing the music file.
abstract stopAudioMixing(): number;
After calling startAudioMixing to play a music file, you can call this method to stop the playing. If you only need to pause the playback, call pauseAudioMixing.
Call timing
Call this method after joining a channel.
Restrictions
None.
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.
Returns
- 0: Success.
- < 0: Failure.
- -5: The method call was rejected. There is no ongoing channel media relay.
stopEchoTest
Stops the audio call test.
abstract stopEchoTest(): number;
After calling startEchoTest, you must call this method to end the test; otherwise, the user cannot perform the next audio and video call loop test and cannot join the channel.
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;
When you no longer need to play the audio effect, you can call this method to stop the playback. If you only need to pause the playback, call pauseEffect.
Call timing
Call this method after playEffect.
Restrictions
None.
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;
Applicable scenarios
After calling startPreview to start the preview, if you want to stop the local video preview, call this method.
Call timing
Call this method before joining a channel or after leaving a channel.
Restrictions
None.
Parameters
- sourceType
- The type of the video source. See VideoSourceType.
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;
Applicable scenarios
If you start screen capture by calling startScreenCaptureBySourceType, startScreenCaptureByWindowId, or startScreenCaptureByDisplayId, you need to call this method to stop screen capture.
Call timing
You can call this method either before or after joining a channel.
Restrictions
None.
Returns
- 0: Success.
- < 0: Failure.
takeSnapshot
Takes a snapshot of a video stream.
abstract takeSnapshot(uid: number, filePath: string): number;
This method takes a snapshot of a video stream from the specified user, generates a JPG image, and saves it to the specified path.
Call timing
Call this method after joining a channel.
Restrictions
- The method is asynchronous, and the SDK has not taken the snapshot when the method call returns.
- 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:
- Windows:
C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.jpg
- macOS:
~/Library/Logs/example.jpg
Attention: Ensure that the path you specify exists and is writable. - Windows:
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;
After loading the audio effect file into memory using preloadEffect, if you need to release the audio effect file, call this method.
Call timing
You can call this method either before or after joining a channel.
Restrictions
None.
Parameters
- soundId
- The ID of the audio effect. Each audio effect has a unique ID.
Returns
- 0: Success.
- < 0: Failure.
unregisterAudioEncodedFrameObserver
Unregisters the encoded audio frame observer.
abstract unregisterAudioEncodedFrameObserver( observer: IAudioEncodedFrameObserver ): number;
Parameters
- observer
- The encoded audio observer. See IAudioEncodedFrameObserver.
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.
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 ChannelMediaOptions 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 see whether the user is 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.
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.
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.
updateScreenCaptureParameters
Updates the screen capturing parameters.
abstract updateScreenCaptureParameters( captureParams: ScreenCaptureParameters ): number;
Details
- 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 ScreenCaptureParameters.Attention: The video properties of the screen sharing stream only need to be set through this parameter, and are unrelated to setVideoEncoderConfiguration.
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
Parameters
- regionRect
- The relative location of the screen-share area to the screen or window. If you do not set this parameter, the SDK shares the whole screen or window. See Rectangle. If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window.
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.