Lite SDK API List
This page lists the APIs supported by Lite SDK.
Attention: If you cannot find the API you are looking for on this page, it means the Lite SDK does not support this API, and calling it returns error code -2.
RtcEngine
- addHandler
- adjustAudioMixingPlayoutVolume
- adjustAudioMixingPublishVolume
- adjustAudioMixingVolume
- adjustCustomAudioPlayoutVolume
- adjustCustomAudioPublishVolume
- adjustPlaybackSignalVolume
- adjustRecordingSignalVolume
- adjustUserPlaybackSignalVolume
- complain
- configRhythmPlayer
- create [1/2]
- createCustomAudioTrack
- createCustomVideoTrack
- createDataStream [1/2]
- createDataStream [2/2]
- createMediaPlayer
- destroyCustomAudioTrack
- destroyCustomVideoTrack
- disableAudio
- disableAudioSpectrumMonitor
- disableVideo
- enableAudio
- enableAudioSpectrumMonitor
- enableAudioVolumeIndication
- enableContentInspect
- enableCustomAudioLocalPlayback
- enableDualStreamMode [1/2]
- enableDualStreamMode [2/2]
- enableEncryption
- enableExtension
- enableFaceDetection
- enableInEarMonitoring [1/2]
- enableInEarMonitoring [2/2]
- enableInstantMediaRendering
- enableLocalAudio
- enableLocalVideo
- enableSoundPositionIndication
- enableVideo
- enableVideoImageSource
- enableVoiceAITuner
- enableWebSdkInteroperability
- getAudioDeviceInfo
- getAudioEffectManager
- getAudioMixingCurrentPosition
- getAudioMixingDuration
- getAudioMixingPlayoutVolume
- getAudioMixingPublishVolume
- getAudioTrackCount
- getCallId
- getCameraMaxZoomFactor
- getConnectionState
- getCurrentMonotonicTimeInMs
- getEffectCurrentPosition
- getEffectDuration
- getEffectsVolume
- getErrorDescription
- getExtensionProperty [1/2]
- getExtensionProperty [2/2]
- getNativeHandle
- getNetworkType
- getNtpWallTimeInMs
- getUserInfoByUid
- getUserInfoByUserAccount
- getSdkVersion
- getVolumeOfEffect
- create [2/2]
- isCameraAutoFocusFaceModeSupported
- isCameraExposurePositionSupported
- isCameraExposureSupported
- isCameraFaceDetectSupported
- isCameraFocusSupported
- isCameraTorchSupported
- isCameraZoomSupported
- isFeatureAvailableOnDevice
- isSpeakerphoneEnabled
- isTextureEncodeSupported
- joinChannel [1/2]
- In joinChannel [2/2], the following screen capture-related parameter settings are invalid:
- publishScreenCaptureVideo
- publishScreenCaptureAudio
- joinChannelWithUserAccount [1/2]
- In joinChannelWithUserAccount [2/2], the following screen capture-related parameter settings are invalid:
- publishScreenCaptureVideo
- publishScreenCaptureAudio
- leaveChannel [1/2]
- leaveChannel [2/2]
- muteAllRemoteAudioStreams
- muteAllRemoteVideoStreams
- muteLocalAudioStream
- muteLocalVideoStream
- muteRecordingSignal
- muteRemoteAudioStream
- muteRemoteVideoStream
- pauseAllChannelMediaRelay
- pauseAllEffects
- pauseAudioMixing
- pauseEffect
- playEffect [1/2]
- playEffect [2/2]
- preloadChannel
- preloadChannelWithUserAccount
- preloadEffect
- pullPlaybackAudioFrame [1/2]
- pullPlaybackAudioFrame [2/2]
- pushExternalAudioFrame
- pushExternalAudioFrame
- pushExternalVideoFrameById [1/2]
- pushExternalVideoFrameById [2/2]
- pushExternalVideoFrame [1/2]
- pushExternalVideoFrame [2/2]
- queryCameraFocalLengthCapability
- queryCodecCapability
- queryDeviceScore
- rate
- In registerAudioEncodedFrameObserver, the encodingType parameter in config only supports the OPUS format for audio encoding.
- registerAudioFrameObserver
- registerAudioSpectrumObserver
- registerExtension
- registerLocalUserAccount
- registerMediaMetadataObserver
- registerVideoEncodedFrameObserver
- registerVideoFrameObserver
- destroy
- removeHandler
- renewToken
- resumeAllChannelMediaRelay
- resumeAllEffects
- resumeAudioMixing
- resumeEffect
- selectAudioTrack
- sendCustomReportMessage
- sendStreamMessage
- setAdvancedAudioOptions
- setAudioEffectParameters
- setAudioEffectPreset
- setAudioMixingDualMonoMode
- setAudioMixingPitch
- setAudioMixingPosition
- setAudioMixingPlaybackSpeed
- setAudioProfile [1/2]
- setAudioProfile [2/2]
- setAudioScenario
- setCameraAutoFocusFaceModeEnabled
- setCameraCapturerConfiguration
- setCameraExposureFactor
- setCameraExposurePosition
- setCameraFocusPositionInPreview
- setCameraTorchOn
- setCameraZoomFactor
- setChannelProfile
- setClientRole [1/2]
- setClientRole [2/2]
- setCloudProxy
- setColorEnhanceOptions [1/2]
- setColorEnhanceOptions [2/2]
- setDefaultAudioRouteToSpeakerphone
- setDualStreamMode [1/2]
- setDualStreamMode [2/2]
- setEarMonitoringAudioFrameParameters
- setEffectPosition
- setEffectsVolume
- setEnableSpeakerphone
- setExtensionProperty
- setExtensionProviderProperty
- setExternalAudioSink
- setExternalAudioSink
- setExternalAudioSource [1/2]
- setExternalAudioSource [2/2]
- setExternalVideoSource
- setHeadphoneEQParameters
- setHeadphoneEQPreset
- setInEarMonitoringVolume
- setLocalRenderMode [1/2]
- setLocalRenderMode [2/2]
- setLocalVideoMirrorMode
- setLocalVoiceEqualization
- setLocalVoiceFormant
- setLocalVoicePitch
- setLocalVoiceReverb
- setLogFile
- setLogFileSize
- setLogFilter
- setLogLevel
- setLowlightEnhanceOptions [1/2]
- setLowlightEnhanceOptions [2/2]
- setMixedAudioFrameParameters
- setParameters
- setPlaybackAudioFrameBeforeMixingParameters
- setPlaybackAudioFrameParameters
- setRecordingAudioFrameParameters
- setRemoteDefaultVideoStreamType [1/2]
- setRemoteDefaultVideoStreamType [2/2]
- setRemoteRenderMode
- setRemoteSubscribeFallbackOption [1/2]
- setRemoteSubscribeFallbackOption [2/2]
- setRemoteVideoStreamType [1/2]
- setRemoteVideoStreamType [2/2]
- setRemoteVideoSubscriptionOptions
- setRemoteVoicePosition
- setRouteInCommunicationMode
- setSubscribeAudioAllowlist
- setSubscribeAudioBlocklist
- setSubscribeVideoAllowlist
- setSubscribeVideoBlocklist
- setupLocalVideo
- setupRemoteVideo
- setVideoDenoiserOptions [1/2]
- setVideoDenoiserOptions [2/2]
- setVideoEncoderConfiguration
- setVideoScenario
- setVoiceBeautifierParameters
- setVoiceBeautifierPreset
- setVoiceConversionPreset
- setVolumeOfEffect
- startAudioMixing [1/2]
- startAudioMixing [2/2]
- startEchoTest
- startLastmileProbeTest
- startLocalVideoTranscoder
- startOrUpdateChannelMediaRelay
- startPreview [1/2]
- startPreview [2/2]
- startCameraCapture
- startRhythmPlayer
- startMediaRenderingTracing
- stopAllEffects
- stopAudioMixing
- stopChannelMediaRelay
- stopEchoTest
- stopEffect
- stopLastmileProbeTest
- stopPreview [1/2]
- stopPreview [2/2]
- stopCameraCapture
- stopRhythmPlayer
- switchCamera [1/2]
- switchCamera [2/2]
- unloadEffect
- unregisterAudioSpectrumObserver
- unregisterMediaMetadataObserver
- In updateChannelMediaOptions, the following screen capture-related parameter settings are invalid:
- publishScreenCaptureVideo
- publishScreenCaptureAudio
- updateLocalTranscoderConfiguration
- updatePreloadChannelToken
RtcEngineEx
- createDataStreamEx [1/2]
- createDataStreamEx [2/2]
- enableAudioVolumeIndicationEx
- enableContentInspectEx
- enableDualStreamModeEx
- enableEncryptionEx
- getCallIdEx
- getConnectionStateEx
- getUserInfoByUid
- getUserInfoByUserAccount
- joinChannelEx
- joinChannelWithUserAccountEx
- leaveChannelEx [1/2]
- leaveChannelEx [2/2]
- muteAllRemoteAudioStreamsEx
- muteAllRemoteVideoStreamsEx
- muteLocalAudioStreamEx
- muteLocalVideoStreamEx
- muteRemoteAudioStreamEx
- muteRemoteVideoStreamEx
- pauseAllChannelMediaRelayEx
- resumeAllChannelMediaRelayEx
- sendCustomReportMessageEx
- setDualStreamModeEx
- setRemoteRenderModeEx
- setRemoteVideoStreamTypeEx [1/2]
- setRemoteVideoStreamTypeEx [2/2]
- setRemoteVoicePositionEx
- setSubscribeAudioBlocklistEx
- setSubscribeAudioAllowlistEx
- setSubscribeVideoBlocklistEx
- setSubscribeVideoAllowlistEx
- setupRemoteVideoEx
- setVideoEncoderConfigurationEx
- sendStreamMessageEx
- startMediaRenderingTracingEx
- startOrUpdateChannelMediaRelayEx
- stopChannelMediaRelayEx
- In updateChannelMediaOptionsEx, the following screen capture-related parameter settings are invalid:
- publishScreenCaptureVideo
- publishScreenCaptureAudio
- setRemoteVideoSubscriptionOptionsEx
- adjustUserPlaybackSignalVolumeEx
IRtcEngineEventHandler
- onActiveSpeaker
- onAudioEffectFinished
- onAudioMixingFinished
- onAudioMixingPositionChanged
- onAudioMixingStateChanged
- onAudioPublishStateChanged
- onAudioQuality
- onAudioRouteChanged
- onAudioSubscribeStateChanged
- onAudioVolumeIndication
- onCameraExposureAreaChanged
- onCameraFocusAreaChanged
- onCameraReady
- onChannelMediaRelayStateChanged
- onClientRoleChanged
- onClientRoleChangeFailed
- onConnectionBanned
- onConnectionInterrupted
- onConnectionLost
- onConnectionStateChanged
- onEncryptionError
- onError
- onFacePositionChanged
- onFirstLocalAudioFramePublished
- onFirstLocalVideoFrame
- onFirstLocalVideoFramePublished
- onFirstRemoteAudioFrame
- onFirstRemoteAudioDecoded
- onFirstRemoteVideoDecoded
- onFirstRemoteVideoFrame
- onJoinChannelSuccess
- onLastmileProbeResult
- onLastmileQuality
- onLeaveChannel
- onLocalAudioStateChanged
- onLocalAudioStats
- onLocalUserRegistered
- onLocalVideoStateChanged
- onLocalVideoStats
- onLocalVideoTranscoderError
- onTranscodedStreamLayoutInfo
- onNetworkQuality
- onNetworkTypeChanged
- onPermissionError
- onProxyConnected
- onRejoinChannelSuccess
- onRemoteAudioStateChanged
- onRemoteAudioStats
- onRemoteAudioTransportStats
- onRemoteSubscribeFallbackToAudioOnly
- onRemoteVideoStateChanged
- onRemoteVideoStats
- onRemoteVideoTransportStats
- onRequestToken
- onRhythmPlayerStateChanged
- onRtcStats
- onStreamMessage
- onStreamMessageError
- onTokenPrivilegeWillExpire
- onTranscodingUpdated
- onUplinkNetworkInfoUpdated
- onUserEnableLocalVideo
- onUserEnableVideo
- onUserInfoUpdated
- onUserJoined
- onUserMuteAudio
- onUserMuteVideo
- onUserOffline
- onVideoPublishStateChanged
- onVideoSizeChanged
- onVideoStopped
- onVideoSubscribeStateChanged
- onVideoRenderingTracingResult
IMediaExtensionObserver
IMediaPlayer
Attention: The APIs in this group only support processing audio media files and di not support processing video media files.
- adjustPlayoutVolume
- adjustPublishSignalVolume
- getDuration
- getMediaPlayerId
- getMute
- getPlayoutVolume
- getPlayPosition
- getPlaySrc [1/2]
- getPublishSignalVolume
- getState
- getStreamCount
- getStreamInfo
- mute
- open [1/2]
- open [2/2]
- openWithMediaSource
- pause
- play
- playPreloadedSrc
- preloadSrc
- registerAudioFrameObserver
- registerPlayerObserver
- registerVideoFrameObserver
- resume
- seek
- selectAudioTrack
- selectMultiAudioTrack
- setAudioPitch
- setAudioDualMonoMode
- setLoopCount
- setPlaybackSpeed
- setPlayerOption
- setPlayerOptionString
- setRenderMode
- setView
- stop [1/2]
- switchSrc
- unloadSrc
- unRegisterPlayerObserver
IVideoEncodedFrameObserver
IVideoFrameObserver
Attention: In the video data returned by the onCaptureVideoFrame, onPreEncodeVideoFrame, and onRenderVideoFramecallbacks, the alphabuffer is
NULL.