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

API 概览

  • C#

更新时间不可用

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

初始化相关

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

频道相关

方法/回调描述
SetChannelProfile设置频道场景。
JoinChannel [2/2]设置媒体选项并加入频道。
JoinChannelEx加入频道。
UpdateChannelMediaOptions加入频道后更新频道媒体选项。
UpdateChannelMediaOptionsEx加入频道后更新频道媒体选项。
LeaveChannelEx [1/2]离开频道。
LeaveChannel [2/2]设置频道选项并离开频道。
LeaveChannelEx [2/2]设置频道选项并离开频道。
PreloadChannel使用 token、channelId、uid 预加载频道。
PreloadChannelWithUserAccount使用 token、channelId、userAccount 预加载频道。
UpdatePreloadChannelToken更新预加载频道的通配 Token。
RenewToken更新 Token。
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 [2/2]在发送端设置双流模式并设置视频小流。
SetDualStreamModeEx在发送端设置双流模式。
OnAudioPublishStateChanged音频发布状态改变回调。
OnAudioSubscribeStateChanged音频订阅状态发生改变回调。
OnVideoSubscribeStateChanged视频订阅状态发生改变回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音频基础功能

方法/回调描述
AdjustUserPlaybackSignalVolume调节本地播放的指定远端用户信号音量。
AdjustUserPlaybackSignalVolumeEx调节本地播放的指定远端用户信号音量。
AdjustPlaybackSignalVolume调节本地播放的所有远端用户信号音量。
EnableAudio启用音频模块。
DisableAudio关闭音频模块。
EnableAudioVolumeIndication启用用户音量提示。
EnableAudioVolumeIndicationEx

启用用户音量提示。

SetAudioScenario设置音频场景。
OnAudioVolumeIndication用户音量提示回调。
OnActiveSpeaker监测到远端最活跃用户回调。
OnLocalAudioStateChanged本地音频状态发生改变回调。
OnFirstLocalAudioFramePublished已发布本地音频首帧回调。
OnFirstRemoteAudioFrame已接收远端音频首帧回调。
OnUserMuteAudio远端用户（通信场景）/主播（直播场景）停止或恢复发送音频流回调。
OnRemoteAudioStateChanged远端音频流状态发生改变回调。
OnLocalAudioStats通话中本地音频流的统计信息回调。
OnRemoteAudioStats通话中远端音频流的统计信息回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音频采集

方法/回调描述
EnableLocalAudio开启或关闭本地音频采集。
EnableLoopbackRecording开启声卡采集。
EnableLoopbackRecordingEx开启声卡采集。
AdjustRecordingSignalVolume调节音频采集信号音量。
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获取 ILocalSpatialAudioEngine 对象。
Initialize初始化 ILocalSpatialAudioEngine。
Dispose销毁 ILocalSpatialAudioEngine。
UpdateSelfPosition更新本地用户的空间位置。
UpdateRemotePosition更新远端用户的空间位置信息。
RemoveRemotePosition删除指定远端用户的空间位置信息。
ClearRemotePositions删除所有远端用户的空间位置信息。
SetHeadphoneEQParameters设置耳机均衡器的低频和高频参数。
SetHeadphoneEQPreset设置预设的耳机均衡效果。
StartLocalAudioMixer开启本地音频合流。
UpdateLocalAudioMixerConfiguration更新本地音频合流的配置。
StopLocalAudioMixer停止本地音频合流。
表格内容超出当前宽度，可横向滚动查看更多列。

原始音频数据

方法/回调描述
RegisterAudioFrameObserver注册音频观测器对象。
UnRegisterAudioFrameObserver取消注册音频帧观测器。
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设置视频编码属性。
StartPreview [2/2]开启视频预览并指定预览的视频源。
StopPreview [2/2]停止视频预览。
OnLocalVideoStateChanged本地视频状态发生改变回调。
OnLocalVideoStats本地视频流统计信息回调。
OnFirstLocalVideoFramePublished已发布本地视频首帧回调。
OnVideoPublishStateChanged视频发布状态改变回调。
OnVideoSizeChanged本地或远端视频大小和旋转信息发生改变回调。
OnRemoteVideoStateChanged远端视频状态发生改变回调。
OnRemoteVideoStats通话中远端视频流的统计信息回调。
OnFirstLocalVideoFrame已显示本地视频首帧回调。
OnFirstRemoteVideoFrame渲染器已接收首帧远端视频回调。
OnFirstRemoteVideoDecoded已接收到远端视频并完成解码回调。
OnUserMuteVideo远端用户取消或恢复发布视频流回调。
OnUserEnableVideo远端用户开/关视频模块回调。
表格内容超出当前宽度，可横向滚动查看更多列。

视频采集

方法/回调描述
EnableLocalVideo开关本地视频采集。
StartCameraCapture开始通过摄像头采集视频。
StopCameraCapture停止通过摄像头采集视频。
表格内容超出当前宽度，可横向滚动查看更多列。

屏幕共享

方法/回调描述
GetScreenCaptureSources获取可共享的屏幕和窗口对象列表。
StartScreenCaptureByWindowId开始采集指定窗口的视频流。
StartScreenCaptureByDisplayId开始采集指定屏幕的视频流。
SetScreenCaptureContentHint设置屏幕共享内容类型。
UpdateScreenCaptureRegion更新屏幕采集的区域。
StartScreenCapture [2/2]开始屏幕采集并指定视频源。
UpdateScreenCaptureParameters更新屏幕采集的参数配置。
StopScreenCapture [1/2]停止屏幕采集。
StopScreenCapture [2/2]停止对指定的视频源进行屏幕采集。
SetScreenCaptureScenario设置屏幕共享的场景。
表格内容超出当前宽度，可横向滚动查看更多列。

