需要访问旧版文档站？前往旧版文档官网首页。 (在新标签页打开)
声网文档中心

API 概览

  • Unreal C++

更新时间不可用

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

初始化相关

方法/回调描述
Get创建 IRtcEngine 对象。
initialize初始化 IRtcEngine。
Release销毁 IRtcEngine 对象。
表格内容超出当前宽度，可横向滚动查看更多列。

频道相关

方法/回调描述
setChannelProfile设置频道场景。
joinChannel [1/2]加入频道。
joinChannel [2/2]设置媒体选项并加入频道。
joinChannelEx加入频道。
updateChannelMediaOptions加入频道后更新频道媒体选项。
updateChannelMediaOptionsEx加入频道后更新频道媒体选项。
leaveChannel [1/2]离开频道。
leaveChannelEx [1/2]离开频道。
leaveChannel [2/2]设置频道选项并离开频道。
leaveChannelEx [2/2]设置频道选项并离开频道。
preloadChannel使用 token、channelId、uid 预加载频道。
preloadChannelWithUserAccount使用 token、channelId、userAccount 预加载频道。
updatePreloadChannelToken更新预加载频道的通配 Token。
renewToken更新 Token。
setClientRole [1/2]设置用户角色。
setClientRole [2/2]设置直播场景下的用户角色和观众端延时级别。
onJoinChannelSuccess成功加入频道回调。
onRejoinChannelSuccess成功重新加入频道回调。
onClientRoleChanged用户角色、观众端延时级别已切换回调。
onClientRoleChangeFailed用户角色切换失败回调。
onLeaveChannel离开频道回调。
onUserJoined远端用户（通信场景）/主播（直播场景）加入当前频道回调。
onUserOffline远端用户（通信场景）/主播（直播场景）离开当前频道回调。
onNetworkTypeChanged本地网络类型发生改变回调。
onUplinkNetworkInfoUpdated上行网络信息变化回调。
onConnectionLost网络连接中断，且 SDK 无法在 10 秒内连接服务器回调。
onConnectionStateChanged网络连接状态已改变回调。
onRequestTokenToken 已过期回调。
onTokenPrivilegeWillExpireToken 即将在 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 [1/2]在发送端设置双流模式。
setDualStreamMode [2/2]在发送端设置双流模式并设置视频小流。
setDualStreamModeEx在发送端设置双流模式。
onAudioPublishStateChanged音频发布状态改变回调。
onAudioSubscribeStateChanged音频订阅状态发生改变回调。
onVideoSubscribeStateChanged视频订阅状态发生改变回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音频基础功能

方法/回调描述
adjustUserPlaybackSignalVolume调节本地播放的指定远端用户信号音量。
adjustUserPlaybackSignalVolumeEx调节本地播放的指定远端用户信号音量。
adjustPlaybackSignalVolume调节本地播放的所有远端用户信号音量。
enableAudio启用音频模块。
disableAudio关闭音频模块。
enableAudioVolumeIndication启用用户音量提示。
enableAudioVolumeIndicationEx

启用用户音量提示。

setAudioProfile [2/2]设置音频编码属性。
setAudioScenario设置音频场景。
setAudioSessionOperationRestriction设置 SDK 对 Audio Session 的操作权限。
onAudioVolumeIndication用户音量提示回调。
onActiveSpeaker监测到远端最活跃用户回调。
onLocalAudioStateChanged本地音频状态发生改变回调。
onFirstLocalAudioFramePublished已发布本地音频首帧回调。
onFirstRemoteAudioFrame已接收远端音频首帧回调。
onUserMuteAudio远端用户（通信场景）/主播（直播场景）停止或恢复发送音频流回调。
onRemoteAudioStateChanged远端音频流状态发生改变回调。
onLocalAudioStats通话中本地音频流的统计信息回调。
onRemoteAudioStats通话中远端音频流的统计信息回调。
onReceiveAudioPacket本地用户收到音频包回调。
onSendAudioPacket已发送音频包回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音频采集

方法/回调描述
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 位置，即水平面位置。
initialize初始化 ILocalSpatialAudioEngine。
updateSelfPosition更新本地用户的空间位置。
updateRemotePosition更新远端用户的空间位置信息。
removeRemotePosition删除指定远端用户的空间位置信息。
clearRemotePositions删除所有远端用户的空间位置信息。
setHeadphoneEQParameters设置耳机均衡器的低频和高频参数。
setHeadphoneEQPreset设置预设的耳机均衡效果。
startLocalAudioMixer开启本地音频合流。
updateLocalAudioMixerConfiguration更新本地音频合流的配置。
stopLocalAudioMixer停止本地音频合流。
表格内容超出当前宽度，可横向滚动查看更多列。

