API 概览

声网通过全球部署的 SD-RTN™，提供可以灵活搭配的 API 组合，实现质量可靠的实时音视频通信。

初始化相关

方法/回调	描述
createAgoraRtcEngine	创建 RtcEngine 对象。
initialize	初始化 RtcEngine。
release	销毁 RtcEngine 对象。
getMediaEngine	获取 MediaEngine 对象。

频道相关

方法/回调	描述
setChannelProfile	设置频道场景。
joinChannel	设置媒体选项并加入频道。
joinChannelEx	加入频道。
updateChannelMediaOptions	加入频道后更新频道媒体选项。
updateChannelMediaOptionsEx	加入频道后更新频道媒体选项 。
leaveChannel	设置频道选项并离开频道。
leaveChannelEx	设置频道选项并离开频道。
preloadChannel	使用 token、channelId、uid 预加载频道。
preloadChannelWithUserAccount	使用 token、channelId、userAccount 预加载频道。
updatePreloadChannelToken	更新预加载频道的通配 Token。
renewToken	更新 Token。
setClientRole	设置直播场景下的用户角色和观众端延时级别。
onJoinChannelSuccess	成功加入频道回调。
onRejoinChannelSuccess	成功重新加入频道回调。
onClientRoleChanged	用户角色、观众端延时级别已切换回调。
onClientRoleChangeFailed	用户角色切换失败回调。
onLeaveChannel	离开频道回调。
onUserJoined	远端用户（通信场景）/主播（直播场景）加入当前频道回调。
onUserOffline	远端用户（通信场景）/主播（直播场景）离开当前频道回调。
onNetworkTypeChanged	本地网络类型发生改变回调。
onUplinkNetworkInfoUpdated	上行网络信息变化回调。
onConnectionLost	网络连接中断，且 SDK 无法在 10 秒内连接服务器回调。
onConnectionStateChanged	网络连接状态已改变回调。
onRequestToken	Token 已过期回调。
onTokenPrivilegeWillExpire	Token 即将在 30s 内过期回调。
onError	发生错误回调。

发布和订阅

方法/回调	描述
muteLocalAudioStream	取消或恢复发布本地音频流。
muteLocalAudioStreamEx	取消或恢复发布本地音频流。
muteRemoteAudioStream	取消或恢复订阅指定远端用户的音频流。
muteRemoteAudioStreamEx	停止/恢复接收指定的音频流。
muteAllRemoteAudioStreams	取消或恢复订阅所有远端用户的音频流。
muteAllRemoteAudioStreamsEx	取消或恢复订阅所有远端用户的音频流。
muteLocalVideoStream	取消或恢复发布本地视频流。
muteLocalVideoStreamEx	取消或恢复发布本地视频流。
muteRemoteVideoStream	取消或恢复订阅指定远端用户的视频流。
muteRemoteVideoStreamEx	停止/恢复接收指定的视频流。
muteAllRemoteVideoStreams	取消或恢复订阅所有远端用户的视频流。
muteAllRemoteVideoStreamsEx	取消或恢复订阅所有远端用户的视频流。
setRemoteVideoSubscriptionOptions	设置远端视频流的订阅选项。
setRemoteVideoSubscriptionOptionsEx	设置远端视频流的订阅选项。
setSubscribeAudioBlocklist	设置音频订阅黑名单。
setSubscribeAudioBlocklistEx	设置音频订阅黑名单。
setSubscribeAudioAllowlist	设置音频订阅白名单。
setSubscribeAudioAllowlistEx	设置音频订阅白名单。
setSubscribeVideoBlocklist	设置视频订阅黑名单。
setSubscribeVideoBlocklistEx	设置视频订阅黑名单。
setSubscribeVideoAllowlist	设置视频订阅白名单。
setSubscribeVideoAllowlistEx	设置视频订阅白名单。
setRemoteVideoStreamType	设置订阅的视频流类型。
setRemoteVideoStreamTypeEx	设置订阅的视频流类型。
setRemoteDefaultVideoStreamType	设置默认订阅的视频流类型。
setDualStreamMode	在发送端设置双流模式并设置视频小流。
setDualStreamModeEx	在发送端设置双流模式。
onAudioPublishStateChanged	音频发布状态改变回调。
onAudioSubscribeStateChanged	音频订阅状态发生改变回调。
onVideoSubscribeStateChanged	视频订阅状态发生改变回调。

音频基础功能

