接口类

本页列出 Android 所有的接口类。

RtcEngine

RTC SDK 的基础接口类，实现实时音视频的主要功能。

RtcEngine 提供了 app 调用的主要方法。

相关参考

• addHandler

• addVideoWatermark [1/2]

• addVideoWatermark [2/2]

• adjustAudioMixingPlayoutVolume

• adjustAudioMixingPublishVolume

• adjustAudioMixingVolume

• adjustCustomAudioPlayoutVolume

• adjustCustomAudioPublishVolume

• adjustPlaybackSignalVolume

• adjustRecordingSignalVolume

• adjustUserPlaybackSignalVolume

• clearVideoWatermarks

• complain

• configRhythmPlayer

• create [1/2]

• createCustomAudioTrack

• createCustomVideoTrack

• createDataStream [1/2]

• createDataStream [2/2]

• createMediaPlayer

• createMediaRecorder

• CreateRendererView

• CreateTextureView

• destroyCustomAudioTrack

• destroyCustomVideoTrack

• disableAudio

• disableAudioSpectrumMonitor

• disableVideo

• enableAudio

• enableAudioQualityIndication

• enableAudioSpectrumMonitor

• enableAudioVolumeIndication

• enableContentInspect

• enableDualStreamMode [1/2]

• enableDualStreamMode [2/2]

• enableEncryption

• enableExtension

• enableFaceDetection

• enableInEarMonitoring [1/2]

• enableInEarMonitoring [2/2]

• enableInstantMediaRendering

• enableLocalAudio

• enableLocalVideo

• enableSoundPositionIndication

• enableSpatialAudio

• enableVideo

• enableVideoImageSource

• enableVirtualBackground

• enableWebSdkInteroperability

• getAudioDeviceInfo

• getAudioEffectManager

• getAudioMixingCurrentPosition

• getAudioMixingDuration

• getAudioMixingPlayoutVolume

• getAudioMixingPublishVolume

• getAudioTrackCount

• getCallId

• getCameraMaxZoomFactor

• getConnectionState

• getCurrentMonotonicTimeInMs

• getEffectCurrentPosition

• getEffectDuration

• getEffectsVolume

• getErrorDescription

• getExtensionProperty [1/2]

• getExtensionProperty [2/2]

• getMediaPlayerCacheManager

• getNativeHandle

• getNetworkType

• getNtpWallTimeInMs

• getUserInfoByUid

• getUserInfoByUserAccount

• getSdkVersion

• getVolumeOfEffect

• create [2/2]

• isCameraAutoFocusFaceModeSupported

• isCameraExposurePositionSupported

• isCameraExposureSupported

• isCameraFaceDetectSupported

• isCameraFocusSupported

• isCameraTorchSupported

• isCameraZoomSupported

• 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

• playEffect [1/2]

• playEffect [2/2]

• preloadChannel[1/2]

• preloadChannel[2/2]

• preloadEffect

• pullPlaybackAudioFrame [1/2]

• pullPlaybackAudioFrame [2/2]

• pushExternalAudioFrame

• pushExternalVideoFrame [1/2]

• pushExternalVideoFrame [2/2]

• queryCodecCapability

• queryScreenCaptureCapability

• rate

• registerAudioEncodedFrameObserver

• registerAudioFrameObserver

• registerAudioSpectrumObserver

• registerLocalUserAccount

• registerMediaMetadataObserver

• registerVideoEncodedFrameObserver

• registerVideoFrameObserver

• destroy

• removeHandler

• renewToken

• resumeAllChannelMediaRelay

• resumeAllEffects

• resumeAudioMixing

• resumeEffect

• selectAudioTrack

• sendCustomReportMessage

• sendStreamMessage

• setAdvancedAudioOptions

• setAINSMode

• setAudioEffectParameters

• setAudioEffectPreset

• setAudioMixingDualMonoMode

• setAudioMixingPitch

• setAudioMixingPosition

• setAudioProfile [1/2]

• setAudioProfile [2/2]

• setAudioScenario

• setAVSyncSource

• setBeautyEffectOptions

• setCameraAutoFocusFaceModeEnabled

• setCameraCapturerConfiguration

• setCameraExposureFactor

• setCameraExposurePosition

• setCameraFocusPositionInPreview

• setCameraTorchOn

• setCameraZoomFactor

• setChannelProfile

• setClientRole [1/2]

