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

API 概览

  • C++

更新时间不可用

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

初始化相关

API描述
createAgoraRtcEngine创建一个 IRtcEngine 对象。
initialize初始化 IRtcEngine。
release释放 IRtcEngine 实例。
RtcEngineReleaseCallbackIRtcEngine 被释放时触发的回调。
表格内容超出当前宽度，可横向滚动查看更多列。

频道相关

API描述
setChannelProfile设置频道场景。
joinChannel [1/2]加入一个频道。
joinChannel [2/2]加入频道并设置媒体选项。
joinChannelEx加入一个频道。
updateChannelMediaOptions在加入频道后更新频道的媒体选项。
updateChannelMediaOptionsEx在加入频道后更新频道媒体选项。
leaveChannel [1/2]离开频道。
leaveChannel [2/2]设置频道选项并离开频道。
leaveChannelEx [1/2]离开频道。
leaveChannelEx [2/2]设置频道选项并离开频道。
preloadChannel预加载指定频道以缩短观众加入频道的时间。
updatePreloadChannelToken更新预加载频道使用的通配 Token。
renewToken更新 Token。
setClientRole [1/2]设置用户角色。
setClientRole [2/2]设置用户角色和观众延迟等级。
getUserInfoByUidEx通过传入用户 ID 获取用户信息。
onClientRoleChanged用户角色或观众延迟等级发生变化时触发的回调。
onClientRoleChangeFailed切换用户角色失败时触发的回调。
onErroronError 回调。报告 SDK 运行时发生的错误。
onJoinChannelSuccess本地用户成功加入频道回调。
onLeaveChannel用户离开频道时触发的回调。
onRejoinChannelSuccessonRejoinChannelSuccess 回调。
onRenewTokenResultrenewToken 方法调用结果回调。
onRequestTokenToken 过期时触发的回调。
onRtcStats报告当前通话的统计信息。
onTokenPrivilegeWillExpireToken 即将在 30 秒后过期时触发的回调。
onUserJoined远端用户或主播加入频道时触发的回调。
onUserOfflineonUserOffline 回调：当远端用户（通信频道场景）或主播（直播频道场景）离开频道时触发。
表格内容超出当前宽度，可横向滚动查看更多列。

发布和订阅

API描述
muteAllRemoteAudioStreams停止或恢复接收所有远端音频流。
muteAllRemoteAudioStreamsEx停止或恢复订阅所有远端用户的音频流。
muteAllRemoteVideoStreams停止或恢复接收所有远端用户的视频流。
muteAllRemoteVideoStreamsEx停止或恢复订阅所有远端用户的视频流。
muteLocalAudioStream控制是否发布本地采集的音频流。
muteLocalAudioStreamEx停止或恢复发布本地音频流。
muteLocalVideoStream控制是否发布本地采集的视频流。
muteLocalVideoStreamEx停止或恢复发布本地视频流。
muteRemoteAudioStream停止或恢复订阅指定远端用户的音频流。
muteRemoteAudioStreamEx停止或恢复接收指定用户的音频流。
muteRemoteVideoStream停止或恢复订阅指定远端用户的视频流。
muteRemoteVideoStreamEx停止或恢复接收指定远端用户的视频流。
setDualStreamMode [1/2]设置发送端的视频流模式，用于控制是否发送视频小流。
setDualStreamMode [2/2]设置发送端不同质量层级的视频流模式。
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 [2/2]设置音频配置文件。
setAudioScenario设置音频场景。
setAudioSessionOperationRestriction设置 SDK 对音频会话的操作权限。
onActiveSpeaker最活跃远端说话人回调。
onAudioVolumeIndicationonAudioVolumeIndication 回调。
onFirstLocalAudioFramePublished本地用户发布首帧音频时触发的回调。
onLocalAudioStateChanged本地音频流状态发生变化回调。
onLocalAudioStats本地音频统计信息回调。
onRemoteAudioStateChanged远端音频状态发生变化回调。
onRemoteAudioStats远端音频流统计信息回调。
onUserMuteAudio远端用户或主播停止或恢复发送音频流回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音频采集

