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

API 概览

  • React Native

更新时间不可用

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

初始化相关

API描述
createAgoraRtcEngine创建 IRtcEngine 对象。
initialize创建并初始化 IRtcEngine。
registerEventHandler添加主回调事件。
addListener添加一个 IRtcEngineEvent 监听器。
getMediaEngine获取 IMediaEngine 对象。
release销毁 IRtcEngine 对象。
removeAllListeners移除指定事件类型的所有监听器。
unregisterEventHandler删除指定的回调事件。
removeListener移除指定的 IRtcEngineEvent 监听器。
表格内容超出当前宽度，可横向滚动查看更多列。

频道相关

API描述
setChannelProfile设置频道场景。
joinChannel设置媒体选项并加入频道。
joinChannelEx加入频道。
updateChannelMediaOptions加入频道后更新频道媒体选项。
updateChannelMediaOptionsEx加入频道后更新频道媒体选项。
leaveChannel设置频道选项并离开频道。
leaveChannelEx设置频道选项并离开频道。
preloadChannel使用 token、channelId、uid 预加载频道。
updatePreloadChannelToken更新预加载频道的通配 Token。
renewToken更新 Token。
setClientRole设置直播场景下的用户角色和观众端延时级别。
onClientRoleChanged用户角色、观众端延时级别已切换回调。
onClientRoleChangeFailed用户角色切换失败回调。
onError发生错误回调。
onJoinChannelSuccess成功加入频道回调。
onLeaveChannel离开频道回调。
onRejoinChannelSuccess成功重新加入频道回调。
onRenewTokenResultrenewToken 方法调用结果回调。
onRequestTokenToken 已过期回调。
onRtcStats当前通话相关的统计信息回调。
onTokenPrivilegeWillExpireToken 即将在 30s 内过期回调。
onUserJoined远端用户（通信场景）/主播（直播场景）加入当前频道回调。
onUserOffline远端用户（通信场景）/主播（直播场景）离开当前频道回调。
表格内容超出当前宽度，可横向滚动查看更多列。

发布和订阅

API描述
muteAllRemoteAudioStreams取消或恢复订阅所有远端用户的音频流。
muteAllRemoteAudioStreamsEx取消或恢复订阅所有远端用户的音频流。
muteAllRemoteVideoStreams取消或恢复订阅所有远端用户的视频流。
muteAllRemoteVideoStreamsEx取消或恢复订阅所有远端用户的视频流。
muteLocalAudioStream取消或恢复发布本地音频流。
muteLocalAudioStreamEx取消或恢复发布本地音频流。
muteLocalVideoStream取消或恢复发布本地视频流。
muteLocalVideoStreamEx取消或恢复发布本地视频流。
muteRemoteAudioStream取消或恢复订阅指定远端用户的音频流。
muteRemoteAudioStreamEx停止/恢复接收指定的音频流。
muteRemoteVideoStream取消或恢复订阅指定远端用户的视频流。
muteRemoteVideoStreamEx停止/恢复接收指定的视频流。
setDualStreamMode在发送端设置双流模式并设置视频小流。
setDualStreamModeEx在发送端设置双流模式。
setRemoteDefaultVideoStreamType设置默认订阅的视频流类型。
setRemoteVideoStreamType设置订阅的视频流类型。
setRemoteVideoStreamTypeEx设置订阅的视频流类型。
setRemoteVideoSubscriptionOptions设置远端视频流的订阅选项。
setRemoteVideoSubscriptionOptionsEx设置远端视频流的订阅选项。
setSubscribeAudioAllowlist设置音频订阅白名单。
setSubscribeAudioAllowlistEx设置音频订阅白名单。
setSubscribeAudioBlocklist设置音频订阅黑名单。
setSubscribeAudioBlocklistEx设置音频订阅黑名单。
setSubscribeVideoAllowlist设置视频订阅白名单。
setSubscribeVideoAllowlistEx设置视频订阅白名单。
setSubscribeVideoBlocklist设置视频订阅黑名单。
setSubscribeVideoBlocklistEx设置视频订阅黑名单。
onAudioPublishStateChanged音频发布状态改变回调。
onAudioSubscribeStateChanged音频订阅状态发生改变回调。
onVideoSubscribeStateChanged视频订阅状态发生改变回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音频基础功能