方法/回调	描述
adjustUserPlaybackSignalVolume	调节本地播放的指定远端用户信号音量。
adjustUserPlaybackSignalVolumeEx	调节本地播放的指定远端用户信号音量。
adjustPlaybackSignalVolume	调节本地播放的所有远端用户信号音量。
enableAudio	启用音频模块。
disableAudio	关闭音频模块。
enableAudioVolumeIndication	启用用户音量提示。
enableAudioVolumeIndicationEx	启用用户音量提示。
setAudioProfile	设置音频编码属性和音频场景。
setAudioScenario	设置音频场景。
setAudioSessionOperationRestriction	设置 SDK 对 Audio Session 的操作权限。
onAudioVolumeIndication	用户音量提示回调。
onActiveSpeaker	监测到远端最活跃用户回调。
onLocalAudioStateChanged	本地音频状态发生改变回调。
onFirstLocalAudioFramePublished	已发布本地音频首帧回调。
onFirstRemoteAudioFrame	已接收远端音频首帧回调。
onUserMuteAudio	远端用户（通信场景）/主播（直播场景）停止或恢复发送音频流回调。
onRemoteAudioStateChanged	远端音频流状态发生改变回调。
onLocalAudioStats	通话中本地音频流的统计信息回调。
onRemoteAudioStats	通话中远端音频流的统计信息回调。

音频采集

方法/回调	描述
enableLocalAudio	开启或关闭本地音频采集。
enableLoopbackRecording	开启声卡采集。
enableLoopbackRecordingEx	开启声卡采集。
adjustRecordingSignalVolume	调节音频采集信号音量。
adjustLoopbackSignalVolume	调节声卡采集信号音量。
muteRecordingSignal	是否将录音信号静音。
enableInEarMonitoring	开启耳返功能。
setInEarMonitoringVolume	设置耳返音量。

音频前处理和后处理

方法/回调	描述
enableVoiceAITuner	开启或关闭 AI 调音器功能。
setAdvancedAudioOptions	设置音频的高级选项。
setAINSMode	设置是否开启 AI 降噪功能并设置降噪模式。
setLocalVoiceEqualization	设置本地语音音效均衡。
setLocalVoicePitch	设置本地语音音调。
setLocalVoiceReverb	设置本地音效混响。
setVoiceBeautifierPreset	设置预设的美声效果。
setVoiceBeautifierParameters	设置预设美声效果的参数。
setAudioEffectPreset	设置 SDK 预设的人声音效。
setAudioEffectParameters	设置 SDK 预设人声音效的参数。
setVoiceConversionPreset	设置预设的变声效果。
setLocalVoiceFormant	设置共振峰比率以改变语音的音色。
enableSoundPositionIndication	开启/关闭远端用户的语音立体声。
setRemoteVoicePosition	设置远端用户声音的 2D 位置，即水平面位置。
setRemoteVoicePositionEx	设置远端用户声音的 2D 位置，即水平面位置。
getLocalSpatialAudioEngine	获取 LocalSpatialAudioEngine 对象。
initialize	初始化 LocalSpatialAudioEngine。
updateSelfPosition	更新本地用户的空间位置。
updateRemotePosition	更新远端用户的空间位置信息。
removeRemotePosition	删除指定远端用户的空间位置信息。
clearRemotePositions	删除所有远端用户的空间位置信息。
setHeadphoneEQParameters	设置耳机均衡器的低频和高频参数。
setHeadphoneEQPreset	设置预设的耳机均衡效果。
startLocalAudioMixer	开启本地音频合流。
updateLocalAudioMixerConfiguration	更新本地音频合流的配置。
stopLocalAudioMixer	停止本地音频合流。

原始音频数据

方法/回调	描述
registerAudioFrameObserver	注册音频观测器对象。
setEarMonitoringAudioFrameParameters	设置耳返的音频数据格式。
setRecordingAudioFrameParameters	设置采集的原始音频数据格式。
setPlaybackAudioFrameParameters	设置播放的原始音频数据格式。
setMixedAudioFrameParameters	设置采集和播放音频混音后的原始音频数据格式。
setPlaybackAudioFrameBeforeMixingParameters	设置混音前的原始音频播放数据格式。
onEarMonitoringAudioFrame	获得耳返的原始音频数据。
onRecordAudioFrame	获得采集的原始音频数据。
onPlaybackAudioFrame	获得播放的原始音频数据。
onPlaybackAudioFrameBeforeMixing	获取所订阅的远端用户混音前的声音。
onMixedAudioFrame	获取采集和播放音频混音后的数据。

已编码音频数据

方法/回调	描述
registerAudioEncodedFrameObserver	注册音频编码数据观测器。
unregisterAudioEncodedFrameObserver	取消注册音频编码数据观测器。
onRecordAudioEncodedFrame	获取本地用户的音频编码数据。
onPlaybackAudioEncodedFrame	获取所有远端用户的音频编码数据。
onMixedAudioEncodedFrame	获取本地和所有远端用户混音后的音频编码数据。