API描述
adjustLoopbackSignalVolume调整声卡采集信号的音量。
adjustRecordingSignalVolume调节采集音频信号的音量。
enableInEarMonitoring启用或关闭耳返功能。
enableLocalAudio启用或关闭本地音频采集功能。
enableLoopbackRecording启用声卡采集功能。
enableLoopbackRecordingEx启用声卡采集功能，将声卡输出混入发送的音频流中。
muteRecordingSignal设置是否静音录制信号。
setInEarMonitoringVolume设置耳返音量。
表格内容超出当前宽度，可横向滚动查看更多列。

人声音效

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

听声辨位

API描述
enableSoundPositionIndication启用或关闭远端用户的立体声声像功能。
setRemoteVoicePosition设置远端用户语音在水平面上的位置和音量。
setRemoteVoicePositionEx设置远端用户语音的二维位置和音量。
表格内容超出当前宽度，可横向滚动查看更多列。

空间音频

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

本地音频合流

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

原始音频数据

API描述
getEarMonitoringAudioParamsonEarMonitoringAudioFrame 回调的音频格式设置回调。
getMixedAudioParamsonMixedAudioFrame 回调的音频格式设置回调。
getObservedAudioFramePosition设置音频数据观察位置。
getPlaybackAudioParams设置 onPlaybackAudioFrame 回调的音频格式。
getRecordAudioParamsonRecordAudioFrame 回调的音频格式设置回调。
registerAudioFrameObserver注册音频帧观测器对象。
setEarMonitoringAudioFrameParameters设置耳返音频数据的格式。
setMixedAudioFrameParameters设置混音后用于音频采集和播放的原始音频数据格式。
setPlaybackAudioFrameBeforeMixingParameters [1/2]设置混音前的原始音频播放数据格式。
setPlaybackAudioFrameBeforeMixingParameters [2/2]设置 onPlaybackAudioFrameBeforeMixing 回调中返回音频数据的格式。
setPlaybackAudioFrameParameters设置原始音频播放数据的格式。
setRecordingAudioFrameParameters设置采集的原始音频数据格式。
onEarMonitoringAudioFrame耳返音频帧回调。
onMixedAudioFrame混合采集和播放音频帧的回调。
onPlaybackAudioFrameonPlaybackAudioFrame 回调：获取用于播放的原始音频帧。
onPlaybackAudioFrameBeforeMixing获取订阅远端用户混音前的音频帧回调。
onRecordAudioFrame采集到音频帧时触发的回调。
表格内容超出当前宽度，可横向滚动查看更多列。

已编码音频数据

API描述
registerAudioEncodedFrameObserver注册编码音频数据的观察器。
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设置视频应用场景。
startPreview [1/2]启用本地视频预览。
startPreview [2/2]启用本地视频预览，并指定用于预览的视频源。
stopPreview [1/2]停止本地视频预览。
stopPreview [2/2]停止本地视频预览。
onFirstLocalVideoFrame本地视频画面首次在本地视图中显示时触发的回调。
onFirstLocalVideoFramePublished首帧本地视频发布时触发的回调。
onFirstRemoteVideoFrame远端视频首帧显示回调。
onLocalVideoEvent本地视频事件发生时触发的回调。
onLocalVideoStateChanged本地视频状态发生变化回调。
onLocalVideoStats本地视频流统计信息回调。
onRemoteVideoStateChanged远端视频状态发生改变回调。
onRemoteVideoStats远端用户发送的视频流统计信息回调。
onUserEnableVideo远端用户启用或关闭视频模块时触发的回调。
onUserMuteVideo远端视频发布状态变化回调。
onVideoPublishStateChanged视频发布状态发生变化回调。
onVideoSizeChanged当指定用户的视频尺寸或旋转发生变化时触发。
表格内容超出当前宽度，可横向滚动查看更多列。

摄像头采集

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

屏幕采集