API描述
adjustPlaybackSignalVolume调节本地播放的所有远端用户信号音量。
adjustUserPlaybackSignalVolume调节本地播放的指定远端用户信号音量。
adjustUserPlaybackSignalVolumeEx调节本地播放的指定远端用户信号音量。
disableAudio关闭音频模块。
enableAudio启用音频模块。
enableAudioVolumeIndication启用用户音量提示。
enableAudioVolumeIndicationEx启用用户音量提示。
setAudioProfile设置音频编码属性和音频场景。
setAudioScenario设置音频场景。
setAudioSessionOperationRestriction设置 SDK 对 Audio Session 的操作权限。
onActiveSpeaker监测到远端最活跃用户回调。
onAudioVolumeIndication用户音量提示回调。
onFirstLocalAudioFramePublished已发布本地音频首帧回调。
onLocalAudioStateChanged本地音频状态发生改变回调。
onLocalAudioStats通话中本地音频流的统计信息回调。
onRemoteAudioStateChanged远端音频流状态发生改变回调。
onRemoteAudioStats通话中远端音频流的统计信息回调。
onRemoteAudioTransportStats通话中远端音频流传输的统计信息回调。
onUserMuteAudio远端用户（通信场景）/主播（直播场景）停止或恢复发送音频流回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音频采集

API描述
adjustRecordingSignalVolume调节音频采集信号音量。
enableInEarMonitoring开启耳返功能。
enableLocalAudio开启或关闭本地音频采集。
muteRecordingSignal是否将录音信号静音。
setInEarMonitoringVolume设置耳返音量。
表格内容超出当前宽度，可横向滚动查看更多列。

人声音效

API描述
enableVoiceAITuner开启或关闭 AI 调音器功能。
setAdvancedAudioOptions设置音频的高级选项。
setAINSMode设置是否开启 AI 降噪功能并设置降噪模式。
setAudioEffectParameters设置 SDK 预设人声音效的参数。
setAudioEffectPreset设置 SDK 预设的人声音效。
setLocalVoiceEqualization设置本地语音音效均衡。
setLocalVoiceFormant设置共振峰比率以改变语音的音色。
setLocalVoicePitch设置本地语音音调。
setLocalVoiceReverb设置本地音效混响。
setVoiceBeautifierParameters设置预设美声效果的参数。
setVoiceBeautifierPreset设置预设的美声效果。
setVoiceConversionPreset设置预设的变声效果。
表格内容超出当前宽度，可横向滚动查看更多列。

听声辨位

API描述
enableSoundPositionIndication开启/关闭远端用户的语音立体声。
setRemoteVoicePosition设置远端用户声音的 2D 位置，即水平面位置。
setRemoteVoicePositionEx设置远端用户声音的 2D 位置，即水平面位置。
表格内容超出当前宽度，可横向滚动查看更多列。

空间音频

API描述
initialize初始化 ILocalSpatialAudioEngine。
clearRemotePositions删除所有远端用户的空间位置信息。
enableSpatialAudio开启或关闭空间音频。
getLocalSpatialAudioEngine获取 ILocalSpatialAudioEngine 对象。
muteAllRemoteAudioStreams取消或恢复订阅所有远端用户的音频流。
muteLocalAudioStream取消或恢复发布本地音频流。
muteRemoteAudioStream取消或恢复订阅指定远端用户的音频流。
release销毁 IBaseSpatialAudioEngine。
removeRemotePosition删除指定远端用户的空间位置信息。
setAudioRecvRange设置本地用户的音频接收范围。
setDistanceUnit设置游戏引擎单位距离的长度（米）。
setHeadphoneEQParameters设置耳机均衡器的低频和高频参数。
setHeadphoneEQPreset设置预设的耳机均衡效果。
setMaxAudioRecvCount设置音频接收范围内最多可接收的音频流数。
setPlayerAttenuation设置媒体播放器的声音衰减属性。
setRemoteAudioAttenuation设置指定用户的声音衰减效果。
setRemoteUserSpatialAudioParams设置远端用户的空间音频参数。
setSpatialAudioParams开启或关闭媒体播放器的空间音频。
setZones设置隔声区域。
updatePlayerPositionInfo更新媒体播放器的空间位置。
updateRemotePosition更新远端用户的空间位置信息。
updateSelfPosition更新本地用户的空间位置。
表格内容超出当前宽度，可横向滚动查看更多列。