自定义音频采集和渲染

方法/回调	描述
createCustomAudioTrack	创建一个自定义音频采集轨道。
destroyCustomAudioTrack	销毁指定的音频轨道。
setExternalAudioSink	设置外部音频渲染。
pullAudioFrame	拉取远端音频数据。
pushAudioFrame	推送外部音频帧。
adjustCustomAudioPlayoutVolume	调节自定义音频采集轨道在本地播放的音量。
adjustCustomAudioPublishVolume	调节自定义音频采集轨道在远端播放的音量。
enableCustomAudioLocalPlayback	设置是否在本地播放外部音频源。

音频频谱

方法/回调	描述
registerAudioSpectrumObserver	注册音频频谱观测器。
enableAudioSpectrumMonitor	开启音频频谱监测。
disableAudioSpectrumMonitor	关闭音频频谱监测。
unregisterAudioSpectrumObserver	取消注册音频频谱观测器。
onLocalAudioSpectrum	获取本地音频频谱。
onRemoteAudioSpectrum	获取远端音频频谱。

视频基础功能

方法/回调	描述
enableVideo	启用视频模块。
disableVideo	关闭视频模块。
setVideoScenario	设置视频业务场景。
setVideoEncoderConfiguration	设置视频编码属性。
setVideoEncoderConfigurationEx	设置视频编码属性。
startPreviewWithoutSourceType	开启视频预览。
startPreview	开启视频预览并指定预览的视频源。
stopPreview	停止视频预览。
onLocalVideoStateChanged	本地视频状态发生改变回调。
onLocalVideoStats	本地视频流统计信息回调。
onFirstLocalVideoFramePublished	已发布本地视频首帧回调。
onVideoPublishStateChanged	视频发布状态改变回调。
onVideoSizeChanged	本地或远端视频大小和旋转信息发生改变回调。
onRemoteVideoStateChanged	远端视频状态发生改变回调。
onRemoteVideoStats	通话中远端视频流的统计信息回调。
onFirstLocalVideoFrame	已显示本地视频首帧回调。
onFirstRemoteVideoFrame	渲染器已接收首帧远端视频回调。
onFirstRemoteVideoDecoded	已接收到远端视频并完成解码回调。
onUserMuteVideo	远端用户取消或恢复发布视频流回调。
onUserEnableVideo	远端用户开/关视频模块回调。

视频采集

方法/回调	描述
enableLocalVideo	开关本地视频采集。
startCameraCapture	开始通过摄像头采集视频。
stopCameraCapture	停止通过摄像头采集视频。
setCameraStabilizationMode	设置摄像头防抖模式。（仅适用于 iOS）

屏幕共享

方法/回调	描述
getScreenCaptureSources	获取可共享的屏幕和窗口对象列表。（仅适用于 Windows 和 macOS）
startScreenCaptureByWindowId	开始采集指定窗口的视频流。（仅适用于 Windows 和 macOS）
startScreenCaptureByDisplayId	开始采集指定屏幕的视频流。（仅适用于 Windows 和 macOS）
setScreenCaptureContentHint	设置屏幕共享内容类型。（仅适用于 Windows 和 macOS）
updateScreenCaptureRegion	更新屏幕采集的区域。（仅适用于 Windows 和 macOS）
queryScreenCaptureCapability	查询设备在屏幕共享时支持的最高帧率。（仅适用于 Android 和 iOS）
setExternalMediaProjection	设置 SDK 外部的 MediaProjection 采集屏幕视频流。
startScreenCapture	开始屏幕采集。（仅适用于 Android 和 iOS）
startScreenCaptureBySourceType	开始屏幕采集并指定视频源。（仅适用于 Windows 和 macOS）
updateScreenCapture	更新屏幕采集的参数配置。（仅适用于 Android 和 iOS）
updateScreenCaptureParameters	更新屏幕采集的参数配置。（仅适用于 Windows 和 macOS）
stopScreenCapture	停止屏幕采集。
stopScreenCaptureBySourceType	停止对指定的视频源进行屏幕采集。（仅适用于 Windows 和 macOS）
setScreenCaptureScenario	设置屏幕共享的场景。

视频前处理和后处理

