API Overview

Agora provides ensured quality of experience (QoE) for worldwide Internet-based voice and video communications through SD-RTN™.

Channel management

Method Description
createAgoraRtcEngine Creates the IRtcEngine object.
initialize Initializes IRtcEngine.
release Releases the IRtcEngine instance.
setChannelProfile Sets the channel profile.
joinChannel [1/2] Joins a channel.
joinChannel [2/2] Joins a channel with media options.
updateChannelMediaOptions Updates the channel media options after joining the channel.
leaveChannel [1/2] Leaves a channel.
leaveChannel [2/2] Leaves a channel.
renewToken Gets a new token when the current token expires after a period of time.
setClientRole [1/2] Sets the client role.
setClientRole [2/2] Sets the user role and level in an interactive live streaming channel.
getConnectionState Gets the current connection state of the SDK.

Channel events

Event Description
onJoinChannelSuccess Occurs when a user joins a channel.
onRejoinChannelSuccess Occurs when a user rejoins the channel.
onClientRoleChanged Occurs when the user role switches in the interactive live streaming.
onClientRoleChangeFailed Occurs when the user role switch fails in the interactive live streaming.
onLeaveChannel Occurs when a user leaves a channel.
onUserJoined Occurs when a remote user (COMMUNICATION)/ host (LIVE_BROADCASTING) joins the channel.
onUserOffline Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) leaves the channel.
onNetworkTypeChanged Occurs when the local network type changes.
onUplinkNetworkInfoUpdated Occurs when the uplink network information changes.
onConnectionLost Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the server is interrupted.
onConnectionStateChanged Occurs when the network connection state changes.
onRequestToken Occurs when the token expires.
onTokenPrivilegeWillExpire Occurs when the token expires in 30 seconds.
onError Reports an error during SDK runtime.

Audio management

Method Description
enableAudio Enables the audio module.
disableAudio Disables the audio module.
setAudioProfile [2/2] Sets the audio parameters and application scenarios.
setAudioScenario Sets audio scenarios.
adjustRecordingSignalVolume Adjusts the capturing signal volume.
adjustUserPlaybackSignalVolume Adjusts the playback signal volume of a specified remote user.
adjustPlaybackSignalVolume Adjusts the playback signal volume of all remote users.
adjustLoopbackSignalVolume Adjusts the volume of the signal captured by the sound card.
adjustCustomAudioPublishVolume Adjusts the volume of the custom external audio source when it is published in the channel.
enableLocalAudio Enables/Disables the local audio capture.
getAudioDeviceInfo Gets the audio device information.

Video management

Method Description
enableVideo Enables the video module.
disableVideo Disables the video module.
setVideoEncoderConfiguration Sets the video encoder configuration.
startPreview [1/2] Enables the local video preview.
stopPreview [1/2] Stops the local video preview.
startPreview [2/2] Enables the local video preview and specifies the video source for the preview.
stopPreview [2/2] Stops the local video preview.
setupLocalVideo Initializes the local video view.
setupRemoteVideo Initializes the video view of a remote user.
setLocalRenderMode [2/2] Updates the display mode of the local video view.
setRemoteRenderMode Updates the display mode of the video view of a remote user.
enableLocalVideo Enables/Disables the local video capture.
muteLocalVideoStream Stops or resumes publishing the local video stream.
muteRemoteVideoStream Cancels or resumes subscribing to the specified remote user's video stream.
muteAllRemoteVideoStreams Stops or resumes subscribing to the video streams of all remote users.

Capture screenshots

Method Description
takeSnapshot Takes a snapshot of a video stream.
Event Description
onSnapshotTaken Reports the result of taking a video snapshot.

Subscribing to and publishing audio and video streams

Method Description
setSubscribeAudioBlacklist Set the blocklist of subscriptions for audio streams.
setSubscribeAudioWhitelist Sets the allowlist of subscriptions for audio streams.
setSubscribeVideoBlacklist Set the bocklist of subscriptions for video streams.
setSubscribeVideoWhitelist Set the allowlist of subscriptions for video streams.
muteLocalAudioStream Stops or resumes publishing the local audio stream.
muteRemoteAudioStream Cancels or resumes subscribing to the specified remote user's audio stream.
muteAllRemoteAudioStreams Stops or resumes subscribing to the audio streams of all remote users.
enableLocalVideo Enables/Disables the local video capture.
muteLocalVideoStream Stops or resumes publishing the local video stream.
muteRemoteVideoStream Cancels or resumes subscribing to the specified remote user's video stream.
muteAllRemoteVideoStreams Stops or resumes subscribing to the video streams of all remote users.