原始音频数据

方法/回调描述
registerAudioFrameObserver注册音频观测器对象。
setEarMonitoringAudioFrameParameters设置耳返的音频数据格式。
setRecordingAudioFrameParameters设置采集的原始音频数据格式。
setPlaybackAudioFrameParameters设置播放的原始音频数据格式。
setMixedAudioFrameParameters设置采集和播放音频混音后的原始音频数据格式。
setPlaybackAudioFrameBeforeMixingParameters设置混音前的原始音频播放数据格式。
onEarMonitoringAudioFrame获得耳返的原始音频数据。
onRecordAudioFrame获得采集的原始音频数据。
onPlaybackAudioFrame获得播放的原始音频数据。
onPlaybackAudioFrameBeforeMixing获取所订阅的远端用户混音前的声音。
onMixedAudioFrame获取采集和播放音频混音后的数据。
getEarMonitoringAudioParams设置 onEarMonitoringAudioFrame 回调数据的格式。
getObservedAudioFramePosition设置音频观测位置。
getRecordAudioParams设置 onRecordAudioFrame 回调数据的格式。
getPlaybackAudioParams设置 onPlaybackAudioFrame 回调数据的格式。
getMixedAudioParams设置 onMixedAudioFrame 回调数据的格式。
表格内容超出当前宽度，可横向滚动查看更多列。

已编码音频数据

方法/回调描述
registerAudioEncodedFrameObserver注册音频编码数据观测器。
onRecordAudioEncodedFrame获取本地用户的音频编码数据。
onPlaybackAudioEncodedFrame获取所有远端用户的音频编码数据。
onMixedAudioEncodedFrame获取本地和所有远端用户混音后的音频编码数据。
表格内容超出当前宽度，可横向滚动查看更多列。

自定义音频采集和渲染

方法/回调描述
createCustomAudioTrack创建一个自定义音频采集轨道。
destroyCustomAudioTrack销毁指定的音频轨道。
setExternalAudioSink设置外部音频渲染。
pullAudioFrame拉取远端音频数据。
pushAudioFrame推送外部音频帧。
adjustCustomAudioPlayoutVolume调节自定义音频采集轨道在本地播放的音量。
adjustCustomAudioPublishVolume调节自定义音频采集轨道在远端播放的音量。
enableCustomAudioLocalPlayback设置是否在本地播放外部音频源。
表格内容超出当前宽度，可横向滚动查看更多列。

音频频谱

方法/回调描述
registerAudioSpectrumObserver注册音频频谱观测器。
enableAudioSpectrumMonitor开启音频频谱监测。
disableAudioSpectrumMonitor关闭音频频谱监测。
unregisterAudioSpectrumObserver取消注册音频频谱观测器。
onLocalAudioSpectrum获取本地音频频谱。
onRemoteAudioSpectrum获取远端音频频谱。
表格内容超出当前宽度，可横向滚动查看更多列。

视频基础功能

方法/回调描述
enableVideo启用视频模块。
disableVideo关闭视频模块。
setVideoScenario设置视频业务场景。
setVideoEncoderConfiguration设置视频编码属性。
setVideoEncoderConfigurationEx设置视频编码属性。
startPreview [1/2]开启视频预览。
stopPreview [1/2]停止视频预览。
startPreview [2/2]开启视频预览并指定预览的视频源。
stopPreview [2/2]停止视频预览。
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 [1/2]开始屏幕采集。（仅适用于 Android 和 iOS）
startScreenCapture [2/2]开始屏幕采集并指定视频源。（仅适用于 Windows 和 macOS）
updateScreenCapture更新屏幕采集的参数配置。（仅适用于 Android 和 iOS）
updateScreenCaptureParameters更新屏幕采集的参数配置。（仅适用于 Windows 和 macOS）
stopScreenCapture [1/2]停止屏幕采集。
stopScreenCapture [2/2]停止对指定的视频源进行屏幕采集。（仅适用于 Windows 和 macOS）
getCount获取可共享的窗口和屏幕的个数。（仅适用于 Windows 和 macOS）
getSourceInfo获取指定的可共享窗口或屏幕的信息。（仅适用于 Windows 和 macOS）
release释放 IScreenCaptureSourceList。（仅适用于 Windows 和 macOS）
setScreenCaptureScenario设置屏幕共享的场景。
表格内容超出当前宽度，可横向滚动查看更多列。

