API 概览
声网通过全球部署的 SD-RTN™,提供可以灵活搭配的 API 组合,实现质量可靠的实时音视频通信。
频道管理
方法 | 描述 |
---|---|
CreateAgoraRtcEngine | 创建 IRtcEngine 对象。 |
Initialize | 初始化 IRtcEngine。 |
Dispose | 销毁 IRtcEngine 对象。 |
SetChannelProfile | 设置频道场景。 |
JoinChannel [2/2] | 设置媒体选项并加入频道。 |
UpdateChannelMediaOptions | 加入频道后更新频道媒体选项。 |
LeaveChannel [2/2] | 设置频道选项并离开频道。 |
RenewToken | 更新 Token。 |
SetClientRole [2/2] | 设置直播场景下的用户角色和级别。 |
GetConnectionState | 获取当前网络连接状态。 |
频道事件
事件 | 描述 |
---|---|
OnJoinChannelSuccess | 成功加入频道回调。 |
OnRejoinChannelSuccess | 成功重新加入频道回调。 |
OnClientRoleChanged | 直播场景下用户角色已切换回调。 |
OnClientRoleChangeFailed | 直播场景下切换用户角色失败回调。 |
OnLeaveChannel | 离开频道回调。 |
OnUserJoined | 远端用户(通信场景)/主播(直播场景)加入当前频道回调。 |
OnUserOffline | 远端用户(通信场景)/主播(直播场景)离开当前频道回调。 |
OnNetworkTypeChanged | 本地网络类型发生改变回调。 |
OnUplinkNetworkInfoUpdated | 上行网络信息变化回调。 |
OnConnectionLost | 网络连接中断,且 SDK 无法在 10 秒内连接服务器回调。 |
OnConnectionStateChanged | 网络连接状态已改变回调。 |
OnRequestToken | Token 已过期回调。 |
OnTokenPrivilegeWillExpire | Token 服务将在30s内过期回调。 |
OnError | 发生错误回调。 |
音频管理
方法 | 描述 |
---|---|
EnableAudio | 启用音频模块。 |
DisableAudio | 关闭音频模块。 |
SetAudioScenario | 设置音频场景。 |
AdjustRecordingSignalVolume | 调节音频采集信号音量。 |
AdjustUserPlaybackSignalVolume | 调节本地播放的指定远端用户信号音量。 |
AdjustPlaybackSignalVolume | 调节本地播放的所有远端用户信号音量。 |
AdjustCustomAudioPublishVolume | 调节自定义采集的音频轨道在远端播放的音量。 |
MuteRecordingSignal | 是否将录音信号静音。 |
EnableLocalAudio | 开关本地音频采集。 |
视频管理
方法 | 描述 |
---|---|
EnableVideo | 启用视频模块。 |
DisableVideo | 关闭视频模块。 |
SetRenderMode | 设置播放器视图的渲染模式。 |
SetView | 设置播放器渲染视图。 |
SetVideoEncoderConfiguration | 设置视频编码属性。 |
StartPreview [2/2] | 开启视频预览并指定预览的视频源。 |
StopPreview [2/2] | 停止视频预览。 |
SetLocalRenderMode [2/2] | 更新本地视图显示模式。 |
SetRemoteRenderMode | 更新远端视图显示模式。 |
EnableLocalVideo | 开关本地视频采集。 |
MuteLocalVideoStream | 取消或恢复发布本地视频流。 |
MuteRemoteVideoStream | 取消或恢复订阅指定远端用户的视频流。 |
MuteAllRemoteVideoStreams | 取消或恢复订阅所有远端用户的视频流。 |
EnableInstantMediaRendering | 开启音视频帧加速渲染。 |
StartMediaRenderingTracing | 开启视频帧渲染数据打点。 |
SetVideoScenario | 设置视频业务场景。 |
事件 | 描述 |
---|---|
OnVideoRenderingTracingResult | 视频帧渲染事件回调。 |
视频截图
方法 | 描述 |
---|---|
TakeSnapshot | 获取视频截图。 |
事件 | 描述 |
---|---|
OnSnapshotTaken | 视频截图结果回调。 |
视频截图上传
方法 | 描述 |
---|---|
EnableContentInspect | 开启/关闭视频截图上传。 |
音视频订阅及发布管理
方法 | 描述 |
---|---|
SetSubscribeAudioBlocklist | 设置音频订阅黑名单。 |
SetSubscribeAudioAllowlist | 设置音频订阅白名单。 |
SetSubscribeVideoBlocklist | 设置视频订阅黑名单。 |
SetSubscribeVideoAllowlist | 设置视频订阅白名单。 |
MuteLocalAudioStream | 取消或恢复发布本地音频流。 |
MuteRemoteAudioStream | 取消或恢复订阅指定远端用户的音频流。 |
MuteAllRemoteAudioStreams | 取消或恢复订阅所有远端用户的音频流。 |
EnableLocalVideo | 开关本地视频采集。 |
MuteLocalVideoStream | 取消或恢复发布本地视频流。 |
MuteRemoteVideoStream | 取消或恢复订阅指定远端用户的视频流。 |
MuteAllRemoteVideoStreams | 取消或恢复订阅所有远端用户的视频流。 |
SetRemoteVideoSubscriptionOptions | 设置远端视频流的订阅选项。 |
媒体播放器
更多有关媒体播放器的方法,详见内置媒体播放器。
方法 | 描述 |
---|---|
CreateMediaPlayer | 创建媒体播放器。 |
GetMediaPlayerCacheManager | 获取 IMediaPlayerCacheManager 实例。 |
IMediaPlayer | 提供媒体播放器功能的类,支持多实例。 |
IMediaPlayerCacheManager | 该类提供管理媒体播放器中缓存媒体文件的方法。 |
IMediaPlayerSourceObserver | 提供媒体播放器的回调。 |
SDK 直接推流到 CDN
方法 | 描述 |
---|---|
StartDirectCdnStreaming | 设置主播端开始直接向 CDN 推流。 |
StopDirectCdnStreaming | 设置主播端停止直接向 CDN 推流。 |
SetDirectCdnStreamingAudioConfiguration | 设置主播端直接向 CDN 推流时的音频编码属性。 |
SetDirectCdnStreamingVideoConfiguration | 设置主播端直接向 CDN 推流时的视频编码属性。 |
事件 | 描述 |
---|---|
OnDirectCdnStreamingStateChanged | CDN 推流状态改变回调。 |
OnDirectCdnStreamingStats | CDN 推流统计数据回调。 |
本地媒体事件
事件 | 描述 |
---|---|
OnLocalAudioStateChanged | 本地音频状态发生改变回调。 |
OnLocalVideoStateChanged | 本地视频状态发生改变回调。 |
OnFirstLocalAudioFramePublished | 已发布本地音频首帧回调。 |
OnFirstLocalVideoFramePublished | 已发布本地视频首帧回调。 |
OnAudioPublishStateChanged | 音频发布状态改变回调。 |
OnVideoPublishStateChanged | 视频发布状态改变回调。 |
远端媒体事件
事件 | 描述 |
---|---|
OnRemoteAudioStateChanged | 远端音频流状态发生改变回调。 |
OnRemoteVideoStateChanged | 远端视频状态发生改变回调。 |
OnFirstRemoteAudioFrame | 已接收远端音频首帧回调。 |
OnFirstRemoteVideoFrame | 渲染器已接收首帧远端视频回调。 |
OnFirstRemoteVideoDecoded | 已接收到远端视频并完成解码回调。 |
OnAudioSubscribeStateChanged | 音频订阅状态发生改变回调。 |
OnVideoSubscribeStateChanged | 视频订阅状态发生改变回调。 |
OnUserMuteAudio | 远端用户(通信场景)/主播(直播场景)停止或恢复发送音频流回调。 |
OnUserMuteVideo | 远端用户取消或恢复发布视频流回调。 |
OnUserEnableVideo | 远端用户开/关视频模块回调。 |
OnUserEnableLocalVideo | 远端用户开/关本地视频采集回调。 |
数据统计事件
事件 | 描述 |
---|---|
OnRtcStats | 当前通话统计信息回调。 |
OnNetworkQuality | 通话中每个用户的网络上下行 last mile 质量报告回调。 |
OnLocalAudioStats | 通话中本地音频流的统计信息回调。 |
OnLocalVideoStats | 本地视频流统计信息回调。 |
OnRemoteAudioStats | 通话中远端音频流的统计信息回调。 |
OnRemoteVideoStats | 通话中远端视频流的统计信息回调。 |
音频前后处理
方法 | 描述 |
---|---|
SetAdvancedAudioOptions | 设置音频的高级选项。 |
SetAINSMode | 设置是否开启 AI 降噪功能并设置降噪模式。 |
视频前后处理
方法 | 描述 |
---|---|
SetBeautyEffectOptions | 设置美颜效果选项。 |
EnableVirtualBackground | 开启/关闭虚拟背景。 |
SetColorEnhanceOptions | 设置色彩增强功能。 |
SetLowlightEnhanceOptions | 设置暗光增强功能。 |
SetVideoDenoiserOptions | 设置视频降噪功能。 |
耳返
方法 | 描述 |
---|---|
EnableInEarMonitoring | 开启耳返功能。 |
SetInEarMonitoringVolume | 设置耳返音量。 |
SetEarMonitoringAudioFrameParameters | 设置耳返的音频数据格式。 |
事件 | 描述 |
---|---|
OnEarMonitoringAudioFrame | 获得耳返的原始音频数据。 |
音乐文件播放及混音
方法 | 描述 |
---|---|
StartAudioMixing [2/2] | 开始播放音乐文件。 |
StopAudioMixing | 停止播放音乐文件。 |
PauseAudioMixing | 暂停播放音乐文件。 |
ResumeAudioMixing | 恢复播放音乐文件。 |
AdjustAudioMixingVolume | 调节音乐文件的播放音量。 |
AdjustAudioMixingPlayoutVolume | 调节音乐文件在本地播放的音量。 |
AdjustAudioMixingPublishVolume | 调节音乐文件远端播放音量。 |
GetAudioMixingPlayoutVolume | 获取音乐文件的本地播放音量。 |
GetAudioMixingPublishVolume | 获取音乐文件的远端播放音量。 |
GetAudioMixingDuration | 获取音乐文件总时长。 |
GetAudioMixingCurrentPosition | 获取音乐文件的播放进度。 |
SetAudioMixingPitch | 调整本地播放的音乐文件的音调。 |
SetAudioMixingPosition | 设置音乐文件的播放位置。 |
SetAudioMixingDualMonoMode | 设置当前音频文件的声道模式。 |
事件 | 描述 |
---|---|
OnAudioMixingStateChanged | 音乐文件的播放状态已改变回调。 |
OnAudioMixingPositionChanged | 音乐文件播放进度回调。 |
音效文件播放管理
方法 | 描述 |
---|---|
GetEffectsVolume | 获取音效文件的播放音量。 |
SetEffectsVolume | 设置音效文件的播放音量。 |
GetVolumeOfEffect | 获取指定音效文件的播放音量。 |
SetVolumeOfEffect | 实时调整音效文件的播放音量。 |
PreloadEffect | 将音效文件加载至内存。 |
PlayEffect | 播放指定的本地或在线音效文件。 |
PlayAllEffects | 播放所有音效文件。 |
PauseEffect | 暂停音效文件播放。 |
PauseAllEffects | 暂停所有音效文件播放。 |
ResumeEffect | 恢复播放指定音效文件。 |
ResumeAllEffects | 恢复播放所有音效文件。 |
StopEffect | 停止播放指定音效文件。 |
StopAllEffects | 停止播放所有音效文件。 |
UnloadEffect | 从内存释放某个预加载的音效文件。 |
UnloadAllEffects | 从内存释放所有预加载音效文件。 |
GetEffectDuration | 获取指定音效文件总时长。 |
GetEffectCurrentPosition | 获取指定音效文件的播放进度。 |
SetEffectPosition | 设置指定音效文件的播放位置。 |
变声与混响
方法 | 描述 |
---|---|
SetLocalVoiceEqualization | 设置本地语音音效均衡。 |
SetLocalVoicePitch | 设置本地语音音调。 |
SetLocalVoiceReverb | 设置本地音效混响。 |
SetVoiceBeautifierPreset | 设置预设的美声效果。 |
SetVoiceBeautifierParameters | 设置预设美声效果的参数。 |
SetAudioEffectPreset | 设置 SDK 预设的人声音效。 |
SetAudioEffectParameters | 设置 SDK 预设人声音效的参数。 |
SetVoiceConversionPreset | 设置预设的变声效果。 |
SetLocalVoiceFormant | 设置共振峰比率以改变语音的音色。 |
通话前网络测试
方法 | 描述 |
---|---|
StartEchoTest [1/3] | 开始语音通话回路测试。 |
StartEchoTest [2/3] | 开始语音通话回路测试。 |
StartEchoTest [3/3] | 开始音视频通话回路测试。 |
StopEchoTest | 停止语音通话回路测试。 |
StartLastmileProbeTest | 开始通话前网络质量探测。 |
StopLastmileProbeTest | 停止通话前网络质量探测。 |
事件 | 描述 |
---|---|
OnLastmileQuality | 网络上下行 last mile 质量报告回调。 |
OnLastmileProbeResult | 通话前网络上下行 Last mile 质量探测报告回调。 |
屏幕共享
方法 | 描述 |
---|---|
GetScreenCaptureSources | 获取可共享的屏幕和窗口对象列表。 |
StartScreenCaptureByWindowId | 开始采集指定窗口的视频流。 |
StartScreenCaptureByScreenRect | 开始采集指定屏幕区域的视频流。 |
StartScreenCaptureByDisplayId | 开始采集指定屏幕的视频流。 |
SetScreenCaptureContentHint | 设置屏幕共享内容类型。 |
UpdateScreenCaptureRegion | 更新屏幕采集的区域。 |
StartScreenCapture [2/2] | 开始屏幕采集。 |
UpdateScreenCaptureParameters | 更新屏幕采集的参数配置。 |
StopScreenCapture [1/2] | 停止屏幕采集。 |
StopScreenCapture [2/2] | 停止屏幕采集。 |
SetScreenCaptureScenario | 设置屏幕共享的场景。 |
视频双流
方法 | 描述 |
---|---|
SetRemoteVideoStreamType | 设置订阅的视频流类型。 |
SetRemoteDefaultVideoStreamType | 设置默认订阅的视频流类型。 |
SetDualStreamMode [2/2] | 在发送端设置双流模式并设置视频小流。 |
直播水印
方法 | 描述 |
---|---|
AddVideoWatermark [2/2] | 添加本地视频水印。 |
ClearVideoWatermarks | 删除已添加的视频水印。 |
加密
方法 | 描述 |
---|---|
EnableEncryption | 开启或关闭内置加密。 |
事件 | 描述 |
---|---|
OnEncryptionError | 内置加密出错回调。 |
听声辨位
方法 | 描述 |
---|---|
EnableSoundPositionIndication | 开启/关闭远端用户的语音立体声。 |
SetRemoteVoicePosition | 设置远端用户声音的 2D 位置,即水平面位置。 |
空间音效
本地直角坐标系计算方法 | 描述 |
---|---|
GetLocalSpatialAudioEngine | 获取 ILocalSpatialAudioEngine 对象。 |
Initialize | 初始化 ILocalSpatialAudioEngine。 |
Dispose | 销毁 ILocalSpatialAudioEngine。 |
UpdateSelfPosition | 更新本地用户的空间位置。 |
UpdateRemotePosition | 更新远端用户的空间位置信息。 |
RemoveRemotePosition | 删除指定远端用户的空间位置信息。 |
ClearRemotePositions | 删除所有远端用户的空间位置信息。 |
旁路推流
方法 | 描述 |
---|---|
StartRtmpStreamWithoutTranscoding | 开始非转码推流。 |
StartRtmpStreamWithTranscoding | 开始旁路推流并设置转码属性。 |
UpdateRtmpTranscoding | 更新旁路推流转码属性。 |
StopRtmpStream | 结束旁路推流。 |
事件 | 描述 |
---|---|
OnRtmpStreamingEvent | 旁路推流事件回调。 |
OnRtmpStreamingStateChanged | 旁路推流状态发生改变回调。 |
OnTranscodingUpdated | 旁路推流转码设置已被更新回调。 |
本地合图
方法 | 描述 |
---|---|
StartLocalVideoTranscoder | 开启本地合图。 |
StopLocalVideoTranscoder | 停止本地合图。 |
UpdateLocalTranscoderConfiguration | 更新本地合图配置。 |
事件 | 描述 |
---|---|
OnLocalVideoTranscoderError | 本地合图发生错误回调。 |
跨频道媒体流转发
方法 | 描述 |
---|---|
StartChannelMediaRelay | 开始跨频道媒体流转发。该方法可用于实现跨频道连麦等场景。 |
UpdateChannelMediaRelay | 更新媒体流转发的频道。 |
StartOrUpdateChannelMediaRelay | 开始或更新跨频道媒体流转发。 |
StopChannelMediaRelay | 停止跨频道媒体流转发。一旦停止,主播会退出所有目标频道。 |
PauseAllChannelMediaRelay | 暂停向所有目标频道转发媒体流。 |
ResumeAllChannelMediaRelay | 恢复向所有目标频道转发媒体流。 |
事件 | 描述 |
---|---|
OnChannelMediaRelayStateChanged | 跨频道媒体流转发状态发生改变回调。 |
OnChannelMediaRelayEvent | 跨频道媒体流转发事件回调。 |
自定义音频采集
方法 | 描述 |
---|---|
CreateCustomAudioTrack | 创建一个自定义音频轨道。 |
DestroyCustomAudioTrack | 销毁指定的音频轨道。 |
SetExternalAudioSource | 设置外部音频采集参数。 |
PushAudioFrame | 推送外部音频帧。 |
自定义音频渲染
方法 | 描述 |
---|---|
SetExternalAudioSink | 设置外部音频渲染。 |
PullAudioFrame | 拉取远端音频数据。 |
原始音频数据
方法 | 描述 |
---|---|
RegisterAudioFrameObserver | 注册音频观测器对象。 |
SetRecordingAudioFrameParameters | 设置采集的原始音频数据格式。 |
SetPlaybackAudioFrameParameters | 设置播放的音频格式。 |
SetMixedAudioFrameParameters | 设置 OnMixedAudioFrame 报告的音频数据格式。 |
SetPlaybackAudioFrameBeforeMixingParameters | 设置 OnPlaybackAudioFrameBeforeMixing 报告的音频数据格式。 |
事件 | 描述 |
---|---|
OnRecordAudioFrame | 获得采集的原始音频数据。 |
OnPlaybackAudioFrame | 获得播放的原始音频数据。 |
OnPlaybackAudioFrameBeforeMixing | 获得混音前的指定用户的声音。 |
OnMixedAudioFrame | 获取采集和播放音频混音后的数据。 |
GetObservedAudioFramePosition | 设置音频观测位置。 |
GetRecordAudioParams | 设置 OnRecordAudioFrame 回调数据的格式。 |
GetPlaybackAudioParams | 设置 OnPlaybackAudioFrame 回调数据的格式。 |
GetMixedAudioParams | 设置 OnMixedAudioFrame 回调数据的格式。 |
音频编码数据
方法 | 描述 |
---|---|
RegisterAudioEncodedFrameObserver | 注册音频编码数据观测器。 |
事件 | 描述 |
---|---|
OnRecordAudioEncodedFrame | 获取本地用户的音频编码数据。 |
OnPlaybackAudioEncodedFrame | 获取所有远端用户的音频编码数据。 |
OnMixedAudioEncodedFrame | 获取本地和所有远端用户混音后的音频编码数据。 |
音频频谱
方法 | 描述 |
---|---|
RegisterAudioSpectrumObserver | 注册音频频谱观测器。 |
EnableAudioSpectrumMonitor | 开启音频频谱监测。 |
DisableAudioSpectrumMonitor | 关闭音频频谱监测。 |
UnregisterAudioSpectrumObserver | 取消注册音频频谱观测器。 |
事件 | 描述 |
---|---|
OnLocalAudioSpectrum | 获取本地音频频谱。 |
OnRemoteAudioSpectrum | 获取远端音频频谱。 |
自定义视频采集
方法 | 描述 |
---|---|
CreateCustomVideoTrack | 创建一个自定义的视频轨道。 |
DestroyCustomVideoTrack | 销毁指定的视频轨道。 |
外部视频数据
方法 | 描述 |
---|---|
SetExternalVideoSource | 设置外部视频源。 |
PushVideoFrame | 推送外部原始视频帧到 SDK。 |
原始视频数据
方法 | 描述 |
---|---|
RegisterVideoFrameObserver | 注册原始视频观测器对象。 |
事件 | 描述 |
---|---|
OnCaptureVideoFrame | 获取本地设备采集到的视频数据。 |
OnPreEncodeVideoFrame | 获取本地视频编码前的视频数据。 |
OnRenderVideoFrame | 获取远端发送的视频数据。 |
GetObservedFramePosition | 设置视频观测位置。 |
GetVideoFormatPreference | 设置 SDK 输出的原始视频数据格式。 |
视频编码数据
方法 | 描述 |
---|---|
RegisterVideoEncodedFrameObserver | 为编码后的视频图像注册视频帧接收观测器。 |
事件 | 描述 |
---|---|
OnEncodedVideoFrameReceived | 报告接收端已收到远端发送的待解码视频帧。 |
插件
方法 | 描述 |
---|---|
EnableExtension | 启用/禁用插件。 |
SetExtensionProperty | 设置插件的属性。 |
SetExtensionProviderProperty | 设置插件服务商的属性。 |
GetExtensionProperty | 获取插件的详细信息。 |
RegisterExtension | 注册插件。 |
事件 | 描述 |
---|---|
OnExtensionEvent | 插件事件回调。 |
OnExtensionStarted | 插件启用回调。 |
OnExtensionStopped | 插件禁用回调。 |
媒体附属信息
方法 | 描述 |
---|---|
RegisterMediaMetadataObserver | 注册媒体 metadata 观测器用于接收或发送 metadata。 |
UnregisterMediaMetadataObserver | 取消注册媒体 metadata 观测器。 |
事件 | 描述 |
---|---|
GetMaxMetadataSize | 请求最大的 metadata 大小。 |
OnReadyToSendMetadata | 发送端已准备好发送 metadata。 |
OnMetadataReceived | 接收端已收到 metadata。 |
录音
方法 | 描述 |
---|---|
StartAudioRecording [3/3] | 开始客户端录音并进行录音配置。 |
StopAudioRecording | 停止客户端录音。 |
音视频录制
方法 | 描述 |
---|---|
CreateMediaRecorder | 创建音视频录制对象。 |
SetMediaRecorderObserver | 注册 IMediaRecorderObserver 观测器。 |
StartRecording | 开启音视频流录制。 |
StopRecording | 停止音视频流录制。 |
DestroyMediaRecorder | 销毁音视频录制对象。 |
事件 | 描述 |
---|---|
OnRecorderStateChanged | 录制状态发生改变回调。 |
OnRecorderInfoUpdated | 录制信息更新回调。 |
摄像头管理
方法 | 描述 |
---|---|
SetCameraDeviceOrientation | 设置采集视频的旋转角度。 |
StartCameraCapture | 开始通过摄像头采集视频。 |
StopCameraCapture | 停止通过摄像头采集视频。 |
多频道
更多有关多频道的方法,详见多频道管理。
方法 | 描述 |
---|---|
CreateAgoraRtcEngineEx | 创建 IRtcEngineEx 对象。 |
JoinChannelEx | 使用连接 ID 加入频道。 |
LeaveChannelEx [2/2] | 设置频道选项并离开频道。 |
音量提示
方法 | 描述 |
---|---|
EnableAudioVolumeIndication | 启用用户音量提示。 |
事件 | 描述 |
---|---|
OnAudioVolumeIndication | 用户音量提示回调。 |
OnActiveSpeaker | 监测到远端最活跃用户回调。 |
数据流
方法 | 描述 |
---|---|
CreateDataStream [2/2] | 创建数据流。 |
SendStreamMessage | 发送数据流。 |
事件 | 描述 |
---|---|
OnStreamMessage | 接收到对方数据流消息的回调。 |
OnStreamMessageError | 接收对方数据流消息发生错误的回调。 |
视频设备管理
方法 | 描述 |
---|---|
EnumerateVideoDevices | 获取系统中所有的视频设备列表。 |
SetDevice | 通过设备 ID 指定视频采集设备。 |
GetDevice | 获取当前使用的视频采集设备。 |
NumberOfCapabilities | 获取指定视频采集设备支持的视频格式数量。 |
GetCapability | 获取视频采集设备在指定的视频格式下的详细视频帧信息。 |
QueryCodecCapability | 查询当前设备支持的视频编解码能力。 |
事件 | 描述 |
---|---|
OnVideoDeviceStateChanged | 视频设备变化回调。 |
音频设备管理
方法 | 描述 |
---|---|
EnumeratePlaybackDevices | 获取系统中所有的播放设备列表。 |
EnumerateRecordingDevices | 获取系统中所有的音频采集设备列表。 |
FollowSystemPlaybackDevice | 设置 SDK 使用的音频播放设备跟随系统默认的音频播放设备。 |
FollowSystemRecordingDevice | 设置 SDK 使用的音频采集设备跟随系统默认的音频采集设备。 |
SetPlaybackDevice | 指定播放设备。 |
GetPlaybackDevice | 获取当前音频播放设备。 |
GetPlaybackDeviceInfo | 获取音频播放设备信息。 |
SetLoopbackDevice | 指定声卡采集设备。 |
GetLoopbackDevice | 获取当前的声卡采集设备。 |
FollowSystemLoopbackDevice | 设置声卡采集设备是否跟随系统默认的播放设备。 |
SetRecordingDevice | 指定音频采集设备。 |
GetRecordingDevice | 获取当前音频采集设备。 |
GetRecordingDeviceInfo | 获取音频采集设备信息。 |
SetRecordingDeviceVolume | 设置音频采集设备音量。 |
StartPlaybackDeviceTest | 启动音频播放设备测试。 |
StopPlaybackDeviceTest | 停止音频播放设备测试。 |
StartRecordingDeviceTest | 启动音频采集设备测试。 |
StopRecordingDeviceTest | 停止音频采集设备测试。 |
StartAudioDeviceLoopbackTest | 开始音频设备回路测试。 |
StopAudioDeviceLoopbackTest | 停止音频设备回路测试。 |
事件 | 描述 |
---|---|
OnAudioDeviceStateChanged | 音频设备变化回调。 |
OnAudioDeviceVolumeChanged | 音频设备或 app 的音量发生改变回调。 |
其他方法
方法 | 描述 |
---|---|
GetCurrentMonotonicTimeInMs | 获取 SDK 当前的 Monotonic Time。 |
SetAVSyncSource | 设置发流端音画同步。 |
SetCloudProxy | 设置云代理服务。 |
SetLocalAccessPoint | 配置与声网私有媒体服务器 Native 接入模块的连接。 |
SetParameters [1/2] | SDK 的 JSON 配置信息,用于提供技术预览或特别定制功能。 |
GetCallId | 获取通话 ID。 |
Rate | 给通话评分。 |
Complain | 投诉通话质量。 |
GetVersion | 获取 SDK 版本。 |
GetErrorDescription | 获取警告或错误描述。 |
EnableVideoImageSource | 设置是否开启垫片推流功能。 |
GetNetworkType | 获取本地网络连接类型。 |
GetNtpWallTimeInMs | 获取当前的 NTP (网络时间协议) 时间。 |
SetHeadphoneEQPreset | 设置预设的耳机均衡效果。 |
SetHeadphoneEQParameters | 设置耳机均衡器的低频和高频参数。 |
其他事件
事件 | 描述 |
---|---|
OnProxyConnected | 代理连接状态回调。 |