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

API 概览

  • Unreal Blueprint

更新时间不可用

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

初始化相关

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

频道相关

方法/回调描述
SetChannelProfile设置频道场景。
JoinChannelWithOptions设置媒体选项并加入频道。
JoinChannelEx加入频道。
UpdateChannelMediaOptions加入频道后更新频道媒体选项。
UpdateChannelMediaOptionsEx加入频道后更新频道媒体选项。
LeaveChannelWithOptions设置频道选项并离开频道。
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网络连接状态已改变回调。
OnRequestTokenToken 已过期回调。
OnTokenPrivilegeWillExpireToken 即将在 30s 内过期回调。
OnError发生错误回调。
表格内容超出当前宽度，可横向滚动查看更多列。

发布和订阅

方法/回调描述
MuteLocalAudioStream取消或恢复发布本地音频流。
MuteLocalAudioStreamEx取消或恢复发布本地音频流。
MuteRemoteAudioStream取消或恢复订阅指定远端用户的音频流。
MuteRemoteAudioStreamEx停止/恢复接收指定的音频流。
MuteAllRemoteAudioStreams取消或恢复订阅所有远端用户的音频流。
MuteAllRemoteAudioStreamsEx取消或恢复订阅所有远端用户的音频流。
MuteLocalVideoStream取消或恢复发布本地视频流。
MuteLocalVideoStreamEx取消或恢复发布本地视频流。
MuteRemoteVideoStream取消或恢复订阅指定远端用户的视频流。
MuteRemoteVideoStreamEx停止/恢复接收指定的视频流。
MuteAllRemoteVideoStreams取消或恢复订阅所有远端用户的视频流。
MuteAllRemoteVideoStreamsEx取消或恢复订阅所有远端用户的视频流。
SetSubscribeAudioBlocklist设置音频订阅黑名单。
SetSubscribeAudioBlocklistEx

设置音频订阅黑名单。

SetSubscribeAudioAllowlist设置音频订阅白名单。
SetSubscribeAudioAllowlistEx

设置音频订阅白名单。

SetSubscribeVideoBlocklist设置视频订阅黑名单。
SetSubscribeVideoBlocklistEx

设置视频订阅黑名单。

SetSubscribeVideoAllowlist设置视频订阅白名单。
SetSubscribeVideoAllowlistEx

设置视频订阅白名单。

SetRemoteVideoStreamType设置订阅的视频流类型。
SetRemoteVideoStreamTypeEx设置订阅的视频流类型。
SetRemoteDefaultVideoStreamType设置默认订阅的视频流类型。
SetDualStreamMode在发送端设置双流模式并设置视频小流。
SetDualStreamModeEx在发送端设置双流模式。
OnAudioPublishStateChanged音频发布状态改变回调。
OnAudioSubscribeStateChanged音频订阅状态发生改变回调。
OnVideoSubscribeStateChanged视频订阅状态发生改变回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音频基础功能

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

启用用户音量提示。

SetAudioProfileAndScenario设置音频编码属性和音频场景。
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 位置，即水平面位置。
表格内容超出当前宽度，可横向滚动查看更多列。

视频基础功能

方法/回调描述
EnableVideo启用视频模块。
DisableVideo关闭视频模块。
SetVideoScenario设置视频业务场景。
SetVideoEncoderConfiguration设置视频编码属性。
SetVideoEncoderConfigurationEx设置视频编码属性。
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）
StartScreenCapture开始屏幕采集。（仅适用于 Android 和 iOS）
StartScreenCaptureBySourceType开始屏幕采集并指定视频源。（仅适用于 Windows 和 macOS）
UpdateScreenCapture更新屏幕采集的参数配置。（仅适用于 Android 和 iOS）
UpdateScreenCaptureParameters更新屏幕采集的参数配置。（仅适用于 Windows 和 macOS）
StopScreenCapture停止屏幕采集。
StopScreenCaptureBySourceType停止对指定的视频源进行屏幕采集。（仅适用于 Windows 和 macOS）
GetCount获取可共享的窗口和屏幕的个数。（仅适用于 Windows 和 macOS）
GetSourceInfo获取指定的可共享窗口或屏幕的信息。（仅适用于 Windows 和 macOS）
Release释放 IScreenCaptureSourceList。（仅适用于 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更新远端视图显示模式。
SetRemoteRenderModeEx设置远端视图显示模式。
SetLocalRenderTargetFps设置本地视频渲染的最大帧率。
SetRemoteRenderTargetFps设置视频在远端渲染的最大帧率。
SetView设置播放器渲染视图。
SetupLocalVideo初始化本地视图。
SetupRemoteVideo初始化远端用户视图。
SetupRemoteVideoEx初始化远端用户视图。
EnableInstantMediaRendering开启音视频帧加速渲染。
StartMediaRenderingTracing开启视频帧渲染数据打点。
StartMediaRenderingTracingEx开启视频帧渲染数据打点。
OnVideoRenderingTracingResult视频帧渲染事件回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音乐文件播放