Multi-device capture

Method Description
startPrimaryCameraCapture Starts video capture with a primary camera.
startPrimaryScreenCapture Starts sharing the primary screen.
startSecondaryCameraCapture Starts video capture with a secondary camera.
startSecondaryScreenCapture Starts sharing a secondary screen.
stopPrimaryCameraCapture Stops capturing video through a primary camera.
stopPrimaryScreenCapture Stop sharing the first screen.
stopSecondaryCameraCapture Stops capturing video through the secondary camera.
stopSecondaryScreenCapture Stops sharing the secondary screen.

Media player

Method Description
createMediaPlayer Creates a media player instance.
getMediaPlayerCacheManager Gets an IMediaPlayerCacheManager 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.

Local media events

Event Description
onLocalAudioStateChanged Occurs when the local audio stream state changes.
onLocalVideoStateChanged Occurs when the local video stream state changes.
onFirstLocalAudioFramePublished Occurs when the first audio frame is published.
onFirstLocalVideoFramePublished Occurs when the first video frame is published.
onAudioPublishStateChanged Occurs when the audio publishing state changes.
onVideoPublishStateChanged Occurs when the video publishing state changes.

Remote media events

Event Description
onRemoteAudioStateChanged Occurs when the remote audio state changes.
onRemoteVideoStateChanged Occurs when the remote video stream state changes.
onFirstRemoteVideoFrame Occurs when the renderer receives the first frame of the remote video.
onFirstRemoteVideoDecoded Occurs when the first remote video frame is received and decoded.
onAudioSubscribeStateChanged Occurs when the audio subscribing state changes.
onVideoSubscribeStateChanged Occurs when the video subscribing state changes.
onUserMuteAudio Occurs when a remote user (in the communication profile) or a host (in the live streaming profile) stops/resumes sending the audio stream.
onUserMuteVideo Occurs when a remote user stops/resumes publishing the video stream.
onUserEnableVideo Occurs when a remote user enables/disables the video module.
onUserEnableLocalVideo Occurs when a specific remote user enables/disables the local video capturing function.

Statistics events

Event Description
onRtcStats Reports the statistics of the current call.
onNetworkQuality Reports the last mile network quality of each user in the channel.
onLocalAudioStats Reports the statistics of the local audio stream.
onLocalVideoStats Reports the statistics of the local video stream.
onRemoteAudioStats Reports the statistics of the audio stream sent by each remote users.
onRemoteVideoStats Reports the statistics of the video stream sent by each remote users.

Audio pre-process and post-process

Attention:

This method is for Android and iOS only.

Method Description
setAdvancedAudioOptions Sets audio advanced options.

Video pre-process and post-process

Method Description
setBeautyEffectOptions Sets the image enhancement options.
enableVirtualBackground Enables/Disables the virtual background.
enableRemoteSuperResolution Enables/Disables the super resolution algorithm for a remote user's video stream.
setColorEnhanceOptions Sets color enhancement.
setLowlightEnhanceOptions Sets low-light enhancement.
setVideoDenoiserOptions Sets video noise reduction.

Face detection

Note: This method is for Android and iOS only.
Method Description
enableFaceDetection Enables/Disables face detection for the local user.
Event Description
onFacePositionChanged Reports the face detection result of the local user.

In-ear monitoring

Method Description
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.
Event Description
onEarMonitoringAudioFrame Gets the in-ear monitoring audio frame.
getEarMonitoringAudioParams Sets the audio format for the onEarMonitoringAudioFrame callback.

Music file playback and mixing

Method Description
startAudioMixing [2/2] Starts playing the music file.
stopAudioMixing Stops playing and mixing the music file.
pauseAudioMixing Pauses playing 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.
Event Description
onAudioMixingStateChanged Occurs when the playback state of the music file changes.

Audio effect file playback

Method 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.
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 effects.
pauseEffect Pauses playing a specified audio effect file.
pauseAllEffects Pauses playing all audio effect files.
resumeEffect Resumes playing a specified audio effect.
resumeAllEffects Resumes playing all audio effects.
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.

Virtual metronome

Attention:

This method is for Android and iOS only.

Method Description
startRhythmPlayer Enables the virtual metronome.
stopRhythmPlayer Disables the virtual metronome.
configRhythmPlayer Configures the virtual metronome.

Voice changer and reverberation

Method Description
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.

Pre-call network test

