API 概览

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

初始化相关

API	描述
CreateAgoraRtcEngine	创建 IRtcEngine 对象。
Initialize	初始化 IRtcEngine。
InitEventHandler	添加主回调事件。
CreateAgoraRtcEngineEx	创建 IRtcEngineEx 对象。
Dispose	销毁 IRtcEngine 对象。

频道相关

API	描述
SetChannelProfile	设置频道场景。
JoinChannel [1/2]	加入频道。
JoinChannel [2/2]	设置媒体选项并加入频道。
JoinChannelEx	加入频道。
UpdateChannelMediaOptions	加入频道后更新频道媒体选项。
UpdateChannelMediaOptionsEx	加入频道后更新频道媒体选项 。
LeaveChannel [1/2]	离开频道。
LeaveChannel [2/2]	设置频道选项并离开频道。
LeaveChannelEx [1/2]	离开频道。
LeaveChannelEx [2/2]	设置频道选项并离开频道。
PreloadChannel	使用 token、channelId、uid 预加载频道。
UpdatePreloadChannelToken	更新预加载频道的通配 Token。
RenewToken	更新 Token。
SetClientRole [1/2]	设置用户角色。
SetClientRole [2/2]	设置直播场景下的用户角色和观众端延时级别。
OnClientRoleChanged	用户角色、观众端延时级别已切换回调。
OnClientRoleChangeFailed	用户角色切换失败回调。
OnError	发生错误回调。
OnJoinChannelSuccess	成功加入频道回调。
OnLeaveChannel	离开频道回调。
OnRejoinChannelSuccess	成功重新加入频道回调。
OnRequestToken	Token 已过期回调。
OnRtcStats	当前通话相关的统计信息回调。
OnTokenPrivilegeWillExpire	Token 即将在 30s 内过期回调。
OnUserJoined	远端用户（通信场景）/主播（直播场景）加入当前频道回调。
OnUserOffline	远端用户（通信场景）/主播（直播场景）离开当前频道回调。

发布和订阅

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 对 Audio Session 的操作权限。
OnActiveSpeaker	监测到远端最活跃用户回调。
OnAudioVolumeIndication	用户音量提示回调。
OnFirstLocalAudioFramePublished	已发布本地音频首帧回调。
OnLocalAudioStateChanged	本地音频状态发生改变回调。
OnLocalAudioStats	通话中本地音频流的统计信息回调。
OnRemoteAudioStateChanged	远端音频流状态发生改变回调。
OnRemoteAudioStats	通话中远端音频流的统计信息回调。
OnRemoteAudioTransportStats	通话中远端音频流传输的统计信息回调。
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	设置远端用户声音的 2D 位置，即水平面位置。
SetRemoteVoicePositionEx	设置远端用户声音的 2D 位置，即水平面位置。

空间音频

API	描述
Initialize	初始化 ILocalSpatialAudioEngine。
ClearRemotePositions	删除所有远端用户的空间位置信息。
EnableSpatialAudio	开启或关闭空间音频。
GetLocalSpatialAudioEngine	获取 ILocalSpatialAudioEngine 对象。
MuteAllRemoteAudioStreams	取消或恢复订阅所有远端用户的音频流。
MuteLocalAudioStream	取消或恢复发布本地音频流。
MuteRemoteAudioStream	取消或恢复订阅指定远端用户的音频流。
Dispose	销毁 ILocalSpatialAudioEngine。
RemoveRemotePosition	删除指定远端用户的空间位置信息。
SetAudioRecvRange	设置本地用户的音频接收范围。
SetDistanceUnit	设置游戏引擎单位距离的长度（米）。
SetHeadphoneEQParameters	设置耳机均衡器的低频和高频参数。
SetHeadphoneEQPreset	设置预设的耳机均衡效果。
SetMaxAudioRecvCount	设置音频接收范围内最多可接收的音频流数。
SetPlayerAttenuation	设置媒体播放器的声音衰减属性。
SetRemoteAudioAttenuation	设置指定用户的声音衰减效果。
SetRemoteUserSpatialAudioParams	设置远端用户的空间音频参数。
SetSpatialAudioParams	开启或关闭媒体播放器的空间音频。
SetZones	设置隔声区域。
UpdatePlayerPositionInfo	更新媒体播放器的空间位置。
UpdateRemotePosition	更新远端用户的空间位置信息。
UpdateSelfPosition	更新本地用户的空间位置。