方法/回调	描述
enableContentInspect	开启/关闭本地截图上传。
takeSnapshot	对视频截图。
takeSnapshotWithConfig	在指定观测位置进行视频截图。
takeSnapshotEx	使用连接 ID 获取视频截图。
takeSnapshotWithConfigEx	使用连接 ID 获取指定观测位置的视频截图。
enableVirtualBackground	开启/关闭虚拟背景。
startLocalVideoTranscoder	开启本地合图。
stopLocalVideoTranscoder	停止本地合图。
updateLocalTranscoderConfiguration	更新本地合图配置。
onLocalVideoTranscoderError	本地合图发生错误回调。
enableVideoImageSource	设置是否开启垫片推流功能。
setBeautyEffectOptions	设置美颜效果选项。
setColorEnhanceOptions	设置色彩增强功能。
setLowlightEnhanceOptions	设置暗光增强功能。
setVideoDenoiserOptions	设置视频降噪功能。
setFilterEffectOptions	设置滤镜效果选项并指定媒体源。
setFaceShapeBeautyOptions	设置美型效果选项并指定媒体源。
setFaceShapeAreaOptions	设置美型部位选项并指定媒体源。
getFaceShapeBeautyOptions	获取美型效果选项。
getFaceShapeAreaOptions	获取美型部位选项。
enableFaceDetection	开启/关闭本地人脸检测。
onFacePositionChanged	报告本地人脸检测结果。
isCameraCenterStageSupported	查询摄像头是否支持人像锁定。(仅适用于 iOS 和 macOS)
enableCameraCenterStage	开启或关闭人像锁定功能。(仅适用于 iOS 和 macOS)
onSnapshotTaken	视频截图结果回调。
addVideoWatermark	添加本地视频水印。
addVideoWatermarkEx	添加本地视频水印。
clearVideoWatermarks	删除已添加的视频水印。
clearVideoWatermarkEx	删除已添加的视频水印。

视频渲染

方法/回调	描述
setRenderMode	设置播放器视图的渲染模式。
setLocalRenderMode	更新本地视图显示模式。
setRemoteRenderMode	更新远端视图显示模式。
setLocalRenderTargetFps	设置本地视频渲染的最大帧率。
setRemoteRenderTargetFps	设置视频在远端渲染的最大帧率。
setView	设置播放器渲染视图。
setupLocalVideo	初始化本地视图。
setupRemoteVideo	初始化远端用户视图。
setupRemoteVideoEx	初始化远端用户视图。
enableInstantMediaRendering	开启音视频帧加速渲染。
startMediaRenderingTracing	开启视频帧渲染数据打点。
startMediaRenderingTracingEx	开启视频帧渲染数据打点。
onTranscodedStreamLayoutInfo	已接收携带布局信息的合图视频流回调。
onVideoRenderingTracingResult	视频帧渲染事件回调。

原始视频数据

方法/回调	描述
registerVideoFrameObserver	注册原始视频观测器对象。
onCaptureVideoFrame	获取本地设备采集到的视频数据。
onPreEncodeVideoFrame	获取本地视频编码前的视频数据。
onRenderVideoFrame	获取远端发送的视频数据。

已编码视频数据

方法/回调	描述
registerVideoEncodedFrameObserver	为编码后的视频图像注册视频帧接收观测器。
unregisterVideoEncodedFrameObserver	为编码后的视频图像取消注册视频帧接收观测器。
onEncodedVideoFrameReceived	报告接收端已收到远端发送的待解码视频帧。

自定义视频采集和渲染

方法/回调	描述
createCustomVideoTrack	创建一个自定义的视频轨道。
destroyCustomVideoTrack	销毁指定的视频轨道。
setExternalVideoSource	设置外部视频源。
setExternalRemoteEglContext	设置远端视频流渲染的 EGL 环境上下文。（仅适用于 Android）
pushVideoFrame	将外部原始视频帧通过自定义视频轨道发布到频道中。

音乐文件播放

方法/回调	描述
startAudioMixing	开始播放音乐文件。
stopAudioMixing	停止播放音乐文件。
pauseAudioMixing	暂停播放音乐文件。
resumeAudioMixing	恢复播放音乐文件。
adjustAudioMixingVolume	调节音乐文件的播放音量。
adjustAudioMixingPlayoutVolume	调节音乐文件在本地播放的音量。
adjustAudioMixingPublishVolume	调节音乐文件远端播放音量。
getAudioMixingPlayoutVolume	获取音乐文件的本地播放音量。
getAudioMixingPublishVolume	获取音乐文件的远端播放音量。
setAudioMixingPlaybackSpeed	设置当前音乐文件的播放速度。
getAudioMixingDuration	获取音乐文件总时长。
getAudioMixingCurrentPosition	获取音乐文件的播放进度。
setAudioMixingPitch	调整本地播放的音乐文件的音调。
setAudioMixingPosition	设置音乐文件的播放位置。
setAudioMixingDualMonoMode	设置当前音频文件的声道模式。
getAudioTrackCount	获取当前音乐文件的音轨索引。
selectAudioTrack	指定当前音乐文件的播放音轨。
selectMultiAudioTrack	选择本地播放和发送至远端的音轨。
onAudioMixingStateChanged	音乐文件的播放状态已改变回调。
onAudioMixingPositionChanged	音乐文件播放进度回调。

