Full SDK API 列表
- Android
更新时间不可用
本页列出 Android 所有的接口类以及其中包含的 API。
AsyncCallback
用于处理异步操作结果的回调。
相关参考
Canvas
用于设置视频渲染视图。
自从
自 v4.4.0 版本新增。
相关参考
CanvasConfig
用于配置播放器的视频渲染。
自从
自 v4.4.0 版本新增。
相关参考
Error
用于获取错误码和错误信息。
自从
自 v4.4.0 版本新增。
相关参考
IAudioEncodedFrameObserver
用于监听音频编码帧的接口。
相关参考
IAudioFrameObserver
用于观测和处理音频帧的接口。
相关参考
- getEarMonitoringAudioParams
- getMixedAudioParams
- getObservedAudioFramePosition
- getPlaybackAudioParams
- getRecordAudioParams
- onEarMonitoringAudioFrame
- onMixedAudioFrame
- onPlaybackAudioFrame
- onPlaybackAudioFrameBeforeMixing
- onRecordAudioFrame
IAudioSpectrumObserver
用于音频频谱观测的接口。
相关参考
IBaseSpatialAudioEngine
IBaseSpatialAudioEngine：基础空间音效引擎接口。
相关参考
- clearRemotePositions
- muteAllRemoteAudioStreams
- muteLocalAudioStream
- muteRemoteAudioStream
- setAudioRecvRange
- setDistanceUnit
- setMaxAudioRecvCount
- setPlayerAttenuation
- setZones
- updatePlayerPositionInfo
- updateSelfPosition
ILocalSpatialAudioEngine
ILocalSpatialAudioEngine 是本地空间音效引擎接口。
相关参考
IMediaExtensionObserver
IMediaExtensionObserver 接口用于监听媒体扩展相关的事件。
IMediaPlayer
IMediaPlayer 接口用于实现媒体播放功能。
相关参考
- adjustPlayoutVolume
- adjustPublishSignalVolume
- destroy
- getAudioBufferDelay
- 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
- setAudioDualMonoMode
- setAudioPitch
- setLoopCount
- setPlaybackSpeed
- setPlayerOption
- setPlayerOptionString
- setVideoRenderMode
- setSpatialAudioParams
- setView
- stop [1/2]
- switchSrc
- unloadSrc
- unRegisterPlayerObserver
IMediaPlayerAudioFrameObserver
用于观测媒体播放器的音频帧。
相关参考
IMediaPlayerCacheManager
用于管理媒体播放器的缓存。
相关参考
- enableAutoRemoveCache
- getCacheDir
- getCacheFileCount
- getMaxCacheFileCount
- getMaxCacheFileSize
- getMediaPlayerCacheManager
- removeAllCaches
- removeCacheByUri
- removeOldCache
- setCacheDir
- setMaxCacheFileCount
- setMaxCacheFileSize
IMediaPlayerCustomDataProvider
IMediaPlayerCustomDataProvider 接口用于为媒体播放器提供自定义数据源。
相关参考
IMediaPlayerObserver
用于监听媒体播放器状态变化的接口。
相关参考
- onAudioVolumeIndication
- onMetaData
- onPlayBufferUpdated
- onPlayerCacheStats
- onPlayerEvent
- onPlayerInfoUpdated
- onPlayerPlaybackStats
- onPlayerStateChanged
- onPlayerSrcInfoChanged
- onPositionChanged
- onPreloadEvent
IMediaPlayerVideoFrameObserver
用于观测媒体播放器的视频帧。
相关参考
AgoraMediaRecorder
用于录制客户端的音频和视频。
自从
自 v3.5.2 版本新增。
AgoraMediaRecorder 可录制以下内容：
- 本地麦克风采集并由 SDK 编码为 AAC 格式的音频。
- 本地摄像头采集并由 SDK 编码的视频。
注： 在 COMMUNICATION 频道场景下，当频道中存在使用 v3.0.0 之前版本 SDK 的用户时，该功能不可用。
相关参考
IMediaRecorderCallback
用于设置媒体录制的回调方法。
自从
自 v4.0.0 版本新增。
相关参考
IMetadataObserver
用于实现元数据观察功能。
注： 请在关键线程中实现该类中的所有回调方法。建议避免在关键线程中执行任何耗时操作。
相关参考
IAgoraMusicContentCenter
IAgoraMusicContentCenter 提供用于管理和访问音乐内容中心的接口。
相关参考
- createMusicPlayer
- destroy
- destroyMusicPlayer
- getCaches
- getInternalSongCode
- getLyric
- getMusicCharts
- getMusicCollectionByMusicChartId [1/2]
- getMusicCollectionByMusicChartId [2/2]
- getSongSimpleInfo
- initialize
- isPreloaded
- preload [1/2]
- preload [2/2]
- registerEventHandler
- removeCache
- renewToken
- searchMusic [1/2]
- searchMusic [2/2]
- unregisterEventHandler
IMusicContentCenterEventHandler
用于处理音乐内容中心相关事件的接口。
相关参考
IAgoraMusicPlayer
扩展 IMediaPlayer 接口，支持更多音乐播放功能。
相关参考
RtcEngine
调用该类的方法以使用声网 SDK 的全部功能。
声网建议在同一线程中调用 RtcEngine 的 API 方法，避免在多个线程中调用。该类在早期版本中名为 AgoraAudio，从 1.0 版本起更名为 RtcEngine。
相关参考
- addExtension
- addHandler
- addVideoWatermark [1/3]
- addVideoWatermark [2/3]
- addVideoWatermark [3/3]
- adjustAudioMixingPlayoutVolume
- adjustAudioMixingPublishVolume
- adjustAudioMixingVolume
- adjustCustomAudioPlayoutVolume
- adjustCustomAudioPublishVolume
- adjustPlaybackSignalVolume
- adjustRecordingSignalVolume
- adjustUserPlaybackSignalVolume
- clearVideoWatermarks
- complain
- configRhythmPlayer
- create [1/2]
- createCustomAudioTrack
- createCustomVideoTrack
- createDataStream [1/2]
- createDataStream [2/2]
- createMediaPlayer
- createMediaRecorder
- createVideoEffectObject
- destroy [2/2]
- destroyCustomAudioTrack
- destroyCustomVideoTrack
- destroyMediaRecorder
- destroyVideoEffectObject
- 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
- enableSpatialAudio
- enableVideo
- enableVideoImageSource
- enableVirtualBackground [1/2]
- enableVirtualBackground [2/2]
- enableVoiceAITuner
- enableWebSdkInteroperability
- getAudioDeviceInfo
- getAudioEffectManager
- getAudioMixingCurrentPosition
- getAudioMixingDuration
- getAudioMixingPlayoutVolume
- getAudioMixingPublishVolume
- getAudioTrackCount
- getCallId
- getCameraMaxZoomFactor
- getConnectionState
- getCurrentMonotonicTimeInMs
- getEffectCurrentPosition
- getEffectDuration
- getEffectsVolume
- getErrorDescription
- getExtensionProperty [1/2]
- getExtensionProperty [2/2]
- getFaceShapeAreaOptions [1/2]
- getFaceShapeAreaOptions [2/2]
- getFaceShapeBeautyOptions [1/2]
- getFaceShapeBeautyOptions [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]
- joinChannel [2/2]
- joinChannelWithUserAccount [1/2]
- joinChannelWithUserAccount [2/2]
- leaveChannel [1/2]
- leaveChannel [2/2]
- muteAllRemoteAudioStreams
- muteAllRemoteVideoStreams
- muteLocalAudioStream
- muteLocalVideoStream
- muteRecordingSignal
- muteRemoteAudioStream
- muteRemoteVideoStream
- pauseAllChannelMediaRelay
- pauseAllEffects
- pauseAudioMixing
- pauseEffect
- playAllEffects
- playEffect [1/2]
- playEffect [2/2]
- preloadChannel
- preloadChannelWithUserAccount
- preloadEffect [1/2]
- preloadEffect [2/2]
- pullPlaybackAudioFrame [1/2]
- pullPlaybackAudioFrame [2/2]
- pushExternalAudioFrame
- pushExternalVideoFrameById [1/2]
- pushExternalVideoFrame [1/2]
- pushExternalVideoFrameById [2/2]
- pushExternalVideoFrame [2/2]
- queryCameraFocalLengthCapability
- queryCodecCapability
- queryDeviceScore
- queryScreenCaptureCapability
- rate
- registerAudioEncodedFrameObserver
- registerAudioFrameObserver
- registerAudioSpectrumObserver
- registerExtension
- registerLocalUserAccount
- registerMediaMetadataObserver
- registerVideoEncodedFrameObserver
- registerVideoFrameObserver
- destroy [1/2]
- removeHandler
- removeVideoWatermark
- renewToken
- resumeAllChannelMediaRelay
- resumeAllEffects
- resumeAudioMixing
- resumeEffect
- selectAudioTrack
- sendCustomReportMessage
- sendStreamMessage
- setAdvancedAudioOptions
- setAINSMode
- setAudioEffectParameters
- setAudioEffectPreset
- setAudioMixingDualMonoMode
- setAudioMixingPitch
- setAudioMixingPlaybackSpeed
- setAudioMixingPosition
- setAudioProfile [1/2]
- setAudioProfile [2/2]
- setAudioScenario
- setAVSyncSource
- setBeautyEffectOptions [1/2]
- setBeautyEffectOptions [2/2]
- 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
- setExternalAudioSource [1/2]
- setExternalAudioSource [2/2]
- setExternalMediaProjection
- setExternalRemoteEglContext
- setExternalVideoSource
- setFaceShapeAreaOptions [1/2]
- setFaceShapeAreaOptions [2/2]
- setFaceShapeBeautyOptions [1/2]
- setFaceShapeBeautyOptions [2/2]
- setFilterEffectOptions [1/2]
- setFilterEffectOptions [2/2]
- setHeadphoneEQParameters
- setHeadphoneEQPreset
- setInEarMonitoringVolume
- setLocalAccessPoint
- setLocalRenderMode [1/2]
- setLocalRenderMode [2/2]
- setLocalRenderTargetFps
- setLocalVideoMirrorMode
- setLocalVoiceEqualization
- setLocalVoiceFormant
- setLocalVoicePitch
- setLocalVoiceReverb
- setLogFile
- setLogFileSize
- setLogFilter
- setLogLevel
- setLowlightEnhanceOptions [1/2]
- setLowlightEnhanceOptions [2/2]
- setMixedAudioFrameParameters
- setParameters
- setPlaybackAudioFrameBeforeMixingParameters [1/2]
- setPlaybackAudioFrameBeforeMixingParameters [2/2]
- setPlaybackAudioFrameParameters
- setRecordingAudioFrameParameters
- setRemoteDefaultVideoStreamType [1/2]
- setRemoteDefaultVideoStreamType [2/2]
- setRemoteRenderMode
- setRemoteRenderTargetFps
- setRemoteSubscribeFallbackOption [1/2]
- setRemoteSubscribeFallbackOption [2/2]
- setRemoteUserSpatialAudioParams
- setRemoteVideoStreamType [1/2]
- setRemoteVideoStreamType [2/2]
- setRemoteVideoSubscriptionOptions
- setRemoteVoicePosition
- setRouteInCommunicationMode
- setScreenCaptureScenario
- setSubscribeAudioAllowlist
- setSubscribeAudioBlocklist
- setSubscribeVideoAllowlist
- setSubscribeVideoBlocklist
- setupLocalVideo
- setupRemoteVideo
- setVideoDenoiserOptions [1/2]
- setVideoDenoiserOptions [2/2]
- setVideoEncoderConfiguration
- setVideoScenario
- setVoiceBeautifierParameters
- setVoiceBeautifierPreset
- setVoiceConversionPreset
- setVolumeOfEffect
- startAudioMixing [1/2]
- startAudioMixing [2/2]
- startAudioRecording [1/2]
- startAudioRecording [2/2]
- startCameraCapture
- startEchoTest
- startLastmileProbeTest
- startLocalAudioMixer
- startLocalVideoTranscoder
- startMediaRenderingTracing
- startOrUpdateChannelMediaRelay
- startPlaybackDeviceTest
- startPreview [1/2]
- startPreview [2/2]
- startRecordingDeviceTest
- startRhythmPlayer
- startRtmpStreamWithoutTranscoding
- startRtmpStreamWithTranscoding
- startScreenCapture
- stopAllEffects
- stopAudioMixing
- stopAudioRecording
- stopCameraCapture
- stopChannelMediaRelay
- stopEchoTest
- stopEffect
- stopLastmileProbeTest
- stopLocalAudioMixer
- stopLocalVideoTranscoder
- stopPlaybackDeviceTest
- stopPreview [1/2]
- stopPreview [2/2]
- stopRecordingDeviceTest
- stopRhythmPlayer
- stopRtmpStream
- stopScreenCapture
- switchCamera [1/2]
- switchCamera [2/2]
- takeSnapshot [1/2]
- takeSnapshot [2/2]
- unloadEffect
- unRegisterAudioSpectrumObserver
- unregisterMediaMetadataObserver
- updateChannelMediaOptions
- updateLocalAudioMixerConfiguration
- updateLocalTranscoderConfiguration
- updatePreloadChannelToken
- updateRtmpTranscoding
- updateScreenCaptureParameters
IRtcEngineEventHandler
封装 SDK 向应用层发送事件回调的方法。
IRtcEngineEventHandler 是 SDK 用于向应用层发送事件回调的接口类。你可以继承该类以接收所需的事件通知。该接口中的所有方法均为默认空实现，你可以根据需要选择性地重写部分方法。为确保 SDK 正常运行，建议在回调方法中避免执行耗时操作或调用阻塞 API，例如 SendMessage。
相关参考
- onActiveSpeaker
- onAudioEffectFinished
- onAudioMixingFinished
- onAudioMixingPositionChanged
- onAudioMixingStateChanged
- onAudioPublishStateChanged
- onAudioQuality
- onAudioRouteChanged
- onAudioSubscribeStateChanged
- onAudioVolumeIndication
- onCameraExposureAreaChanged
- onCameraFocusAreaChanged
- onCameraReady
- onChannelMediaRelayStateChanged
- onClientRoleChanged
- onClientRoleChangeFailed
- onConnectionBanned
- onConnectionInterrupted
- onConnectionLost
- onConnectionStateChanged
- onEncryptionError
- onError
- onErrorWithContext
- onEventWithContext
- onStartedWithContext
- onStoppedWithContext
- onFacePositionChanged
- onFirstLocalAudioFramePublished
- onFirstLocalVideoFrame
- onFirstLocalVideoFramePublished
- onFirstRemoteAudioDecoded
- onFirstRemoteAudioFrame
- onFirstRemoteVideoDecoded
- onFirstRemoteVideoFrame
- onJoinChannelSuccess
- onLastmileProbeResult
- onLastmileQuality
- onLeaveChannel
- onLocalAudioStateChanged
- onLocalAudioStats
- onLocalUserRegistered
- onLocalVideoEvent
- onLocalVideoStateChanged
- onLocalVideoStats
- onLocalVideoTranscoderError
- onMultipathStats
- onNetworkQuality
- onNetworkTypeChanged
- onPermissionError
- onPermissionGranted
- onProxyConnected
- onRejoinChannelSuccess
- onRemoteAudioStateChanged
- onRemoteAudioStats
- onRemoteAudioTransportStats
- onRemoteSubscribeFallbackToAudioOnly
- onRemoteVideoStateChanged
- onRemoteVideoStats
- onRemoteVideoTransportStats
- onRenewTokenResult
- onRequestToken
- onRhythmPlayerStateChanged
- onRtcStats
- onRtmpStreamingEvent
- onRtmpStreamingStateChanged
- onSnapshotTaken
- onStreamMessage
- onStreamMessageError
- onTokenPrivilegeWillExpire
- onTranscodedStreamLayoutInfo
- onTranscodingUpdated
- onUplinkNetworkInfoUpdated
- onUserEnableLocalVideo
- onUserEnableVideo
- onUserInfoUpdated
- onUserJoined
- onUserMuteAudio
- onUserMuteVideo
- onUserOffline
- onVideoPublishStateChanged
- onVideoRenderingTracingResult
- onVideoSizeChanged
- onVideoStopped
- onVideoSubscribeStateChanged
RtcEngineEx
扩展 RtcEngine 接口的功能。
相关参考
- addVideoWatermarkEx [1/2]
- addVideoWatermarkEx [2/2]
- adjustUserPlaybackSignalVolumeEx
- clearVideoWatermarkEx
- createDataStreamEx [1/2]
- createDataStreamEx [2/2]
- enableAudioVolumeIndicationEx
- enableContentInspectEx
- enableDualStreamModeEx
- enableEncryptionEx
- getCallIdEx
- getConnectionStateEx
- getUserInfoByUidEx
- getUserInfoByUserAccountEx
- joinChannelEx
- joinChannelWithUserAccountEx
- leaveChannelEx [1/2]
- leaveChannelEx [2/2]
- muteAllRemoteAudioStreamsEx
- muteAllRemoteVideoStreamsEx
- muteLocalAudioStreamEx
- muteLocalVideoStreamEx
- muteRemoteAudioStreamEx
- muteRemoteVideoStreamEx
- pauseAllChannelMediaRelayEx
- playEffectEx [1/2]
- playEffectEx [2/2]
- preloadEffectEx [1/2]
- preloadEffectEx [2/2]
- removeVideoWatermarkEx
- resumeAllChannelMediaRelayEx
- sendCustomReportMessageEx
- sendStreamMessageEx
- setDualStreamModeEx
- setRemoteRenderModeEx
- setRemoteVideoStreamTypeEx [1/2]
- setRemoteVideoStreamTypeEx [2/2]
- setRemoteVideoSubscriptionOptionsEx
- setRemoteVoicePositionEx
- setSubscribeAudioAllowlistEx
- setSubscribeAudioBlocklistEx
- setSubscribeVideoAllowlistEx
- setSubscribeVideoBlocklistEx
- setupRemoteVideoEx
- setVideoEncoderConfigurationEx
- startMediaRenderingTracingEx
- startOrUpdateChannelMediaRelayEx
- startRtmpStreamWithoutTranscodingEx
- startRtmpStreamWithTranscodingEx
- stopChannelMediaRelayEx
- stopRtmpStreamEx
- takeSnapshotEx [1/2]
- takeSnapshotEx [2/2]
- updateChannelMediaOptionsEx
- updateRtmpTranscodingEx
IRtcEngineReleaseCallback
用于异步销毁引擎。
自从
自 v4.6.0 版本新增。
相关参考
IVideoEncodedFrameObserver
用于监听编码后的视频帧。
相关参考
IVideoFrameObserver
用于处理视频帧的回调。
你可以通过实现 IVideoFrameObserver 接口中的方法，接收并处理本地设备采集或远端用户发送的视频帧。
相关参考
- getMirrorApplied
- getObservedFramePosition
- getRotationApplied
- getVideoFormatPreference
- getVideoFrameProcessMode
- onCaptureVideoFrame
- onPreEncodeVideoFrame
- onRenderVideoFrame
Player
用于播放 URL 资源。
自从
自 v4.4.0 版本新增。
相关参考
- getConfigs [2/3]
- getInfo
- getPosition
- getStats
- muteAudio
- muteVideo
- openWithUrl
- pause
- play
- Player
- preloadWithUrl
- registerObserver
- seek
- setCanvas
- setConfigs [2/3]
- stop
- switchWithUrl
- unregisterObserver
PlayerConfig
用于配置媒体播放器选项。
自从
自 v4.4.0 版本新增。
相关参考
- getAbrFallbackLayer
- getAbrSubscriptionLayer
- getAutoPlay
- getLoopCount
- getPlaybackSpeed
- getPlayoutVolume
- setAbrFallbackLayer
- setAbrSubscriptionLayer
- setAutoPlay
- setLoopCount
- setPlaybackSpeed
- setPlayoutVolume
PlayerGetStatsCallback
用于获取播放统计信息的回调接口。
自从
自 v4.4.0 版本新增。
相关参考
PlayerObserver
PlayerObserver 用于接收播放器的事件回调。
自从
自 v4.4.0 版本新增。
相关参考
- onAudioVolumeIndication
- onEvent
- onMetadata [2/2]
- onPlayerInfoUpdated [2/2]
- onPositionChanged
- onResolutionChanged
- onStateChanged
Rte
Rte 类是声网实时互动 SDK 的基础接口。
自从
自 v4.4.0 版本新增。
相关参考
PlayerInfo
包含播放器和媒体流的信息。
自从
自 v4.4.0 版本新增。