本地音频合流

API	描述
StartLocalAudioMixer	开启本地音频合流。
StopLocalAudioMixer	停止本地音频合流。
UpdateLocalAudioMixerConfiguration	更新本地音频合流的配置。

原始音频数据

API	描述
RegisterAudioFrameObserver	注册音频观测器对象。
SetEarMonitoringAudioFrameParameters	设置耳返的音频数据格式。
SetMixedAudioFrameParameters	设置采集和播放音频混音后的原始音频数据格式。
SetPlaybackAudioFrameBeforeMixingParameters	设置混音前的原始音频播放数据格式。
SetPlaybackAudioFrameParameters	设置播放的原始音频数据格式。
SetRecordingAudioFrameParameters	设置采集的原始音频数据格式。
UnRegisterAudioFrameObserver	取消注册音频帧观测器。
OnEarMonitoringAudioFrame	获得耳返的原始音频数据。
OnMixedAudioFrame	获取采集和播放音频混音后的数据。
OnPlaybackAudioFrame	获得播放的原始音频数据。
OnPlaybackAudioFrameBeforeMixing	获取所订阅的远端用户混音前的声音。
OnRecordAudioFrame	获得采集的原始音频数据。

已编码音频数据

API	描述
RegisterAudioEncodedFrameObserver	注册音频编码数据观测器。
UnRegisterAudioEncodedFrameObserver	取消注册音频编码数据观测器。
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	已发布本地视频首帧回调。
OnFirstRemoteVideoDecoded	已接收到远端视频并完成解码回调。
OnFirstRemoteVideoFrame	渲染器已接收首帧远端视频回调。
OnLocalVideoStateChanged	本地视频状态发生改变回调。
OnLocalVideoStats	本地视频流统计信息回调。
OnRemoteVideoStateChanged	远端视频状态发生改变回调。
OnRemoteVideoStats	通话中远端视频流的统计信息回调。
OnUserEnableVideo	远端用户开/关视频模块回调。
OnUserMuteVideo	远端用户取消或恢复发布视频流回调。
OnVideoPublishStateChanged	视频发布状态改变回调。
OnVideoSizeChanged	本地或远端视频大小和旋转信息发生改变回调。

摄像头采集

API	描述
SetCameraStabilizationMode	设置摄像头防抖模式。
StartCameraCapture	开始通过摄像头采集视频。
StopCameraCapture	停止通过摄像头采集视频。

屏幕采集

API	描述
GetScreenCaptureSources	获取可共享的屏幕和窗口对象列表。
QueryScreenCaptureCapability	查询设备在屏幕共享时支持的最高帧率。
SetExternalMediaProjection	设置 SDK 外部的 MediaProjection 采集屏幕视频流。
SetScreenCaptureContentHint	设置屏幕共享内容类型。
SetScreenCaptureScenario	设置屏幕共享的场景。
StartScreenCapture [1/2]	开始屏幕采集。
StartScreenCapture [2/2]	开始屏幕采集并指定视频源。
StartScreenCaptureByDisplayId	开始采集指定屏幕的视频流。
StartScreenCaptureByWindowId	开始采集指定窗口的视频流。
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	描述
GetFaceShapeAreaOptions	获取美型部位选项。
GetFaceShapeBeautyOptions	获取美型效果选项。
SetBeautyEffectOptions	设置美颜效果选项。
SetColorEnhanceOptions	设置色彩增强功能。
SetFaceShapeAreaOptions	设置美型部位选项并指定媒体源。
SetFaceShapeBeautyOptions	设置美型效果选项并指定媒体源。
SetFilterEffectOptions	设置滤镜效果选项并指定媒体源。
SetLowlightEnhanceOptions	设置暗光增强功能。
SetVideoDenoiserOptions	设置视频降噪功能。

人脸检测

API	描述
EnableFaceDetection	开启/关闭本地人脸检测。
OnFacePositionChanged	报告本地人脸检测结果。

语音驱动