视频前处理和后处理

方法/回调描述
enableContentInspect开启/关闭本地截图上传。
takeSnapshot对视频截图。
takeSnapshot [2/2]在指定观测位置进行视频截图。
takeSnapshotEx使用连接 ID 获取视频截图。
takeSnapshotEx [2/2]使用连接 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 [1/2]添加本地视频水印。
addVideoWatermark [2/2]添加本地视频水印。
addVideoWatermarkEx添加本地视频水印。
clearVideoWatermarks删除已添加的视频水印。
clearVideoWatermarkEx删除已添加的视频水印。
表格内容超出当前宽度，可横向滚动查看更多列。

视频渲染

方法/回调描述
setRenderMode设置播放器视图的渲染模式。
setLocalRenderMode [2/2]更新本地视图显示模式。
setRemoteRenderMode更新远端视图显示模式。
setRemoteRenderModeEx设置远端视图显示模式。
setLocalRenderTargetFps设置本地视频渲染的最大帧率。
setRemoteRenderTargetFps设置视频在远端渲染的最大帧率。
setView设置播放器渲染视图。
setupLocalVideo初始化本地视图。
setupRemoteVideo初始化远端用户视图。
setupRemoteVideoEx初始化远端用户视图。
enableInstantMediaRendering开启音视频帧加速渲染。
startMediaRenderingTracing开启视频帧渲染数据打点。
startMediaRenderingTracingEx开启视频帧渲染数据打点。
onVideoRenderingTracingResult视频帧渲染事件回调。
表格内容超出当前宽度，可横向滚动查看更多列。

原始视频数据

方法/回调描述
registerVideoFrameObserver注册原始视频观测器对象。
onCaptureVideoFrame获取本地设备采集到的视频数据。
onFrame已获取视频帧回调。
onPreEncodeVideoFrame获取本地视频编码前的视频数据。
onRenderVideoFrame获取远端发送的视频数据。
getObservedFramePosition设置视频观测位置。
getVideoFrameProcessMode设置视频处理模式。
getMirrorApplied设置视频数据镜像。
getRotationApplied设置视频数据旋转。
getVideoFormatPreference设置 SDK 输出的原始视频数据格式。
表格内容超出当前宽度，可横向滚动查看更多列。

已编码视频数据

方法/回调描述
registerVideoEncodedFrameObserver为编码后的视频图像注册视频帧接收观测器。
onEncodedVideoFrameReceived报告接收端已收到远端发送的待解码视频帧。
表格内容超出当前宽度，可横向滚动查看更多列。

自定义视频采集和渲染

方法/回调描述
createCustomVideoTrack创建一个自定义的视频轨道。
destroyCustomVideoTrack销毁指定的视频轨道。
setExternalVideoSource设置外部视频源。
setExternalRemoteEglContext设置远端视频流渲染的 EGL 环境上下文。（仅适用于 Android）
pushVideoFrame将外部原始视频帧通过自定义视频轨道发布到频道中。
表格内容超出当前宽度，可横向滚动查看更多列。

音乐文件播放

方法/回调描述
startAudioMixing [1/2]开始播放音乐文件。
startAudioMixing [2/2]开始播放音乐文件。
stopAudioMixing停止播放音乐文件。
pauseAudioMixing暂停播放音乐文件。
resumeAudioMixing恢复播放音乐文件。
adjustAudioMixingVolume调节音乐文件的播放音量。
adjustAudioMixingPlayoutVolume调节音乐文件在本地播放的音量。
adjustAudioMixingPublishVolume调节音乐文件远端播放音量。
getAudioMixingPlayoutVolume获取音乐文件的本地播放音量。
getAudioMixingPublishVolume获取音乐文件的远端播放音量。
setAudioMixingPlaybackSpeed设置当前音乐文件的播放速度。
getAudioMixingDuration获取音乐文件总时长。
getAudioMixingCurrentPosition获取音乐文件的播放进度。
setAudioMixingPitch调整本地播放的音乐文件的音调。
setAudioMixingPosition设置音乐文件的播放位置。
setAudioMixingDualMonoMode设置当前音频文件的声道模式。
getAudioTrackCount获取当前音乐文件的音轨索引。
selectAudioTrack [1/2]指定当前音乐文件的播放音轨。
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获取 IMediaPlayerCacheManager 实例。
IMediaPlayer提供媒体播放器功能的类，支持多实例。
IMediaPlayerCacheManager该类提供管理媒体播放器中缓存媒体文件的方法。
IMediaPlayerSourceObserver提供媒体播放器的回调。
表格内容超出当前宽度，可横向滚动查看更多列。