API描述
getCount获取可共享窗口和屏幕的数量。
getScreenCaptureSources获取可共享的屏幕和窗口列表。
getSourceInfo获取指定可共享窗口或屏幕的信息。
queryScreenCaptureCapability查询设备在屏幕共享时支持的最高帧率。
release释放 IScreenCaptureSourceList。
setExternalMediaProjection配置 SDK 外部的 MediaProjection 以采集屏幕视频流。
setScreenCaptureContentHint设置屏幕共享的内容提示。
setScreenCaptureScenario设置屏幕共享场景。
startScreenCapture [1/2]开始屏幕采集。
startScreenCapture [2/2]从指定的视频源开始屏幕采集。
startScreenCaptureByDisplayId通过指定屏幕 ID 采集屏幕。
startScreenCaptureByWindowId通过指定窗口 ID 采集整个或部分窗口。
stopScreenCapture [1/2]停止屏幕采集。
stopScreenCapture [2/2]停止来自指定视频源的视频采集。
updateScreenCapture更新屏幕采集参数。
updateScreenCaptureParameters更新屏幕采集参数。
updateScreenCaptureRegion更新屏幕共享区域。
表格内容超出当前宽度，可横向滚动查看更多列。

本地截图上传

API描述
enableContentInspect启用或关闭本地截图上传功能。
enableContentInspectEx启用或关闭本地截图上传功能。
takeSnapshot [1/2]截取视频流快照。
takeSnapshot [2/2]截取指定观察点的视频截图。
takeSnapshotEx [1/2]使用连接 ID 对指定用户的视频流进行截图。
takeSnapshotEx [2/2]通过连接 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：设置视频特效的整数参数。
setVideoEffectStringParam设置视频效果的字符串参数。
表格内容超出当前宽度，可横向滚动查看更多列。

人脸检测

API描述
enableFaceDetection启用或关闭本地用户的人脸检测功能。
onFacePositionChanged上报本地用户的人脸检测结果。
表格内容超出当前宽度，可横向滚动查看更多列。

人像锁定

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

直播水印

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

垫片推流

API描述
enableVideoImageSource设置在发布视频流时是否用图片替代当前视频画面。
表格内容超出当前宽度，可横向滚动查看更多列。

视频渲染

API描述
enableInstantMediaRendering启用音视频帧的极速渲染。
setLocalRenderMode [2/2]更新本地视频画面的显示模式。
setLocalRenderTargetFps设置本地视频渲染的最大帧率。
setRemoteRenderMode更新远端用户视频视图的显示模式。
setRemoteRenderModeEx设置指定远端用户的视频显示模式。
setRemoteRenderTargetFps设置远端视频渲染的最大帧率。
setRenderMode设置媒体播放器的渲染模式。
setupLocalVideo初始化本地视频画面。
setupRemoteVideo初始化远端用户的视频视图。
setupRemoteVideoEx初始化远端用户的视频视图。
startMediaRenderingTracing启用视频帧渲染过程的追踪功能。
startMediaRenderingTracingEx启用视频帧渲染过程的追踪。
onTranscodedStreamLayoutInfo本地用户接收到携带视频合图布局信息的合图视频时触发。
onVideoRenderingTracingResult视频帧渲染事件回调。
表格内容超出当前宽度，可横向滚动查看更多列。

原始视频数据

API描述
getMirrorApplied每次 SDK 接收到视频帧时触发的回调，用于设置是否镜像采集的视频。
getObservedFramePosition设置视频观察器的帧位置。
getRotationApplied是否旋转采集视频的回调。
getVideoFormatPreference设置 SDK 输出的原始视频数据格式。
getVideoFrameProcessModegetVideoFrameProcessMode 回调。每次 SDK 接收到视频帧时触发，用于设置视频帧的处理模式。
registerVideoFrameObserver注册原始视频帧观察器对象。
onCaptureVideoFrame本地采集视频帧回调。
onFrame播放器接收到视频帧时触发的回调。
onPreEncodeVideoFrame接收到编码前视频帧回调。
onRenderVideoFrame接收到远端用户发送的视频帧回调。
表格内容超出当前宽度，可横向滚动查看更多列。

已编码视频数据

API描述
registerVideoEncodedFrameObserver注册用于接收编码后视频帧的观察器对象。
onEncodedVideoFrameReceived报告接收端已接收到远端发送的待解码视频帧。
表格内容超出当前宽度，可横向滚动查看更多列。