API	描述
RegisterFaceInfoObserver	注册一个人脸信息观测器。
UnregisterFaceInfoObserver	取消注册人脸信息观测器。
OnFaceInfo	报告已获取语音驱动插件处理后的人脸信息。

人像锁定

API	描述
EnableCameraCenterStage	开启或关闭人像锁定功能。
IsCameraCenterStageSupported	查询摄像头是否支持人像锁定。

直播水印

API	描述
AddVideoWatermark [2/2]	添加本地视频水印。
AddVideoWatermarkEx	添加本地视频水印。
ClearVideoWatermarkEx	删除已添加的视频水印。
ClearVideoWatermarks	删除已添加的视频水印。

垫片推流

API	描述
EnableVideoImageSource	设置是否开启垫片推流功能。

视频渲染

API	描述
EnableInstantMediaRendering	开启音视频帧加速渲染。
SetEnable	开始/停止视频渲染。
SetForUser	设置本地/远端视频显示。
SetLocalRenderMode [2/2]	更新本地视图显示模式。
SetLocalRenderTargetFps	设置本地视频渲染的最大帧率。
SetLocalVideoDataSourcePosition	设置本地视频帧的观测位置。
SetRemoteRenderMode	更新远端视图显示模式。
SetRemoteRenderModeEx	设置远端视图显示模式。
SetRemoteRenderTargetFps	设置视频在远端渲染的最大帧率。
SetRenderMode	设置播放器视图的渲染模式。
SetupLocalVideo	初始化本地视图。
SetupRemoteVideo	初始化远端用户视图。
SetupRemoteVideoEx	初始化远端用户视图。
StartMediaRenderingTracing	开启视频帧渲染数据打点。
StartMediaRenderingTracingEx	开启视频帧渲染数据打点。
OnTextureSizeModify	Texture 的宽高发生改变回调。
OnTranscodedStreamLayoutInfo	已接收携带布局信息的合图视频流回调。
OnVideoRenderingTracingResult	视频帧渲染事件回调。

原始视频数据

API	描述
RegisterVideoFrameObserver	注册原始视频观测器对象。
UnregisterVideoFrameObserver	取消注册视频帧观测器。
OnCaptureVideoFrame	获取本地设备采集到的视频数据。
OnPreEncodeVideoFrame	获取本地视频编码前的视频数据。
OnRenderVideoFrame	获取远端发送的视频数据。

已编码视频数据

API	描述
RegisterVideoEncodedFrameObserver	为编码后的视频图像注册视频帧接收观测器。
UnregisterVideoEncodedFrameObserver	为编码后的视频图像取消注册视频帧接收观测器。
OnEncodedVideoFrameReceived	报告接收端已收到远端发送的待解码视频帧。

自定义视频采集和渲染

API	描述
CreateCustomVideoTrack	创建一个自定义的视频轨道。
DestroyCustomVideoTrack	销毁指定的视频轨道。
PushVideoFrame	将外部原始视频帧通过自定义视频轨道发布到频道中。
SetExternalRemoteEglContext	设置远端视频流渲染的 EGL 环境上下文。
SetExternalVideoSource	设置外部视频源。

音乐文件播放

API	描述
AdjustAudioMixingPlayoutVolume	调节音乐文件在本地播放的音量。
AdjustAudioMixingPublishVolume	调节音乐文件远端播放音量。
AdjustAudioMixingVolume	调节音乐文件的播放音量。
GetAudioMixingCurrentPosition	获取音乐文件的播放进度。
GetAudioMixingDuration	获取音乐文件总时长。
GetAudioMixingPlayoutVolume	获取音乐文件的本地播放音量。
GetAudioMixingPublishVolume	获取音乐文件的远端播放音量。
GetAudioTrackCount	获取当前音乐文件的音轨索引。
PauseAudioMixing	暂停播放音乐文件。
ResumeAudioMixing	恢复播放音乐文件。
SelectAudioTrack [1/2]	指定当前音乐文件的播放音轨。
SelectMultiAudioTrack	选择本地播放和发送至远端的音轨。
SetAudioMixingDualMonoMode	设置当前音频文件的声道模式。
SetAudioMixingPitch	调整本地播放的音乐文件的音调。
SetAudioMixingPlaybackSpeed	设置当前音乐文件的播放速度。
SetAudioMixingPosition	设置音乐文件的播放位置。
StartAudioMixing [1/2]	开始播放音乐文件。
StartAudioMixing [2/2]	开始播放音乐文件。
StopAudioMixing	停止播放音乐文件。
OnAudioMixingPositionChanged	音乐文件播放进度回调。
OnAudioMixingStateChanged	音乐文件的播放状态已改变回调。