本地音频合流

API描述
startLocalAudioMixer开启本地音频合流。
stopLocalAudioMixer停止本地音频合流。
updateLocalAudioMixerConfiguration更新本地音频合流的配置。
表格内容超出当前宽度，可横向滚动查看更多列。

原始音频数据

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

已编码音频数据

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

自定义音频采集和渲染

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

音频频谱

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

视频基础功能

API描述
disableVideo关闭视频模块。
enableLocalVideo开关本地视频采集。
enableVideo启用视频模块。
setVideoEncoderConfiguration设置视频编码属性。
setVideoEncoderConfigurationEx设置视频编码属性。
setVideoScenario设置视频业务场景。
startPreviewWithoutSourceType开启视频预览。
startPreview开启视频预览并指定预览的视频源。
stopPreview停止视频预览。
onFirstLocalVideoFrame已显示本地视频首帧回调。
onFirstLocalVideoFramePublished已发布本地视频首帧回调。
onFirstRemoteVideoDecoded已接收到远端视频并完成解码回调。
onFirstRemoteVideoFrame渲染器已接收首帧远端视频回调。
onLocalVideoEvent本地视频事件发生时触发的回调。
onLocalVideoStateChanged本地视频状态发生改变回调。
onLocalVideoStats本地视频流统计信息回调。
onRemoteVideoStateChanged远端视频状态发生改变回调。
onRemoteVideoStats通话中远端视频流的统计信息回调。
onUserEnableVideo远端用户开/关视频模块回调。
onUserMuteVideo远端用户取消或恢复发布视频流回调。
onVideoPublishStateChanged视频发布状态改变回调。
onVideoSizeChanged本地或远端视频大小和旋转信息发生改变回调。
表格内容超出当前宽度，可横向滚动查看更多列。

摄像头采集

API描述
setCameraStabilizationMode设置摄像头防抖模式。
startCameraCapture开始通过摄像头采集视频。
stopCameraCapture停止通过摄像头采集视频。
表格内容超出当前宽度，可横向滚动查看更多列。

屏幕采集

API描述
queryScreenCaptureCapability查询设备在屏幕共享时支持的最高帧率。
setExternalMediaProjection设置 SDK 外部的 MediaProjection 采集屏幕视频流。
setScreenCaptureContentHint设置屏幕共享内容类型。
setScreenCaptureScenario设置屏幕共享的场景。
startScreenCapture开始屏幕采集。
stopScreenCapture停止屏幕采集。
updateScreenCapture更新屏幕采集的参数配置。
updateScreenCaptureParameters更新屏幕采集的参数配置。
updateScreenCaptureRegion更新屏幕采集的区域。
表格内容超出当前宽度，可横向滚动查看更多列。

本地截图上传

API描述
enableContentInspect开启/关闭本地截图上传。
enableContentInspectEx开启/关闭本地截图上传。
takeSnapshot对视频截图。
takeSnapshotWithConfig在指定观测位置进行视频截图。
takeSnapshotEx使用连接 ID 获取视频截图。
takeSnapshotWithConfigEx使用连接 ID 获取指定观测位置的视频截图。
onSnapshotTaken视频截图结果回调。
表格内容超出当前宽度，可横向滚动查看更多列。

虚拟背景

API描述
enableVirtualBackground开启/关闭虚拟背景。
表格内容超出当前宽度，可横向滚动查看更多列。

本地合图

API描述
startLocalVideoTranscoder开启本地合图。
stopLocalVideoTranscoder停止本地合图。
updateLocalTranscoderConfiguration更新本地合图配置。
onLocalVideoTranscoderError本地合图发生错误回调。
表格内容超出当前宽度，可横向滚动查看更多列。

视频增强