• setClientRole [2/2]

• setCloudProxy

• setColorEnhanceOptions

• setDefaultAudioRouteToSpeakerphone

• setDirectCdnStreamingAudioConfiguration

• setDirectCdnStreamingVideoConfiguration

• setDualStreamMode [1/2]

• setDualStreamMode [2/2]

• setEarMonitoringAudioFrameParameters

• setEffectPosition

• setEffectsVolume

• setEnableSpeakerphone

• setEncryptionMode

• setEncryptionSecret

• setExtensionProperty

• setExtensionProviderProperty

• setExternalAudioSink

• setExternalAudioSource [1/2]

• setExternalAudioSource [2/2]

• setExternalVideoSource

• setHeadphoneEQParameters

• setHeadphoneEQPreset

• setInEarMonitoringVolume

• setLocalAccessPoint

• setLocalRenderMode [1/2]

• setLocalRenderMode [2/2]

• setLocalVideoMirrorMode

• setLocalVoiceEqualization

• setLocalVoiceFormant

• setLocalVoicePitch

• setLocalVoiceReverb

• setLogFile

• setLogFileSize

• setLogFilter

• setLogLevel

• setLowlightEnhanceOptions

• setMixedAudioFrameParameters

• setParameters

• setPlaybackAudioFrameBeforeMixingParameters

• setPlaybackAudioFrameParameters

• setRecordingAudioFrameParameters

• setRemoteDefaultVideoStreamType

• setRemoteRenderMode [1/2]

• setRemoteRenderMode [2/2]

• setRemoteUserSpatialAudioParams

• setRemoteVideoStreamType

• setRemoteVideoSubscriptionOptions

• setRemoteVoicePosition

• setRouteInCommunicationMode

• setSubscribeAudioAllowlist

• setSubscribeAudioBlocklist

• setSubscribeVideoAllowlist

• setSubscribeVideoBlocklist

• setupLocalVideo

• setupRemoteVideo

• setVideoDenoiserOptions

• setVideoEncoderConfiguration

• setVideoProfile

• setVideoScenario

• setVoiceBeautifierParameters

• setVoiceBeautifierPreset

• setVoiceConversionPreset

• setVolumeOfEffect

• startAudioMixing [1/2]

• startAudioMixing [2/2]

• startAudioRecording [1/2]

• startAudioRecording [2/2]

• startChannelMediaRelay

• startDirectCdnStreaming

• startEchoTest [1/3]

• startEchoTest [2/3]

• startEchoTest [3/3]

• startLastmileProbeTest

• startLocalVideoTranscoder

• startOrUpdateChannelMediaRelay

• startPreview [1/2]

• startPreview [2/2]

• startCameraCapture

• startRhythmPlayer

• startRtmpStreamWithoutTranscoding

• startRtmpStreamWithTranscoding

• startScreenCapture

• startMediaRenderingTracing

• stopAllEffects

• stopAudioMixing

• stopAudioRecording

• stopChannelMediaRelay

• stopDirectCdnStreaming

• stopEchoTest

• stopEffect

• stopLastmileProbeTest

• stopPreview [1/2]

• stopPreview [2/2]

• stopCameraCapture

• stopRhythmPlayer

• stopRtmpStream

• stopScreenCapture

• switchCamera

• takeSnapshot

• unloadEffect

• unregisterAudioSpectrumObserver

• unregisterMediaMetadataObserver

• updateChannelMediaOptions

• updateChannelMediaRelay

• updateLocalTranscoderConfiguration

• updatePreloadChannelToken

• updateRtmpTranscoding

• updateScreenCaptureParameters

RtcEngineEx

提供多频道方法的接口类。

继承自 RtcEngine。

相关参考

• addVideoWatermarkEx

• clearVideoWatermarkEx

• createDataStreamEx [1/2]

• createDataStreamEx [2/2]

• enableAudioVolumeIndicationEx

• enableDualStreamModeEx

• getConnectionStateEx

• getUserInfoByUid

• getUserInfoByUserAccount

• joinChannelEx

• joinChannelWithUserAccountEx

• leaveChannelEx [1/2]

• leaveChannelEx [2/2]

• muteAllRemoteAudioStreamsEx

• muteAllRemoteVideoStreamsEx

• muteLocalAudioStreamEx

• muteLocalVideoStreamEx

• muteRemoteAudioStreamEx

• muteRemoteVideoStreamEx

