C++ API Reference for All Platforms
概览
IRtcEngine
IRtcEngineEventHandler
IChannel
IChannelEventHandler
IAudioDeviceManager
IVideoDeviceManager
声网通过全球部署的虚拟网络，提供可以灵活搭配的 API 组合，为移动端到移动端以及移动端到 Web 端提供质量可靠的实时音视频通信。
- 自 v2.3.3 开始，C++ API Reference for All Platforms 可以在 Dash 平台下载，详见 FAQ。
- 自 v3.0.0 开始，声网废弃
RtcEngineParameters类。该类下所有接口均被 IRtcEngine 类覆盖，请使用IRtcEngine类。- 在调用 API 过程中，SDK 可能会返回错误码和警告码，详见错误码和警告码。
- IRtcEngine 类包含应用程序调用的主要方法。
- IRtcEngineEventHandler 类用于向应用程序发送回调通知。
- IChannel 类在指定频道中实现实时音视频功能。通过创建多个
IChannel对象，用户可以同时加入多个频道。 - IChannelEventHandler 类监听和报告指定频道的事件和数据。
- IAudioDeviceManager 类提供用于测试音频设备的相关接口。
- IVideoDeviceManager 类提供用于测试视频设备的相关接口。
核心方法
| 方法 | 描述 |
|---|---|
| createAgoraRtcEngine | 创建 IRtcEngine 对象并返回指针。 |
| initialize | 初始化 SDK 服务。 |
| release | 销毁 IRtcEngine 对象。 |
| setChannelProfile | 设置频道场景。 |
| setClientRole [1/2] | 设置直播场景下的用户角色。 |
| setClientRole [2/2] | 设置直播场景下的用户角色和级别。 |
| joinChannel [1/2] | 加入频道。 |
| joinChannel [2/2] | 加入频道并设置发布和订阅状态。 |
| switchChannel [1/2] | 快速切换直播频道。 |
| switchChannel [2/2] | 快速切换直播频道并设置订阅状态。 |
| leaveChannel | 离开频道。 |
| renewToken | 更新 Token。 |
| getConnectionState | 获取当前网络连接状态。 |
核心事件
| 事件 | 描述 |
|---|---|
| onConnectionStateChanged | 网络连接状态已改变回调。 |
| onJoinChannelSuccess | 加入频道回调。 |
| onRejoinChannelSuccess | 重新加入频道回调。 |
| onLeaveChannel | 离开频道回调。 |
| onClientRoleChanged | 直播场景下用户角色切换成功回调。 |
| onClientRoleChangeFailed | 直播场景下切换用户角色失败回调。 |
| onUserJoined | 远端用户（通信场景）/主播（直播场景）加入当前频道回调。 |
| onUserOffline | 远端用户（通信场景）/主播（直播场景）离开当前频道回调。 |
| onNetworkTypeChanged | 本地网络类型发生改变回调。 |
| onConnectionLost | 网络连接丢失回调。 |
| onTokenPrivilegeWillExpire | Token 服务即将过期回调。 |
| onRequestToken | Token 已过期回调。 |
音频管理
| 方法 | 描述 |
|---|---|
| enableAudio | 启用音频模块。 |
| disableAudio | 关闭音频模块。 |
| setAudioProfile | 设置音频编码属性。 |
| adjustRecordingSignalVolume | 调节麦克风采集信号音量。 |
| adjustLoopbackRecordingSignalVolume | 调节声卡采集信号音量。（仅适用于 Windows 和 macOS） |
| adjustUserPlaybackSignalVolume | 调节本地播放的指定远端用户信号音量。 |
| adjustPlaybackSignalVolume | 调节本地播放的所有远端用户信号音量。 |
| enableLocalAudio | 开关本地音频采集。 |
| muteLocalAudioStream | 取消或恢复发布本地音频流。 |
| muteRemoteAudioStream | 取消或恢复订阅指定远端用户的音频流。 |
| muteAllRemoteAudioStreams | 取消或恢复订阅所有远端用户的音频流。 |
视频管理
| 方法 | 描述 |
|---|---|
| enableVideo | 启用视频模块。 |
| disableVideo | 关闭视频模块。 |
| setVideoEncoderConfiguration | 设置视频编码属性。 |
| setupLocalVideo | 初始化本地视图 |
| setupRemoteVideo | 初始化远端用户视图。 |
| setLocalRenderMode | 更新本地视图显示模式。 |
| setRemoteRenderMode | 更新远端视图显示模式。 |
| startPreview | 开启视频预览。 |
| stopPreview | 停止视频预览。 |
| enableLocalVideo | 开关本地视频采集。 |
| muteLocalVideoStream | 取消或恢复发布本地视频流。 |
| muteRemoteVideoStream | 取消或恢复订阅指定远端用户的视频流。 |
| muteAllRemoteVideoStreams | 取消或恢复订阅所有远端用户的视频流。 |
本地媒体事件
| 事件 | 描述 |
|---|---|
| onLocalAudioStateChanged | 本地音频状态改变回调。 |
| onLocalVideoStateChanged | 本地视频状态发生改变回调。 |
| onFirstLocalAudioFramePublished | 已发布本地音频首帧回调。 |
| onFirstLocalVideoFramePublished | 已发布本地视频首帧回调。 |
| onFirstLocalVideoFrame | 已显示本地视频首帧回调。 |
| onAudioPublishStateChanged | 音频发布状态改变回调。 |
| onVideoPublishStateChanged | 视频发布状态改变回调。 |
远端媒体事件
| 事件 | 描述 |
|---|---|
| onRemoteAudioStateChanged | 远端用户音频流状态已变化回调。 |
| onRemoteVideoStateChanged | 远端用户视频流状态已变化回调。 |
| onFirstRemoteVideoFrame | 已显示远端视频首帧回调。 |
| onFirstRemoteVideoDecoded | 已接收并解码远端视频首帧回调。 |
| onAudioSubscribeStateChanged | 音频订阅状态发生改变回调。 |
| onVideoSubscribeStateChanged | 视频订阅状态发生改变回调。 |
| onUserMuteAudio | 远端用户取消或恢复发布音频流回调。 |
| onUserMuteVideo | 远端用户取消或恢复发布视频流回调。 |
| onUserEnableVideo | 远端用户开关视频功能回调。 |
| onUserEnableLocalVideo | 远端用户开关本地视频采集回调。 |
数据统计事件
加入频道后，SDK 每隔 2 秒自动触发本组回调。 我们为这些回调提供了详细的功能描述、实现方法文档，详情请参考通话中质量监测。
| 事件 | 描述 |
|---|---|
| onRtcStats | 当前通话统计回调。 |
| onNetworkQuality | 网络上下行质量报告回调。 |
| onLocalAudioStats | 本地音频流统计信息回调。 |
| onLocalVideoStats | 本地视频流统计信息回调。 |
| onRemoteAudioStats | 通话中远端音频流的统计信息回调。 |
| onRemoteVideoStats | 远端视频流统计信息回调。 |
视频前处理及后处理
| 方法 | 描述 |
|---|---|
| setBeautyEffectOptions | 设置美颜效果选项。 |
| enableVirtualBackground | 开启/关闭虚拟背景。 |
| enableRemoteSuperResolution | 开启/关闭远端视频超分辨率。（beta 功能） |
| setVideoDenoiserOptions | 设置视频降噪功能。 |
| setLowlightEnhanceOptions | 设置暗光增强功能。 |
| setColorEnhanceOptions | 设置色彩增强功能。 |
| 事件 | 描述 |
|---|---|
| onVirtualBackgroundSourceEnabled | 报告虚拟背景是否成功开启。 |
| onUserSuperResolutionEnabled | 报告超分辨率功能是否成功开启。（beta 功能） |
多频道管理
我们为该组接口提供了详细的场景描述、实现方法及开发注意事项文档，详情请参考加入多频道。
| API | 描述 |
|---|---|
| createChannel | 创建并获取一个 IChannel 对象。通过创建多个对象，用户可以同时加入多个频道。 |
| IChannel | 该类提供在指定频道内实现实时音视频功能的方法。 |
| IChannelEventHandler | 该类提供监听指定频道事件和数据的回调。 |
屏幕共享
我们为该组方法提供了详细的场景描述、实现方法及开发注意事项文档，详情请参考进行屏幕共享。
| 方法 | 描述 |
|---|---|
| getScreenCaptureSources | 获取可共享的屏幕和窗口对象列表（仅适用于 macOS 和 Windows）。 |
| startScreenCaptureByDisplayId | 通过屏幕 ID 共享屏幕（仅适用于 macOS 和 Windows）。 |
| startScreenCaptureByWindowId | 通过窗口 ID 共享窗口（仅适用于 macOS 和 Windows）。 |
| setScreenCaptureContentHint | 设置屏幕共享内容类型（仅适用于 macOS 和 Windows）。 |
| setScreenCaptureScenario | 设置屏幕共享的场景（仅适用于 macOS 和 Windows）。 |
| updateScreenCaptureParameters | 更新屏幕共享的参数配置（仅适用于 macOS 和 Windows）。 |
| updateScreenCaptureRegion | 更新屏幕共享区域（仅适用于 macOS 和 Windows）。 |
| stopScreenCapture | 停止屏幕共享（仅适用于 macOS 和 Windows）。 |
| 事件 | 描述 |
|---|---|
| onScreenCaptureInfoUpdated | 屏幕共享信息更新回调（仅适用于 Windows）。 |
音乐文件播放及混音
| 方法 | 描述 |
|---|---|
| startAudioMixing | 开始播放音乐文件。 |
| stopAudioMixing | 停止播放音乐文件。 |
| pauseAudioMixing | 暂停播放音乐文件。 |
| resumeAudioMixing | 恢复播放音乐文件。 |
| adjustAudioMixingVolume | 调节音乐文件播放音量。 |
| adjustAudioMixingPlayoutVolume | 调节音乐文件的本地播放音量。 |
| adjustAudioMixingPublishVolume | 调节音乐文件的远端播放音量。 |
| setAudioMixingPitch | 调节音乐文件播放音调。 |
| getAudioMixingPlayoutVolume | 获取音乐文件的本地播放音量。 |
| getAudioMixingPublishVolume | 获取音乐文件的远端播放音量。 |
| getAudioMixingCurrentPosition | 获取音乐文件的播放进度。 |
| setAudioMixingPosition | 设置音乐文件的播放位置。 |
| getAudioTrackCount | 获取当前音乐文件的音轨数量（仅适用于 Android，iOS，Windows）。 |
| selectAudioTrack | 指定当前音乐文件的播放音轨（仅适用于 Android，iOS，Windows）。 |
| setAudioMixingPlaybackSpeed | 设置当前音乐文件的播放速度。 |
| setAudioMixingDualMonoMode | 设置当前音乐文件的声道模式。 |
| 事件 | 描述 |
|---|---|
| onAudioMixingStateChanged | 本地用户的音乐文件播放状态改变回调。 |
| onRemoteAudioMixingBegin | 远端音乐文件播放已开始回调。 |
| onRemoteAudioMixingEnd | 远端音乐文件播放已结束回调。 |
| onAudioMixingFinished | 本地音乐文件播放已结束回调。 |
音效文件播放管理
| 方法 | 描述 |
|---|---|
| getEffectsVolume | 获取音效文件的播放音量。 |
| setEffectsVolume | 设置音效文件的播放音量。 |
| setVolumeOfEffect | 实时调整音效文件的播放音量。 |
| playEffect | 播放指定音效文件。 |
| stopEffect | 停止播放指定音效文件。 |
| stopAllEffects | 停止播放所有音效文件。 |
| preloadEffect | 将音效文件加载至内存。 |
| unloadEffect | 从内存释放某个预加载的音效文件。 |
| pauseEffect | 暂停音效文件播放。 |
| pauseAllEffects | 暂停所有音效文件播放。 |
| resumeEffect | 恢复播放指定音效文件。 |
| resumeAllEffects | 恢复播放所有音效文件。 |
| getEffectCurrentPosition | 获取指定音效文件的播放进度。 |
| setEffectPosition | 设置指定音效文件的播放位置。 |
| 事件 | 描述 |
|---|---|
| onAudioEffectFinished | 本地音效文件播放已结束回调。 |
音频文件信息
| 方法 | 描述 |
|---|---|
| getAudioFileInfo | 获取指定音频文件信息。 |
| getEffectDuration | 获取指定音频文件信息。 |
| 事件 | 描述 |
|---|---|
| onRequestAudioFileInfo | 音频文件信息回调。 |
人声效果
| 方法 | 描述 |
|---|---|
| setLocalVoicePitch | 设置本地语音音调。 |
| enableLocalVoicePitchCallback | 开启本地语音音调回调。 |
| setLocalVoiceEqualization | 设置本地语音音效均衡。 |
| setLocalVoiceReverb | 设置本地音效混响。 |
| setVoiceBeautifierPreset | 设置 SDK 预设的美声效果。 |
| setVoiceBeautifierParameters | 设置 SDK 预设美声效果的参数。 |
| setAudioEffectPreset | 设置 SDK 预设的人声音效。 |
| setAudioEffectParameters | 设置 SDK 预设人声音效的参数。 |
| setVoiceConversionPreset | 设置 SDK 预设的变声效果。 |
| 事件 | 描述 |
|---|---|
| onLocalVoicePitchInHz | 报告本地用户的语音音调。 |
听声辨位
| 方法 | 描述 |
|---|---|
| enableSoundPositionIndication | 开启/关闭远端用户的语音立体声。 |
| setRemoteVoicePosition | 设置远端用户的语音位置。 |
旁路推流
该组方法仅适用于互动直播。
| 方法 | 描述 |
|---|---|
| startRtmpStreamWithoutTranscoding | 开始非转码推流。 |
| startRtmpStreamWithTranscoding | 开始 CDN 直播推流并设置转码属性。 |
| updateRtmpTranscoding | 更新转码属性。 |
| stopRtmpStream | 结束 CDN 直播推流。 |
| 事件 | 描述 |
|---|---|
| onRtmpStreamingStateChanged | RTMP/RTMPS 推流状态发生改变回调。 |
| onRtmpStreamingEvent | RTMP/RTMPS 推流事件回调。 |
| onTranscodingUpdated | 旁路推流设置已被更新回调。 |
跨频道媒体流转发
| 方法 | 描述 |
|---|---|
| startChannelMediaRelay | 开始跨频道媒体流转发。 |
| updateChannelMediaRelay | 更新媒体流转发的频道。 |
| pauseAllChannelMediaRelay | 暂停向所有目标频道转发媒体流。 |
| resumeAllChannelMediaRelay | 恢复向所有目标频道转发媒体流。 |
| stopChannelMediaRelay | 停止跨频道媒体流转发。 |
| 事件 | 描述 |
|---|---|
| onChannelMediaRelayStateChanged | 跨频道媒体流转发状态发生改变回调。 |
| onChannelMediaRelayEvent | 跨频道媒体流转发事件回调。 |
音量提示
| 方法 | 描述 |
|---|---|
| enableAudioVolumeIndication | 启用用户音量提示。 |
| 事件 | 描述 |
|---|---|
| onAudioVolumeIndication | 用户音量提示回调。 |
| onActiveSpeaker | 监测到远端最活跃用户回调。 |
人脸检测
该组功能仅适用于 Android 和 iOS 平台。
| 方法 | 描述 |
|---|---|
| enableFaceDetection | 开启/关闭本地人脸检测。 |
| 事件 | 描述 |
|---|---|
| onFacePositionChanged | 报告本地人脸检测结果。 |
音频播放路由
| 方法 | 描述 |
|---|---|
| setDefaultAudioRouteToSpeakerphone | 设置默认的音频路由（仅适用于 Android 和 iOS）。 |
| setEnableSpeakerphone | 开启/关闭扬声器播放（仅适用于 Android 和 iOS）。 |
| isSpeakerphoneEnabled | 查询扬声器启用状态（仅适用于 Android 和 iOS）。 |
| 事件 | 描述 |
|---|---|
| onAudioRouteChanged | 音频路由已改变回调。（仅适用于 Android、iOS 和 macOS） |
耳返控制
| 方法 | 描述 |
|---|---|
| enableInEarMonitoring | 开启耳返功能（仅适用于 Android 和 iOS）。 |
| setInEarMonitoringVolume | 设置耳返音量（仅适用于 Android 和 iOS）。 |
视频双流模式
| 方法 | 描述 |
|---|---|
| enableDualStreamMode | 开关视频双流模式。 |
| setRemoteVideoStreamType | 设置订阅的视频流类型。 |
| setRemoteDefaultVideoStreamType | 设置默认订阅的视频流类型。 |
视频流回退
我们为该组 API 提供了详细的场景描述、实现方法及开发注意事项文档，详情请参考视频流回退。
| 方法 | 描述 |
|---|---|
| setLocalPublishFallbackOption | 设置弱网条件下发布的音视频流的回退选项。 |
| setRemoteSubscribeFallbackOption | 设置弱网条件下订阅的音视频流的回退选项。 |
| setRemoteUserPriority | 设置远端用户流的优先级。 |
| 事件 | 描述 |
|---|---|
| onLocalPublishFallbackToAudioOnly | 本地发布流已回退为音频流或恢复为音视频流回调。 |
| onRemoteSubscribeFallbackToAudioOnly | 远端订阅流已回退为音频流或恢复为音视频流回调。 |
通话前网络测试
我们为该组 API 提供了详细的场景描述、实现方法及开发注意事项文档，详情请参考通话前检测。
| 方法 | 描述 |
|---|---|
| startEchoTest [2/3] | 开始音频通话回路测试。 |
| startEchoTest [3/3] | 开始音视频通话回路测试。 |
| stopEchoTest | 停止通话回路测试。 |
| enableLastmileTest | 启用网络测试。 |
| disableLastmileTest | 关闭网络测试。 |
| startLastmileProbeTest | 开始通话前网络质量探测。 |
| stopLastmileProbeTest | 停止通话前网络质量探测。 |
| 事件 | 描述 |
|---|---|
| onLastmileQuality | 本地网络质量报告回调。 |
| onLastmileProbeResult | 通话前网络质量探测报告回调。 |
自定义视频渲染器
| 方法 | 描述 |
|---|---|
| setVideoSource | 设置自定义视频源。 |
| setLocalVideoRenderer | 自定义本地视频渲染。 |
| setRemoteVideoRenderer | 自定义远端视频渲染。 |
视频自采集（仅 Push 模式）
| 方法 | 描述 |
|---|---|
| setExternalVideoSource | 配置外部视频源。 |
| pushVideoFrame | 推送外部视频帧。 |
音频自采集（仅 Push 模式）
| 方法 | 描述 |
|---|---|
| setExternalAudioSource | 设置外部音频采集参数。 |
| setExternalAudioSourceVolume | 设置指定位置的外部音频帧音量。 |
| pushAudioFrame | 推送外部音频帧到指定位置。 |
音频自渲染（仅 Pull 模式）
| 方法 | 描述 |
|---|---|
| setExternalAudioSink | 设置外部音频渲染。 |
| pullAudioFrame | 主动拉取外部音频帧。 |
原始音频数据
| 方法 | 描述 |
|---|---|
| registerAudioFrameObserver | 注册语音观测器对象。 |
| setRecordingAudioFrameParameters | 设置采集的音频格式。 |
| setPlaybackAudioFrameParameters | 设置播放的声音格式。 |
| setMixedAudioFrameParameters | 设置采集与播放声音混音后的数据格式。 |
| 事件 | 描述 |
|---|---|
| onRecordAudioFrame | 获得采集的音频。 |
| onPlaybackAudioFrame | 获得播放的声音。 |
| onPlaybackAudioFrameBeforeMixing | 获得混音前的指定用户的声音。 |
| onMixedAudioFrame | 获取采集和播放语音混音后的数据。 |
原始视频数据
| 方法 | 描述 |
|---|---|
| registerVideoFrameObserver | 注册视频观测器对象。 |
| 事件 | 描述 |
|---|---|
| getObservedFramePosition | 设置视频观测位置。 |
| onCaptureVideoFrame | 获取本地摄像头采集到的视频数据。 |
| onPreEncodeVideoFrame | 获取本地编码前的视频数据。 |
| onRenderVideoFrame | 获取远端发送的视频数据。 |
| getVideoFormatPreference | 请求视频数据格式。 |
| getRotationApplied | 设置视频数据旋转。 |
| getMirrorApplied | 设置视频数据镜像。 |
本地视频编码数据
| 方法 | 描述 |
|---|---|
| registerVideoEncodedFrameObserver | 注册本地视频编码数据观测器。 |
| 事件 | 描述 |
|---|---|
| onVideoEncodedFrame | 获取本地视频编码数据。 |
媒体附属信息
请不要在 IRtcEngineEventHandler 中实现 getMaxMetadataSize，onReadyToSendMetadata，onMetadataReceived，和 onMetadataReceived 回调。
| 方法 | 描述 |
|---|---|
| registerMediaMetadataObserver | 注册媒体 Metadata 观测器。 |
| 事件 | 描述 |
|---|---|
| getMaxMetadataSize | 请求最大的 Metadata 大小回调。 |
| onReadyToSendMetadata | 发送端已准备好发送 Metadata 回调。 |
| onMetadataReceived | 接收端已收到 Metadata 回调。 |
直播水印
该组方法仅适用于互动直播。
| 方法 | 描述 |
|---|---|
| addVideoWatermark | 添加本地视频水印。 |
| clearVideoWatermarks | 删除已添加的视频水印。 |
视频截图
| 方法 | 描述 |
|---|---|
| takeSnapshot | 获取视频截图。 |
| 事件 | 描述 |
|---|---|
| onSnapshotTaken | 视频截图结果回调。 |
视频截图上传
| 方法 | 描述 |
|---|---|
| enableContentInspect | 开启/关闭视频截图上传。 |
加密
| 方法 | 描述 |
|---|---|
| enableEncryption | 开启/关闭内置加密。 |
| registerPacketObserver | 注册数据包观测器。 |
音频录制
| 方法 | 描述 |
|---|---|
| startAudioRecording | 开始客户端录音。 |
| stopAudioRecording | 停止客户端录音。 |
音视频录制
| 方法 | 描述 |
|---|---|
| getMediaRecorder | 获取 IMediaRecorder 对象。 |
| startRecording | 开启本地音视频流录制。 |
| stopRecording | 停止本地音视频流录制。 |
| releaseRecorder | 释放 IMediaRecorder 对象。 |
| 事件 | 描述 |
|---|---|
| onRecorderStateChanged | 录制状态发生改变回调。 |
| onRecorderInfoUpdated | 录制信息更新回调。 |
摄像头控制
| 方法 | 描述 |
|---|---|
| switchCamera | 切换前置/后置摄像头（仅适用于 Android 和 iOS）。 |
| isCameraTorchSupported | 检查设备是否支持打开闪光灯（仅适用于 Android 和 iOS）。 |
| setCameraTorchOn | 设置是否打开闪光灯（仅适用于 Android 和 iOS）。 |
| 事件 | 描述 |
|---|---|
| onCameraFocusAreaChanged | 摄像头对焦区域已改变回调。 |
| onCameraExposureAreaChanged | 摄像头曝光区域已改变回调。 |
设备管理
| 方法 | 描述 |
|---|---|
| enumeratePlaybackDevices | 获取系统中所有的音频播放设备（仅适用于 Windows 和 macOS）。 |
| enumerateRecordingDevices | 获取系统中所有的音频采集设备（仅适用于 Windows 和 macOS）。 |
| setPlaybackDevice | 指定音频播放设备（仅适用于 Windows 和 macOS）。 |
| setRecordingDevice | 指定音频采集设备（仅适用于 Windows 和 macOS）。 |
| startPlaybackDeviceTest | 启动音频播放设备测试（仅适用于 Windows 和 macOS）。 |
| stopPlaybackDeviceTest | 停止音频播放设备测试（仅适用于 Windows 和 macOS）。 |
| startRecordingDeviceTest | 启动音频采集设备测试（仅适用于 Windows 和 macOS）。 |
| stopRecordingDeviceTest | 停止音频采集设备测试（仅适用于 Windows 和 macOS）。 |
| startAudioDeviceLoopbackTest | 开始音频设备回路测试（仅适用于 Windows 和 macOS）。 |
| stopAudioDeviceLoopbackTest | 停止音频设备回路测试（仅适用于 Windows 和 macOS）。 |
| setPlaybackDeviceVolume | 设置音频播放设备音量（仅适用于 Windows 和 macOS）。 |
| getPlaybackDeviceVolume | 获取音频播放设备音量（仅适用于 Windows 和 macOS）。 |
| setRecordingDeviceVolume | 设置音频采集设备音量（仅适用于 Windows 和 macOS）。 |
| getRecordingDeviceVolume | 获取音频采集设备音量（仅适用于 Windows 和 macOS）。 |
| setPlaybackDeviceMute | 静音音频播放设备（仅适用于 Windows 和 macOS）。 |
| isApplicationMute | 获取 App 当前的静音状态（仅适用于 Windows 和 macOS）。 |
| getDefaultDevice | 获取系统默认的音频设备（仅适用于 Windows 和 macOS）。 |
| getPlaybackDeviceMute | 获取播放设备的静音状态（仅适用于 Windows 和 macOS）。 |
| setRecordingDeviceMute | 静音音频采集设备（仅适用于 Windows 和 macOS）。 |
| getRecordingDeviceMute | 获取音频采集设备的静音状态（仅适用于 Windows 和 macOS）。 |
| followSystemPlaybackDevice | 设置 SDK 使用的音频播放设备跟随系统默认的音频播放设备（仅适用于 Windows 和 macOS）。 |
| followSystemRecordingDevice | 设置 SDK 使用的音频采集设备跟随系统默认的音频采集设备（仅适用于 Windows 和 macOS）。 |
| enumerateVideoDevices | 获取系统中所有的视频设备列表（仅适用于 Windows 和 macOS）。 |
| startDeviceTest | 启动视频采集设备测试（仅适用于 Windows 和 macOS）。 |
| stopDeviceTest | 停止视频采集设备测试（仅适用于 Windows 和 macOS）。 |
| getCount | 获取系统中被索引的视频采集或播放设备的总数（仅适用于 Windows 和 macOS）。 |
| getDevice | 获取某个被索引的视频采集设备的指定信息（仅适用于 Windows 和 macOS）。 |
| setDevice | 指定设备（仅适用于 Windows 和 macOS）。 |
| 事件 | 描述 |
|---|---|
| onAudioDeviceStateChanged | 音频设备变化回调（仅适用于 Windows 和 macOS）。 |
| onAudioDeviceVolumeChanged | 回放、音频采集设备或 App 的音量发生改变。 |
| onAudioDeviceTestVolumeIndication | 音频设备测试回调。 |
| onVideoDeviceStateChanged | 视频设备变化回调（仅适用于 Windows 和 macOS）。 |
流消息
| 方法 | 描述 |
|---|---|
| createDataStream | 创建数据流。 |
| sendStreamMessage | 发送数据流。 |
| 事件 | 描述 |
|---|---|
| onStreamMessage | 接收到对方数据流消息回调。 |
| onStreamMessageError | 接收对方数据流消息发生错误回调。 |
Wi-Fi 加速
| 方法 | 描述 |
|---|---|
| enableWirelessAccelerate | 开启或关闭 Wi-Fi 加速功能。 |
| 事件 | 描述 |
|---|---|
| onWlAccMessage | 报告 Wi-Fi 连接质量不佳的原因和改善 Wi-Fi 连接的操作建议。 |
| onWlAccStats | 报告 Wi-Fi 加速效果。 |
网络代理
| 方法 | 描述 |
|---|---|
| setCloudProxy | 设置声网云代理服务。 |
| setLocalAccessPoint | 设置本地代理。 |
| 事件 | 描述 |
|---|---|
| onProxyConnected | 代理连接状态回调。 |
其他音频控制
| 方法 | 描述 |
|---|---|
| enableLoopbackRecording | 开启声卡采集（仅适用于 macOS 和 Windows）。 |
| setAudioSessionOperationRestriction | 设置 SDK 对 Audio Session 的控制权限（仅适用于 iOS）。 |
其他视频控制
| 方法 | 描述 |
|---|---|
| setCameraCapturerConfiguration | 设置摄像头采集配置。 |
其他方法
| 方法 | 描述 |
|---|---|
| setAVSyncSource | 设置发流端音画同步。 |
| enableDeepLearningDenoise | 开启/关闭 AI 降噪模式。 |
| sendCustomReportMessage | 自定义数据上报。 |
| getCallId | 获取通话 ID。 |
| rate | 给通话评分。 |
| complain | 投诉通话质量。 |
| getVersion | 查询 SDK 版本号。 |
| getErrorDescription | 获取警告或错误描述。 |
| queryInterface | 获取设备管理员对象的指针。 |
其他事件
| 事件 | 描述 |
|---|---|
| onWarning | 发生警告回调。 |
| onError | 发生错误回调。 |
| onApiCallExecuted | API 方法已执行回调。 |