媒体播放器缓存

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

版权音乐

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

方法/回调描述
initialize初始化 IMusicContentCenter。
release释放音乐内容中心所占用的所有资源。
createMusicPlayer创建音乐播放器。
destroyMusicPlayer销毁音乐播放器对象。
preload [1/2]预加载音乐资源。
preload [2/2]预加载音乐资源。
isPreloaded检测音乐资源是否已被预加载。
open通过音乐资源编号打开音乐资源。
registerEventHandler注册音乐内容中心回调事件。
renewToken更新 Token。
getCaches获取已缓存的音乐资源信息。
removeCache删除已缓存的音乐资源。
getMusicCharts获取全部音乐榜单。
getMusicCollectionWithMusicChartId通过音乐榜单的 ID 获取指定榜单的音乐资源列表。
searchMusic搜索音乐资源。
setPlayMode设置音乐资源的播放模式。
renewToken更新 Token。
getLyric获取音乐资源的歌词下载地址。
getInternalSongCode创建音乐资源的副歌片段编号。
getSongSimpleInfo获取某一音乐资源的详细信息。
onPreLoadEvent报告预加载音乐资源的事件。
onLyricResult歌词下载地址回调。
onMusicChartsResult获取音乐榜单回调。
onMusicCollectionResult获取音乐资源列表回调。
onSongSimpleInfoResult音乐资源的详细信息回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音视频录制

方法/回调描述
createMediaRecorder创建音视频录制对象。
setMediaRecorderObserver注册 IMediaRecorderObserver 观测器。
startRecording开启音视频流录制。
stopRecording停止音视频流录制。
startAudioRecording [1/3]开始客户端录音。
startAudioRecording [2/3]开始客户端录音并设置录音采样率。
startAudioRecording [3/3]开始客户端录音并进行录音配置。
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 推流时的视频编码属性。
onDirectCdnStreamingStateChangedCDN 推流状态改变回调。
onDirectCdnStreamingStatsCDN 推流统计数据回调。
表格内容超出当前宽度，可横向滚动查看更多列。

数据流

方法/回调描述
createDataStream [1/2]创建数据流。
createDataStream [2/2]创建数据流。
createDataStreamEx [2/2]创建数据流。
sendStreamMessage发送数据流。
onStreamMessage接收到对方数据流消息的回调。
onStreamMessageError接收对方数据流消息发生错误的回调。
表格内容超出当前宽度，可横向滚动查看更多列。

Metadata (SEI)

方法/回调描述
registerMediaMetadataObserver注册媒体 metadata 观测器用于接收或发送 metadata。
unregisterMediaMetadataObserver取消注册媒体 metadata 观测器。
getMaxMetadataSize请求最大的 metadata 大小。
onReadyToSendMetadata发送端已准备好发送 metadata。
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释放 IVideoDeviceManager 对象占用的所有资源。(仅适用于 Windows 和 macOS)
getCapability获取视频采集设备在指定的视频格式下的详细视频帧信息。(仅适用于 Windows 和 macOS)
numberOfCapabilities获取指定视频采集设备支持的视频格式数量。(仅适用于 Windows 和 macOS)
setCameraDeviceOrientation设置采集视频的旋转角度。（仅适用于 Windows）
setDevice指定设备。(仅适用于 Windows 和 macOS)
getDevice获取某个被索引的视频采集设备的指定信息。(仅适用于 Windows 和 macOS)
getCount获取系统中被索引的视频采集或播放设备的总数。
release释放 IVideoDeviceCollection 对象占用的所有资源。
onVideoDeviceStateChanged视频设备变化回调。(仅适用于 Windows 和 macOS)
表格内容超出当前宽度，可横向滚动查看更多列。

音频设备管理