音效文件播放

API	描述
GetEffectCurrentPosition	获取指定音效文件的播放进度。
GetEffectDuration	获取指定音效文件总时长。
GetEffectsVolume	获取音效文件的播放音量。
GetVolumeOfEffect	获取指定音效文件的播放音量。
PauseAllEffects	暂停所有音效文件播放。
PauseEffect	暂停音效文件播放。
PlayAllEffects	播放所有音效文件。
PlayEffect	播放指定的本地或在线音效文件。
PreloadEffect	将音效文件加载至内存。
ResumeAllEffects	恢复播放所有音效文件。
ResumeEffect	恢复播放指定音效文件。
SetEffectPosition	设置指定音效文件的播放位置。
SetEffectsVolume	设置音效文件的播放音量。
SetVolumeOfEffect	设置指定音效文件的播放音量。
StopAllEffects	停止播放所有音效文件。
StopEffect	停止播放指定音效文件。
UnloadAllEffects	从内存释放所有预加载音效文件。
UnloadEffect	从内存释放某个预加载的音效文件。
OnAudioEffectFinished	本地音效文件播放已结束回调。

虚拟节拍器

API	描述
ConfigRhythmPlayer	配置虚拟节拍器。
StartRhythmPlayer	开启虚拟节拍器。
StopRhythmPlayer	关闭虚拟节拍器。
OnRhythmPlayerStateChanged	虚拟节拍器状态发生改变回调。

初始化

API	描述
CreateMediaPlayer	创建媒体播放器对象。
DestroyMediaPlayer	销毁媒体播放器。
Dispose	释放媒体播放器占用的所有资源。
GetMediaPlayerCacheManager	获取 IMediaPlayerCacheManager 实例。
InitEventHandler	添加媒体播放器的回调事件。

媒体资源打开

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	描述
GetDuration	获取媒体文件总时长。
GetId	获取播放器 ID。
GetMute	获取当前播放的媒体文件是否静音。
GetPlayoutVolume	获取当前本地播放音量。
GetPlayPosition	获取当前播放进度。
GetPlaySrc	获取播放的媒体资源的路径。
GetPublishSignalVolume	获取远端用户听到的音量。
GetState	获取播放器当前状态。
GetStreamCount	获取当前媒体文件中媒体流的数量。
GetStreamInfo	通过媒体流的索引值获取媒体流信息。
OnPlayerPlaybackStats	报告当前播放的媒体资源的相关信息。

音视频观测器

API	描述
RegisterAudioFrameObserver [1/2]	注册 PCM 音频帧观测器。
RegisterAudioFrameObserver [2/2]	注册音频帧观测器。
UnregisterAudioFrameObserver	取消注册音频帧观测器。
onAudioVolumeIndication	媒体播放器音量提示回调。
OnFrame	已获取音频帧回调。
OnMetaData	报告已获取媒体附属信息。
OnPlayBufferUpdated	报告当前缓冲数据能播放的时间。
OnPlayerEvent	报告播放器的事件。
OnPlayerInfoUpdated	媒体播放器相关信息发生改变回调。
OnPlayerSourceStateChanged	报告播放器状态改变。
OnPlayerSrcInfoChanged	媒体资源视频码率变化回调。
OnPositionChanged	报告当前媒体资源的播放进度。
OnPreloadEvent	报告预加载媒体资源的事件。
OnReadData	读取媒体资源数据回调。

媒体播放器缓存