自定义视频采集和渲染

API描述
createCustomVideoTrack创建一个自定义视频轨道。
destroyCustomVideoTrack销毁指定的视频轨道。
pushVideoFrame通过视频轨道将外部原始视频帧推送到 SDK。
setExternalRemoteEglContext设置用于渲染远端视频流的 EGL 上下文。
setExternalVideoSource配置外部视频源。
表格内容超出当前宽度，可横向滚动查看更多列。

音乐文件播放

API描述
adjustAudioMixingPlayoutVolume调节本地播放的混音音量。
adjustAudioMixingPublishVolume调节用于发布的混音音量。
adjustAudioMixingVolume调节本地和远端的混音音量。
getAudioMixingCurrentPosition获取当前混音的播放进度（毫秒）。
getAudioMixingDuration获取混音文件的总时长（毫秒）。
getAudioMixingPlayoutVolume获取本地播放的混音音量。
getAudioMixingPublishVolume获取用于发布的混音音量。
getAudioTrackCount获取当前音乐文件的音轨索引。
pauseAudioMixing暂停播放和混音的音乐文件。
resumeAudioMixing恢复播放并混音音乐文件。
selectAudioTrack [1/2]选择播放过程中使用的音轨。
selectMultiAudioTrack选择用于本地播放和发布到频道的音轨。
setAudioMixingDualMonoMode设置当前音频文件的声道模式。
setAudioMixingPitch设置本地音乐文件的音调。
setAudioMixingPlaybackSpeed设置当前音频文件的播放速度。
setAudioMixingPosition设置混音文件的播放起始位置。
startAudioMixing [2/2]开始播放音乐文件。
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描述
createMediaPlayer创建一个 IMediaPlayer 对象。
destroyMediaPlayer销毁一个 IMediaPlayer 实例。
getMediaPlayerCacheManager获取一个 IMediaPlayerCacheManager 实例。
表格内容超出当前宽度，可横向滚动查看更多列。

媒体资源打开

API描述
open打开媒体资源。
openWithMediaSource打开媒体文件并配置播放场景。
preloadSrc预加载媒体资源。
switchSrc切换当前正在播放的媒体资源。
unloadSrc卸载预加载的媒体资源。
表格内容超出当前宽度，可横向滚动查看更多列。

媒体资源播放和渲染

API描述
selectAudioTrack [2/2]选择播放过程中使用的音轨。
setAudioDualMonoMode设置当前音频文件的声道模式。
setAudioPitch设置当前媒体资源的音调。
setLoopCount设置音效的循环播放次数。
setPlaybackSpeed设置当前音频文件的播放速度。
setPlayerOption [1/2]设置媒体播放器选项。
setPlayerOption [2/2]设置媒体播放器的参数选项。
setView设置视图。
表格内容超出当前宽度，可横向滚动查看更多列。

播放器控制

API描述
adjustPlayoutVolume调整本地播放音量。
adjustPublishSignalVolume调节用于发布的媒体文件音量。
mute设置是否将媒体文件静音。
pause暂停播放。
play播放媒体文件。
playPreloadedSrc播放预加载的媒体资源。
resume恢复播放媒体文件。
seek跳转到新的播放位置。
stop停止播放媒体轨道。
onSeek定位媒体资源数据时触发的回调。
表格内容超出当前宽度，可横向滚动查看更多列。

播放信息获取

API描述
getAudioBufferDelay获取播放媒体文件时的音频缓冲延迟。
getDuration获取媒体资源的时长。
getMediaPlayerId获取媒体播放器的 ID。
getMute查询媒体资源是否处于静音状态。
getPlayoutVolume获取本地播放音量。
getPlayPosition获取当前音效文件的本地播放进度。
getPlaySrc获取当前正在播放的媒体资源路径。
getPublishSignalVolume获取用于发布的媒体文件音量。
getState获取当前播放状态。
getStreamCount获取媒体资源中的媒体流数量。
getStreamInfo获取媒体流的详细信息。
onPlayerPlaybackStats播放中的媒体文件的统计信息回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音视频观测器