方法/回调描述
startPlaybackDeviceTest启动音频播放设备测试。
stopPlaybackDeviceTest停止音频播放设备测试。
startRecordingDeviceTest启动音频采集设备测试。
stopRecordingDeviceTest停止音频采集设备测试。
enumeratePlaybackDevices获取系统中所有的播放设备列表。（仅适用于 Windows 和 macOS）
enumerateRecordingDevices获取系统中所有的音频采集设备列表。（仅适用于 Windows 和 macOS）
followSystemPlaybackDevice设置 SDK 使用的音频播放设备跟随系统默认的音频播放设备。（仅适用于 Windows 和 macOS）
followSystemRecordingDevice设置 SDK 使用的音频采集设备跟随系统默认的音频采集设备。（仅适用于 Windows 和 macOS）
setPlaybackDevice指定播放设备。（仅适用于 Windows 和 macOS）
getPlaybackDevice获取当前音频播放设备。（仅适用于 Windows 和 macOS）
getPlaybackDeviceInfo [1/2]获取音频播放设备信息。（仅适用于 Windows 和 macOS）
setLoopbackDevice指定声卡采集设备。（仅适用于 Windows 和 macOS）
getLoopbackDevice获取当前的声卡采集设备。（仅适用于 Windows 和 macOS）
followSystemLoopbackDevice设置声卡采集设备是否跟随系统默认的播放设备。（仅适用于 Windows 和 macOS）
setPlaybackDeviceVolume设置播放设备音量。（仅适用于 Windows）
setRecordingDevice指定音频采集设备。（仅适用于 Windows 和 macOS）
getRecordingDevice获取当前音频采集设备。（仅适用于 Windows 和 macOS）
getRecordingDeviceInfo [1/2]获取音频采集设备信息。（仅适用于 Windows 和 macOS）
setRecordingDeviceVolume设置音频采集设备音量。（仅适用于 Windows 和 macOS）
getRecordingDeviceVolume获取音频采集设备音量。（仅适用于 Windows）
setPlaybackDeviceMute设置播放设备静音。（仅适用于 Windows）
getPlaybackDeviceMute获取当前播放设备静音状态。（仅适用于 Windows）
setRecordingDeviceMute设置当前音频采集设备静音。（仅适用于 Windows）
getRecordingDeviceMute获取当前音频采集设备静音状态。（仅适用于 Windows）
startAudioDeviceLoopbackTest开始音频设备回路测试。（仅适用于 Windows 和 macOS）
stopAudioDeviceLoopbackTest停止音频设备回路测试。（仅适用于 Windows 和 macOS）
release释放 IAudioDeviceManager 对象占用的所有资源。（仅适用于 Windows）
setDevice指定音频设备。（仅适用于 Windows 和 macOS）
getDefaultDevice [1/2]获取系统默认的音频设备。（仅适用于 Windows 和 macOS）
getDevice [1/2]获取指定 index 的音频设备信息。（仅适用于 Windows 和 macOS）
getCount获取播放或音频采集设备数量。（仅适用于 Windows 和 macOS）
setApplicationVolume设置 App 音量。（仅适用于 Windows 和 macOS）
getApplicationVolume获取 App 的当前音量。（仅适用于 Windows 和 macOS）
setApplicationMute设置是否将 App 静音。（仅适用于 Windows 和 macOS）
isApplicationMute获取 App 当前的静音状态。（仅适用于 Windows 和 macOS）
release释放 IAudioDeviceCollection 对象占用的所有资源。（仅适用于 Windows 和 macOS）
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 [1/2]SDK 的 JSON 配置信息，用于提供技术预览或特别定制功能。
getCallId获取通话 ID。
getCallIdEx使用连接 ID 获取通话 ID。
isFeatureAvailableOnDevice查询设备是否支持指定进阶功能。
rate给通话评分。
complain投诉通话质量。
getConnectionState获取当前网络连接状态。
getConnectionStateEx获取当前网络连接状态。
getVersion获取 SDK 版本。
getErrorDescription获取警告或错误描述。
queryInterface获取指定接口类的指针。
getNetworkType获取本地网络连接类型。
getNtpWallTimeInMs获取当前的 NTP (网络时间协议) 时间。
enableEncryption开启或关闭内置加密。
enableEncryptionEx开启或关闭内置加密。
registerPacketObserver注册数据包观测器。
sendCustomReportMessage发送自定义上报消息。
sendCustomReportMessageEx自定义数据上报和分析服务。
setRemoteSubscribeFallbackOption设置弱网环境下订阅的音视频流回退选项。
onReceiveVideoPacket本地用户收到视频包回调。
onSendVideoPacket已发送视频包回调。
onRemoteSubscribeFallbackToAudioOnly订阅流已回退为音频流或恢复为音视频流回调。
onEncryptionError内置加密出错回调。
onProxyConnected代理连接状态回调。
onNetworkQuality通话中每个用户的网络上下行 last mile 质量报告回调。
onRtcStats当前通话相关的统计信息回调。
onPermissionError获取设备权限出错回调。
表格内容超出当前宽度，可横向滚动查看更多列。

咨询电话

400 632 6626

上海声网科技有限公司

Copyright © 2026 声网保留所有权利