API描述
addOrUpdateVideoEffect添加或更新指定视频特效节点和模板的特效。
createVideoEffectObject创建一个 IVideoEffectObject 视频特效对象。
destroyVideoEffectObject销毁视频特效对象。
getFaceShapeAreaOptions获取美型部位选项。
getFaceShapeBeautyOptions获取美型效果选项。
getVideoEffectBoolParam获取视频特效中的布尔参数。
getVideoEffectFloatParam获取视频特效中指定 float 类型参数的值。
getVideoEffectIntParam获取视频特效中的整数类型参数。
performVideoEffectAction对指定的视频特效节点执行操作。
removeVideoEffect移除指定节点 ID 的视频特效。
setBeautyEffectOptions设置美颜效果选项。
setColorEnhanceOptions设置色彩增强功能。
setFaceShapeAreaOptions设置美型部位选项并指定媒体源。
setFaceShapeBeautyOptions设置美型效果选项并指定媒体源。
setFilterEffectOptions设置滤镜效果选项并指定媒体源。
setLowlightEnhanceOptions设置暗光增强功能。
setVideoDenoiserOptions设置视频降噪功能。
setVideoEffectBoolParam设置视频特效的布尔参数。
setVideoEffectFloatParam设置视频特效的浮点参数。
setVideoEffectIntParamsetVideoEffectIntParam：设置视频特效的整数参数。
表格内容超出当前宽度，可横向滚动查看更多列。

人脸检测

API描述
enableFaceDetection开启/关闭本地人脸检测。
onFacePositionChanged报告本地人脸检测结果。
表格内容超出当前宽度，可横向滚动查看更多列。

语音驱动

API描述
registerFaceInfoObserver注册一个人脸信息观测器。
unregisterFaceInfoObserver取消注册人脸信息观测器。
onFaceInfo报告已获取语音驱动插件处理后的人脸信息。
表格内容超出当前宽度，可横向滚动查看更多列。

人像锁定

API描述
enableCameraCenterStage开启或关闭人像锁定功能。
isCameraCenterStageSupported查询摄像头是否支持人像锁定。
表格内容超出当前宽度，可横向滚动查看更多列。

直播水印

API描述
addVideoWatermarkWithConfig向本地视频流添加水印图像。
addVideoWatermarkWithConfigEx向本地视频添加水印图像。
clearVideoWatermarkEx删除已添加的视频水印。
clearVideoWatermarks删除已添加的视频水印。
removeVideoWatermark从本地视频中移除水印图像。
removeVideoWatermarkEx从本地或远端视频流中移除指定的水印图像。
表格内容超出当前宽度，可横向滚动查看更多列。

垫片推流

API描述
enableVideoImageSource设置是否开启垫片推流功能。
表格内容超出当前宽度，可横向滚动查看更多列。

视频渲染

API描述
enableInstantMediaRendering开启音视频帧加速渲染。
setLocalRenderMode更新本地视图显示模式。
setLocalRenderTargetFps设置本地视频渲染的最大帧率。
setRemoteRenderMode更新远端视图显示模式。
setRemoteRenderModeEx设置远端视图显示模式。
setRemoteRenderTargetFps设置视频在远端渲染的最大帧率。
setRenderMode设置播放器视图的渲染模式。
startMediaRenderingTracing开启视频帧渲染数据打点。
startMediaRenderingTracingEx开启视频帧渲染数据打点。
onTranscodedStreamLayoutInfo已接收携带布局信息的合图视频流回调。
onVideoRenderingTracingResult视频帧渲染事件回调。
表格内容超出当前宽度，可横向滚动查看更多列。

原始视频数据

API描述
registerVideoFrameObserver注册原始视频观测器对象。
unregisterVideoFrameObserver取消注册视频帧观测器。
onCaptureVideoFrame获取本地设备采集到的视频数据。
onFrame已获取视频帧回调。
onPreEncodeVideoFrame获取本地视频编码前的视频数据。
onRenderVideoFrame获取远端发送的视频数据。
表格内容超出当前宽度，可横向滚动查看更多列。

已编码视频数据

API描述
addListener添加一个 IMediaEngineEvent 监听器。
registerVideoEncodedFrameObserver为编码后的视频图像注册视频帧接收观测器。
removeAllListeners移除指定事件的所有监听器。
removeListener移除指定的 IMediaEngineEvent 监听器。
unregisterVideoEncodedFrameObserver为编码后的视频图像取消注册视频帧接收观测器。
onEncodedVideoFrameReceived报告接收端已收到远端发送的待解码视频帧。
表格内容超出当前宽度，可横向滚动查看更多列。

自定义视频采集和渲染