API描述
registerAudioFrameObserver [1/2]注册一个 IAudioPcmFrameSink 音频帧观察者对象。
registerAudioFrameObserver [2/2]注册音频帧观测器对象。
registerPlayerSourceObserver注册媒体播放器观察器。
registerVideoFrameObserver注册视频帧观察器对象。
unregisterAudioFrameObserver取消注册音频帧观察器。
unregisterPlayerSourceObserver释放媒体播放器观察者。
unregisterVideoFrameObserver取消注册视频帧观察器。
onAudioVolumeIndication报告媒体播放器音量的回调。
onFrameonFrame 回调。每次播放器接收到音频帧时触发。
onMetaData [1/2]接收到媒体元数据时触发的回调。
onPlayBufferUpdated报告缓冲数据可支持的播放时长。
onPlayerEvent播放器事件回调。
onPlayerInfoUpdated [1/2]onPlayerInfoUpdated 回调：当媒体播放器信息发生变化时触发。
onPlayerSourceStateChanged播放状态变化回调。
onPlayerSrcInfoChanged媒体资源视频码率发生变化时触发的回调。
onPositionChanged播放进度发生变化回调。
onPreloadEvent预加载媒体资源事件回调。
onReadDataSDK 读取媒体资源数据时触发的回调。
表格内容超出当前宽度，可横向滚动查看更多列。

媒体播放器缓存

API描述
enableAutoRemoveCache设置是否自动删除缓存的媒体文件。
getCacheDir获取待缓存媒体文件的存储路径。
getCacheFileCount获取已缓存的媒体文件数量。
getMaxCacheFileCount获取可缓存的媒体文件的最大数量。
getMaxCacheFileSize获取缓存媒体文件聚合存储空间的最大大小。
removeAllCaches删除媒体播放器中所有缓存的媒体文件。
removeCacheByUri删除缓存的媒体文件。
removeOldCache删除最少使用的缓存媒体文件。
setCacheDir设置要缓存的媒体文件的存储路径。
setMaxCacheFileCount设置可缓存的媒体文件的最大数量。
setMaxCacheFileSize设置缓存媒体文件的聚合存储空间的最大大小。
onPlayerCacheStats上报正在缓存的媒体文件的统计信息。
表格内容超出当前宽度，可横向滚动查看更多列。

版权音乐

API描述
createMusicPlayer创建一个音乐播放器。
destroyMusicPlayer销毁音乐播放器对象。
get获取指定音乐榜单的详细信息。
getCaches获取已缓存的音乐资源信息。
getCount [1/2]获取当前请求中的音乐排行榜数量。
getCount [2/2]获取当前请求中的音乐项数量。
getInternalSongCode创建音乐资源副歌片段的内部歌曲编码。
getLyric获取音乐资源歌词的下载链接。
getMusic获取当前页面中指定音乐资源的详细信息。
getMusicCharts获取所有音乐排行榜。
getMusicCollectionByMusicChartId获取指定音乐榜单 ID 的音乐资源列表。
getPage获取音乐资源列表当前的页码。
getPageSize获取 SDK 实际返回的音乐资源数量。
getSongSimpleInfo获取指定音乐资源的详细信息。
getTotal获取音乐资源列表中的总数。
initialize初始化 IMusicContentCenter。
isPreloaded检查指定音乐资源是否已预加载。
open通过歌曲编码打开音乐资源。
preload [2/2]预加载音乐资源。
registerEventHandler注册 MusicContentCenter 的事件处理器。
release释放 MusicContentCenter 使用的所有资源。
removeCache删除已缓存的音乐资源。
renewToken更新 Token。
searchMusic搜索音乐资源。
setPlayMode设置音乐资源的播放模式。
unregisterEventHandler取消注册 MusicContentCenter 的事件回调。
onLyricResult获取歌词下载链接的回调。
onMusicChartsResult获取音乐排行榜结果的回调。
onMusicCollectionResult获取音乐资源列表的回调。
onPreLoadEvent预加载音乐资源相关事件的回调。
onSongSimpleInfoResult获取音乐资源详细信息的回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音视频录制