Method Description
startEchoTest [2/3] Starts an audio call test.
stopEchoTest Stops the audio call test.
startLastmileProbeTest Starts the last mile network probe test.
stopLastmileProbeTest Stops the last mile network probe test.
Event Description
onLastmileQuality Reports the last-mile network quality of the local user.
onLastmileProbeResult Reports the last mile network probe result.

Screen share API

Method Description
getScreenCaptureSources Gets a list of shareable screens and windows. (For Windows and macOS only)
startScreenCaptureByWindowId Shares the whole or part of a window by specifying the window ID. (For Windows and macOS only)
startScreenCaptureByDisplayId Shares the screen by specifying the display ID. (For Windows and macOS only)
setScreenCaptureContentHint Sets the content hint for screen sharing. (For Windows and macOS only)
updateScreenCaptureRegion Updates the screen sharing region. (For Windows and macOS only)
startScreenCapture Starts screen sharing.(For Android and iOS only)
updateScreenCapture Updates the screen sharing parameters.(For Android and iOS only)
updateScreenCaptureParameters Updates the screen sharing parameters. (For Windows and macOS only)
stopScreenCapture Stops screen sharing.
getCount Gets the number of shareable windows and screens. (For Windows only)
getSourceInfo Gets information about the specified shareable window or screen. (For Windows only)
release Releases IScreenCaptureSourceList. (For Windows only)
setScreenCaptureScenario Sets the screen sharing scenario. (For Windows and macOS only)

Video dual stream

Method Description
enableDualStreamMode [1/2] Enables or disables dual-stream mode on the sender side.
class_irtcengine.html#api_irtcengine_enabledualstreammode2 Enables or disables dual-stream mode.
enableDualStreamMode [2/2] Enables or disables the dual-stream mode on the sender and sets the video stream.
setRemoteVideoStreamType Sets the stream type of the remote video.
setRemoteDefaultVideoStreamType Sets the default stream type of subscrption for remote video streams.
setDualStreamMode [2/2] Sets the dual-stream mode on the sender and sets the low-quality video stream.

Watermark

Method Description
addVideoWatermark [2/2] Adds a watermark image to the local video.
clearVideoWatermarks Removes the watermark image from the video stream.

Encryption

Method Description
enableEncryption Enables/Disables the built-in encryption.
registerPacketObserver Registers a packet observer.
Event Description
onEncryptionError Reports the built-in encryption errors.

Sound localization

Method Description
enableSoundPositionIndication Enables/Disables stereo panning for remote users.
setRemoteVoicePosition Sets the 2D position (the position on the horizontal plane) of the remote user's voice.

Media push

Method Description
startRtmpStreamWithoutTranscoding Starts Media Push without transcoding.
startRtmpStreamWithTranscoding Starts Media Push and sets the transcoding configuration.
updateRtmpTranscoding Updates the transcoding configuration.
stopRtmpStream Stops pushing media streams to a CDN.
Event Description
onRtmpStreamingEvent Reports events during the media push.
onRtmpStreamingStateChanged Occurs when the media push state changes.
onTranscodingUpdated Occurs when the publisher's transcoding is updated.

Local video transcoder

Method Description
startLocalVideoTranscoder Starts the local video mixing.
stopLocalVideoTranscoder Stops the local video mixing.
updateLocalTranscoderConfiguration Update the local video mixing configuration.

Channel media stream relay

Method Description
startChannelMediaRelay 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.
stopChannelMediaRelay Stops the media stream relay. Once the relay stops, the host quits all the destination channels.
pauseAllChannelMediaRelay Pauses the media stream relay to all destination channels.
resumeAllChannelMediaRelay Resumes the media stream relay to all destination channels.
Event Description
onChannelMediaRelayStateChanged Occurs when the state of the media stream relay changes.
onChannelMediaRelayEvent Reports events during the media stream relay.

Custom audio source

Method Description
setExternalAudioSource Sets the external audio source parameters.
pushAudioFrame Pushes the external audio frame.

Custom audio renderer

Method Description
setExternalAudioSink Sets the external audio sink.
pullAudioFrame Pulls the remote audio data.

Raw audio data

Method Description
registerAudioFrameObserver Registers an audio frame observer object.
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 onMixedAudioFrame.
setPlaybackAudioFrameBeforeMixingParameters Sets the audio data format reported by onPlaybackAudioFrameBeforeMixing.
Event Description
onRecordAudioFrame Gets the captured audio frame.
onPlaybackAudioFrame Gets the raw audio frame for playback.
onPlaybackAudioFrameBeforeMixing Retrieves the audio frame of a specified user before mixing.
onMixedAudioFrame Retrieves the mixed captured and playback audio frame.
getRecordAudioParams Sets the audio format for the onRecordAudioFrame callback.
getPlaybackAudioParams Sets the audio format for the onPlaybackAudioFrame callback.
getMixedAudioParams Sets the audio format for the onMixedAudioFrame callback.
getMixedAudioParams Sets the audio format for the onMixedAudioFrame callback.