API	描述
EnableAutoRemoveCache	设置是否开启自动清除缓存文件功能。
GetCacheDir	获取缓存文件的储存路径。
GetCacheFileCount	获取当前已缓存的媒体文件的总数量。
GetMaxCacheFileCount	获取所设置的缓存文件数量上限。
GetMaxCacheFileSize	获取所设置的缓存文件总缓存的上限。
RemoveAllCaches	删除媒体播放器中所有已缓存的媒体文件。
RemoveCacheByUri	删除指定的已缓存媒体文件。
RemoveOldCache	删除媒体播放器中近期最少使用的一个缓存媒体文件。
SetCacheDir	设置待缓存的媒体文件的储存路径。
SetMaxCacheFileCount	设置缓存媒体文件数量的上限。
SetMaxCacheFileSize	设置缓存媒体文件的总缓存大小的上限。
OnPlayerCacheStats	报告当前缓存中的媒体资源的相关信息。

版权音乐

API	描述
CreateMusicPlayer	创建音乐播放器。
DestroyMusicPlayer	销毁音乐播放器对象。
GetCaches	获取已缓存的音乐资源信息。
GetInternalSongCode	创建音乐资源的副歌片段编号。
GetLyric	获取音乐资源的歌词下载地址。
GetMusicCharts	获取全部音乐榜单。
GetMusicCollectionByMusicChartId	通过音乐榜单的 ID 获取指定榜单的音乐资源列表。
GetMusicContentCenter	获取 IMusicContentCenter。
GetSongSimpleInfo	获取某一音乐资源的详细信息。
Initialize	初始化 IMusicContentCenter。
IsPreloaded	检测音乐资源是否已被预加载。
Open	通过音乐资源编号打开音乐资源。
Preload [2/2]	预加载音乐资源。
RegisterEventHandler	注册音乐内容中心回调事件。
RemoveCache	删除已缓存的音乐资源。
RenewToken	更新 Token。
SearchMusic	搜索音乐资源。
SetPlayMode	设置音乐资源的播放模式。
UnregisterEventHandler	取消注册音乐内容中心事件回调。
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	开始非转码推流。
StartRtmpStreamWithoutTranscodingEx	开始非转码推流。
StartRtmpStreamWithTranscoding	开始旁路推流并设置转码属性。
StartRtmpStreamWithTranscodingEx	开始旁路推流并设置转码属性。
StopRtmpStream	结束旁路推流。
StopRtmpStreamEx	结束旁路推流。
UpdateRtmpTranscoding	更新旁路推流转码属性。
UpdateRtmpTranscodingEx	更新旁路推流转码属性。
OnRtmpStreamingEvent	旁路推流事件回调。
OnRtmpStreamingStateChanged	旁路推流状态发生改变回调。
OnTranscodingUpdated	旁路推流转码设置已被更新回调。

直推 CDN

API	描述
SetDirectCdnStreamingAudioConfiguration	设置主播端直接向 CDN 推流时的音频编码属性。
SetDirectCdnStreamingVideoConfiguration	设置主播端直接向 CDN 推流时的视频编码属性。
StartDirectCdnStreaming	设置主播端开始直接向 CDN 推流。
StopDirectCdnStreaming	设置主播端停止直接向 CDN 推流。
OnDirectCdnStreamingStateChanged	CDN 推流状态改变回调。
OnDirectCdnStreamingStats	CDN 推流统计数据回调。

数据流 Datastream

API	描述
CreateDataStream [1/2]	创建数据流。
CreateDataStream [2/2]	创建数据流。
CreateDataStreamEx [2/2]	创建数据流。
SendStreamMessage	发送数据流。
SendStreamMessageEx	发送数据流。
OnStreamMessage	接收到对方数据流消息的回调。
OnStreamMessageError	接收对方数据流消息发生错误的回调。

媒体流附属信息分发

API	描述
RegisterMediaMetadataObserver	注册媒体 metadata 观测器用于接收或发送 metadata。
SendMetadata	发送媒体附属信息。
SetMaxMetadataSize	设置媒体附属信息的最大大小。
UnregisterMediaMetadataObserver	取消注册媒体 metadata 观测器。
OnMetadataReceived	接收端已收到 metadata。
OnReadyToSendMetadata	发送端已准备好发送 metadata。

音频路由

API	描述
IsSpeakerphoneEnabled	检查扬声器状态启用状态。
SetDefaultAudioRouteToSpeakerphone	设置默认的音频路由。
SetEnableSpeakerphone	开启或关闭扬声器播放。
SetRouteInCommunicationMode	选择通话音量模式下的音频路由。
OnAudioRoutingChanged	音频路由已发生变化回调。