API描述
createMediaRecorder创建一个音视频录制器实例。
destroyMediaRecorder销毁音视频录制器对象。
setMediaRecorderObserver注册 IMediaRecorderObserver 观察器。
startAudioRecording [1/3]开始客户端音频录制。
startAudioRecording [2/3]开始客户端音频录制并设置录制采样率。
startAudioRecording [3/3]开始客户端音频录制，并设置录制参数。
startRecording开始录制音视频流。
stopAudioRecording停止客户端音频录制。
stopRecording停止音视频流的录制。
onRecorderInfoUpdated录制信息更新的回调。
onRecorderStateChanged录制状态发生变化时的回调。
表格内容超出当前宽度，可横向滚动查看更多列。

跨频道媒体流转发

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

旁路推流

API描述
startRtmpStreamWithoutTranscoding开始向 CDN 推送未经转码的媒体流。
startRtmpStreamWithoutTranscodingEx开始向 CDN 推送未经转码的媒体流。
startRtmpStreamWithTranscoding开始旁路推流并设置转码配置。
startRtmpStreamWithTranscodingEx开始旁路推流并设置转码配置。
stopRtmpStream停止向指定 CDN 地址推送媒体流。
stopRtmpStreamEx停止向指定 CDN 地址推送媒体流。
updateRtmpTranscoding更新旁路推流的转码配置。
updateRtmpTranscodingEx更新旁路推流的转码配置。
onRtmpStreamingEvent报告旁路推流过程中的事件。
onRtmpStreamingStateChanged旁路推流状态发生变化时触发的回调。
onTranscodingUpdated当发布端的云端转码设置更新时触发的回调。
表格内容超出当前宽度，可横向滚动查看更多列。

数据流 Datastream

API描述
createDataStream [1/2]创建一个数据流。
createDataStream [2/2]创建一个数据流。
createDataStreamEx [1/2]创建一个数据流。
createDataStreamEx [2/2]创建一个数据流。
sendStreamMessage发送数据流消息。
sendStreamMessageEx发送数据流消息。
onStreamMessageonStreamMessage 回调：远端用户发送数据流时触发。
onStreamMessageError本地用户未收到远端用户发送的数据流消息时触发的回调。
表格内容超出当前宽度，可横向滚动查看更多列。

媒体流附属信息分发

API描述
getMaxMetadataSize当 SDK 请求元数据最大大小时触发的回调。
registerMediaMetadataObserver注册元数据观察器。
unregisterMediaMetadataObserver取消注册指定的元数据观察器。
onMetadataReceived当本地用户接收到 metadata 时触发的回调。
onReadyToSendMetadata当 SDK 准备好发送元数据时触发的回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音频路由

API描述
isSpeakerphoneEnabled检查扬声器是否启用。
setDefaultAudioRouteToSpeakerphone设置默认音频播放路由。
setEnableSpeakerphone设置是否将音频路由切换为扬声器。
setRouteInCommunicationMode设置通信音频模式下的音频播放路由。
onAudioRoutingChanged本地音频路由发生变化时触发的回调。
表格内容超出当前宽度，可横向滚动查看更多列。

视频设备管理