音效文件播放

方法/回调	描述
getEffectsVolume	获取音效文件的播放音量。
setEffectsVolume	设置音效文件的播放音量。
getVolumeOfEffect	获取指定音效文件的播放音量。
setVolumeOfEffect	设置指定音效文件的播放音量。
preloadEffect	将音效文件加载至内存。
playEffect	播放指定的本地或在线音效文件。
playAllEffects	播放所有音效文件。
pauseEffect	暂停音效文件播放。
pauseAllEffects	暂停所有音效文件播放。
resumeEffect	恢复播放指定音效文件。
resumeAllEffects	恢复播放所有音效文件。
stopEffect	停止播放指定音效文件。
stopAllEffects	停止播放所有音效文件。
unloadEffect	从内存释放某个预加载的音效文件。
unloadAllEffects	从内存释放所有预加载音效文件。
getEffectDuration	获取指定音效文件总时长。
getEffectCurrentPosition	获取指定音效文件的播放进度。
setEffectPosition	设置指定音效文件的播放位置。
onAudioEffectFinished	本地音效文件播放已结束回调。

虚拟节拍器

方法/回调	描述
startRhythmPlayer	开启虚拟节拍器。
stopRhythmPlayer	关闭虚拟节拍器。
configRhythmPlayer	配置虚拟节拍器。
onRhythmPlayerStateChanged	虚拟节拍器状态发生改变回调。

媒体播放器

更多有关媒体播放器的方法，详见内置媒体播放器。

方法/回调	描述
createMediaPlayer	创建媒体播放器对象。
getMediaPlayerCacheManager	获取 MediaPlayerCacheManager 实例。
MediaPlayer	提供媒体播放器功能的类，支持多实例。
MediaPlayerCacheManager	该类提供管理媒体播放器中缓存媒体文件的方法。
MediaPlayerSourceObserver	提供媒体播放器的回调。

媒体播放器缓存

方法/回调	描述
enableAutoRemoveCache	设置是否开启自动清除缓存文件功能。
removeAllCaches	删除媒体播放器中所有已缓存的媒体文件。
removeCacheByUri	删除指定的已缓存媒体文件。
removeOldCache	删除媒体播放器中近期最少使用的一个缓存媒体文件。
setCacheDir	设置待缓存的媒体文件的储存路径。
setMaxCacheFileCount	设置缓存媒体文件数量的上限。
setMaxCacheFileSize	设置缓存媒体文件的总缓存大小的上限。
getCacheDir	获取缓存文件的储存路径。
getCacheFileCount	获取当前已缓存的媒体文件的总数量。
getMaxCacheFileCount	获取所设置的缓存文件数量上限。
getMaxCacheFileSize	获取所设置的缓存文件总缓存的上限。
onPlayerCacheStats	报告当前缓存中的媒体资源的相关信息。

版权音乐

本组方法仅适用于 Android 和 iOS。

方法/回调	描述
initialize	初始化 MusicContentCenter。
release	释放音乐内容中心所占用的所有资源。
createMusicPlayer	创建音乐播放器。
destroyMusicPlayer	销毁音乐播放器对象。
preload	预加载音乐资源。
isPreloaded	检测音乐资源是否已被预加载。
openWithSongCode	通过音乐资源编号打开音乐资源。
registerEventHandler	注册音乐内容中心回调事件。
unregisterEventHandler	取消注册音乐内容中心事件回调。
renewToken	更新 Token。
getCaches	获取已缓存的音乐资源信息。
removeCache	删除已缓存的音乐资源。
getMusicCharts	获取全部音乐榜单。
getMusicContentCenter	获取 MusicContentCenter。
getMusicCollectionByMusicChartId	通过音乐榜单的 ID 获取指定榜单的音乐资源列表。
searchMusic	搜索音乐资源。
setPlayMode	设置音乐资源的播放模式。
renewToken	更新 Token。
getLyric	获取音乐资源的歌词下载地址。
getInternalSongCode	创建音乐资源的副歌片段编号。
getSongSimpleInfo	获取某一音乐资源的详细信息。
onPreLoadEvent	报告预加载音乐资源的事件。
onLyricResult	歌词下载地址回调。
onMusicChartsResult	获取音乐榜单回调。
onMusicCollectionResult	获取音乐资源列表回调。
onSongSimpleInfoResult	音乐资源的详细信息回调。