Encoded audio data

Method Description
registerAudioEncodedFrameObserver Registers an encoded audio observer.
Event Description
OnRecordAudioEncodedFrame Gets the encoded audio data of the local user.
OnPlaybackAudioEncodedFrame Gets the encoded audio data of all remote users.
OnMixedAudioEncodedFrame Gets the mixed and encoded audio data of the local and all remote users.

Audio spectrum

Method Description
registerAudioSpectrumObserver Registers an audio spectrum observer.
enableAudioSpectrumMonitor Turns on audio spectrum monitoring.
disableAudioSpectrumMonitor Disables audio spectrum monitoring.
unregisterAudioSpectrumObserver Unregisters the audio spectrum observer.
Event Description
onLocalAudioSpectrum Gets the statistics of a local audio spectrum.
onRemoteAudioSpectrum Gets the remote audio spectrum.

Custom video source

Method Description
createCustomVideoTrack Creates a customized video track.
destroyCustomVideoTrack Destroys the specified video track.

External video source

Method Description
setExternalVideoSource Configures the external video source.
pushVideoFrame Pushes the external raw video frame to the SDK.

Raw video data

Method Description
registerVideoFrameObserver Registers a video frame observer object.
Event Description
onCaptureVideoFrame Occurs each time the SDK receives a video frame captured by the local camera.
onPreEncodeVideoFrame Occurs each time the SDK receives a video frame before encoding.
onPreEncodeScreenVideoFrame Gets the video data captured from the screen before encoding.
onScreenCaptureVideoFrame Occurs each time the SDK receives a video frame captured by the screen.
onSecondaryPreEncodeCameraVideoFrame Gets the video data captured from the second camera before encoding.
onSecondaryPreEncodeScreenVideoFrame Gets the video data captured from the second screen before encoding.
onRenderVideoFrame Occurs each time the SDK receives a video frame sent by the remote user.
onMediaPlayerVideoFrame Gets the video data of the media player.
getObservedFramePosition Sets the frame position for the video observer.
getVideoFrameProcessMode Occurs each time the SDK receives a video frame and prompts you to set the process mode of the video frame.
getMirrorApplied Occurs each time the SDK receives a video frame and prompts you whether or not to mirror the captured video.
getRotationApplied Occurs each time the SDK receives a video frame, and prompts you whether to rotate the captured video.
getVideoFormatPreference Sets the format of the raw video data output by the SDK.

Encoded video data

Method Description
registerVideoEncodedFrameObserver Registers a receiver object for the encoded video image.
Event Description
OnEncodedVideoFrameReceived Occurs each time the SDK receives an encoded video image.

Extension

Method Description
enableExtension Enables/Disables extensions.
setExtensionProperty Sets the properties of the extension.
setExtensionProviderProperty Sets the properties of the extension provider.
Event Description
onExtensionEvent The event callback of the extension.
onExtensionStarted Occurs when the extension is enabled.
onExtensionStopped Occurs when the extension is disabled.
onExtensionError Occurs when the extension runs incorrectly.

Media metadata

Method Description
registerMediaMetadataObserver Registers the metadata observer.
unregisterMediaMetadataObserver Unregisters the specified metadata observer.
Event Description
getMaxMetadataSize Occurs when the SDK requests the maximum size of the metadata.
onReadyToSendMetadata Occurs when the SDK is ready to send metadata.
onMetadataReceived Occurs when the local user receives the metadata.

Audio recording

Method Description
startAudioRecording Starts the audio recording on the client.
stopAudioRecording Stops the audio recording on the client.

Local audio and video recording

Method Description
setMediaRecorderObserver Registers one IMediaRecorderObserver object.
startRecording Starts recording the local audio and video.
stopRecording Stops recording the local audio and video.
release Release the IMediaRecorder object.
Event Description
onRecorderStateChanged Occurs when the recording state changes.
onRecorderInfoUpdated onRecorderInfoUpdated

Camera management