API描述
enableMultiCamera启用或关闭多摄像头采集功能。
enumerateVideoDevices枚举系统中的视频设备。
getCameraMaxZoomFactor获取摄像头支持的最大变焦倍数。
getCapability获取指定视频格式下的视频采集设备的帧信息。
getCount获取系统中已索引的视频采集设备总数。
getDevice获取指定索引的视频设备的信息。
getDevice获取当前的视频采集设备。
isCameraAutoExposureFaceModeSupported检查设备是否支持自动曝光功能。
isCameraAutoFocusFaceModeSupported检查设备是否支持人脸自动对焦功能。
isCameraExposurePositionSupported检查设备是否支持手动曝光。
isCameraExposureSupported查询当前摄像头是否支持调节曝光值。
isCameraFaceDetectSupported检查设备摄像头是否支持人脸检测。
isCameraFocusSupported检查设备是否支持手动对焦功能。
isCameraTorchSupported检查设备是否支持摄像头闪光灯。
isCameraZoomSupported检查设备是否支持摄像头变焦。
numberOfCapabilities获取指定视频采集设备支持的视频格式数量。
queryCameraFocalLengthCapability查询摄像头支持的焦距能力。
queryCodecCapability查询 SDK 支持的视频编解码器能力。
release释放 IVideoDeviceCollection 对象占用的所有资源。
release释放 IVideoDeviceManager 对象占用的所有资源。
setCameraAutoExposureFaceModeEnabled设置是否启用自动曝光功能。
setCameraAutoFocusFaceModeEnabled启用摄像头人脸自动对焦功能。
setCameraCapturerConfiguration设置摄像头采集配置。
setCameraDeviceOrientation设置采集视频的旋转角度。
setCameraExposureFactor设置摄像头曝光值。
setCameraExposurePosition设置相机曝光位置。
setCameraFocusPositionInPreview设置摄像头手动对焦位置。
setCameraTorchOn打开或关闭摄像头闪光灯。
setCameraZoomFactor设置摄像头变焦倍数。
setDevice指定设备 ID 对应的设备。
setDevice指定视频采集设备的设备 ID。
switchCamera切换前后摄像头。
onCameraExposureAreaChanged摄像头曝光区域发生变化回调。
onCameraFocusAreaChangedonCameraFocusAreaChanged 回调。当摄像头对焦区域发生变化时触发。
onVideoDeviceStateChanged视频设备状态变化回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音频设备管理

API描述
enumeratePlaybackDevices枚举系统中的音频播放设备。
enumerateRecordingDevices枚举音频采集设备。
followSystemLoopbackDevice设置是否跟随系统默认音频播放设备。
followSystemPlaybackDevice设置 SDK 是否跟随系统默认音频播放设备。
followSystemRecordingDevice设置 SDK 是否跟随系统默认音频录制设备。
getApplicationVolume获取 App 的音量。
getAudioDeviceInfo获取音频设备信息。
getCount获取音频播放设备或音频采集设备的总数。
getDefaultDevice [2/2]获取系统默认音频设备及其类型。
getDefaultDevice [1/2]获取系统默认音频设备。
getDevice [2/2]按索引获取音频设备的名称、类型和 ID。
getDevice [1/2]获取指定索引的视频设备的信息。
getLoopbackDevice获取当前的声卡采集设备。
getPlaybackDevice检索与设备 ID 关联的音频播放设备。
getPlaybackDeviceInfo [1/2]获取音频播放设备的信息。
getPlaybackDeviceInfo [2/2]获取音频播放设备的信息和类型。
getPlaybackDeviceMute获取音频播放设备的静音状态。
getPlaybackDeviceVolume获取音频播放设备的音量。
getRecordingDevice获取当前音频录制设备的设备 ID。
getRecordingDeviceInfo [1/2]获取音频录制设备的信息。
getRecordingDeviceInfo [2/2]获取音频采集设备的信息和类型。
getRecordingDeviceMute获取音频采集设备的静音状态。
getRecordingDeviceVolume获取音频录制设备的音量。
isApplicationMute检查应用是否处于静音状态。
release释放 IAudioDeviceCollection 对象占用的所有资源。
release释放 IAudioDeviceManager 对象占用的所有资源。
setApplicationMute设置是否静音 App。
setApplicationVolume设置应用程序的音量。
setDevice指定视频采集设备的设备 ID。
setLoopbackDevice设置 SDK 的声卡采集设备。
setPlaybackDevice设置音频播放设备。
setPlaybackDeviceMute设置是否静音音频播放设备。
setPlaybackDeviceVolume设置音频播放设备的音量。
setRecordingDevice设置音频采集设备。
setRecordingDeviceMute设置音频采集设备的静音状态。
setRecordingDeviceVolume设置音频采集设备的音量。
startAudioDeviceLoopbackTest开始音频设备回路测试。
startPlaybackDeviceTest开始本地音频播放设备测试。
startRecordingDeviceTest开始音频采集设备测试。
stopAudioDeviceLoopbackTest停止音频设备回路测试。
stopPlaybackDeviceTest停止音频播放设备测试。
stopRecordingDeviceTest停止音频采集设备测试。
onAudioDeviceStateChanged音频设备状态发生变化回调。
onAudioDeviceVolumeChanged音频设备或 App 音量变化时触发的回调。
表格内容超出当前宽度，可横向滚动查看更多列。