API描述
createCustomVideoTrack创建一个自定义的视频轨道。
destroyCustomVideoTrack销毁指定的视频轨道。
isPipActivated检查画中画模式是否已激活。
pipDispose释放画中画相关的资源。
pipIsAutoEnterSupported检查是否支持自动进入画中画模式。
pipIsSupported检查当前设备是否支持画中画模式。
pipSetup配置画中画模式。
pipStart启动画中画模式。
pipStop停止画中画模式。
pushVideoFrame将外部原始视频帧通过自定义视频轨道发布到频道中。
registerPipStateChangedObserver注册画中画状态改变观测器。
release释放画中画相关的资源。
setExternalRemoteEglContext设置远端视频流渲染的 EGL 环境上下文。
setExternalVideoSource设置外部视频源。
unregisterPipStateChangedObserver取消注册画中画状态改变观测器。
onPipStateChanged画中画状态改变回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音乐文件播放

API描述
adjustAudioMixingPlayoutVolume调节音乐文件在本地播放的音量。
adjustAudioMixingPublishVolume调节音乐文件远端播放音量。
adjustAudioMixingVolume调节音乐文件的播放音量。
getAudioMixingCurrentPosition获取音乐文件的播放进度。
getAudioMixingDuration获取音乐文件总时长。
getAudioMixingPlayoutVolume获取音乐文件的本地播放音量。
getAudioMixingPublishVolume获取音乐文件的远端播放音量。
getAudioTrackCount获取当前音乐文件的音轨索引。
pauseAudioMixing暂停播放音乐文件。
resumeAudioMixing恢复播放音乐文件。
selectAudioTrack指定当前音乐文件的播放音轨。
selectMultiAudioTrack选择本地播放和发送至远端的音轨。
setAudioMixingDualMonoMode设置当前音频文件的声道模式。
setAudioMixingPitch调整本地播放的音乐文件的音调。
setAudioMixingPlaybackSpeed设置当前音乐文件的播放速度。
setAudioMixingPosition设置音乐文件的播放位置。
startAudioMixing开始播放音乐文件。
stopAudioMixing停止播放音乐文件。
onAudioMixingPositionChanged音乐文件播放进度回调。
onAudioMixingStateChanged音乐文件的播放状态已改变回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音效文件播放

API描述
getEffectCurrentPosition获取指定音效文件的播放进度。
getEffectDuration获取指定音效文件总时长。
getEffectsVolume获取音效文件的播放音量。
getVolumeOfEffect获取指定音效文件的播放音量。
pauseAllEffects暂停所有音效文件播放。
pauseEffect暂停音效文件播放。
playAllEffects播放所有音效文件。
playEffect播放指定的本地或在线音效文件。
playEffectEx在频道中播放指定音效。
preloadEffect将音效文件加载至内存。
preloadEffectEx将指定音效预加载到频道中。
resumeAllEffects恢复播放所有音效文件。
resumeEffect恢复播放指定音效文件。
setEffectPosition设置指定音效文件的播放位置。
setEffectsVolume设置音效文件的播放音量。
setVolumeOfEffect设置指定音效文件的播放音量。
stopAllEffects停止播放所有音效文件。
stopEffect停止播放指定音效文件。
unloadAllEffects从内存释放所有预加载音效文件。
unloadEffect从内存释放某个预加载的音效文件。
onAudioEffectFinished本地音效文件播放已结束回调。
表格内容超出当前宽度，可横向滚动查看更多列。

初始化

API描述
addListener添加一个 IMediaPlayerEvent 监听器。
createMediaPlayer创建媒体播放器对象。
destroyMediaPlayer销毁媒体播放器。
getMediaPlayerCacheManager获取 IMediaPlayerCacheManager 实例。
removeAllListeners移除指定事件的所有监听器。
removeListener移除指定的 IMediaPlayerEvent 监听器。
表格内容超出当前宽度，可横向滚动查看更多列。

媒体资源打开

API描述
open打开媒体资源。
openWithMediaSource打开媒体资源并进行播放设置。
preloadSrc预加载媒体资源。
switchSrc切换媒体资源。
unloadSrc释放预加载的媒体资源。
表格内容超出当前宽度，可横向滚动查看更多列。

媒体资源播放和渲染