• pauseAllChannelMediaRelayEx

• pushExternalVideoFrameEx [1/2]

• pushExternalVideoFrameEx [2/2]

• resumeAllChannelMediaRelayEx

• sendCustomReportMessageEx

• setDualStreamModeEx

• setRemoteRenderModeEx

• setRemoteVideoStreamTypeEx

• setRemoteVoicePositionEx

• setSubscribeAudioBlocklistEx

• setSubscribeAudioAllowlistEx

• setSubscribeVideoBlocklistEx

• setSubscribeVideoAllowlistEx

• setupRemoteVideoEx

• setVideoEncoderConfigurationEx

• sendStreamMessageEx

• startChannelMediaRelayEx

• startMediaRenderingTracingEx

• startOrUpdateChannelMediaRelayEx

• startRtmpStreamWithoutTranscodingEx

• startRtmpStreamWithTranscodingEx

• stopChannelMediaRelayEx

• stopRtmpStreamEx

• takeSnapshotEx

• updateChannelMediaOptionsEx

• updateChannelMediaRelayEx

• updateRtmpTranscodingEx

• setRemoteVideoSubscriptionOptionsEx

• adjustUserPlaybackSignalVolumeEx

IRtcEngineEventHandler

IRtcEngineEventHandler 接口类用于 SDK 向 app 发送事件通知，app 通过继承该接口类的方法获取 SDK 的事件通知。

相关参考

• onActiveSpeaker

• onAudioEffectFinished

• onAudioMixingFinished

• onAudioMixingPositionChanged

• onAudioMixingStateChanged

• onAudioPublishStateChanged

• onAudioQuality

• onAudioRouteChanged

• onAudioSubscribeStateChanged

• onAudioVolumeIndication

• onCameraExposureAreaChanged

• onCameraFocusAreaChanged

• onCameraReady

• onChannelMediaRelayEvent

• 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

• onNetworkQuality

• onNetworkTypeChanged

• onPermissionError

• onProxyConnected

• onRejoinChannelSuccess

• onRemoteAudioStateChanged

• onRemoteAudioStats

• onRemoteAudioTransportStats

• onRemoteVideoStateChanged

• onRemoteVideoStats

• onRemoteVideoTransportStats

• onRequestToken

• onRhythmPlayerStateChanged

• onRtcStats

• onRtmpStreamingEvent

• onRtmpStreamingStateChanged

• onSnapshotTaken

• onStreamMessage

• onStreamMessageError

• onTokenPrivilegeWillExpire

• onTranscodingUpdated

• onUplinkNetworkInfoUpdated

• onUserEnableLocalVideo

• onUserEnableVideo

• onUserInfoUpdated

• onUserJoined

• onUserMuteAudio

• onUserMuteVideo

• onUserOffline

• onVideoPublishStateChanged

• onVideoSizeChanged

• onVideoStopped

• onVideoSubscribeStateChanged

• onVideoRenderingTracingResult

IAudioEffectManager

该类提供音效管理方法。

IAudioEncodedFrameObserver

编码后音频的观测器。

相关参考

• onMixedAudioEncodedFrame

• onPlaybackAudioEncodedFrame

• onRecordAudioEncodedFrame

IAudioFrameObserver

音频观测器。

相关参考

• onPlaybackAudioFrameBeforeMixing

IAudioSpectrumObserver

音频频谱观测器。

相关参考

• onLocalAudioSpectrum

• onRemoteAudioSpectrum

IBaseSpatialAudioEngine

该类包含 ILocalSpatialAudioEngine 类中的部分 API。

ILocalSpatialAudioEngine 类继承自 IBaseSpatialAudioEngine。

相关参考

• muteAllRemoteAudioStreams

• muteLocalAudioStream

• setAudioRecvRange

• setDistanceUnit

• setMaxAudioRecvCount

• setPlayerAttenuation

• setRemoteAudioAttenuation

• setZones

• updatePlayerPositionInfo

• updateSelfPosition

IDirectCdnStreamingEventHandler

IDirectCdnStreamingEventHandler 接口类用于 SDK 向 app 发送 CDN 推流的事件通知，app 通过继承该接口类的方法获取 SDK 的事件通知。

相关参考

• onDirectCdnStreamingStateChanged

• onDirectCdnStreamingStats

ILocalSpatialAudioEngine

该类通过 SDK 计算用户坐标，实现空间音效。

