API 概览

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

初始化相关

API	描述
createAgoraRtcEngine	创建一个 IRtcEngine 对象。
initialize	初始化 IRtcEngine。
release	释放 IRtcEngine 实例。
RtcEngineReleaseCallback	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	预加载指定频道以缩短观众加入频道的时间。
updatePreloadChannelToken	更新预加载频道使用的通配 Token。
renewToken	更新 Token。
setClientRole [1/2]	设置用户角色。
setClientRole [2/2]	设置用户角色和观众延迟等级。
getUserInfoByUidEx	通过传入用户 ID 获取用户信息。
getUserInfoByUserAccountEx	通过用户 User Account 获取用户信息。
joinChannelWithUserAccountEx	使用用户 User Account 和 Token 加入频道，并设置媒体选项。
registerLocalUserAccount	注册用户 User Account。
onClientRoleChanged	用户角色或观众延迟等级发生变化时触发的回调。
onClientRoleChangeFailed	切换用户角色失败时触发的回调。
onError	onError 回调。报告 SDK 运行时发生的错误。
onJoinChannelSuccess	本地用户成功加入频道回调。
onLeaveChannel	用户离开频道时触发的回调。
onLocalUserRegistered	onLocalUserRegistered 回调。当本地用户注册用户 User Account 时触发。
onRejoinChannelSuccess	onRejoinChannelSuccess 回调。
onRenewTokenResult	renewToken 方法调用结果回调。
onRequestToken	Token 过期时触发的回调。
onRtcStats	报告当前通话的统计信息。
onTokenPrivilegeWillExpire	Token 即将在 30 秒后过期时触发的回调。
onUserJoined	远端用户或主播加入频道时触发的回调。
onUserOffline	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 对音频会话的操作权限。
onActiveSpeaker	最活跃远端说话人回调。
onAudioVolumeIndication	onAudioVolumeIndication 回调。
onFirstLocalAudioFramePublished	本地用户发布首帧音频时触发的回调。
onLocalAudioStateChanged	本地音频流状态发生变化回调。
onLocalAudioStats	本地音频统计信息回调。
onRemoteAudioStateChanged	远端音频状态发生变化回调。
onRemoteAudioStats	远端音频流统计信息回调。
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	设置远端用户语音在水平面上的位置和音量。
setRemoteVoicePositionEx	设置远端用户语音的二维位置和音量。

空间音频

API	描述
initialize	初始化 ILocalSpatialAudioEngine。
clearRemotePositions	移除所有远端用户的空间位置。
enableSpatialAudio	启用或关闭空间音效。
muteAllRemoteAudioStreams	停止或恢复订阅所有远端用户的音频流。
muteLocalAudioStream	停止或恢复发布本地音频流。
muteRemoteAudioStream	停止或恢复订阅指定远端用户的音频流。
release	释放 ILocalSpatialAudioEngine 的所有资源。
removeRemotePosition	移除指定远端用户的空间位置信息。
setAudioRecvRange	设置本地用户的音频接收范围。
setDistanceUnit	设置游戏引擎中每个单位距离对应的米数。
setHeadphoneEQParameters	设置耳机均衡器的低频和高频参数。
setHeadphoneEQPreset	设置预设的耳机均衡效果。
setMaxAudioRecvCount	设置你在指定音频接收范围内可接收的最大音频流数量。
setPlayerAttenuation	设置媒体播放器的声音衰减属性。
setRemoteAudioAttenuation	设置指定用户的声音衰减效果。
setRemoteUserSpatialAudioParams	设置远端用户的空间音效参数。
setSpatialAudioParams	启用或关闭媒体播放器的空间音效。
setZones	设置隔音区域。
updatePlayerPositionInfo	更新媒体播放器的空间位置。
updateRemotePosition	更新指定远端用户的空间位置。
updateSelfPosition	更新本地用户的空间位置。

本地音频合流

API	描述
startLocalAudioMixer	开始本地音频混音。
stopLocalAudioMixer	停止本地混音。
updateLocalAudioMixerConfiguration	更新本地混音配置。

原始音频数据