API描述
selectAudioTrack指定当前音频文件的播放音轨。
setAudioDualMonoMode设置当前音频文件的声道模式。
setAudioPitch调整当前播放的媒体资源的音调。
setLoopCount设置循环播放。
setPlaybackSpeed设置当前音频文件的播放速度。
setPlayerOptionInInt设置媒体播放器选项。
setPlayerOptionInString设置媒体播放器选项。
setView设置播放器渲染视图。
表格内容超出当前宽度，可横向滚动查看更多列。

播放器控制

API描述
adjustPlayoutVolume调节本地播放音量。
adjustPublishSignalVolume调节远端用户听到的音量。
mute设置是否静音。
pause暂停播放。
play播放媒体文件。
playPreloadedSrc播放预加载的媒体资源。
resume暂停后恢复播放。
seek定位到媒体文件的指定播放位置。
stop停止播放。
表格内容超出当前宽度，可横向滚动查看更多列。

播放信息获取

API描述
getAudioBufferDelay获取播放媒体文件时的音频缓冲延迟。
getDuration获取媒体文件总时长。
getMediaPlayerId获取播放器 ID。
getMute获取当前播放的媒体文件是否静音。
getPlayoutVolume获取当前本地播放音量。
getPlayPosition获取当前播放进度。
getPlaySrc获取播放的媒体资源的路径。
getPublishSignalVolume获取远端用户听到的音量。
getState获取播放器当前状态。
getStreamCount获取当前媒体文件中媒体流的数量。
getStreamInfo通过媒体流的索引值获取媒体流信息。
onPlayerPlaybackStats报告当前播放的媒体资源的相关信息。
表格内容超出当前宽度，可横向滚动查看更多列。

音视频观测器

API描述
registerAudioFrameObserver注册音频帧观测器。
registerPlayerSourceObserver注册一个播放观测器。
registerVideoFrameObserver注册视频帧观测器。
unregisterAudioFrameObserver取消注册音频帧观测器。
unregisterPlayerSourceObserver取消注册播放观测器。
unregisterVideoFrameObserver取消注册视频帧观测器。
onAudioVolumeIndication媒体播放器音量提示回调。
onFrame已获取音频帧回调。
onMetaData报告已获取媒体附属信息。
onPlayBufferUpdated报告当前缓冲数据能播放的时间。
onPlayerEvent报告播放器的事件。
onPlayerInfoUpdated媒体播放器相关信息发生改变回调。
onPlayerSourceStateChanged报告播放器状态改变。
onPlayerSrcInfoChanged媒体资源视频码率变化回调。
onPositionChanged报告当前媒体资源的播放进度。
onPreloadEvent报告预加载媒体资源的事件。
表格内容超出当前宽度，可横向滚动查看更多列。

媒体播放器缓存

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

版权音乐

API描述
createMusicPlayer创建音乐播放器。
destroyMusicPlayer销毁音乐播放器对象。
get获取音乐榜单的详细信息。
getCaches获取已缓存的音乐资源信息。
getCount获取本次请求的音乐榜单数量。
getCount获取本次请求的音乐数量。
getInternalSongCode创建音乐资源的副歌片段编号。
getLyric获取音乐资源的歌词下载地址。
getMusic获取当前页面列表中音乐资源的详细信息。
getMusicCharts获取全部音乐榜单。
getMusicCollectionByMusicChartId通过音乐榜单的 ID 获取指定榜单的音乐资源列表。
getMusicContentCenter获取 IMusicContentCenter。
getPage获取音乐资源列表当前页的页码。
getPageSize获取 SDK 实际返回的音乐资源数量。
getSongSimpleInfo获取某一音乐资源的详细信息。
getTotal获取列表内音乐资源的总数量。
initialize初始化 IMusicContentCenter。
isPreloaded检测音乐资源是否已被预加载。
openWithSongCode通过音乐资源编号打开音乐资源。
Preload预加载音乐资源。
registerEventHandler注册音乐内容中心回调事件。
release释放音乐内容中心所占用的所有资源。
removeCache删除已缓存的音乐资源。
renewToken更新 Token。
searchMusic搜索音乐资源。
setPlayMode设置音乐资源的播放模式。
unregisterEventHandler取消注册音乐内容中心事件回调。
onLyricResult歌词下载地址回调。
onMusicChartsResult获取音乐榜单回调。
onMusicCollectionResult获取音乐资源列表回调。
onPreLoadEvent报告预加载音乐资源的事件。
onSongSimpleInfoResult音乐资源的详细信息回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音视频录制