视频设备管理

API	描述
EnableMultiCamera	开启或关闭多路摄像头采集。
EnumerateVideoDevices	获取系统中所有的视频设备列表。
GetCameraMaxZoomFactor	获取摄像头支持的最大放大倍率。
GetCapability	获取视频采集设备在指定的视频格式下的详细视频帧信息。
GetDevice	获取当前使用的视频采集设备。
GetVideoDeviceManager	获取 IVideoDeviceManager 对象，以管理视频设备。
IsCameraAutoExposureFaceModeSupported	检测设备是否支持自动曝光功能。
IsCameraAutoFocusFaceModeSupported	检测设备是否支持人脸对焦功能。
IsCameraExposurePositionSupported	检测设备是否支持手动曝光功能。
IsCameraExposureSupported	查询当前摄像头是否支持曝光调节。
IsCameraFaceDetectSupported	检查设备摄像头是否支持人脸检测。
IsCameraFocusSupported	检测设备是否支持手动对焦功能。
IsCameraTorchSupported	检测设备是否支持闪光灯常开。
IsCameraZoomSupported	检测设备是否支持摄像头缩放功能。
NumberOfCapabilities	获取指定视频采集设备支持的视频格式数量。
QueryCameraFocalLengthCapability	查询摄像头支持的焦距能力。
QueryCodecCapability	查询 SDK 支持的视频编解码能力。
SetCameraAutoExposureFaceModeEnabled	设置是否开启自动曝光功能。
SetCameraAutoFocusFaceModeEnabled	设置是否开启人脸对焦功能。
SetCameraCapturerConfiguration	设置摄像头采集配置。
SetCameraDeviceOrientation	设置采集视频的旋转角度。
SetCameraExposureFactor	设置当前摄像头的曝光系数。
SetCameraExposurePosition	设置手动曝光位置。
SetCameraFocusPositionInPreview	设置手动对焦位置，并触发对焦。
SetCameraTorchOn	设置是否打开闪光灯。
SetCameraZoomFactor	设置摄像头放大比例。
SetDevice	通过设备 ID 指定视频采集设备。
SwitchCamera	切换前置/后置摄像头。
OnCameraExposureAreaChanged	摄像头曝光区域已改变回调。
OnCameraFocusAreaChanged	相机对焦区域已改变回调。
OnVideoDeviceStateChanged	视频设备变化回调。

音频设备管理

API	描述
EnumeratePlaybackDevices	获取系统中所有的播放设备列表。
EnumerateRecordingDevices	获取系统中所有的音频采集设备列表。
FollowSystemLoopbackDevice	设置声卡采集设备是否跟随系统默认的播放设备。
FollowSystemPlaybackDevice	设置 SDK 使用的音频播放设备跟随系统默认的音频播放设备。
FollowSystemRecordingDevice	设置 SDK 使用的音频采集设备跟随系统默认的音频采集设备。
GetAudioDeviceInfo	获取音频设备信息。
GetAudioDeviceManager	获取 IAudioDeviceManager 对象，以管理音频设备。
GetLoopbackDevice	获取当前的声卡采集设备。
GetPlaybackDefaultDevice [1/2]	获取系统默认的音频播放设备。
GetPlaybackDefaultDevice [2/2]	获取系统默认的音频播放设备及设备类型。
GetPlaybackDevice	获取当前音频播放设备。
GetPlaybackDeviceInfo [1/2]	获取音频播放设备信息。
GetPlaybackDeviceInfo [2/2]	获取音频播放设备信息及其类型。
GetPlaybackDeviceVolume	获取播放设备音量。
GetRecordingDefaultDevice [1/2]	获取系统默认的音频采集设备。
GetRecordingDefaultDevice [2/2]	获取系统默认的音频采集设备及类型。
GetRecordingDevice	获取当前音频采集设备。
GetRecordingDeviceInfo [1/2]	获取音频采集设备信息。
GetRecordingDeviceInfo [2/2]	获取音频采集设备信息及其类型。
GetRecordingDeviceMute	获取当前音频采集设备静音状态。
GetRecordingDeviceVolume	获取音频采集设备音量。
SetLoopbackDevice	指定声卡采集设备。
SetPlaybackDevice	指定播放设备。
SetPlaybackDeviceMute	设置播放设备静音。
SetPlaybackDeviceVolume	设置播放设备音量。
SetRecordingDevice	指定音频采集设备。
SetRecordingDeviceMute	设置当前音频采集设备静音。
SetRecordingDeviceVolume	设置音频采集设备音量。
StartAudioDeviceLoopbackTest	开始音频设备回路测试。
StartPlaybackDeviceTest	启动音频播放设备测试。
StartRecordingDeviceTest	启动音频采集设备测试。
StopAudioDeviceLoopbackTest	停止音频设备回路测试。
StopPlaybackDeviceTest	停止音频播放设备测试。
StopRecordingDeviceTest	停止音频采集设备测试。
OnAudioDeviceStateChanged	音频设备变化回调。
OnAudioDeviceVolumeChanged	音频设备或 App 的音量发生改变回调。