音视频录制

方法/回调	描述
createMediaRecorder	创建音视频录制对象。
setMediaRecorderObserver	注册 MediaRecorderObserver 观测器。
startRecording	开启音视频流录制。
stopRecording	停止音视频流录制。
startAudioRecording	开始客户端录音并进行录音配置。
stopAudioRecording	停止客户端录音。
destroyMediaRecorder	销毁音视频录制对象。
onRecorderStateChanged	录制状态发生改变回调。
onRecorderInfoUpdated	录制信息更新回调。

跨频道媒体流转发

方法/回调	描述
startOrUpdateChannelMediaRelay	开始或更新跨频道媒体流转发。
startOrUpdateChannelMediaRelayEx	开始或更新跨频道媒体流转发。
stopChannelMediaRelay	停止跨频道媒体流转发。一旦停止，主播会退出所有目标频道。
stopChannelMediaRelayEx	停止跨频道媒体流转发。一旦停止，主播会退出所有目标频道。
pauseAllChannelMediaRelay	暂停向所有目标频道转发媒体流。
pauseAllChannelMediaRelayEx	暂停向所有目标频道转发媒体流。
resumeAllChannelMediaRelay	恢复向所有目标频道转发媒体流。
resumeAllChannelMediaRelayEx	恢复向所有目标频道转发媒体流。
onChannelMediaRelayStateChanged	跨频道媒体流转发状态发生改变回调。

旁路推流

方法/回调	描述
startRtmpStreamWithoutTranscoding	开始非转码推流。
startRtmpStreamWithoutTranscodingEx	开始非转码推流。
startRtmpStreamWithTranscoding	开始旁路推流并设置转码属性。
startRtmpStreamWithTranscodingEx	开始旁路推流并设置转码属性。
updateRtmpTranscoding	更新旁路推流转码属性。
updateRtmpTranscodingEx	更新旁路推流转码属性。
stopRtmpStream	结束旁路推流。
stopRtmpStreamEx	结束旁路推流。
onRtmpStreamingEvent	旁路推流事件回调。
onRtmpStreamingStateChanged	旁路推流状态发生改变回调。
onTranscodingUpdated	旁路推流转码设置已被更新回调。

直推 CDN

方法/回调	描述
startDirectCdnStreaming	设置主播端开始直接向 CDN 推流。
stopDirectCdnStreaming	设置主播端停止直接向 CDN 推流。
setDirectCdnStreamingAudioConfiguration	设置主播端直接向 CDN 推流时的音频编码属性。
setDirectCdnStreamingVideoConfiguration	设置主播端直接向 CDN 推流时的视频编码属性。
onDirectCdnStreamingStateChanged	CDN 推流状态改变回调。
onDirectCdnStreamingStats	CDN 推流统计数据回调。

数据流

方法/回调	描述
createDataStream	创建数据流。
createDataStreamEx	创建数据流。
sendStreamMessage	发送数据流。
onStreamMessage	接收到对方数据流消息的回调。
onStreamMessageError	接收对方数据流消息发生错误的回调。

Metadata (SEI)

方法/回调	描述
registerMediaMetadataObserver	注册媒体 metadata 观测器用于接收或发送 metadata。
unregisterMediaMetadataObserver	取消注册媒体 metadata 观测器。
setMaxMetadataSize	设置媒体附属信息的最大大小。
sendMetaData	发送媒体附属信息。
onMetaData	报告已获取媒体附属信息。
onMetadataReceived	接收端已收到 metadata。

音频路由

该组方法仅适用于 Android 和 iOS 平台。

方法/回调	描述
setDefaultAudioRouteToSpeakerphone	设置默认的音频路由。
setEnableSpeakerphone	开启或关闭扬声器播放。
setRouteInCommunicationMode	选择通话音量模式下的音频路由。
isSpeakerphoneEnabled	检查扬声器状态启用状态。
onAudioRoutingChanged	音频路由已发生变化回调。

视频设备管理

