API 列表
- Flutter
更新时间不可用
本页列出 Flutter 所有的接口类以及其中包含的 API。
AgoraPipController
管理画中画功能的控制器接口。
自从
自 v6.6.2 版本新增。
此抽象类定义了控制画中画模式所需的方法，包括设置、状态管理和生命周期操作。
相关参考
- isPipActivated
- pipDispose
- pipIsAutoEnterSupported
- pipIsSupported
- pipSetup
- pipStart
- pipStop
- registerPipStateChangedObserver
- dispose
- unregisterPipStateChangedObserver
AgoraPipStateChangedObserver
画中画状态改变的观测器。
自从
自 v6.6.2 版本新增。
实现此类以接收画中画状态转换和潜在错误的通知。
相关参考
AudioDeviceManager
音频设备管理方法。
相关参考
- enumeratePlaybackDevices
- enumerateRecordingDevices
- followSystemLoopbackDevice
- followSystemPlaybackDevice
- followSystemRecordingDevice
- getLoopbackDevice
- getPlaybackDefaultDevice
- getPlaybackDevice
- getPlaybackDeviceInfo
- getPlaybackDeviceMute
- getPlaybackDeviceVolume
- getRecordingDefaultDevice
- getRecordingDevice
- getRecordingDeviceInfo
- getRecordingDeviceMute
- getRecordingDeviceVolume
- release
- setLoopbackDevice
- setPlaybackDevice
- setPlaybackDeviceMute
- setPlaybackDeviceVolume
- setRecordingDevice
- setRecordingDeviceMute
- setRecordingDeviceVolume
- startAudioDeviceLoopbackTest
- startPlaybackDeviceTest
- startRecordingDeviceTest
- stopAudioDeviceLoopbackTest
- stopPlaybackDeviceTest
- stopRecordingDeviceTest
AudioEncodedFrameObserver
编码后音频的观测器。
相关参考
AudioFrameObserver
音频观测器。
你可以调用 registerAudioFrameObserver 注册或取消注册 AudioFrameObserver 音频观测器。
相关参考
AudioFrameObserverBase
音频观测器。
你可以调用 registerAudioFrameObserver 注册或取消注册 AudioFrameObserverBase 音频观测器。
相关参考
AudioPcmFrameSink
该类用于获取原始的 PCM 音频数据。
你可以继承这个类，实现 onFrame 回调来获得 PCM 音频数据。
相关参考
AudioSpectrumObserver
音频频谱观测器。
相关参考
BaseSpatialAudioEngine
该类包含 LocalSpatialAudioEngine 类中的部分 API。
LocalSpatialAudioEngine 类继承自 BaseSpatialAudioEngine。
相关参考
- muteAllRemoteAudioStreams
- muteLocalAudioStream
- muteRemoteAudioStream
- release
- setAudioRecvRange
- setDistanceUnit
- setMaxAudioRecvCount
- setPlayerAttenuation
- setZones
- updatePlayerPositionInfo
- updateSelfPosition
FaceInfoObserver
人脸信息观测器。
你可以调用 registerFaceInfoObserver 注册 FaceInfoObserver 观测器。
相关参考
LocalSpatialAudioEngine
该类通过 SDK 计算用户坐标，实现空间音频。
该类继承自 BaseSpatialAudioEngine。调用该类下其他 API 前，你需要调用 initialize 方法初始化该类。
相关参考
MediaEngine
MediaEngine 类。
相关参考
- createCustomAudioTrack
- destroyCustomAudioTrack
- pullAudioFrame
- pushAudioFrame
- pushVideoFrame
- registerAudioFrameObserver
- registerFaceInfoObserver
- registerVideoEncodedFrameObserver
- registerVideoFrameObserver
- setExternalAudioSink
- setExternalAudioSource
- setExternalVideoSource
- unregisterAudioFrameObserver
- unregisterFaceInfoObserver
- unregisterVideoEncodedFrameObserver
- unregisterVideoFrameObserver
MediaPlayer
提供媒体播放器功能的类，支持多实例。
相关参考
- adjustPlayoutVolume
- adjustPublishSignalVolume
- getAudioBufferDelay
- getDuration
- getMediaPlayerId
- getMute
- getPlayoutVolume
- getPlayPosition
- getPlaySrc
- getPublishSignalVolume
- getState
- getStreamCount
- getStreamInfo
- mute
- open
- openWithMediaSource
- pause
- play
- playPreloadedSrc
- preloadSrc
- registerAudioFrameObserver
- registerPlayerSourceObserver
- registerVideoFrameObserver
- resume
- seek
- selectAudioTrack
- selectMultiAudioTrack
- setAudioDualMonoMode
- setAudioPitch
- setLoopCount
- setPlaybackSpeed
- setPlayerOptionInInt
- setPlayerOptionInString
- setRenderMode
- setSpatialAudioParams
- setView
- stop
- switchSrc
- unloadSrc
- unregisterAudioFrameObserver
- unregisterPlayerSourceObserver
- unregisterVideoFrameObserver
MediaPlayerAudioFrameObserver
媒体播放器的音频数据观测器。
你可以调用 registerAudioFrameObserver 注册或取消注册 MediaPlayerAudioFrameObserver 观测器。
MediaPlayerCacheManager
该类提供管理媒体播放器中缓存媒体文件的方法。
相关参考
- enableAutoRemoveCache
- getCacheDir
- getCacheFileCount
- getMaxCacheFileCount
- getMaxCacheFileSize
- getMediaPlayerCacheManager
- removeAllCaches
- removeCacheByUri
- removeOldCache
- setCacheDir
- setMaxCacheFileCount
- setMaxCacheFileSize
MediaPlayerSourceObserver
提供媒体播放器的回调。
相关参考
- onAudioVolumeIndication
- onMetaData
- onPlayBufferUpdated
- onPlayerCacheStats
- onPlayerEvent
- onPlayerInfoUpdated
- onPlayerPlaybackStats
- onPlayerSourceStateChanged
- onPlayerSrcInfoChanged
- onPositionChanged
- onPreloadEvent
MediaPlayerVideoFrameObserver
媒体播放器的视频数据观测器。
你可以调用 registerVideoFrameObserver 注册或取消注册 MediaPlayerVideoFrameObserver 观测器。
相关参考
MediaRecorder
提供本地及远端音视频录制功能的类。
相关参考
MediaRecorderObserver
包含音视频录制的事件。
相关参考
MetadataObserver
Metadata 观测器。
相关参考
MusicContentCenter
MusicContentCenter 接口类提供音乐内容中心的相关方法。
相关参考
- createMusicPlayer
- destroyMusicPlayer
- getCaches
- getInternalSongCode
- getLyric
- getMusicCharts
- getMusicCollectionByMusicChartId
- getSongSimpleInfo
- initialize
- isPreloaded
- preload
- registerEventHandler
- release
- removeCache
- renewToken
- searchMusic
- unregisterEventHandler
MusicContentCenterEventHandler
MusicContentCenterEventHandler 接口类，用于 SDK 向客户端发送音乐内容中心事件通知。
相关参考
MusicPlayer
继承自 MediaPlayer 类，提供音乐播放器的相关方法。
相关参考
RtcEngine
RTC SDK 的基础接口类，实现实时音视频的主要功能。
RtcEngine 提供了 App 调用的主要方法。 在调用其他 API 之前，必须先调用 createAgoraRtcEngine 创建 RtcEngine 对象。
相关参考
- registerEventHandler
- addVideoWatermark
- addVideoWatermarkWithConfig
- adjustAudioMixingPlayoutVolume
- adjustAudioMixingPublishVolume
- adjustAudioMixingVolume
- adjustCustomAudioPlayoutVolume
- adjustCustomAudioPublishVolume
- adjustLoopbackSignalVolume
- adjustPlaybackSignalVolume
- adjustRecordingSignalVolume
- adjustUserPlaybackSignalVolume
- clearVideoWatermarks
- complain
- configRhythmPlayer
- createAgoraRtcEngine
- createCustomVideoTrack
- createDataStream
- createMediaPlayer
- createMediaRecorder
- createVideoEffectObject
- destroyCustomVideoTrack
- destroyMediaPlayer
- destroyMediaRecorder
- destroyVideoEffectObject
- disableAudio
- disableAudioSpectrumMonitor
- disableVideo
- enableAudio
- enableAudioSpectrumMonitor
- enableAudioVolumeIndication
- enableCameraCenterStage
- enableContentInspect
- enableCustomAudioLocalPlayback
- enableDualStreamMode
- enableEncryption
- enableExtension
- enableFaceDetection
- enableInEarMonitoring
- enableInstantMediaRendering
- enableLocalAudio
- enableLocalVideo
- enableLoopbackRecording
- enableMultiCamera
- enableSoundPositionIndication
- enableSpatialAudio
- enableVideo
- enableVideoImageSource
- enableVirtualBackground
- enableVoiceAITuner
- enableWebSdkInteroperability
- getAudioDeviceInfo
- getAudioDeviceManager
- getAudioMixingCurrentPosition
- getAudioMixingDuration
- getAudioMixingPlayoutVolume
- getAudioMixingPublishVolume
- getAudioTrackCount
- getCallId
- getCameraMaxZoomFactor
- getConnectionState
- getCurrentMonotonicTimeInMs
- getEffectCurrentPosition
- getEffectDuration
- getEffectsVolume
- getErrorDescription
- getExtensionProperty
- getFaceShapeAreaOptions
- getFaceShapeBeautyOptions
- getLocalSpatialAudioEngine
- getMediaEngine
- getMusicContentCenter
- getNativeHandle
- getNetworkType
- getNtpWallTimeInMs
- getScreenCaptureSources
- getUserInfoByUid
- getUserInfoByUserAccount
- getVersion
- getVideoDeviceManager
- getVolumeOfEffect
- initialize
- isCameraAutoExposureFaceModeSupported
- isCameraAutoFocusFaceModeSupported
- isCameraCenterStageSupported
- isCameraExposurePositionSupported
- isCameraExposureSupported
- isCameraFaceDetectSupported
- isCameraFocusSupported
- isCameraTorchSupported
- isCameraZoomSupported
- isFeatureAvailableOnDevice
- isSpeakerphoneEnabled
- joinChannel
- joinChannelWithUserAccount
- joinChannelWithUserAccountEx
- leaveChannel
- loadExtensionProvider
- muteAllRemoteAudioStreams
- muteAllRemoteVideoStreams
- muteLocalAudioStream
- muteLocalVideoStream
- muteRecordingSignal
- muteRemoteAudioStream
- muteRemoteVideoStream
- pauseAllChannelMediaRelay
- pauseAllEffects
- pauseAudioMixing
- pauseEffect
- playAllEffects
- playEffect
- preloadChannel
- preloadChannelWithUserAccount
- preloadEffect
- queryCameraFocalLengthCapability
- queryCodecCapability
- queryDeviceScore
- queryScreenCaptureCapability
- rate
- registerAudioEncodedFrameObserver
- registerAudioSpectrumObserver
- registerExtension
- registerLocalUserAccount
- registerMediaMetadataObserver
- release
- unregisterEventHandler
- removeVideoWatermark
- renewToken
- resumeAllChannelMediaRelay
- resumeAllEffects
- resumeAudioMixing
- resumeEffect
- selectAudioTrack
- sendCustomReportMessage
- sendMetaData
- sendStreamMessage
- setAdvancedAudioOptions
- setAINSMode
- setAudioEffectParameters
- setAudioEffectPreset
- setAudioMixingDualMonoMode
- setAudioMixingPitch
- setAudioMixingPlaybackSpeed
- setAudioMixingPosition
- setAudioProfile
- setAudioScenario
- setAudioSessionOperationRestriction
- setAVSyncSource
- setBeautyEffectOptions
- setCameraAutoExposureFaceModeEnabled
- setCameraAutoFocusFaceModeEnabled
- setCameraCapturerConfiguration
- setCameraDeviceOrientation
- setCameraExposureFactor
- setCameraExposurePosition
- setCameraFocusPositionInPreview
- setCameraStabilizationMode
- setCameraTorchOn
- setCameraZoomFactor
- setChannelProfile
- setClientRole
- setCloudProxy
- setColorEnhanceOptions
- setDefaultAudioRouteToSpeakerphone
- setDualStreamMode
- setEarMonitoringAudioFrameParameters
- setEffectPosition
- setEffectsVolume
- setEnableSpeakerphone
- setExtensionProperty
- setExtensionProviderProperty
- setExternalMediaProjection
- setExternalRemoteEglContext
- setFaceShapeAreaOptions
- setFaceShapeBeautyOptions
- setFilterEffectOptions
- setHeadphoneEQParameters
- setHeadphoneEQPreset
- setInEarMonitoringVolume
- setLocalAccessPoint
- setLocalRenderMode
- setLocalRenderTargetFps
- setLocalVideoMirrorMode
- setLocalVoiceEqualization
- setLocalVoiceFormant
- setLocalVoicePitch
- setLocalVoiceReverb
- setLogFile
- setLogFileSize
- setLogFilter
- setLogLevel
- setLowlightEnhanceOptions
- setMaxMetadataSize
- setMixedAudioFrameParameters
- setParameters
- setPlaybackAudioFrameBeforeMixingParameters
- setPlaybackAudioFrameParameters
- setRecordingAudioFrameParameters
- setRemoteDefaultVideoStreamType
- setRemoteRenderMode
- setRemoteRenderTargetFps
- setRemoteSubscribeFallbackOption
- setRemoteUserSpatialAudioParams
- setRemoteVideoStreamType
- setRemoteVideoSubscriptionOptions
- setRemoteVoicePosition
- setRouteInCommunicationMode
- setScreenCaptureContentHint
- setScreenCaptureScenario
- setSubscribeAudioAllowlist
- setSubscribeAudioBlocklist
- setSubscribeVideoAllowlist
- setSubscribeVideoBlocklist
- setupLocalVideo
- setupRemoteVideo
- setVideoDenoiserOptions
- setVideoEncoderConfiguration
- setVideoScenario
- setVoiceBeautifierParameters
- setVoiceBeautifierPreset
- setVoiceConversionPreset
- setVolumeOfEffect
- startAudioMixing
- startAudioRecording
- startCameraCapture
- startEchoTest
- startLastmileProbeTest
- startLocalAudioMixer
- startLocalVideoTranscoder
- startMediaRenderingTracing
- startOrUpdateChannelMediaRelay
- startPreviewWithoutSourceType
- startPreview
- startRhythmPlayer
- startRtmpStreamWithoutTranscoding
- startRtmpStreamWithTranscoding
- startScreenCapture
- startScreenCaptureBySourceType
- startScreenCaptureByDisplayId
- startScreenCaptureByScreenRect
- startScreenCaptureByWindowId
- stopAllEffects
- stopAudioMixing
- stopAudioRecording
- stopCameraCapture
- stopChannelMediaRelay
- stopEchoTest
- stopEffect
- stopLastmileProbeTest
- stopLocalAudioMixer
- stopLocalVideoTranscoder
- stopPreview
- stopRhythmPlayer
- stopRtmpStream
- stopScreenCapture
- stopScreenCaptureBySourceType
- switchCamera
- takeSnapshot
- takeSnapshotWithConfig
- unloadAllEffects
- unloadEffect
- unregisterAudioEncodedFrameObserver
- unregisterAudioSpectrumObserver
- unregisterMediaMetadataObserver
- updateChannelMediaOptions
- updateLocalAudioMixerConfiguration
- updateLocalTranscoderConfiguration
- updatePreloadChannelToken
- updateRtmpTranscoding
- updateScreenCapture
- updateScreenCaptureParameters
- updateScreenCaptureRegion
RtcEngineEventHandler
接口类 RtcEngineEventHandler 用于 SDK 向 App 发送事件通知，App 通过继承该接口类的方法获取 SDK 的事件通知。
该接口类的所有方法都有缺省（空）实现， App 可以根据需要只继承关心的事件。
注：
- 在回调方法中，App 不应该做耗时或者调用可能会引起阻塞的 API（如
sendMessage），否则可能影响 SDK 的运行。 - SDK 不再捕获开发者在 RtcEngineEventHandler 类回调中自行实现的代码逻辑中的异常。你需要自行处理该异常，否则异常出现时可能引起 App 崩溃。
相关参考
- onActiveSpeaker
- onAudioDeviceStateChanged
- onAudioDeviceVolumeChanged
- onAudioEffectFinished
- onAudioMixingFinished
- onAudioMixingPositionChanged
- onAudioMixingStateChanged
- onAudioPublishStateChanged
- onAudioQuality
- onAudioRoutingChanged
- onAudioSubscribeStateChanged
- onAudioVolumeIndication
- onCameraExposureAreaChanged
- onCameraFocusAreaChanged
- onCameraReady
- onChannelMediaRelayStateChanged
- onClientRoleChanged
- onClientRoleChangeFailed
- onConnectionBanned
- onConnectionInterrupted
- onConnectionLost
- onConnectionStateChanged
- onEncryptionError
- onError
- onExtensionErrorWithContext
- onExtensionEventWithContext
- onExtensionStartedWithContext
- onExtensionStoppedWithContext
- 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
- onVideoDeviceStateChanged
- onVideoPublishStateChanged
- onVideoRenderingTracingResult
- onVideoSizeChanged
- onVideoStopped
- onVideoSubscribeStateChanged
RtcEngineEx
提供多频道方法的接口类。
继承自 RtcEngine。
相关参考
- addVideoWatermarkEx
- addVideoWatermarkWithConfigEx
- adjustUserPlaybackSignalVolumeEx
- clearVideoWatermarkEx
- createAgoraRtcEngineEx
- createDataStreamEx
- enableAudioVolumeIndicationEx
- enableContentInspectEx
- enableDualStreamModeEx
- enableEncryptionEx
- enableLoopbackRecordingEx
- getCallIdEx
- getConnectionStateEx
- joinChannelEx
- leaveChannelEx
- muteAllRemoteAudioStreamsEx
- muteAllRemoteVideoStreamsEx
- muteLocalAudioStreamEx
- muteLocalVideoStreamEx
- muteRemoteAudioStreamEx
- muteRemoteVideoStreamEx
- pauseAllChannelMediaRelayEx
- playEffectEx
- preloadEffectEx
- removeVideoWatermarkEx
- resumeAllChannelMediaRelayEx
- sendCustomReportMessageEx
- sendStreamMessageEx
- setDualStreamModeEx
- setRemoteRenderModeEx
- setRemoteVideoStreamTypeEx
- setRemoteVideoSubscriptionOptionsEx
- setRemoteVoicePositionEx
- setSubscribeAudioAllowlistEx
- setSubscribeAudioBlocklistEx
- setSubscribeVideoAllowlistEx
- setSubscribeVideoBlocklistEx
- setupRemoteVideoEx
- setVideoEncoderConfigurationEx
- startMediaRenderingTracingEx
- startOrUpdateChannelMediaRelayEx
- startRtmpStreamWithoutTranscodingEx
- startRtmpStreamWithTranscodingEx
- stopChannelMediaRelayEx
- stopRtmpStreamEx
- takeSnapshotEx
- takeSnapshotWithConfigEx
- updateChannelMediaOptionsEx
- updateRtmpTranscodingEx
VideoDeviceManager
视频设备管理方法。
相关参考
VideoEffectObject
用于管理和配置视频特效，例如美颜、风格妆容和滤镜。
自从
自 v6.6.2 版本新增。
相关参考
- addOrUpdateVideoEffect
- getVideoEffectBoolParam
- getVideoEffectFloatParam
- getVideoEffectIntParam
- performVideoEffectAction
- removeVideoEffect
- setVideoEffectBoolParam
- setVideoEffectFloatParam
- setVideoEffectIntParam
VideoEncodedFrameObserver
用于接收编码后的视频图像的类。
相关参考
VideoFrameObserver
视频观测器。
你可以调用 registerVideoFrameObserver 注册或取消注册 VideoFrameObserver 视频观测器。
相关参考
MediaPlayerController
AgoraVideoView 的控制器，用于渲染媒体播放器的视频。
相关参考
MusicChartCollection
音乐榜单的详细信息。
相关参考
RtcEngineExt
RtcEngine 的衍生接口类。