该类继承自 IBaseSpatialAudioEngine。调用该类下其他 API 前，你需要调用 initialize 方法初始化该类。

相关参考

• clearRemotePositions

• create

• initialize

• destroy

• removeRemotePosition

• updateRemotePosition

• LocalSpatialAudioConfig

IMediaPlayer

提供媒体播放器功能的类，支持多实例。

相关参考

• adjustPlayoutVolume

• adjustPublishSignalVolume

• getDuration

• getMediaPlayerCacheManager

• getMediaPlayerId

• getMute

• getPlayoutVolume

• getPlayPosition

• getPlaySrc [1/2]

• getPublishSignalVolume

• getState

• getStreamCount

• getStreamInfo

• mute

• open [1/2]

• open [2/2]

• openWithCustomSource

• openWithMediaSource

• pause

• play

• playPreloadedSrc

• preloadSrc

• registerAudioFrameObserver

• registerPlayerObserver

• registerVideoFrameObserver

• resume

• seek

• selectAudioTrack

• setAudioPitch

• setAudioDualMonoMode

• setLoopCount

• setPlaybackSpeed

• setRenderMode

• setSpatialAudioParams

• setView

• stop

• switchSrc

• unloadSrc

• unRegisterPlayerObserver

IMediaPlayerAudioFrameObserver

媒体播放器的音频数据观测器。

相关参考

• onFrame

IMediaPlayerCacheManager

该类提供管理媒体播放器中缓存媒体文件的方法。

相关参考

• enableAutoRemoveCache

• getCacheDir

• getCacheFileCount

• getMaxCacheFileCount

• getMaxCacheFileSize

• removeAllCaches

• removeCacheByUri

• removeOldCache

• setCacheDir

• setMaxCacheFileCount

• setMaxCacheFileSize

IMediaPlayerCustomDataProvider

提供打开自定义媒体资源文件的回调。

相关参考

• onReadData

• onSeek

IMediaPlayerObserver

提供媒体播放器的回调。

相关参考

• onAudioVolumeIndication

• onMetaData

• onPlayBufferUpdated

• onPlayerEvent

• onPlayerInfoUpdated

• onPlayerStateChanged

• onPlayerSrcInfoChanged

• onPositionChanged

• onPreloadEvent

IMediaPlayerVideoFrameObserver

媒体播放器的视频数据观测器。

相关参考

• onFrame

IMetadataObserver

Metadata 观测器。

IVideoEncodedFrameObserver

用于接收编码后的视频图像的类。

相关参考

• onEncodedVideoFrameReceived

IVideoFrameObserver

视频观测器。

相关参考

• getMirrorApplied

• getObservedFramePosition

• getRotationApplied

• getVideoFormatPreference

• getVideoFrameProcessMode

• onCaptureVideoFrame

• onPreEncodeVideoFrame

• onRenderVideoFrame

AgoraMediaRecorder

提供本地及远端音视频录制功能的类。

相关参考

• setMediaRecorderObserver

• startRecording

• stopRecording

IMediaRecorderCallback

包含音视频录制的事件。

相关参考

• onRecorderStateChanged

• onRecorderInfoUpdated

IMediaExtensionObserver

插件事件回调接口类。

相关参考

• onError

• onEvent

• onStarted

• onStopped

IMusicContentCenterEventHandler

IMusicContentCenterEventHandler 接口类，用于 SDK 向客户端发送音乐内容中心事件通知。

相关参考

• onLyricResult

• onMusicChartsResult

• onMusicCollectionResult

• onPreLoadEvent

• onSongSimpleInfoResult

IAgoraMusicPlayer

继承自 IMediaPlayer 类，提供音乐播放器的相关方法。

相关参考

• getPlaySrc [2/2]

• open

• open2

• stop

IAgoraMusicContentCenter

IAgoraMusicContentCenter 接口类提供音乐内容中心的相关方法。

相关参考

• initialize

• renewToken

• release

• removeCache

• registerEventHandler

• unregisterEventHandler

• createMusicPlayer

• getCaches

• getInternalSongCode

• getMusicCharts

• getMusicCollectionByMusicChartId [1/2]

• getMusicCollectionByMusicChartId [2/2]

• getSongSimpleInfo

• searchMusic [1/2]

• searchMusic [2/2]

• preload [1/2]

• preload [2/2]

• isPreloaded

• getLyric

• destroy