插件

API描述
enableExtension启用或禁用插件。
getExtensionProperty获取扩展属性。
loadExtensionProvider加载扩展。
registerExtension注册一个扩展。
setExtensionProperty设置插件的属性。
setExtensionProviderProperty设置扩展提供方的属性。
onExtensionErrorWithContext扩展运行异常时触发的回调。
onExtensionEventWithContext扩展事件回调。
onExtensionStartedWithContextonExtensionStartedWithContext 回调。当扩展启用成功时触发。
onExtensionStoppedWithContextonExtensionStoppedWithContext 回调：扩展被禁用时触发。
表格内容超出当前宽度，可横向滚动查看更多列。

网络及其他

API描述
complain允许用户在通话结束后投诉通话质量。
enableEncryption启用或关闭内置加密功能。
enableEncryptionEx启用或关闭内置加密功能。
getCallId获取当前通话 ID。
getCallIdEx获取与连接 ID 对应的通话 ID。
getConnectionState获取 SDK 当前的连接状态。
getConnectionStateEx获取 SDK 当前的连接状态。
getCurrentMonotonicTimeInMs获取 SDK 当前的单调时间。
getErrorDescriptiongetErrorDescription：获取警告或错误描述。
getNetworkType获取本地网络连接类型。
getNtpWallTimeInMs获取当前的 NTP（网络时间协议）时间。
getVersion获取 SDK 版本号。
isFeatureAvailableOnDevice检查当前设备是否支持指定的高级功能。
queryDeviceScore查询设备评分。
queryInterface获取指定接口的指针。
rate允许用户在通话结束后对通话进行评分。
registerPacketObserver注册一个数据包观察器。
sendCustomReportMessage上报自定义消息。
sendCustomReportMessageEx支持上报和分析自定义消息。
setAVSyncSource设置发送端的音视频同步。
setCloudProxy设置云代理服务。
setLocalAccessPoint配置连接到声网私有媒体服务器接入模块。
setParameters通过配置 JSON 选项为 SDK 提供技术预览功能或特殊定制。
setRemoteSubscribeFallbackOption根据网络状况设置订阅端的视频流回退选项。
startEchoTest启动音视频通话回路测试。
startLastmileProbeTest启动 Last-mile 网络探测测试。
stopEchoTest停止音频通话测试。
stopLastmileProbeTest停止 Last-mile 网络探测测试。
onConnectionLostonConnectionLost 回调。当 SDK 与声网边缘服务器的连接中断后 10 秒内无法重新连接时触发。
onConnectionStateChanged网络连接状态发生变化时触发的回调。
onEncryptionError报告内置加密错误的回调。
onLastmileProbeResult上行和下行 Last-mile 网络探测结果回调。
onLastmileQuality报告本地用户的 Last-mile 网络质量回调。
onMultipathStats多路径传输统计信息的回调。
onNetworkQuality报告频道中每个用户的 Last-mile 网络质量。
onNetworkTypeChanged本地网络类型发生变化时触发的回调。
onPermissionError报告 SDK 无法获取设备权限。
onPermissionGranted权限被授予时的回调。
onProxyConnected代理连接状态回调。
onReceiveAudioPacket当本地用户接收到音频包时触发的回调。
onReceiveVideoPacket本地用户接收到视频数据包时触发的回调。
onRemoteSubscribeFallbackToAudioOnly远端媒体流因网络变化在音频流与视频流之间切换时触发的回调。
onSendAudioPacket本地用户发送音频包时触发的回调。
onSendVideoPacket本地用户发送视频数据包时触发的回调。
onUplinkNetworkInfoUpdated上行网络信息发生变化时触发的回调。
表格内容超出当前宽度，可横向滚动查看更多列。

咨询电话

400 632 6626

上海声网科技有限公司

Copyright © 2026 声网保留所有权利