API Overview
Agora provides ensured quality of experience (QoE) for worldwide Internet-based voice and video communications through SD-RTN™.
Initialization related
| Method / Callback | Description |
|---|---|
| Initialize | Initializes IRtcEngine. |
| Release | Releases the IRtcEngine instance. |
Channel related
| Method / Callback | Description |
|---|---|
| SetChannelProfile | Sets the channel profile. |
| JoinChannel | Joins a channel with media options. |
| JoinChannelEx | Joins a channel with the connection ID. |
| UpdateChannelMediaOptions | Updates the channel media options after joining the channel. |
| UpdateChannelMediaOptionsEx | Updates the channel media options after joining the channel. |
| LeaveChannel | Sets channel options and leaves the channel. |
| LeaveChannelEx | Sets channel options and leaves the channel. |
| RenewToken | Renews the token. |
| SetClientRole | Sets the user role and level in an interactive live streaming channel. |
| FOnJoinChannelSuccess | Occurs when a user joins a channel. |
| FOnRejoinChannelSuccess | Occurs when a user rejoins the channel. |
| FOnClientRoleChanged | Occurs when the user role switches during the interactive live streaming. |
| FOnClientRoleChangeFailed | Occurs when the user role switching fails in the interactive live streaming. |
| FOnLeaveChannel | Occurs when a user leaves a channel. |
| FOnUserJoined | Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) joins the channel. |
| FOnUserOffline | Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) leaves the channel. |
| FOnNetworkTypeChanged | Occurs when the local network type changes. |
| FOnUplinkNetworkInfoUpdated | Occurs when the uplink network information changes. |
| FOnConnectionLost | Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the server is interrupted. |
| FOnConnectionStateChanged | Occurs when the network connection state changes. |
| FOnRequestToken | Occurs when the token expires. |
| FOnTokenPrivilegeWillExpire | Occurs when the token expires in 30 seconds. |
| FOnError | Reports an error during SDK runtime. |
Publish and subscription
| Method / Callback | Description |
|---|---|
| MuteLocalAudioStream | Stops or resumes publishing the local audio stream. |
| MuteLocalAudioStreamEx | Stops or resumes publishing the local audio stream. |
| MuteRemoteAudioStream | Stops or resumes subscribing to the audio stream of a specified user. |
| MuteRemoteAudioStreamEx | Stops or resumes receiving the audio stream of a specified user. |
| MuteAllRemoteAudioStreams | Stops or resumes subscribing to the audio streams of all remote users. |
| MuteAllRemoteAudioStreamsEx | Stops or resumes subscribing to the audio streams of all remote users. |
| MuteLocalVideoStream | Stops or resumes publishing the local video stream. |
| MuteLocalVideoStreamEx | Stops or resumes publishing the local video stream. |
| MuteRemoteVideoStream | Stops or resumes subscribing to the video stream of a specified user. |
| MuteRemoteVideoStreamEx | Stops or resumes receiving the video stream of a specified user. |
| MuteAllRemoteVideoStreams | Stops or resumes subscribing to the video streams of all remote users. |
| MuteAllRemoteVideoStreamsEx | Stops or resumes subscribing to the video streams of all remote users. |
| SetRemoteVideoSubscriptionOptions | Options for subscribing to remote video streams. |
| SetRemoteVideoSubscriptionOptionsEx | Options for subscribing to remote video streams. |
| SetSubscribeAudioBlocklist | Set the blocklist of subscriptions for audio streams. |
| SetSubscribeAudioBlocklistEx | Set the blocklist of subscriptions for audio streams. |
| SetSubscribeAudioAllowlist | Sets the allowlist of subscriptions for audio streams. |
| SetSubscribeAudioAllowlistEx | Sets the allowlist of subscriptions for audio streams. |
| SetSubscribeVideoBlocklist | Set the blocklist of subscriptions for video streams. |
| SetSubscribeVideoBlocklistEx | Set the blocklist of subscriptions for video streams. |
| SetSubscribeVideoAllowlist | Set the allowlist of subscriptions for video streams. |
| SetSubscribeVideoAllowlistEx | Set the allowlist of subscriptions for video streams. |
| FOnAudioPublishStateChanged | Occurs when the audio publishing state changes. |
| FOnAudioSubscribeStateChanged | Occurs when the audio subscribing state changes. |
| FOnVideoSubscribeStateChanged | Occurs when the video subscribing state changes. |
Audio basic functions
| Method / Callback | Description |
|---|---|
| AdjustUserPlaybackSignalVolume | Adjusts the playback signal volume of a specified remote user. |
| AdjustUserPlaybackSignalVolumeEx | Adjusts the playback signal volume of a specified remote user. |
| AdjustCustomAudioPlayoutVolume | Adjusts the volume of the custom audio track played locally. |
| AdjustCustomAudioPublishVolume | Adjusts the volume of the custom audio track played remotely. |
| AdjustPlaybackSignalVolume | Adjusts the playback signal volume of all remote users. |
| EnableAudio | Enables the audio module. |
| DisableAudio | Disables the audio module. |
| EnableAudioVolumeIndication | Enables the reporting of users' volume indication. |
| EnableAudioVolumeIndicationEx | Enables the reporting of users' volume indication. |
| SetHeadphoneEQPreset | Sets the preset headphone equalization effect. |
| SetHeadphoneEQParameters | Sets the low- and high-frequency parameters of the headphone equalizer. |
| SetAudioProfile | Sets the audio parameters and application scenarios. |
| SetAudioScenario | Sets audio scenarios. |
| SetAudioSessionOperationRestriction | Sets the operational permission of the SDK on the audio session. |
| FOnAudioVolumeIndication | Reports the volume information of users. |
| FOnActiveSpeaker | Occurs when the most active remote speaker is detected. |
| FOnLocalAudioStateChanged | Occurs when the local audio stream state changes. |
| FOnFirstLocalAudioFramePublished | Occurs when the first audio frame is published. |
| FOnFirstRemoteAudioFrame | Occurs when the SDK receives the first audio frame from a specific remote user. |
| FOnUserMuteAudio | Occurs when a remote user (in the communication profile) or a host (in the live streaming profile) stops/resumes sending the audio stream. |
| FOnRemoteAudioStateChanged | Occurs when the remote audio state changes. |
| FOnLocalAudioStats | Reports the statistics of the local audio stream. |
| FOnRemoteAudioStats | Reports the transport-layer statistics of each remote audio stream. |
| FOnReceiveAudioPacket | Occurs when the local user receives an audio packet. |
| FOnSendAudioPacket | Occurs when the local user sends an audio packet. |
Audio capture
| Method / Callback | Description |
|---|---|
| EnableLocalAudio | Enables or disables the local audio capture. |
| EnableLoopbackRecording | Enables loopback audio capturing. |
| EnableLoopbackRecordingEx | Enables loopback audio capturing. |
| AdjustRecordingSignalVolume | Adjusts the capturing signal volume. |
| AdjustLoopbackSignalVolume | Adjusts the volume of the signal captured by the sound card. |
| MuteRecordingSignal | Whether to mute the recording signal. |
| GetAudioDeviceInfo | Gets the audio device information. |
| EnableInEarMonitoring | Enables in-ear monitoring. |
| SetInEarMonitoringVolume | Sets the volume of the in-ear monitor. |
| SetEarMonitoringAudioFrameParameters | Sets the format of the in-ear monitoring raw audio data. |
Audio pre-processing and post-processing
| Method / Callback | Description |
|---|---|
| SetAdvancedAudioOptions | Sets audio advanced options. |
| SetAINSMode | Sets whether to enable the AI noise suppression function and set the noise suppression mode. |
| SetLocalVoiceEqualization | Sets the local voice equalization effect. |
| SetLocalVoicePitch | Changes the voice pitch of the local speaker. |
| SetLocalVoiceReverb | Sets the local voice reverberation. |
| SetVoiceBeautifierPreset | Sets a preset voice beautifier effect. |
| SetVoiceBeautifierParameters | Sets parameters for the preset voice beautifier effects. |
| SetAudioEffectPreset | Sets an SDK preset audio effect. |
| SetAudioEffectParameters | Sets parameters for SDK preset audio effects. |
| SetVoiceConversionPreset | Sets a preset voice beautifier effect. |
| SetLocalVoiceFormant | Set the formant ratio to change the timbre of human voice. |
| EnableSoundPositionIndication | Enables or disables stereo panning for remote users. |
| SetRemoteVoicePosition | Sets the 2D position (the position on the horizontal plane) of the remote user's voice. |
| SetRemoteVoicePositionEx | Sets the 2D position (the position on the horizontal plane) of the remote user's voice. |
| Initialize | Initializes ILocalSpatialAudioEngine. |
| UpdateSelfPosition | Updates the spatial position of the local user. |
| UpdateRemotePosition | Updates the spatial position of the specified remote user. |
| RemoveRemotePosition | Removes the spatial position of the specified remote user. |
| ClearRemotePositions | Removes the spatial positions of all remote users. |
Raw audio data
| Method / Callback | Description |
|---|---|
| SetRecordingAudioFrameParameters | Sets the format of the captured raw audio data. |
| SetPlaybackAudioFrameParameters | Sets the audio data format for playback. |
| SetMixedAudioFrameParameters | Sets the audio data format reported by FOnMixedAudioFrame. |
| SetPlaybackAudioFrameBeforeMixingParameters | Sets the audio data format reported by FOnPlaybackAudioFrameBeforeMixing. |
| FOnRecordAudioFrame | Gets the captured audio frame. |
| FOnFrame | Occurs each time the player receives an audio frame. |
| FOnPlaybackAudioFrame | Gets the raw audio frame for playback. |
| FOnPlaybackAudioFrameBeforeMixing | Retrieves the audio frame of a specified user before mixing. |
| FOnMixedAudioFrame | Retrieves the mixed captured and playback audio frame. |
| FGetObservedAudioFramePosition | Sets the frame position for the video observer. |
| FGetRecordAudioParams | Sets the audio format for the FOnRecordAudioFrame callback. |
| FGetPlaybackAudioParams | Sets the audio format for the FOnPlaybackAudioFrame callback. |
| FGetMixedAudioParams | Sets the audio format for the FOnMixedAudioFrame callback. |
Encoded audio data
| Method / Callback | Description |
|---|---|
| RegisterAudioEncodedFrameObserver | Registers an encoded audio observer. |
| FOnRecordAudioEncodedFrame | Gets the encoded audio data of the local user. |
| FOnPlaybackAudioEncodedFrame | Gets the encoded audio data of all remote users. |
| FOnMixedAudioEncodedFrame | Gets the mixed and encoded audio data of the local and all remote users. |
Custom audio capture and renderer
| Method / Callback | Description |
|---|---|
| AdjustCustomAudioPlayoutVolume | Adjusts the volume of the custom audio track played locally. |
| AdjustCustomAudioPublishVolume | Adjusts the volume of the custom audio track played remotely. |
Audio spectrum
| Method / Callback | Description |
|---|---|
| RegisterAudioSpectrumObserver | Register an audio spectrum observer. |
| EnableAudioSpectrumMonitor | Turns on audio spectrum monitoring. |
| DisableAudioSpectrumMonitor | Disables audio spectrum monitoring. |
| UnregisterAudioSpectrumObserver | Unregisters the audio spectrum observer. |
| FOnLocalAudioSpectrum | Gets the statistics of a local audio spectrum. |
| FOnRemoteAudioSpectrum | Gets the remote audio spectrum. |
Video basic functions
| Method / Callback | Description |
|---|---|
| EnableVideo | Enables the video module. |
| DisableVideo | Disables the video module. |
| SetVideoScenario | Sets video application scenarios. |
| SetVideoEncoderConfiguration | Sets the video encoder configuration. |
| SetVideoEncoderConfigurationEx | Sets the encoder configuration for the local video. |
| StartPreview | Enables the local video preview and specifies the video source for the preview. |
| StopPreview | Stops the local video preview. |
| FOnLocalVideoStateChanged | Occurs when the local video stream state changes. |
| FOnLocalVideoStats | Reports the statistics of the local video stream. |
| FOnFirstLocalVideoFramePublished | Occurs when the first video frame is published. |
| FOnVideoPublishStateChanged | Occurs when the video publishing state changes. |
| FOnVideoSizeChanged | Occurs when the video size or rotation of a specified user changes. |
| FOnRemoteVideoStateChanged | Occurs when the remote video stream state changes. |
| FOnRemoteVideoStats | Reports the statistics of the video stream sent by each remote users. |
| FOnFirstLocalVideoFrame | Occurs when the first local video frame is displayed on the local video view. |
| FOnFirstRemoteVideoFrame | Occurs when the renderer receives the first frame of the remote video. |
| FOnFirstRemoteVideoDecoded | Occurs when the first remote video frame is received and decoded. |
| FOnUserMuteVideo | Occurs when a remote user stops or resumes publishing the video stream. |
| FOnUserEnableVideo | Occurs when a remote user enables or disables the video module. |
Video capture
| Method / Callback | Description |
|---|---|
| EnableLocalVideo | Enables/Disables the local video capture. |
| StartCameraCapture | Starts camera capture. |
| StopCameraCapture | Stops camera capture. |
| FOnUserEnableLocalVideo | Occurs when a specific remote user enables/disables the local video capturing function. |
Video pre-processing and post-processing
| Method / Callback | Description |
|---|---|
| TakeSnapshot | Takes a snapshot of a video stream. |
| TakeSnapshotEx | Takes a snapshot of a video stream. |
| EnableVirtualBackground | Enables/Disables the virtual background. |
| EnableVideoImageSource | Sets whether to replace the current video feeds with images when publishing video streams. |
| SetBeautyEffectOptions | Sets the image enhancement options. |
| SetColorEnhanceOptions | Sets color enhancement. |
| SetLowlightEnhanceOptions | Sets low-light enhancement. |
| SetVideoDenoiserOptions | Sets video noise reduction. |
| EnableFaceDetection | Enables or disables face detection for the local user. |
| FOnFacePositionChanged | Reports the face detection result of the local user. |
| FOnSnapshotTaken | Reports the result of taking a video snapshot. |
| AddVideoWatermark | Adds a watermark image to the local video. |
| AddVideoWatermarkEx | Adds a watermark image to the local video. |
| ClearVideoWatermarks | Removes the watermark image from the video stream. |
| ClearVideoWatermarkEx | Removes the watermark image from the video stream. |
Video encoding
| Method / Callback | Description |
|---|---|
| SetRemoteVideoStreamType | Sets the stream type of the remote video. |
| SetRemoteVideoStreamTypeEx | Sets the stream type of the remote video. |
| SetRemoteDefaultVideoStreamType | Sets the default stream type of subscrption for remote video streams. |
| EnableDualStreamMode | Enables or disables the dual-stream mode on the sender and sets the low-quality video stream. |
| EnableDualStreamModeEx | Enables or disables dual-stream mode on the sender side. |
| SetDualStreamMode | Sets dual-stream mode configuration on the sender, and sets the low-quality video stream. |
| SetDualStreamModeEx | Sets the dual-stream mode on the sender side. |
| StartLocalVideoTranscoder | Starts the local video mixing. |
| StopLocalVideoTranscoder | Stops the local video mixing. |
| UpdateLocalTranscoderConfiguration | Updates the local video mixing configuration. |
| FOnLocalVideoTranscoderError | Occurs when there's an error during the local video mixing. |
Video rendering
| Method / Callback | Description |
|---|---|
| SetRenderMode | Sets the render mode of the media player. |
| SetLocalRenderMode | Updates the display mode of the local video view. |
| SetRemoteRenderMode | Updates the display mode of the video view of a remote user. |
| SetRemoteRenderModeEx | Sets the video display mode of a specified remote user. |
| SetView | Sets the view. |
| SetupLocalVideo | Initializes the local video view. |
| SetupRemoteVideo | Initializes the video view of a remote user. |
| SetupRemoteVideoEx | Initializes the video view of a remote user. |
| EnableInstantMediaRendering | Enables audio and video frame instant rendering. |
| StartMediaRenderingTracing | Enables tracing the video frame rendering process. |
| StartMediaRenderingTracingEx | Enables tracing the video frame rendering process. |
| FOnVideoRenderingTracingResult | Video frame rendering event callback. |
Raw video data
| Method / Callback | Description |
|---|---|
| FOnCaptureVideoFrame | Occurs each time the SDK receives a video frame captured by local devices. |
| FOnFrame | Occurs each time the player receives a video frame. |
| FOnPreEncodeVideoFrame | Occurs each time the SDK receives a video frame before encoding. |
| FOnRenderVideoFrame | Occurs each time the SDK receives a video frame sent by the remote user. |
| FGetObservedFramePosition | Sets the frame position for the video observer. |
| FGetVideoFrameProcessMode | Occurs each time the SDK receives a video frame and prompts you to set the process mode of the video frame. |
| FGetMirrorApplied | Occurs each time the SDK receives a video frame and prompts you whether or not to mirror the captured video. |
| FGetRotationApplied | Occurs each time the SDK receives a video frame, and prompts you whether to rotate the captured video. |
| FGetVideoFormatPreference | Sets the format of the raw video data output by the SDK. |
Music file playback
| Method / Callback | Description |
|---|---|
| StartAudioMixing | Starts playing the music file. |
| StopAudioMixing | Stops playing and mixing the music file. |
| PauseAudioMixing | Pauses playing and mixing the music file. |
| ResumeAudioMixing | Resumes playing and mixing the music file. |
| AdjustAudioMixingVolume | Adjusts the volume during audio mixing. |
| AdjustAudioMixingPlayoutVolume | Adjusts the volume of audio mixing for local playback. |
| AdjustAudioMixingPublishVolume | Adjusts the volume of audio mixing for publishing. |
| GetAudioMixingPlayoutVolume | Retrieves the audio mixing volume for local playback. |
| GetAudioMixingPublishVolume | Retrieves the audio mixing volume for publishing. |
| GetAudioMixingDuration | Retrieves the duration (ms) of the music file. |
| GetAudioMixingCurrentPosition | Retrieves the playback position (ms) of the music file. |
| SetAudioMixingPitch | Sets the pitch of the local music file. |
| SetAudioMixingPosition | Sets the audio mixing position. |
| SetAudioMixingDualMonoMode | Sets the channel mode of the current audio file. |
| GetAudioTrackCount | Gets the index of audio tracks of the current music file. |
| SelectAudioTrack | Selects the audio track used during playback. |
| FOnAudioMixingStateChanged | Occurs when the playback state of the music file changes. |
| FOnAudioMixingPositionChanged | Reports the playback progress of a music file. |
Audio effect file playback
| Method / Callback | Description |
|---|---|
| GetEffectsVolume | Retrieves the volume of the audio effects. |
| SetEffectsVolume | Sets the volume of the audio effects. |
| GetVolumeOfEffect | Gets the volume of a specified audio effect file. |
| SetVolumeOfEffect | Sets the volume of a specified audio effect. |
| PreloadEffect | Preloads a specified audio effect file into the memory. |
| PlayEffect | Plays the specified local or online audio effect file. |
| PlayAllEffects | Plays all audio effect files. |
| PauseEffect | Pauses a specified audio effect file. |
| PauseAllEffects | Pauses all audio effects. |
| ResumeEffect | Resumes playing a specified audio effect. |
| ResumeAllEffects | Resumes playing all audio effect files. |
| StopEffect | Stops playing a specified audio effect. |
| StopAllEffects | Stops playing all audio effects. |
| UnloadEffect | Releases a specified preloaded audio effect from the memory. |
| UnloadAllEffects | Releases a specified preloaded audio effect from the memory. |
| GetEffectDuration | Retrieves the duration of the audio effect file. |
| GetEffectCurrentPosition | Retrieves the playback position of the audio effect file. |
| SetEffectPosition | Sets the playback position of an audio effect file. |
| FOnAudioEffectFinished | Occurs when the playback of the local music file finishes. |
Virtual metronome
Note:
This group of methods is for Android and iOS only.
| Method / Callback | Description |
|---|---|
| StartRhythmPlayer | Enables the virtual metronome. |
| StopRhythmPlayer | Disables the virtual metronome. |
| ConfigRhythmPlayer | Configures the virtual metronome. |
| FOnRhythmPlayerStateChanged | Occurs when the state of virtual metronome changes. |
Media player
For more methods about the media player, see IMediaPlayer.
| Method / Callback | Description |
|---|---|
| CreateMediaPlayer | Creates a media player instance. |
| IMediaPlayer | This class provides media player functions and supports multiple instances. |
| IMediaPlayerCacheManager | This class provides methods to manage cached media files. |
| IMediaPlayerSourceObserver | Provides callbacks for media players. |
Media player cache
| Method / Callback | Description |
|---|---|
| EnableAutoRemoveCache | Sets whether to delete cached media files automatically. |
| RemoveAllCaches | Deletes all cached media files in the media player. |
| RemoveCacheByUri | Deletes a cached media file. |
| RemoveOldCache | Deletes a cached media file that is the least recently used. |
| SetCacheDir | Sets the storage path for the media files that you want to cache. |
| SetMaxCacheFileCount | Sets the maximum number of media files that can be cached. |
| SetMaxCacheFileSize | Sets the maximum size of the aggregate storage space for cached media files. |
| GetCacheDir | Gets the storage path of the cached media files. |
| GetCacheFileCount | Gets the number of media files that are cached. |
| GetMaxCacheFileCount | Gets the maximum number of media files that can be cached. |
| GetMaxCacheFileSize | Gets the maximum size of the aggregate storage space for cached media files. |
Channel media stream relay
| Method / Callback | Description |
|---|---|
| StartChannelMediaRelay | Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels. |
| StartChannelMediaRelayEx | Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels. |
| UpdateChannelMediaRelay | Updates the channels for media stream relay. |
| UpdateChannelMediaRelayEx | Updates the channels for media stream relay. |
| StartOrUpdateChannelMediaRelay | Starts relaying media streams across channels or updates channels for media relay. |
| StartOrUpdateChannelMediaRelayEx | Starts relaying media streams across channels or updates channels for media relay. |
| StopChannelMediaRelay | Stops the media stream relay. Once the relay stops, the host quits all the target channels. |
| StopChannelMediaRelayEx | Stops the media stream relay. Once the relay stops, the host quits all the target channels. |
| PauseAllChannelMediaRelay | Pauses the media stream relay to all target channels. |
| PauseAllChannelMediaRelayEx | Pauses the media stream relay to all target channels. |
| ResumeAllChannelMediaRelay | Resumes the media stream relay to all target channels. |
| ResumeAllChannelMediaRelayEx | Resumes the media stream relay to all target channels. |
| FOnChannelMediaRelayStateChanged | Occurs when the state of the media stream relay changes. |
| FOnChannelMediaRelayEvent | Reports events during the media stream relay. |
Media push
| Method / Callback | Description |
|---|---|
| StartRtmpStreamWithoutTranscoding | Starts pushing media streams to a CDN without transcoding. |
| StartRtmpStreamWithoutTranscodingEx | Starts pushing media streams to a CDN without transcoding. |
| StartRtmpStreamWithTranscoding | Starts Media Push and sets the transcoding configuration. |
| StartRtmpStreamWithTranscodingEx | Starts Media Push and sets the transcoding configuration. |
| UpdateRtmpTranscoding | Updates the transcoding configuration. |
| UpdateRtmpTranscodingEx | Updates the transcoding configuration. |
| StopRtmpStream | Stops pushing media streams to a CDN. |
| StopRtmpStreamEx | Stops pushing media streams to a CDN. |
| FOnRtmpStreamingEvent | Reports events during the Media Push. |
| FOnRtmpStreamingStateChanged | Occurs when the state of Media Push changes. |
| FOnTranscodingUpdated | Occurs when the publisher's transcoding is updated. |
Pushing streams to a CDN directly
| Method / Callback | Description |
|---|---|
| StartDirectCdnStreaming | Starts pushing media streams to the CDN directly. |
| StopDirectCdnStreaming | Stops pushing media streams to the CDN directly. |
| SetDirectCdnStreamingAudioConfiguration | Sets the audio profile of the audio streams directly pushed to the CDN by the host. |
| SetDirectCdnStreamingVideoConfiguration | Sets the video profile of the media streams directly pushed to the CDN by the host. |
| FOnDirectCdnStreamingStateChanged | Occurs when the CDN streaming state changes. |
| FOnDirectCdnStreamingStats | Reports the CDN streaming statistics. |
Data stream
| Method / Callback | Description |
|---|---|
| CreateDataStream | Creates a data stream. |
| CreateDataStreamEx | Creates a data stream. |
| SendStreamMessage | Sends data stream messages. |
| FOnStreamMessage | Occurs when the local user receives the data stream from the remote user. |
| FOnStreamMessageError | Occurs when the local user does not receive the data stream from the remote user. |
Metadata (SEI)
| Method / Callback | Description |
|---|---|
| RegisterMediaMetadataObserver | Registers the metadata observer. |
| UnregisterMediaMetadataObserver | Unregisters the specified metadata observer. |
| FGetMaxMetadataSize | Occurs when the SDK requests the maximum size of the metadata. |
| FOnReadyToSendMetadata | Occurs when the SDK is ready to send metadata. |
| FOnMetaData | Occurs when the media metadata is received. |
| FOnMetadataReceived | Occurs when the local user receives the metadata. |
Audio route
This group of method is for Android and iOS only.
| Method / Callback | Description |
|---|---|
| SetDefaultAudioRouteToSpeakerphone | Sets the default audio playback route. |
| SetEnableSpeakerphone | Enables/Disables the audio route to the speakerphone. |
| IsSpeakerphoneEnabled | Checks whether the speakerphone is enabled. |
| FOnAudioRoutingChanged | Occurs when the local audio route changes. |
Mobile camera management
This group of method is for Android and iOS only.
| Method / Callback | Description |
|---|---|
| EnableMultiCamera | Enables or disables multi-camera capture.(For iOS only) |
| SwitchCamera | Switches between front and rear cameras. |
| SetCameraCapturerConfiguration | Sets the camera capture configuration. |
| IsCameraZoomSupported | Checks whether the device supports camera zoom. |
| GetCameraMaxZoomFactor | Gets the maximum zoom ratio supported by the camera. |
| SetCameraZoomFactor | Sets the camera zoom ratio. |
| IsCameraTorchSupported | Checks whether the device supports camera flash. |
| SetCameraTorchOn | Enables the camera flash. |
| IsCameraFaceDetectSupported | Checks whether the device camera supports face detection. |
| IsCameraFocusSupported | Check whether the device supports the manual focus function. |
| SetCameraFocusPositionInPreview | Sets the camera manual focus position. |
| IsCameraAutoFocusFaceModeSupported | Checks whether the device supports the face auto-focus function. |
| SetCameraAutoFocusFaceModeEnabled | Enables the camera auto-face focus function. |
| IsCameraExposurePositionSupported | Checks whether the device supports manual exposure. |
| IsCameraAutoExposureFaceModeSupported | Checks whether the device supports auto exposure.(For iOS only) |
| SetCameraExposurePosition | Sets the camera exposure position. |
| SetCameraAutoExposureFaceModeEnabled | Sets whether to enable auto exposure.(For iOS only) |
| FOnCameraFocusAreaChanged | Occurs when the camera focus area changes. |
| FOnCameraExposureAreaChanged | Occurs when the camera exposure area changes. |
Desktop audio device management
This group of methods is for Windows and macOS only.
| Method / Callback | Description |
|---|---|
| EnumeratePlaybackDevices | Enumerates the audio playback devices. |
| EnumerateRecordingDevices | Enumerates the audio capture devices. |
| FollowSystemPlaybackDevice | Sets the audio playback device used by the SDK to follow the system default audio playback device. |
| FollowSystemRecordingDevice | Sets the audio recording device used by the SDK to follow the system default audio recording device. |
| SetPlaybackDevice | Sets the audio playback device. |
| GetPlaybackDevice | Retrieves the audio playback device associated with the device ID. |
| GetPlaybackDeviceInfo | Retrieves the audio playback device information associated with the device ID and device name. |
| SetRecordingDevice | Sets the audio capture device. |
| GetRecordingDevice | Gets the current audio recording device. |
| GetRecordingDeviceInfo | Retrieves the information of the audio recording device. |
| SetRecordingDeviceVolume | Sets the volume of the audio capture device. |
| SetPlaybackDeviceMute | Mutes the audio playback device. (For Windows only) |
| GetPlaybackDeviceMute | Retrieves whether the audio playback device is muted. (For Windows only) |
| StartPlaybackDeviceTest | Starts the audio playback device test. |
| StopPlaybackDeviceTest | Stops the audio playback device test. |
| StartRecordingDeviceTest | Starts the audio capture device test. |
| StopRecordingDeviceTest | Stops the audio capture device test. |
| StartAudioDeviceLoopbackTest | Starts an audio device loopback test. |
| StopAudioDeviceLoopbackTest | Stops the audio device loopback test. |
| Release | Releases all the resources occupied by the IAudioDeviceManager object. (For Windows only) |
| SetDevice | Specifies an audio device. |
| GetDefaultDevice | Gets the default audio device of the system. |
| GetDevice | Gets the information of a specified audio device. |
| GetCount | Gets the total number of audio playback or audio capture devices. |
| SetApplicationVolume | Sets the app volume. |
| GetApplicationVolume | Gets the volume of the application. |
| SetApplicationMute | Mutes/Unmutes the app. |
| IsApplicationMute | Gets whether the app is muted. |
| Release | Releases all the resources occupied by the IAudioDeviceCollection object. |
| FOnAudioDeviceStateChanged | Occurs when the audio device state changes. |
| FOnAudioDeviceVolumeChanged | Reports the volume change of the audio device or app. |
Desktop video device management
This group of methods is for Windows and macOS only.
| Method / Callback | Description |
|---|---|
| EnumerateVideoDevices | Enumerates the video devices. |
| SetDevice | Specifies the video capture device with the device ID. |
| GetDevice | Retrieves the current video capture device. |
| Release | Releases all the resources occupied by the IVideoDeviceManager object. |
| GetCapability | Gets the detailed video frame information of the video capture device in the specified video format. |
| NumberOfCapabilities | Gets the number of video formats supported by the specified video capture device. |
| QueryCodecCapability | Queries the current device's supported video codec capabilities. |
| SetCameraDeviceOrientation | Sets the rotation angle of the captured video. (For Windows only) |
| SetDevice | Specifies a device with the device ID. |
| GetDevice | Gets a specified piece of information about an indexed video device. |
| GetCount | Gets the total number of the indexed video devices in the system. |
| Release | Releases all the resources occupied by the IVideoDeviceCollection object. |
| FOnVideoDeviceStateChanged | Occurs when the video device state changes. |
Extension
| Method / Callback | Description |
|---|---|
| EnableExtension | Enables or disables extensions. |
| LoadExtensionProvider | Adds an extension to the SDK. |
| SetExtensionProperty | Sets the properties of the extension. |
| SetExtensionProviderProperty | Sets the properties of the extension provider. |
| GetExtensionProperty | Gets detailed information on the extensions. |
| RegisterExtension | Registers an extension. (For Windows only) |
| FOnExtensionEvent | The event callback of the extension. |
| FOnExtensionStarted | Occurs when the extension is enabled. |
| FOnExtensionStopped | Occurs when the extension is disabled. |
| FOnExtensionError | Occurs when the extension runs incorrectly. |
Network and Others
| Method / Callback | Description |
|---|---|
| StartEchoTest | Starts an audio device loopback test. |
| StopEchoTest | Stops the audio call test. |
| StartLastmileProbeTest | Starts the last mile network probe test. |
| StopLastmileProbeTest | Stops the last mile network probe test. |
| FOnLastmileQuality | Reports the last-mile network quality of the local user. |
| FOnLastmileProbeResult | Reports the last mile network probe result. |
| GetCurrentMonotonicTimeInMs | Gets the current Monotonic Time of the SDK. |
| SetCloudProxy | Sets up cloud proxy service. |
| SetParameters | Provides technical preview functionalities or special customizations by configuring the SDK with JSON options. |
| GetCallId | Retrieves the call ID. |
| Rate | Allows a user to rate a call after the call ends. |
| Complain | Allows a user to complain about the call quality after a call ends. |
| GetConnectionState | Gets the current connection state of the SDK. |
| GetConnectionStateEx | Gets the current connection state of the SDK. |
| GetVersion | Gets the SDK version. |
| GetErrorDescription | Gets the warning or error description. |
| QueryInterface | Gets the pointer to the specified interface. |
| GetNetworkType | Gets the type of the local network connection. |
| GetNtpWallTimeInMs | Gets the current NTP (Network Time Protocol) time. |
| EnableEncryption | Enables or disables the built-in encryption. |
| RegisterPacketObserver | Registers a packet observer. |
| SendCustomReportMessage | Reports customized messages. |
| SendCustomReportMessageEx | Agora supports reporting and analyzing customized messages. |
| FOnReceiveVideoPacket | Occurs when the local user receives a video packet. |
| FOnSendVideoPacket | Occurs when the local user sends a video packet. |
| FOnEncryptionError | Reports the built-in encryption errors. |
| FOnProxyConnected | Reports the proxy connection state. |
| FOnNetworkQuality | Reports the last mile network quality of each user in the channel. |
| FOnRtcStats | Reports the statistics of the current call. |
| FOnPermissionError | Occurs when the SDK cannot get the device permission. |