方法/回调	描述
enableMultiCamera	开启或关闭多路摄像头采集。(仅适用于 iOS)
switchCamera	切换前置/后置摄像头。(仅适用于 Android 和 iOS)
setCameraCapturerConfiguration	设置摄像头采集配置。
isCameraZoomSupported	检测设备是否支持摄像头缩放功能。(仅适用于 Android 和 iOS)
getCameraMaxZoomFactor	获取摄像头支持最大缩放比例。(仅适用于 Android 和 iOS)
setCameraZoomFactor	设置摄像头缩放比例。(仅适用于 Android 和 iOS)
isCameraTorchSupported	检测设备是否支持闪光灯常开。(仅适用于 Android 和 iOS)
setCameraTorchOn	设置是否打开闪光灯。(仅适用于 Android 和 iOS)
isCameraFaceDetectSupported	检查设备摄像头是否支持人脸检测。(仅适用于 Android 和 iOS)
isCameraFocusSupported	检测设备是否支持手动对焦功能。(仅适用于 Android 和 iOS)
isCameraExposureSupported	查询当前摄像头是否支持曝光调节。(仅适用于 Android 和 iOS)
setCameraExposureFactor	设置当前摄像头的曝光系数。(仅适用于 Android 和 iOS)
setCameraFocusPositionInPreview	设置手动对焦位置，并触发对焦。(仅适用于 Android 和 iOS)
isCameraAutoFocusFaceModeSupported	检测设备是否支持人脸对焦功能。(仅适用于 Android 和 iOS)
setCameraAutoFocusFaceModeEnabled	设置是否开启人脸对焦功能。(仅适用于 Android 和 iOS)
isCameraExposurePositionSupported	检测设备是否支持手动曝光功能。(仅适用于 Android 和 iOS)
isCameraAutoExposureFaceModeSupported	检测设备是否支持自动曝光功能。(仅适用于 iOS)
setCameraExposurePosition	设置手动曝光位置。(仅适用于 Android 和 iOS)
setCameraAutoExposureFaceModeEnabled	设置是否开启自动曝光功能。(仅适用于 iOS)
onCameraFocusAreaChanged	相机对焦区域已改变回调。(仅适用于 Android 和 iOS)
onCameraExposureAreaChanged	摄像头曝光区域已改变回调。(仅适用于 Android 和 iOS)
queryCameraFocalLengthCapability	查询摄像头支持的焦距能力。(仅适用于 Andorid 和 iOS)
queryCodecCapability	查询 SDK 支持的视频编解码能力。
enumerateVideoDevices	获取系统中所有的视频设备列表。(仅适用于 Windows 和 macOS)
setDevice	通过设备 ID 指定视频采集设备。(仅适用于 Windows 和 macOS)
getDevice	获取当前使用的视频采集设备。(仅适用于 Windows 和 macOS)
release	释放 VideoDeviceManager 对象占用的所有资源。(仅适用于 Windows 和 macOS)
getVideoDeviceManager	获取 VideoDeviceManager 对象，以管理视频设备。
getCapability	获取视频采集设备在指定的视频格式下的详细视频帧信息。(仅适用于 Windows 和 macOS)
numberOfCapabilities	获取指定视频采集设备支持的视频格式数量。(仅适用于 Windows 和 macOS)
setCameraDeviceOrientation	设置采集视频的旋转角度。（仅适用于 Windows）
onVideoDeviceStateChanged	视频设备变化回调。(仅适用于 Windows 和 macOS)

音频设备管理