Attention: This method is for Android and iOS only.
Method Description
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 Sets whether to enable face autofocus.
isCameraExposurePositionSupported Checks whether the device supports manual exposure.
isCameraAutoExposureFaceModeSupported Checks whether the device supports auto exposure.
setCameraExposurePosition Sets the camera exposure position.
Event Description
onCameraFocusAreaChanged Occurs when the camera focus area changes.
onCameraExposureAreaChanged Occurs when the camera exposure area changes.

Multiple channels

Method Description
joinChannelEx Joins a channel with the connection ID.
leaveChannelEx Leaves a channel.

Audio route

This method is for Android and iOS only.

Method Description
setDefaultAudioRouteToSpeakerphone Sets the default audio playback route.
setEnableSpeakerphone Enables/Disables the audio route to the speakerphone.
isSpeakerphoneEnabled Checks whether the speakerphone is enabled.

Volume indication

Method Description
enableAudioVolumeIndication Enables the reporting of users' volume indication.
Event Description
onAudioVolumeIndication Reports the volume information of users.
onActiveSpeaker Occurs when the most active remote speaker is detected.

Data stream

Method Description
createDataStream [2/2] Creates a data stream.
sendStreamMessage Sends data stream messages.
Event Description
onStreamMessage Occurs when the local user receives the data stream from the remote user.
onStreamMessageError Occurs when the local user does not receive the data stream from the remote user.

Video device management

Attention:

This group of methods is for Windows only.

Method 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.
numberOfCapabilities Gets the number of video formats supported by the specified video capture device.
getCapability Gets the detailed video frame information of the video capture device in the specified video format.

Video device collection

Attention:

This group of methods is for Windows only.

Method Description
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.

Audio device management

Method Description
enumeratePlaybackDevices Enumerates the audio playback devices. (For Windows only)
enumerateRecordingDevices Enumerates the audio capture devices. (For Windows only)
followSystemPlaybackDevice Sets the audio playback device used by the SDK to follow the system default audio playback device. (For Windows and macOS only)
followSystemRecordingDevice Sets the audio recording device used by the SDK to follow the system default audio recording device. (For Windows and macOS only)
setPlaybackDevice Sets the audio playback device. (For Windows only)
getPlaybackDevice Retrieves the audio playback device associated with the device ID. (For Windows only)
getPlaybackDeviceInfo Retrieves the audio playback device information associated with the device ID and device name. (For Windows only)
setLoopbackDevice Sets the loopback device. (For Windows only)
getLoopbackDevice Get the current loopback device. (For Windows only)
followSystemLoopbackDevice Set whether the loopback device follows the system default playback device. (For Windows only)
setRecordingDevice Sets the audio recording device. (For Windows only)
getRecordingDevice Gets the current audio recording device. (For Windows only)
getRecordingDeviceInfo Retrieves the information of the audio recording device. (For Windows only)
setRecordingDeviceVolume Sets the volume of the audio recording device. (For Windows only)
startPlaybackDeviceTest Starts the audio playback device test. (For Windows and macOS only)
stopPlaybackDeviceTest Stops the audio playback device test. (For Windows and macOS only)
startRecordingDeviceTest Starts the audio capture device test. (For Windows and macOS only)
stopRecordingDeviceTest Stops the audio capture device test. (For Windows and macOS only)
startAudioDeviceLoopbackTest Starts an audio device loopback test. (For Windows and macOS only)
stopAudioDeviceLoopbackTest Stops the audio device loopback test. (For Windows and macOS only)
release Releases all the resources occupied by the IAudioDeviceManager object. (For Windows only)
Event Description
onAudioDeviceStateChanged Occurs when the audio device state changes. (For Windows and macOS only)

Audio device collection

Attention:

This group of methods is for Windows only.

Method Description
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 the whether the app is muted.
release Releases all the resources occupied by the IAudioDeviceCollection object.

Miscellaneous audio control

Attention:

This method is for Windows and macOS only.

Method Description
enableLoopbackRecording Enables loopback audio capture.

Miscellaneous methods

Method Description
setCloudProxy Sets the Agora cloud proxy service.
sendCustomReportMessageEx Agora supports reporting and analyzing customized messages.
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.
getVersion Gets the SDK version.
getErrorDescription Gets the warning or error description.
queryInterface Gets the pointer to the specified interface.
enableVideoImageSource Sets whether to replace the current video feeds with images when publishing video streams.
getNetworkType Gets the type of the local network connection.
setHeadphoneEQPreset Set the preset headphone equalization effect.

Miscellaneous events

Event Description
onApiCallExecuted Occurs when a method is executed by the SDK.
onProxyConnected Reports the proxy connection state.