API描述
addListener添加一个 IMediaRecorderEvent 监听器。
createMediaRecorder创建音视频录制对象。
destroyMediaRecorder销毁音视频录制对象。
removeAllListeners移除指定事件的所有监听器。
removeListener移除指定的 IMediaRecorderEvent 监听器。
setMediaRecorderObserver注册 IMediaRecorderObserver 观测器。
startAudioRecording开始客户端录音并进行录音配置。
startRecording开启音视频流录制。
stopAudioRecording停止客户端录音。
stopRecording停止音视频流录制。
onRecorderInfoUpdated录制信息更新回调。
onRecorderStateChanged录制状态发生改变回调。
表格内容超出当前宽度，可横向滚动查看更多列。

跨频道媒体流转发

API描述
pauseAllChannelMediaRelay暂停向所有目标频道转发媒体流。
pauseAllChannelMediaRelayEx暂停向所有目标频道转发媒体流。
resumeAllChannelMediaRelay恢复向所有目标频道转发媒体流。
resumeAllChannelMediaRelayEx恢复向所有目标频道转发媒体流。
startOrUpdateChannelMediaRelay开始或更新跨频道媒体流转发。
startOrUpdateChannelMediaRelayEx开始或更新跨频道媒体流转发。
stopChannelMediaRelay停止跨频道媒体流转发。一旦停止，主播会退出所有目标频道。
stopChannelMediaRelayEx停止跨频道媒体流转发。一旦停止，主播会退出所有目标频道。
onChannelMediaRelayStateChanged跨频道媒体流转发状态发生改变回调。
表格内容超出当前宽度，可横向滚动查看更多列。

旁路推流

API描述
startRtmpStreamWithoutTranscoding开始非转码推流。
startRtmpStreamWithoutTranscodingEx开始非转码推流。
startRtmpStreamWithTranscoding开始旁路推流并设置转码属性。
startRtmpStreamWithTranscodingEx开始旁路推流并设置转码属性。
stopRtmpStream结束旁路推流。
stopRtmpStreamEx结束旁路推流。
updateRtmpTranscoding更新旁路推流转码属性。
updateRtmpTranscodingEx更新旁路推流转码属性。
onRtmpStreamingEvent旁路推流事件回调。
onRtmpStreamingStateChanged旁路推流状态发生改变回调。
onTranscodingUpdated旁路推流转码设置已被更新回调。
表格内容超出当前宽度，可横向滚动查看更多列。

数据流 Datastream

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

媒体流附属信息分发

API描述
registerMediaMetadataObserver注册媒体 metadata 观测器用于接收或发送 metadata。
sendMetaData发送媒体附属信息。
setMaxMetadataSize设置媒体附属信息的最大大小。
unregisterMediaMetadataObserver取消注册媒体 metadata 观测器。
onMetadataReceived接收端已收到 metadata。
表格内容超出当前宽度，可横向滚动查看更多列。

音频路由

API描述
isSpeakerphoneEnabled检查扬声器状态启用状态。
setDefaultAudioRouteToSpeakerphone设置默认的音频路由。
setEnableSpeakerphone开启或关闭扬声器播放。
setRouteInCommunicationMode选择通话音量模式下的音频路由。
onAudioRoutingChanged音频路由已发生变化回调。
表格内容超出当前宽度，可横向滚动查看更多列。

视频设备管理

API描述
enableMultiCamera开启或关闭多路摄像头采集。
getCameraMaxZoomFactor获取摄像头支持的最大放大倍率。
getVideoDeviceManager获取 IVideoDeviceManager 对象，以管理视频设备。
isCameraAutoExposureFaceModeSupported检测设备是否支持自动曝光功能。
isCameraAutoFocusFaceModeSupported检测设备是否支持人脸对焦功能。
isCameraExposurePositionSupported检测设备是否支持手动曝光功能。
isCameraExposureSupported查询当前摄像头是否支持曝光调节。
isCameraFaceDetectSupported检查设备摄像头是否支持人脸检测。
isCameraFocusSupported检测设备是否支持手动对焦功能。
isCameraTorchSupported检测设备是否支持闪光灯常开。
isCameraZoomSupported检测设备是否支持摄像头缩放功能。
queryCameraFocalLengthCapability查询摄像头支持的焦距能力。
queryCodecCapability查询 SDK 支持的视频编解码能力。
setCameraAutoExposureFaceModeEnabled设置是否开启自动曝光功能。
setCameraAutoFocusFaceModeEnabled设置是否开启人脸对焦功能。
setCameraCapturerConfiguration设置摄像头采集配置。
setCameraDeviceOrientation设置采集视频的旋转角度。
setCameraExposureFactor设置当前摄像头的曝光系数。
setCameraExposurePosition设置手动曝光位置。
setCameraFocusPositionInPreview设置手动对焦位置，并触发对焦。
setCameraTorchOn设置是否打开闪光灯。
setCameraZoomFactor设置摄像头放大比例。
switchCamera切换前置/后置摄像头。
onCameraExposureAreaChanged摄像头曝光区域已改变回调。
onCameraFocusAreaChanged相机对焦区域已改变回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音频设备管理