插件

API	描述
EnableExtension	启用/禁用插件。
GetExtensionProperty	获取插件的详细信息。
LoadExtensionProvider	加载插件。
RegisterExtension	注册插件。
SetExtensionProperty	设置插件的属性。
SetExtensionProviderProperty	设置插件服务商的属性。
OnExtensionErrorWithContext	插件出错回调。
OnExtensionEventWithContext	插件事件回调。
OnExtensionStartedWithContext	插件已启用成功回调。
OnExtensionStoppedWithContext	插件已禁用回调。

网络及其他

API	描述
Complain	投诉通话质量。
EnableEncryption	开启或关闭内置加密。
EnableEncryptionEx	开启或关闭内置加密。
GetCallId	获取通话 ID。
GetCallIdEx	使用连接 ID 获取通话 ID。
GetConnectionState	获取当前网络连接状态。
GetConnectionStateEx	获取当前网络连接状态。
GetCurrentMonotonicTimeInMs	获取 SDK 当前的 Monotonic Time。
GetErrorDescription	获取警告或错误描述。
GetNativeHandler	获取 Native SDK 的 C++ 句柄。
GetNetworkType	获取本地网络连接类型。
GetNtpWallTimeInMs	获取当前的 NTP (网络时间协议) 时间。
GetVersion	获取 SDK 版本。
IsFeatureAvailableOnDevice	查询设备是否支持指定进阶功能。
QueryDeviceScore	查询设备评分等级。
Rate	给通话评分。
SendCustomReportMessage	发送自定义上报消息。
SendCustomReportMessageEx	自定义数据上报和分析服务。
SetAVSyncSource	设置发流端音画同步。
SetCloudProxy	设置云代理服务。
SetLocalAccessPoint	配置与声网私有媒体服务器接入模块的连接。
SetParameters [1/2]	SDK 的 JSON 配置信息，用于提供技术预览或特别定制功能。
SetParameters [2/2]	通过 JSON 配置 SDK 提供技术预览或特别定制功能。
SetRemoteSubscribeFallbackOption	设置弱网环境下订阅的音视频流回退选项。
StartEchoTest	开始音视频通话回路测试。
StartLastmileProbeTest	开始通话前网络质量探测。
StopEchoTest	停止语音通话回路测试。
StopLastmileProbeTest	停止通话前网络质量探测。
OnConnectionLost	网络连接中断，且 SDK 无法在 10 秒内连接服务器回调。
OnConnectionStateChanged	网络连接状态已改变回调。
OnEncryptionError	内置加密出错回调。
OnLastmileProbeResult	通话前网络上下行 Last mile 质量探测报告回调。
OnLastmileQuality	网络上下行 last mile 质量报告回调。
OnNetworkQuality	通话中每个用户的网络上下行 last mile 质量报告回调。
OnNetworkTypeChanged	本地网络类型发生改变回调。
OnPermissionError	获取设备权限出错回调。
OnProxyConnected	代理连接状态回调。
OnRemoteSubscribeFallbackToAudioOnly	订阅流已回退为音频流或恢复为音视频流回调。
OnUplinkNetworkInfoUpdated	上行网络信息变化回调。