API	描述
getEarMonitoringAudioParams	onEarMonitoringAudioFrame 回调的音频格式设置回调。
getMixedAudioParams	onMixedAudioFrame 回调的音频格式设置回调。
getObservedAudioFramePosition	设置音频数据观察位置。
getPlaybackAudioParams	设置 onPlaybackAudioFrame 回调的音频格式。
getRecordAudioParams	onRecordAudioFrame 回调的音频格式设置回调。
registerAudioFrameObserver	注册音频帧观测器对象。
setEarMonitoringAudioFrameParameters	设置耳返音频数据的格式。
setMixedAudioFrameParameters	设置混音后用于音频采集和播放的原始音频数据格式。
setPlaybackAudioFrameBeforeMixingParameters [1/2]	设置混音前的原始音频播放数据格式。
setPlaybackAudioFrameBeforeMixingParameters [2/2]	设置 onPlaybackAudioFrameBeforeMixing 回调中返回音频数据的格式。
setPlaybackAudioFrameParameters	设置原始音频播放数据的格式。
setRecordingAudioFrameParameters	设置采集的原始音频数据格式。
onEarMonitoringAudioFrame	耳返音频帧回调。
onMixedAudioFrame	混合采集和播放音频帧的回调。
onPlaybackAudioFrame	onPlaybackAudioFrame 回调：获取用于播放的原始音频帧。
onPlaybackAudioFrameBeforeMixing	获取订阅远端用户混音前的音频帧回调。
onRecordAudioFrame	采集到音频帧时触发的回调。

已编码音频数据

API	描述
registerAudioEncodedFrameObserver	注册编码音频数据的观察器。
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	首帧本地视频发布时触发的回调。
onFirstRemoteVideoFrame	远端视频首帧显示回调。
onLocalVideoStateChanged	本地视频状态发生变化回调。
onLocalVideoStats	本地视频流统计信息回调。
onRemoteVideoStateChanged	远端视频状态发生改变回调。
onRemoteVideoStats	远端用户发送的视频流统计信息回调。
onUserEnableVideo	远端用户启用或关闭视频模块时触发的回调。
onUserMuteVideo	远端视频发布状态变化回调。
onVideoPublishStateChanged	视频发布状态发生变化回调。
onVideoSizeChanged	当指定用户的视频尺寸或旋转发生变化时触发。

摄像头采集

API	描述
setCameraStabilizationMode	设置摄像头防抖模式。
startCameraCapture	开始视频采集。
stopCameraCapture	停止视频采集。

屏幕采集

API	描述
getCount	获取可共享窗口和屏幕的数量。
getScreenCaptureSources	获取可共享的屏幕和窗口列表。
getSourceInfo	获取指定可共享窗口或屏幕的信息。
queryScreenCaptureCapability	查询设备在屏幕共享时支持的最高帧率。
release	释放 IScreenCaptureSourceList。
setExternalMediaProjection	配置 SDK 外部的 MediaProjection 以采集屏幕视频流。
setScreenCaptureContentHint	设置屏幕共享的内容提示。
setScreenCaptureScenario	设置屏幕共享场景。
startScreenCapture [1/2]	开始屏幕采集。
startScreenCapture [2/2]	从指定的视频源开始屏幕采集。
startScreenCaptureByDisplayId	通过指定屏幕 ID 采集屏幕。
startScreenCaptureByWindowId	通过指定窗口 ID 采集整个或部分窗口。
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	描述
addOrUpdateVideoEffect	添加或更新指定视频特效节点和模板的特效。
createVideoEffectObject	创建一个 IVideoEffectObject 视频特效对象。
destroyVideoEffectObject	销毁视频特效对象。
getFaceShapeAreaOptions	获取美型区域选项。
getFaceShapeBeautyOptions	获取美型选项。
getVideoEffectBoolParam	获取视频特效中的布尔参数。
getVideoEffectFloatParam	获取视频特效中指定 float 类型参数的值。
getVideoEffectIntParam	获取视频特效中的整数类型参数。
performVideoEffectAction	对指定的视频特效节点执行操作。
removeVideoEffect	移除指定节点 ID 的视频特效。
setBeautyEffectOptions	设置美颜特效选项。
setColorEnhanceOptions	设置视频色彩增强效果。
setFaceShapeAreaOptions	设置面部区域的图像增强选项并指定媒体源。
setFaceShapeBeautyOptions	设置美型选项并指定媒体源。
setFilterEffectOptions	设置滤镜特效选项并指定媒体源。
setLowlightEnhanceOptions	设置暗光增强功能。
setVideoDenoiserOptions	设置视频降噪功能。
setVideoEffectBoolParam	设置视频特效的布尔参数。
setVideoEffectFloatParam	设置视频特效的浮点参数。
setVideoEffectIntParam	setVideoEffectIntParam：设置视频特效的整数参数。