方法/回调描述
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虚拟节拍器状态发生改变回调。
表格内容超出当前宽度，可横向滚动查看更多列。

媒体播放器

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

方法/回调描述
GetAgoraMediaPlayer创建媒体播放器对象。
IMediaPlayer提供媒体播放器功能的类，支持多实例。
IMediaPlayerSourceObserver提供媒体播放器的回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音视频录制

方法/回调描述
StartAudioRecording开始客户端录音并进行录音配置。
StopAudioRecording停止客户端录音。
表格内容超出当前宽度，可横向滚动查看更多列。

跨频道媒体流转发

方法/回调描述
StartOrUpdateChannelMediaRelay开始或更新跨频道媒体流转发。
StartOrUpdateChannelMediaRelayEx开始或更新跨频道媒体流转发。
StopChannelMediaRelay停止跨频道媒体流转发。一旦停止，主播会退出所有目标频道。
StopChannelMediaRelayEx停止跨频道媒体流转发。一旦停止，主播会退出所有目标频道。
PauseAllChannelMediaRelay暂停向所有目标频道转发媒体流。
PauseAllChannelMediaRelayEx暂停向所有目标频道转发媒体流。
ResumeAllChannelMediaRelay恢复向所有目标频道转发媒体流。
ResumeAllChannelMediaRelayEx恢复向所有目标频道转发媒体流。
OnChannelMediaRelayStateChanged跨频道媒体流转发状态发生改变回调。
表格内容超出当前宽度，可横向滚动查看更多列。

旁路推流

方法/回调描述
StartRtmpStreamWithoutTranscoding开始非转码推流。
StartRtmpStreamWithoutTranscodingEx开始非转码推流。
StartRtmpStreamWithTranscoding开始旁路推流并设置转码属性。
StartRtmpStreamWithTranscodingEx开始旁路推流并设置转码属性。
UpdateRtmpTranscoding更新旁路推流转码属性。
UpdateRtmpTranscodingEx更新旁路推流转码属性。
StopRtmpStream结束旁路推流。
StopRtmpStreamEx结束旁路推流。
OnRtmpStreamingEvent旁路推流事件回调。
OnRtmpStreamingStateChanged旁路推流状态发生改变回调。
OnTranscodingUpdated旁路推流转码设置已被更新回调。
表格内容超出当前宽度，可横向滚动查看更多列。

数据流

方法/回调描述
CreateDataStream创建数据流。
CreateDataStreamEx创建数据流。
SendStreamMessage发送数据流。
OnStreamMessage接收到对方数据流消息的回调。
OnStreamMessageError接收对方数据流消息发生错误的回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音频路由

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

方法/回调描述
SetDefaultAudioRouteToSpeakerphone设置默认的音频路由。
SetEnableSpeakerphone开启或关闭扬声器播放。
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)
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获取音频播放设备信息及其类型。（仅适用于 macOS）
SetPlaybackDeviceVolume设置播放设备音量。（仅适用于 Windows）
SetRecordingDevice指定音频采集设备。（仅适用于 Windows 和 macOS）
GetRecordingDevice获取当前音频采集设备。（仅适用于 Windows 和 macOS）
GetRecordingDeviceInfo获取音频采集设备信息及其类型。（仅适用于 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获取系统默认的音频设备。（仅适用于 Windows 和 macOS）
GetDevice获取指定 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 质量探测报告回调。
QueryDeviceScore查询设备评分等级。
SetAVSyncSource设置发流端音画同步。
SetCloudProxy设置云代理服务。
SetLocalAccessPoint配置与声网私有媒体服务器接入模块的连接。
SetParametersSDK 的 JSON 配置信息，用于提供技术预览或特别定制功能。
GetCallId获取通话 ID。
GetCallIdEx使用连接 ID 获取通话 ID。
IsFeatureAvailableOnDevice查询设备是否支持指定进阶功能。
Rate给通话评分。
Complain投诉通话质量。
GetConnectionState获取当前网络连接状态。
GetConnectionStateEx获取当前网络连接状态。
GetVersion获取 SDK 版本。
GetErrorDescription获取警告或错误描述。
GetNetworkType获取本地网络连接类型。
GetNtpWallTimeInMs获取当前的 NTP (网络时间协议) 时间。
EnableEncryption开启或关闭内置加密。
EnableEncryptionEx开启或关闭内置加密。
SendCustomReportMessage发送自定义上报消息。
SendCustomReportMessageEx自定义数据上报和分析服务。
SetRemoteSubscribeFallbackOption设置弱网环境下订阅的音视频流回退选项。
OnRemoteSubscribeFallbackToAudioOnly订阅流已回退为音频流或恢复为音视频流回调。
OnEncryptionError内置加密出错回调。
OnProxyConnected代理连接状态回调。
OnNetworkQuality通话中每个用户的网络上下行 last mile 质量报告回调。
OnRtcStats当前通话相关的统计信息回调。
OnPermissionError获取设备权限出错回调。
表格内容超出当前宽度，可横向滚动查看更多列。

咨询电话

400 632 6626

上海声网科技有限公司

Copyright © 2026 声网保留所有权利