视频前处理和后处理

方法/回调描述
EnableContentInspect开启/关闭本地截图上传。
TakeSnapshot [1/2]对视频截图。
TakeSnapshot [2/2]在指定观测位置进行视频截图。
TakeSnapshotEx [1/2]使用连接 ID 获取视频截图。
TakeSnapshotEx [2/2]使用连接 ID 获取指定观测位置的视频截图。
EnableVirtualBackground开启/关闭虚拟背景。
StartLocalVideoTranscoder开启本地合图。
StopLocalVideoTranscoder停止本地合图。
UpdateLocalTranscoderConfiguration更新本地合图配置。
OnLocalVideoTranscoderError本地合图发生错误回调。
EnableVideoImageSource设置是否开启垫片推流功能。
SetBeautyEffectOptions设置美颜效果选项。
SetColorEnhanceOptions设置色彩增强功能。
SetLowlightEnhanceOptions设置暗光增强功能。
SetVideoDenoiserOptions设置视频降噪功能。
SetFilterEffectOptions设置滤镜效果选项并指定媒体源。
SetFaceShapeBeautyOptions设置美型效果选项并指定媒体源。
SetFaceShapeAreaOptions设置美型部位选项并指定媒体源。
GetFaceShapeBeautyOptions获取美型效果选项。
GetFaceShapeAreaOptions获取美型部位选项。
EnableFaceDetection开启/关闭本地人脸检测。
OnFacePositionChanged报告本地人脸检测结果。
IsCameraCenterStageSupported查询摄像头是否支持人像锁定。
EnableCameraCenterStage开启或关闭人像锁定功能。
OnSnapshotTaken视频截图结果回调。
AddVideoWatermark [2/2]添加本地视频水印。
AddVideoWatermarkEx添加本地视频水印。
ClearVideoWatermarks删除已添加的视频水印。
ClearVideoWatermarkEx删除已添加的视频水印。
表格内容超出当前宽度，可横向滚动查看更多列。

视频渲染

方法/回调描述
SetRenderMode设置播放器视图的渲染模式。
SetLocalRenderMode [2/2]更新本地视图显示模式。
SetRemoteRenderMode更新远端视图显示模式。
SetLocalRenderTargetFps设置本地视频渲染的最大帧率。
SetRemoteRenderTargetFps设置视频在远端渲染的最大帧率。
SetView设置播放器渲染视图。
EnableInstantMediaRendering开启音视频帧加速渲染。
StartMediaRenderingTracing开启视频帧渲染数据打点。
StartMediaRenderingTracingEx开启视频帧渲染数据打点。
OnVideoRenderingTracingResult视频帧渲染事件回调。
表格内容超出当前宽度，可横向滚动查看更多列。

原始视频数据

方法/回调描述
RegisterVideoFrameObserver注册原始视频观测器对象。
OnCaptureVideoFrame获取本地设备采集到的视频数据。
OnPreEncodeVideoFrame获取本地视频编码前的视频数据。
OnRenderVideoFrame获取远端发送的视频数据。
表格内容超出当前宽度，可横向滚动查看更多列。

已编码视频数据

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

自定义视频采集和渲染

方法/回调描述
CreateCustomVideoTrack创建一个自定义的视频轨道。
DestroyCustomVideoTrack销毁指定的视频轨道。
SetExternalVideoSource设置外部视频源。
PushVideoFrame将外部原始视频帧通过自定义视频轨道发布到频道中。
表格内容超出当前宽度，可横向滚动查看更多列。

音乐文件播放

方法/回调描述
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报告当前缓存中的媒体资源的相关信息。
表格内容超出当前宽度，可横向滚动查看更多列。

音视频录制

方法/回调描述
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 观测器。
OnMetaData报告已获取媒体附属信息。
OnMetadataReceived接收端已收到 metadata。
表格内容超出当前宽度，可横向滚动查看更多列。

插件相关

方法/回调描述
LoadExtensionProvider加载插件。
RegisterExtension注册插件。
EnableExtension启用/禁用插件。
GetExtensionProperty获取插件的详细信息。
SetExtensionProperty设置插件的属性。
SetExtensionProviderProperty设置插件服务商的属性。
OnExtensionStartedWithContext插件已启用成功回调。
OnExtensionStoppedWithContext插件已禁用回调。
OnExtensionEventWithContext插件事件回调。
表格内容超出当前宽度，可横向滚动查看更多列。

网络及其他

方法/回调描述
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。
Rate给通话评分。
Complain投诉通话质量。
GetConnectionState获取当前网络连接状态。
GetConnectionStateEx获取当前网络连接状态。
GetVersion获取 SDK 版本。
GetErrorDescription获取警告或错误描述。
GetNativeHandler获取 Native SDK 的 C++ 句柄。
GetNetworkType获取本地网络连接类型。
GetNtpWallTimeInMs获取当前的 NTP (网络时间协议) 时间。
EnableEncryption开启或关闭内置加密。
EnableEncryptionEx开启或关闭内置加密。
SendCustomReportMessage发送自定义上报消息。
SendCustomReportMessageEx自定义数据上报和分析服务。
SetRemoteSubscribeFallbackOption设置弱网环境下订阅的音视频流回退选项。
OnRemoteSubscribeFallbackToAudioOnly订阅流已回退为音频流或恢复为音视频流回调。
OnEncryptionError内置加密出错回调。
OnProxyConnected代理连接状态回调。
OnNetworkQuality通话中每个用户的网络上下行 last mile 质量报告回调。
OnRtcStats当前通话相关的统计信息回调。
OnPermissionError获取设备权限出错回调。
表格内容超出当前宽度，可横向滚动查看更多列。

咨询电话

400 632 6626

上海声网科技有限公司

Copyright © 2026 声网保留所有权利