人脸检测

API	描述
enableFaceDetection	启用或关闭本地用户的人脸检测功能。
onFacePositionChanged	上报本地用户的人脸检测结果。

人像锁定

API	描述
enableCameraCenterStage	启用或关闭人像锁定功能。
isCameraCenterStageSupported	检查当前摄像头是否支持人像锁定功能。

直播水印

API	描述
addVideoWatermark [3/3]	向本地视频流添加水印图像。
addVideoWatermarkEx [2/2]	向本地视频添加水印图像。
clearVideoWatermarkEx	移除视频流中的水印图像。
clearVideoWatermarks	移除视频流中的水印图像。
removeVideoWatermark	从本地视频中移除水印图像。
removeVideoWatermarkEx	从本地或远端视频流中移除指定的水印图像。

垫片推流

API	描述
enableVideoImageSource	设置在发布视频流时是否用图片替代当前视频画面。

视频渲染

API	描述
enableInstantMediaRendering	启用音视频帧的极速渲染。
setLocalRenderMode [2/2]	更新本地视频画面的显示模式。
setLocalRenderTargetFps	设置本地视频渲染的最大帧率。
setRemoteRenderMode	更新远端用户视频视图的显示模式。
setRemoteRenderModeEx	设置指定远端用户的视频显示模式。
setRemoteRenderTargetFps	设置远端视频渲染的最大帧率。
setRenderMode	设置媒体播放器的渲染模式。
setupLocalVideo	初始化本地视频画面。
setupRemoteVideo	初始化远端用户的视频视图。
setupRemoteVideoEx	初始化远端用户的视频视图。
startMediaRenderingTracing	启用视频帧渲染过程的追踪功能。
startMediaRenderingTracingEx	启用视频帧渲染过程的追踪。
onTranscodedStreamLayoutInfo	`本地用户接收到携带视频合图布局信息的合图视频时触发。
onVideoRenderingTracingResult	视频帧渲染事件回调。

原始视频数据

API	描述
getMirrorApplied	每次 SDK 接收到视频帧时触发的回调，用于设置是否镜像采集的视频。
getObservedFramePosition	设置视频观察器的帧位置。
getRotationApplied	是否旋转采集视频的回调。
getVideoFormatPreference	设置 SDK 输出的原始视频数据格式。
getVideoFrameProcessMode	getVideoFrameProcessMode 回调。每次 SDK 接收到视频帧时触发，用于设置视频帧的处理模式。
registerVideoFrameObserver	注册原始视频帧观察器对象。
onCaptureVideoFrame	本地采集视频帧回调。
onFrame	播放器接收到视频帧时触发的回调。
onPreEncodeVideoFrame	接收到编码前视频帧回调。
onRenderVideoFrame	接收到远端用户发送的视频帧回调。

已编码视频数据

API	描述
registerVideoEncodedFrameObserver	注册用于接收编码后视频帧的观察器对象。
onEncodedVideoFrameReceived	报告接收端已接收到远端发送的待解码视频帧。

自定义视频采集和渲染

API	描述
createCustomVideoTrack	创建一个自定义视频轨道。
destroyCustomVideoTrack	销毁指定的视频轨道。
pushVideoFrame	通过视频轨道将外部原始视频帧推送到 SDK。
setExternalRemoteEglContext	设置用于渲染远端视频流的 EGL 上下文。
setExternalVideoSource	配置外部视频源。

音乐文件播放

API	描述
adjustAudioMixingPlayoutVolume	调节本地播放的混音音量。
adjustAudioMixingPublishVolume	调节用于发布的混音音量。
adjustAudioMixingVolume	调节本地和远端的混音音量。
getAudioMixingCurrentPosition	获取当前混音的播放进度（毫秒）。
getAudioMixingDuration	获取混音文件的总时长（毫秒）。
getAudioMixingPlayoutVolume	获取本地播放的混音音量。
getAudioMixingPublishVolume	获取用于发布的混音音量。
getAudioTrackCount	获取当前音乐文件的音轨索引。
pauseAudioMixing	暂停播放和混音的音乐文件。
resumeAudioMixing	恢复播放并混音音乐文件。
selectAudioTrack [1/2]	选择播放过程中使用的音轨。
selectMultiAudioTrack	选择用于本地播放和发布到频道的音轨。
setAudioMixingDualMonoMode	设置当前音频文件的声道模式。
setAudioMixingPitch	设置本地音乐文件的音调。
setAudioMixingPlaybackSpeed	设置当前音频文件的播放速度。
setAudioMixingPosition	设置混音文件的播放起始位置。
startAudioMixing [2/2]	开始播放音乐文件。
stopAudioMixing	停止播放音乐文件。
onAudioMixingPositionChanged	报告音乐文件播放进度的回调。
onAudioMixingStateChanged	音乐文件播放状态变化回调。

音效文件播放

API	描述
getEffectCurrentPosition	获取指定音效文件的播放位置。
getEffectDuration	获取音效文件的时长。
getEffectsVolume	获取当前音效的音量。
getVolumeOfEffect	获取指定音效文件的音量。
pauseAllEffects	暂停所有音效。
pauseEffect	暂停指定音效文件的播放。
playAllEffects	播放所有音效文件。
playEffect	播放指定的本地或在线音效文件。
playEffectEx	在频道中播放指定音效。
preloadEffect	将指定的音效文件预加载到内存中。
preloadEffectEx	预加载指定音效文件到频道。
resumeAllEffects	恢复播放所有音效文件。
resumeEffect	恢复播放指定音效的播放。
setEffectPosition	设置音效文件的播放位置。
setEffectsVolume	设置音效播放音量。
setVolumeOfEffect	设置指定音效文件的播放音量。
stopAllEffects	停止播放所有音效。
stopEffect	停止播放指定音效。
unloadAllEffects	释放内存中的所有预加载音效。
unloadEffect	释放指定的预加载音效文件。
onAudioEffectFinished	本地音效文件播放结束回调。

初始化

API	描述
createMediaPlayer	创建一个 IMediaPlayer 对象。
destroyMediaPlayer	销毁一个 IMediaPlayer 实例。
getMediaPlayerCacheManager	获取一个 IMediaPlayerCacheManager 实例。

媒体资源打开

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	获取媒体资源的时长。
getMediaPlayerId	获取媒体播放器的 ID。
getMute	查询媒体资源是否处于静音状态。
getPlayoutVolume	获取本地播放音量。
getPlayPosition	获取当前音效文件的本地播放进度。
getPlaySrc	获取当前正在播放的媒体资源路径。
getPublishSignalVolume	获取用于发布的媒体文件音量。
getState	获取当前播放状态。
getStreamCount	获取媒体资源中的媒体流数量。
getStreamInfo	获取媒体流的详细信息。
onPlayerPlaybackStats	播放中的媒体文件的统计信息回调。

音视频观测器

API	描述
registerAudioFrameObserver [1/2]	注册一个 IAudioPcmFrameSink 音频帧观察者对象。
registerAudioFrameObserver [2/2]	注册音频帧观测器对象。
registerPlayerSourceObserver	注册媒体播放器观察器。
registerVideoFrameObserver	注册视频帧观察器对象。
unregisterAudioFrameObserver	取消注册音频帧观察器。
unregisterPlayerSourceObserver	释放媒体播放器观察者。
unregisterVideoFrameObserver	取消注册视频帧观察器。
onAudioVolumeIndication	报告媒体播放器音量的回调。
onFrame	onFrame 回调。每次播放器接收到音频帧时触发。
onMetaData [1/2]	接收到媒体元数据时触发的回调。
onPlayBufferUpdated	报告缓冲数据可支持的播放时长。
onPlayerEvent	播放器事件回调。
onPlayerInfoUpdated [1/2]	onPlayerInfoUpdated 回调：当媒体播放器信息发生变化时触发。
onPlayerSourceStateChanged	播放状态变化回调。
onPlayerSrcInfoChanged	媒体资源视频码率发生变化时触发的回调。
onPositionChanged	播放进度发生变化回调。
onPreloadEvent	预加载媒体资源事件回调。
onReadData	SDK 读取媒体资源数据时触发的回调。

媒体播放器缓存

API	描述
enableAutoRemoveCache	设置是否自动删除缓存的媒体文件。
getCacheDir	获取待缓存媒体文件的存储路径。
getCacheFileCount	获取已缓存的媒体文件数量。
getMaxCacheFileCount	获取可缓存的媒体文件的最大数量。
getMaxCacheFileSize	获取缓存媒体文件聚合存储空间的最大大小。
removeAllCaches	删除媒体播放器中所有缓存的媒体文件。
removeCacheByUri	删除缓存的媒体文件。
removeOldCache	删除最少使用的缓存媒体文件。
setCacheDir	设置要缓存的媒体文件的存储路径。
setMaxCacheFileCount	设置可缓存的媒体文件的最大数量。
setMaxCacheFileSize	设置缓存媒体文件的聚合存储空间的最大大小。
onPlayerCacheStats	上报正在缓存的媒体文件的统计信息。

版权音乐

API	描述
createMusicPlayer	创建一个音乐播放器。
destroyMusicPlayer	销毁音乐播放器对象。
get	获取指定音乐榜单的详细信息。
getCaches	获取已缓存的音乐资源信息。
getCount [1/2]	获取当前请求中的音乐排行榜数量。
getCount [2/2]	获取当前请求中的音乐项数量。
getInternalSongCode	创建音乐资源副歌片段的内部歌曲编码。
getLyric	获取音乐资源歌词的下载链接。
getMusic	获取当前页面中指定音乐资源的详细信息。
getMusicCharts	获取所有音乐排行榜。
getMusicCollectionByMusicChartId	获取指定音乐榜单 ID 的音乐资源列表。
getPage	获取音乐资源列表当前的页码。
getPageSize	获取 SDK 实际返回的音乐资源数量。
getSongSimpleInfo	获取指定音乐资源的详细信息。
getTotal	获取音乐资源列表中的总数。
initialize	初始化 IMusicContentCenter。
isPreloaded	检查指定音乐资源是否已预加载。
open	通过歌曲编码打开音乐资源。
preload [2/2]	预加载音乐资源。
registerEventHandler	注册 MusicContentCenter 的事件处理器。
release	释放 MusicContentCenter 使用的所有资源。
removeCache	删除已缓存的音乐资源。
renewToken	更新 Token。
searchMusic	搜索音乐资源。
setPlayMode	设置音乐资源的播放模式。
unregisterEventHandler	取消注册 MusicContentCenter 的事件回调。
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	开始向 CDN 推送未经转码的媒体流。
startRtmpStreamWithoutTranscodingEx	开始向 CDN 推送未经转码的媒体流。
startRtmpStreamWithTranscoding	开始旁路推流并设置转码配置。
startRtmpStreamWithTranscodingEx	开始旁路推流并设置转码配置。
stopRtmpStream	停止向指定 CDN 地址推送媒体流。
stopRtmpStreamEx	停止向指定 CDN 地址推送媒体流。
updateRtmpTranscoding	更新旁路推流的转码配置。
updateRtmpTranscodingEx	更新旁路推流的转码配置。
onRtmpStreamingEvent	报告旁路推流过程中的事件。
onRtmpStreamingStateChanged	旁路推流状态发生变化时触发的回调。
onTranscodingUpdated	当发布端的云端转码设置更新时触发的回调。

直推 CDN

API	描述
onDirectCdnStreamingStateChanged	CDN 推流状态变化回调。
onDirectCdnStreamingStats	上报 CDN 推流统计信息的回调。

数据流 Datastream

API	描述
createDataStream [1/2]	创建一个数据流。
createDataStream [2/2]	创建一个数据流。
createDataStreamEx [1/2]	创建一个数据流。
createDataStreamEx [2/2]	创建一个数据流。
sendStreamMessage	发送数据流消息。
sendStreamMessageEx	发送数据流消息。
onStreamMessage	onStreamMessage 回调：远端用户发送数据流时触发。
onStreamMessageError	本地用户未收到远端用户发送的数据流消息时触发的回调。

媒体流附属信息分发

API	描述
getMaxMetadataSize	当 SDK 请求元数据最大大小时触发的回调。
registerMediaMetadataObserver	注册元数据观察器。
unregisterMediaMetadataObserver	取消注册指定的元数据观察器。
onMetadataReceived	当本地用户接收到 metadata 时触发的回调。
onReadyToSendMetadata	当 SDK 准备好发送元数据时触发的回调。

音频路由

API	描述
isSpeakerphoneEnabled	检查扬声器是否启用。
setDefaultAudioRouteToSpeakerphone	设置默认音频播放路由。
setEnableSpeakerphone	设置是否将音频路由切换为扬声器。
setRouteInCommunicationMode	设置通信音频模式下的音频播放路由。
onAudioRoutingChanged	本地音频路由发生变化时触发的回调。

视频设备管理

API	描述
enableMultiCamera	启用或关闭多摄像头采集功能。
enumerateVideoDevices	枚举系统中的视频设备。
getCameraMaxZoomFactor	获取摄像头支持的最大变焦倍数。
getCapability	获取指定视频格式下的视频采集设备的帧信息。
getCount	获取系统中已索引的视频采集设备总数。
getDevice	获取指定索引的视频设备的信息。
getDevice	获取当前的视频采集设备。
isCameraAutoExposureFaceModeSupported	检查设备是否支持自动曝光功能。
isCameraAutoFocusFaceModeSupported	检查设备是否支持人脸自动对焦功能。
isCameraExposurePositionSupported	检查设备是否支持手动曝光。
isCameraExposureSupported	查询当前摄像头是否支持调节曝光值。
isCameraFaceDetectSupported	检查设备摄像头是否支持人脸检测。
isCameraFocusSupported	检查设备是否支持手动对焦功能。
isCameraTorchSupported	检查设备是否支持摄像头闪光灯。
isCameraZoomSupported	检查设备是否支持摄像头变焦。
numberOfCapabilities	获取指定视频采集设备支持的视频格式数量。
queryCameraFocalLengthCapability	查询摄像头支持的焦距能力。
queryCodecCapability	查询 SDK 支持的视频编解码器能力。
release	释放 IVideoDeviceCollection 对象占用的所有资源。
release	释放 IVideoDeviceManager 对象占用的所有资源。
setCameraAutoExposureFaceModeEnabled	设置是否启用自动曝光功能。
setCameraAutoFocusFaceModeEnabled	启用摄像头人脸自动对焦功能。
setCameraCapturerConfiguration	设置摄像头采集配置。
setCameraDeviceOrientation	设置采集视频的旋转角度。
setCameraExposureFactor	设置摄像头曝光值。
setCameraExposurePosition	设置相机曝光位置。
setCameraFocusPositionInPreview	设置摄像头手动对焦位置。
setCameraTorchOn	打开或关闭摄像头闪光灯。
setCameraZoomFactor	设置摄像头变焦倍数。
setDevice	指定设备 ID 对应的设备。
setDevice	指定视频采集设备的设备 ID。
switchCamera	切换前后摄像头。
onCameraExposureAreaChanged	摄像头曝光区域发生变化回调。
onCameraFocusAreaChanged	onCameraFocusAreaChanged 回调。当摄像头对焦区域发生变化时触发。
onVideoDeviceStateChanged	视频设备状态变化回调。

音频设备管理

API	描述
enumeratePlaybackDevices	枚举系统中的音频播放设备。
enumerateRecordingDevices	枚举音频采集设备。
followSystemLoopbackDevice	设置是否跟随系统默认音频播放设备。
followSystemPlaybackDevice	设置 SDK 是否跟随系统默认音频播放设备。
followSystemRecordingDevice	设置 SDK 是否跟随系统默认音频录制设备。
getApplicationVolume	获取 App 的音量。
getAudioDeviceInfo	获取音频设备信息。
getCount	获取音频播放设备或音频采集设备的总数。
getDefaultDevice [2/2]	获取系统默认音频设备及其类型。
getDefaultDevice [1/2]	获取系统默认音频设备。
getDevice [2/2]	按索引获取音频设备的名称、类型和 ID。
getDevice [1/2]	获取指定索引的视频设备的信息。
getLoopbackDevice	获取当前的声卡采集设备。
getPlaybackDevice	检索与设备 ID 关联的音频播放设备。
getPlaybackDeviceInfo [1/2]	获取音频播放设备的信息。
getPlaybackDeviceInfo [2/2]	获取音频播放设备的信息和类型。
getPlaybackDeviceMute	获取音频播放设备的静音状态。
getPlaybackDeviceVolume	获取音频播放设备的音量。
getRecordingDevice	获取当前音频录制设备的设备 ID。
getRecordingDeviceInfo [1/2]	获取音频录制设备的信息。
getRecordingDeviceInfo [2/2]	获取音频采集设备的信息和类型。
getRecordingDeviceMute	获取音频采集设备的静音状态。
getRecordingDeviceVolume	获取音频录制设备的音量。
isApplicationMute	检查应用是否处于静音状态。
release	释放 IAudioDeviceCollection 对象占用的所有资源。
release	释放 IAudioDeviceManager 对象占用的所有资源。
setApplicationMute	设置是否静音 App。
setApplicationVolume	设置应用程序的音量。
setDevice	指定视频采集设备的设备 ID。
setLoopbackDevice	设置 SDK 的声卡采集设备。
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	onExtensionStartedWithContext 回调。当扩展启用成功时触发。
onExtensionStoppedWithContext	onExtensionStoppedWithContext 回调：扩展被禁用时触发。

网络及其他

API	描述
complain	允许用户在通话结束后投诉通话质量。
enableEncryption	启用或关闭内置加密功能。
enableEncryptionEx	启用或关闭内置加密功能。
getCallId	获取当前通话 ID。
getCallIdEx	获取与连接 ID 对应的通话 ID。
getConnectionState	获取 SDK 当前的连接状态。
getConnectionStateEx	获取 SDK 当前的连接状态。
getCurrentMonotonicTimeInMs	获取 SDK 当前的单调时间。
getErrorDescription	getErrorDescription：获取警告或错误描述。
getNetworkType	获取本地网络连接类型。
getNtpWallTimeInMs	获取当前的 NTP（网络时间协议）时间。
getVersion	获取 SDK 版本号。
isFeatureAvailableOnDevice	检查当前设备是否支持指定的高级功能。
queryDeviceScore	查询设备评分。
queryInterface	获取指定接口的指针。
rate	允许用户在通话结束后对通话进行评分。
registerPacketObserver	注册一个数据包观察器。
sendCustomReportMessage	上报自定义消息。
sendCustomReportMessageEx	支持上报和分析自定义消息。
setAVSyncSource	设置发送端的音视频同步。
setCloudProxy	设置云代理服务。
setLocalAccessPoint	配置连接到声网私有媒体服务器接入模块。
setParameters	通过配置 JSON 选项为 SDK 提供技术预览功能或特殊定制。
setRemoteSubscribeFallbackOption	根据网络状况设置订阅端的视频流回退选项。
startEchoTest	启动音视频通话回路测试。
startLastmileProbeTest	启动 Last-mile 网络探测测试。
stopEchoTest	停止音频通话测试。
stopLastmileProbeTest	停止 Last-mile 网络探测测试。
onConnectionLost	onConnectionLost 回调。当 SDK 与声网边缘服务器的连接中断后 10 秒内无法重新连接时触发。
onConnectionStateChanged	网络连接状态发生变化时触发的回调。
onEncryptionError	报告内置加密错误的回调。
onLastmileProbeResult	上行和下行 Last-mile 网络探测结果回调。
onLastmileQuality	报告本地用户的 Last-mile 网络质量回调。
onMultipathStats	多路径传输统计信息的回调。
onNetworkQuality	报告频道中每个用户的 Last-mile 网络质量。
onNetworkTypeChanged	本地网络类型发生变化时触发的回调。
onPermissionError	报告 SDK 无法获取设备权限。
onProxyConnected	代理连接状态回调。
onReceiveAudioPacket	当本地用户接收到音频包时触发的回调。
onReceiveVideoPacket	本地用户接收到视频数据包时触发的回调。
onRemoteSubscribeFallbackToAudioOnly	远端媒体流因网络变化在音频流与视频流之间切换时触发的回调。
onSendAudioPacket	本地用户发送音频包时触发的回调。
onSendVideoPacket	本地用户发送视频数据包时触发的回调。
onUplinkNetworkInfoUpdated	上行网络信息发生变化时触发的回调。