方法/回调	描述
startPlaybackDeviceTest	启动音频播放设备测试。
stopPlaybackDeviceTest	停止音频播放设备测试。
startRecordingDeviceTest	启动音频采集设备测试。
stopRecordingDeviceTest	停止音频采集设备测试。
enumeratePlaybackDevices	获取系统中所有的播放设备列表。（仅适用于 Windows 和 macOS）
enumerateRecordingDevices	获取系统中所有的音频采集设备列表。（仅适用于 Windows 和 macOS）
followSystemPlaybackDevice	设置 SDK 使用的音频播放设备跟随系统默认的音频播放设备。（仅适用于 Windows 和 macOS）
followSystemRecordingDevice	设置 SDK 使用的音频采集设备跟随系统默认的音频采集设备。（仅适用于 Windows 和 macOS）
getAudioDeviceManager	获取 AudioDeviceManager 对象，以管理音频设备。（仅适用于 Windows）
getPlaybackDefaultDevice	获取系统默认的音频播放设备。（仅适用于 Windows 和 macOS）
getRecordingDefaultDevice	获取系统默认的音频采集设备。（仅适用于 Windows 和 macOS）
setPlaybackDevice	指定播放设备。（仅适用于 Windows 和 macOS）
getPlaybackDevice	获取当前音频播放设备。（仅适用于 Windows 和 macOS）
getPlaybackDeviceInfo	获取音频播放设备信息。（仅适用于 Windows 和 macOS）
setLoopbackDevice	指定声卡采集设备。（仅适用于 Windows 和 macOS）
getLoopbackDevice	获取当前的声卡采集设备。（仅适用于 Windows 和 macOS）
followSystemLoopbackDevice	设置声卡采集设备是否跟随系统默认的播放设备。（仅适用于 Windows 和 macOS）
setPlaybackDeviceVolume	设置播放设备音量。（仅适用于 Windows）
setRecordingDevice	指定音频采集设备。（仅适用于 Windows 和 macOS）
getRecordingDevice	获取当前音频采集设备。（仅适用于 Windows 和 macOS）
getRecordingDeviceInfo	获取音频采集设备信息。（仅适用于 Windows 和 macOS）
setRecordingDeviceVolume	设置音频采集设备音量。（仅适用于 Windows 和 macOS）
getRecordingDeviceVolume	获取音频采集设备音量。（仅适用于 Windows）
setPlaybackDeviceMute	设置播放设备静音。（仅适用于 Windows）
getPlaybackDeviceMute	获取当前播放设备静音状态。（仅适用于 Windows）
setRecordingDeviceMute	设置当前音频采集设备静音。（仅适用于 Windows）
getRecordingDeviceMute	获取当前音频采集设备静音状态。（仅适用于 Windows）
startAudioDeviceLoopbackTest	开始音频设备回路测试。（仅适用于 Windows 和 macOS）
stopAudioDeviceLoopbackTest	停止音频设备回路测试。（仅适用于 Windows 和 macOS）
release	释放 AudioDeviceManager 对象占用的所有资源。（仅适用于 Windows）
onAudioDeviceStateChanged	音频设备变化回调。（仅适用于 Windows 和 macOS）
onAudioDeviceVolumeChanged	音频设备或 App 的音量发生改变回调。（仅适用于 Windows 和 macOS）
getAudioDeviceInfo	获取音频设备信息。（仅适用于 Android）

插件相关

方法/回调	描述
loadExtensionProvider	加载插件。
registerExtension	注册插件。
enableExtension	启用/禁用插件。
getExtensionProperty	获取插件的详细信息。
setExtensionProperty	设置插件的属性。
setExtensionProviderProperty	设置插件服务商的属性。
onExtensionStartedWithContext	插件已启用成功回调。
onExtensionStoppedWithContext	插件已禁用回调。
onExtensionEventWithContext	插件事件回调。
onExtensionErrorWithContext	插件出错回调。

网络及其他

方法/回调	描述
startEchoTest	开始音视频通话回路测试。
stopEchoTest	停止语音通话回路测试。
startLastmileProbeTest	开始通话前网络质量探测。
stopLastmileProbeTest	停止通话前网络质量探测。
onLastmileQuality	网络上下行 last mile 质量报告回调。
onLastmileProbeResult	通话前网络上下行 Last mile 质量探测报告回调。
getCurrentMonotonicTimeInMs	获取 SDK 当前的 Monotonic Time。
queryDeviceScore	查询设备评分等级。
setAVSyncSource	设置发流端音画同步。
setCloudProxy	设置云代理服务。
setLocalAccessPoint	配置与声网私有媒体服务器接入模块的连接。
setParameters	SDK 的 JSON 配置信息，用于提供技术预览或特别定制功能。
getCallId	获取通话 ID。
getCallIdEx	使用连接 ID 获取通话 ID。
isFeatureAvailableOnDevice	查询设备是否支持指定进阶功能。
rate	给通话评分。
complain	投诉通话质量。
getConnectionState	获取当前网络连接状态。
getConnectionStateEx	获取当前网络连接状态。
getVersion	获取 SDK 版本。
getErrorDescription	获取警告或错误描述。
getNativeHandle	获取 Native SDK 的 C++ 句柄。
getAssetAbsolutePath	通过 Asset 的相对规路径获取该 Asset 的实际绝对路径。
registerEventHandler	添加主回调事件。
unregisterEventHandler	删除指定的回调事件。
getNetworkType	获取本地网络连接类型。
getNtpWallTimeInMs	获取当前的 NTP (网络时间协议) 时间。
enableEncryption	开启或关闭内置加密。
enableEncryptionEx	开启或关闭内置加密。
sendCustomReportMessage	发送自定义上报消息。
sendCustomReportMessageEx	自定义数据上报和分析服务。
setRemoteSubscribeFallbackOption	设置弱网环境下订阅的音视频流回退选项。
onRemoteSubscribeFallbackToAudioOnly	订阅流已回退为音频流或恢复为音视频流回调。
onEncryptionError	内置加密出错回调。
onProxyConnected	代理连接状态回调。
onNetworkQuality	通话中每个用户的网络上下行 last mile 质量报告回调。
onRtcStats	当前通话相关的统计信息回调。
onPermissionError	获取设备权限出错回调。