API Overview
Agora provides ensured quality of experience (QoE) for worldwide Internet-based voice and video communications through SD-RTN™.
Channel management
Method | Description |
---|---|
create [1/2] | Creates and initializes RtcEngine. |
create [2/2] | Creates and initializes RtcEngine. |
destroy | Releases the RtcEngine 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] | Sets channel options and leaves the channel. |
renewToken | Renews the token. |
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 during the interactive live streaming. |
onClientRoleChangeFailed | Occurs when the user role switching fails in the interactive live streaming. |
onLeaveChannel | Occurs when a user leaves a channel. |
onUserJoined | Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) leaves 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. |
adjustCustomAudioPublishVolume | Adjusts the volume of the custom external audio source when it is published in the channel. |
muteRecordingSignal | Whether to mute the recording signal. |
enableLocalAudio | Enables or 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. |
setRenderMode | Sets the render mode of the media player. |
setView | Sets the view. |
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 [2/2] | 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 | Stops or resumes subscribing to the video stream of a specified user. |
muteAllRemoteVideoStreams | Stops or resumes subscribing to the video streams of all remote users. |
enableInstantMediaRendering | Enables audio and video frame instant rendering. |
startMediaRenderingTracing | Enables tracing the video frame rendering process. |
setVideoScenario | Sets video application scenarios. |
Event | Description |
---|---|
onVideoRenderingTracingResult | Video frame rendering event callback. |
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 |
---|---|
setSubscribeAudioBlocklist | Set the blocklist of subscriptions for audio streams. |
setSubscribeAudioAllowlist | Sets the allowlist of subscriptions for audio streams. |
setSubscribeVideoBlocklist | Set the blocklist of subscriptions for video streams. |
setSubscribeVideoAllowlist | Set the allowlist of subscriptions for video streams. |
muteLocalAudioStream | Stops or resumes publishing the local audio stream. |
muteRemoteAudioStream | Stops or resumes subscribing to the audio stream of a specified user. |
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 | Stops or resumes subscribing to the video stream of a specified user. |
muteAllRemoteVideoStreams | Stops or resumes subscribing to the video streams of all remote users. |
setRemoteVideoSubscriptionOptions | Options for subscribing to remote video streams. |
Media player
For more methods about the media player, see IMediaPlayer.
Method | Description |
---|---|
createMediaPlayer | Creates a media player instance. |
getMediaPlayerCacheManager | Gets one IMediaPlayerCacheManager instance. |
IMediaPlayer | This class provides media player functions and supports multiple instances. |
IMediaPlayerCacheManager | This class provides methods to manage cached media files. |
IMediaPlayerObserver | Provides callbacks for media players. |
Directly pushing streams to the CDN
Method | 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. |
Event | Description |
---|---|
onDirectCdnStreamingStateChanged | Occurs when the CDN streaming state changes. |
onDirectCdnStreamingStats | Reports the CDN streaming statistics. |
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. |
onFirstRemoteAudioFrame | Occurs when the SDK receives the first audio frame from a specific remote user. |
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 or resumes publishing the video stream. |
onUserEnableVideo | Occurs when a remote user enables or 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 transport-layer statistics of each remote audio stream. |
onRemoteVideoStats | Reports the statistics of the video stream sent by each remote users. |
Audio pre-process and post-process
Method | Description |
---|---|
setAdvancedAudioOptions | Sets audio advanced options. |
setAINSMode | Sets whether to enable the AI noise reduction function and set the noise reduction mode. |
Video pre-process and post-process
Method | Description |
---|---|
setBeautyEffectOptions | Sets the image enhancement options. |
enableVirtualBackground | Enables/Disables the virtual background. |
setColorEnhanceOptions | Sets color enhancement. |
setLowlightEnhanceOptions | Sets low-light enhancement. |
setVideoDenoiserOptions | Sets video noise reduction. |
Face detection
Method | Description |
---|---|
enableFaceDetection | Enables or 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 [2/2] | 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 [1/2] | Starts playing the music file. |
startAudioMixing [2/2] | 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. |
Event | Description |
---|---|
onAudioMixingStateChanged | Occurs when the playback state of the music file changes. |
onAudioMixingPositionChanged | Reports the playback progress of a music file. |
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 file. |
setVolumeOfEffect | Sets the volume of a specified audio effect. |
preloadEffect | Preloads a specified audio effect file into the memory. |
playEffect [2/2] | Plays the specified local or online audio effect file. |
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. |
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
Method | Description |
---|---|
startRhythmPlayer | Enables the virtual metronome. |
stopRhythmPlayer | Disables the virtual metronome. |
configRhythmPlayer | Configures the virtual metronome. |
Event | Description |
---|---|
onRhythmPlayerStateChanged | Occurs when the state of virtual metronome changes. |
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. |
setLocalVoiceFormant | Set the formant ratio to change the timbre of human voice. |
Pre-call network test
Method | Description |
---|---|
startEchoTest [1/3] | Starts an audio call test. |
startEchoTest [2/3] | Starts an audio call test. |
startEchoTest [3/3] | 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. |
Event | Description |
---|---|
onLastmileQuality | Reports the last-mile network quality of the local user. |
onLastmileProbeResult | Reports the last mile network probe result. |
Screen Sharing
Method | Description |
---|---|
queryScreenCaptureCapability | Queries the highest frame rate supported by the device during screen sharing. |
startScreenCapture | Starts screen capture. |
updateScreenCaptureParameters | Updates the screen capturing parameters. |
stopScreenCapture | Stops screen capture. |
Video dual stream
Method | Description |
---|---|
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 dual-stream mode configuration 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 or disables the built-in encryption. |
Event | Description |
---|---|
onEncryptionError | Reports the built-in encryption errors. |
Sound localization
Method | Description |
---|---|
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. |
Spatial audio effect
Local Cartesian coordinate system calculation solution | Description |
---|---|
create | Creates ILocalSpatialAudioEngine. |
initialize | Initializes ILocalSpatialAudioEngine. |
destroy | Destroys 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. |
Media push
Method | Description |
---|---|
startRtmpStreamWithoutTranscoding | Starts pushing media streams to a CDN 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 state of Media Push 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 | Updates the local video mixing configuration. |
Event | Description |
---|---|
onLocalVideoTranscoderError | Occurs when there's an error during the local video mixing. |
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. |
startOrUpdateChannelMediaRelay | 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. |
pauseAllChannelMediaRelay | Pauses the media stream relay to all target channels. |
resumeAllChannelMediaRelay | Resumes the media stream relay to all target 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 |
---|---|
createCustomAudioTrack | Creates a customized audio track. |
destroyCustomAudioTrack | Destroys the specified audio track. |
setExternalAudioSource [2/2] | Sets the external audio source parameters. |
pushExternalAudioFrame [2/2] | Pushes the external audio frame to the SDK. |
Custom audio renderer
Method | Description |
---|---|
setExternalAudioSink | Sets the external audio sink. |
pullPlaybackAudioFrame [1/2] | Pulls the remote audio data. |
pullPlaybackAudioFrame [2/2] | 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. |
getObservedAudioFramePosition | Sets the frame position for the video observer. |
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. |
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 | Register 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. |
pushExternalVideoFrame [1/2] | Pushes the external raw video frame to the SDK. |
pushExternalVideoFrame [2/2] | Pushes the external video frame. |
Raw video data
Method | Description |
---|---|
registerVideoFrameObserver | Registers a raw 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. |
onRenderVideoFrame | Occurs each time the SDK receives a video frame sent by the remote user. |
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 | Reports that the receiver has received the to-be-decoded video frame sent by the remote end. |
Extension
Method | Description |
---|---|
enableExtension | Enables or disables extensions. |
setExtensionProperty | Sets the properties of the extension. |
setExtensionProviderProperty | Sets the properties of the extension provider. |
getExtensionProperty [1/2] | Gets detailed information on the extensions. |
getExtensionProperty [2/2] | Gets detailed information on the extensions. |
Media metadata
Method | Description |
---|---|
registerMediaMetadataObserver | Registers the metadata observer. |
unregisterMediaMetadataObserver | Unregisters the specified metadata observer. |
Event | Description |
---|---|
onReadyToSendMetadata | Occurs when the SDK is ready to send metadata. |
onMetadataReceived | Occurs when the local user receives the metadata. |
Audio recording
Method | Description |
---|---|
startAudioRecording [2/2] | Starts audio recording on the client and sets recording configurations. |
stopAudioRecording | Stops the audio recording on the client. |
Camera management
Method | Description |
---|---|
switchCamera | Switches between front and rear cameras. |
setCameraCapturerConfiguration | Sets the camera capture configuration. |
startCameraCapture | Starts camera capture. |
stopCameraCapture | Stops camera capture. |
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. |
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
For more methods about multi-channel, see RtcEngineEx.
Method | Description |
---|---|
joinChannelEx | Joins a channel with the connection ID. |
leaveChannelEx [2/2] | Sets channel options and leaves the channel. |
Audio route
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. |
Event | Description |
---|---|
onAudioRouteChanged | Occurs when the local audio route changes. |
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. |
Audio device management
Method | Description |
---|---|
startRecordingDeviceTest | Starts the audio capture device test. |
stopRecordingDeviceTest | Stops the audio capture device test. |
Miscellaneous methods
Method | Description |
---|---|
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. |
getSdkVersion | Gets the SDK version. |
getErrorDescription | Gets the warning or error description. |
addHandler | Adds event handlers |
removeHandler | Removes the specified callback handler. |
enableVideoImageSource | Sets whether to replace the current video feeds with images when publishing video streams. |
getNetworkType | Gets the type of the local network connection. |
getNtpWallTimeInMs | Gets the current NTP (Network Time Protocol) time. |
setHeadphoneEQPreset | Sets the preset headphone equalization effect. |
setHeadphoneEQParameters | Sets the low- and high-frequency parameters of the headphone equalizer. |
Miscellaneous events
Event | Description |
---|---|
onProxyConnected | Reports the proxy connection state. |