API描述
getAudioDeviceInfo获取音频设备信息。
getAudioDeviceManager获取 IAudioDeviceManager 对象，以管理音频设备。
startPlaybackDeviceTest启动音频播放设备测试。
stopPlaybackDeviceTest停止音频播放设备测试。
表格内容超出当前宽度，可横向滚动查看更多列。

插件

API描述
enableExtension启用/禁用插件。
getExtensionProperty获取插件的详细信息。
loadExtensionProvider加载插件。
registerExtension注册插件。
setExtensionProperty设置插件的属性。
setExtensionProviderProperty设置插件服务商的属性。
onExtensionErrorWithContext插件出错回调。
onExtensionEventWithContext插件事件回调。
onExtensionStartedWithContext插件已启用成功回调。
onExtensionStoppedWithContext插件已禁用回调。
表格内容超出当前宽度，可横向滚动查看更多列。

网络及其他

API描述
complain投诉通话质量。
enableEncryption开启或关闭内置加密。
enableEncryptionEx开启或关闭内置加密。
getCallId获取通话 ID。
getCallIdEx使用连接 ID 获取通话 ID。
getConnectionState获取当前网络连接状态。
getConnectionStateEx获取当前网络连接状态。
getCurrentMonotonicTimeInMs获取 SDK 当前的 Monotonic Time。
getErrorDescription获取警告或错误描述。
getNativeHandle获取 Native SDK 的 C++ 句柄。
getNetworkType获取本地网络连接类型。
getNtpWallTimeInMs获取当前的 NTP (网络时间协议) 时间。
getVersion获取 SDK 版本。
isFeatureAvailableOnDevice查询设备是否支持指定进阶功能。
queryDeviceScore查询设备评分等级。
rate给通话评分。
sendCustomReportMessage发送自定义上报消息。
sendCustomReportMessageEx自定义数据上报和分析服务。
setAVSyncSource设置发流端音画同步。
setCloudProxy设置云代理服务。
setLocalAccessPoint配置与声网私有媒体服务器接入模块的连接。
setParametersSDK 的 JSON 配置信息，用于提供技术预览或特别定制功能。
setRemoteSubscribeFallbackOption设置弱网环境下订阅的音视频流回退选项。
startEchoTest开始音视频通话回路测试。
startLastmileProbeTest开始通话前网络质量探测。
stopEchoTest停止语音通话回路测试。
stopLastmileProbeTest停止通话前网络质量探测。
onConnectionLost网络连接中断，且 SDK 无法在 10 秒内连接服务器回调。
onConnectionStateChanged网络连接状态已改变回调。
onEncryptionError内置加密出错回调。
onLastmileProbeResult通话前网络上下行 Last mile 质量探测报告回调。
onLastmileQuality网络上下行 last mile 质量报告回调。
onMultipathStats多路径传输统计信息的回调。
onNetworkQuality通话中每个用户的网络上下行 last mile 质量报告回调。
onNetworkTypeChanged本地网络类型发生改变回调。
onPermissionError获取设备权限出错回调。
onPermissionGranted权限被授予时的回调。
onProxyConnected代理连接状态回调。
onRemoteSubscribeFallbackToAudioOnly订阅流已回退为音频流或恢复为音视频流回调。
onUplinkNetworkInfoUpdated上行网络信息变化回调。
表格内容超出当前宽度，可横向滚动查看更多列。

咨询电话

400 632 6626

上海声网科技有限公司

Copyright © 2026 声网保留所有权利