API 概览

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

初始化相关

API	描述
create [1/2]	创建并初始化 RtcEngine 实例。
create [2/2]	创建并初始化 RtcEngine 实例。
addHandler	添加事件处理器。
destroy [2/2]	销毁 RtcEngine 实例并释放相关资源。
destroy [1/2]	释放 RtcEngine 实例。
removeHandler	移除指定的 IRtcEngineEventHandler 实例。
onEngineReleased	RtcEngine 被释放时触发的回调。

频道相关

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 获取用户信息。
registerLocalUserAccount	注册用户 User Account。
onClientRoleChanged	用户角色或观众延迟级别发生变化回调。
onClientRoleChangeFailed	切换用户角色失败时的回调。
onError	SDK 运行期间发生错误时触发的回调。
onJoinChannelSuccess	远端用户成功加入频道回调。
onLeaveChannel	用户离开频道回调。
onLocalUserRegistered	本地用户注册用户 User Account 回调。
onRejoinChannelSuccess	用户重新加入频道回调。
onRenewTokenResult	renewToken 调用结果回调。
onRequestToken	Token 过期回调。
onRtcStats	报告当前通话统计信息的回调。
onTokenPrivilegeWillExpire	Token 即将在 30 秒后过期时触发的回调。
onUserJoined	远端用户或主播加入频道回调。
onUserOffline	远端用户或主播离开频道时触发的回调。

发布和订阅

API	描述
muteAllRemoteAudioStreams	停止或恢复订阅所有远端用户的音频流。
muteAllRemoteAudioStreamsEx	停止或恢复订阅所有远端用户的音频流。
muteAllRemoteVideoStreams	停止或恢复订阅所有远端用户的视频流。
muteAllRemoteVideoStreamsEx	停止或恢复订阅所有远端用户的视频流。
muteLocalAudioStream	停止或恢复发布本地采集音频流。
muteLocalAudioStreamEx	停止或恢复发布本地音频流。
muteLocalVideoStream	停止或恢复发布本地视频流。
muteLocalVideoStreamEx	停止或恢复发布本地视频流。
muteRemoteAudioStream	停止或恢复订阅指定远端用户的音频流。
muteRemoteAudioStreamEx	停止或恢复接收指定用户的音频流。
muteRemoteVideoStream	停止或恢复订阅指定远端用户的视频流。
muteRemoteVideoStreamEx	停止或恢复接收指定用户的视频流。
setDualStreamMode [1/2]	设置发送端的视频流模式，用于控制是否发送视频小流。
setDualStreamMode [2/2]	设置发送端的不同质量层级的视频流模式配置。
setDualStreamModeEx	设置发送端的视频流模式，用于控制是否发送视频小流。
setRemoteDefaultVideoStreamType [1/2]	设置默认订阅的视频流类型。
setRemoteVideoStreamType [1/2]	设置要订阅的视频流类型。
setRemoteVideoStreamTypeEx [1/2]	设置要订阅的视频流类型。
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	设置音频场景。
onActiveSpeaker	最活跃远端说话人回调。
onAudioVolumeIndication	报告用户音量信息的回调。
onFirstLocalAudioFramePublished	本地音频首帧发布回调。
onLocalAudioStateChanged	本地音频流状态发生变化回调。
onLocalAudioStats	本地音频流统计信息回调。
onRemoteAudioStateChanged	远端音频状态发生变化回调。
onRemoteAudioStats	报告每个远端音频流的传输层统计信息回调。
onUserMuteAudio	远端用户或主播停止或恢复发送音频流的回调。

音频采集

API	描述
adjustRecordingSignalVolume	调节采集音频信号的音量。
enableInEarMonitoring [1/2]	启用或关闭耳返监听。
enableInEarMonitoring [2/2]	启用或关闭耳返监听功能。
enableLocalAudio	启用或关闭本地音频采集功能。
muteRecordingSignal	设置是否静音录制信号。
setInEarMonitoringVolume	设置耳返音量。

人声音效

API	描述
enableVoiceAITuner	启用或关闭语音 AI 调音器。
getAudioEffectManager	获取用于管理音效文件的 IAudioEffectManager 实例。
setAdvancedAudioOptions	设置高级音频选项。
setAINSMode	设置是否启用 AI 降噪功能并设置降噪模式。
setAudioEffectParameters	设置 SDK 预设音效的参数。
setAudioEffectPreset	设置 SDK 预设的音效效果。
setLocalVoiceEqualization	设置本地语音的均衡效果。
setLocalVoiceFormant	设置共振峰比例以改变人声音色。
setLocalVoicePitch	设置本地语音的音调。
setLocalVoiceReverb	设置本地语音的混响效果。
setVoiceBeautifierParameters	设置预设美声特效的参数。
setVoiceBeautifierPreset	设置预设的美声效果。
setVoiceConversionPreset	设置 SDK 预设的变声效果。

听声辨位

API	描述
enableSoundPositionIndication	启用或关闭远端用户的立体声声像功能。
setRemoteVoicePosition	设置远端用户语音的二维位置和音量。
setRemoteVoicePositionEx	设置远端用户语音的二维位置和音量。

空间音频

API	描述
initialize	初始化 ILocalSpatialAudioEngine。
clearRemotePositions	移除所有远端用户的空间位置。
create	创建一个 ILocalSpatialAudioEngine 实例。
enableSpatialAudio	启用或关闭空间音效。
muteAllRemoteAudioStreams	停止或恢复订阅所有远端用户的音频流。
muteLocalAudioStream	停止或恢复发布本地音频流。
muteRemoteAudioStream	停止或恢复订阅指定远端用户的音频流。
destroy	销毁 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	获取用于播放的原始音频帧回调。
onPlaybackAudioFrameBeforeMixing	获取已订阅远端用户混音前的音频帧回调。
onRecordAudioFrame	获取采集到的音频帧回调。

已编码音频数据

API	描述
registerAudioEncodedFrameObserver	注册编码音频数据的观察器。
onMixedAudioEncodedFrame	本地及所有远端用户的混音编码音频数据回调。
onPlaybackAudioEncodedFrame	获取所有远端用户编码音频数据的回调。
onRecordAudioEncodedFrame	本地用户编码音频数据回调。

自定义音频采集和渲染

API	描述
adjustCustomAudioPlayoutVolume	调节本地播放的自定义音频轨道的音量。
adjustCustomAudioPublishVolume	调节远端播放的自定义音频轨道的音量。
createCustomAudioTrack	创建一个自定义音频轨道。
destroyCustomAudioTrack	销毁指定的音频轨道。
enableCustomAudioLocalPlayback	设置是否启用外部音频源的本地播放。
pullPlaybackAudioFrame [1/2]	拉取远端混音后的音频数据用于播放。
pullPlaybackAudioFrame [2/2]	拉取远端音频数据。
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	描述
startCameraCapture	开始视频采集。
stopCameraCapture	停止摄像头采集。

屏幕采集

API	描述
queryScreenCaptureCapability	查询设备在屏幕共享时支持的最高帧率。
setExternalMediaProjection	配置 SDK 外部的 MediaProjection 以采集屏幕视频流。
setScreenCaptureScenario	设置屏幕共享场景。
startScreenCapture	开始屏幕采集。
stopScreenCapture	停止屏幕采集。
updateScreenCaptureParameters	更新屏幕采集参数。

本地截图上传

API	描述
enableContentInspect	启用或关闭本地截图上传功能。
enableContentInspectEx	启用或关闭本地截图上传功能。
takeSnapshot [1/2]	截取指定用户的视频流快照并保存为 JPG 图像。
takeSnapshot [2/2]	在指定的观察点截取视频截图。
takeSnapshotEx [1/2]	使用连接 ID 对视频流进行截图。
takeSnapshotEx [2/2]	通过连接 ID 获取指定用户的视频截图。
onSnapshotTaken	视频截图结果回调。

虚拟背景

API	描述
enableVirtualBackground [1/2]	启用或关闭虚拟背景功能。
enableVirtualBackground [2/2]	启用虚拟背景并指定媒体源，或关闭虚拟背景。

本地合图

API	描述
startLocalVideoTranscoder	开始本地视频合图。
stopLocalVideoTranscoder	停止本地合图。
updateLocalTranscoderConfiguration	更新本地合图配置。
onLocalVideoTranscoderError	本地视频合图过程中发生错误回调。

视频增强

API	描述
addOrUpdateVideoEffect	为指定的视频特效节点 ID 和模板添加或更新视频特效。
createVideoEffectObject	创建一个 IVideoEffectObject 视频特效对象。
destroyVideoEffectObject	销毁一个视频特效对象。
getFaceShapeAreaOptions [1/2]	获取美颜区域的当前设置。
getFaceShapeAreaOptions [2/2]	获取当前美颜效果区域的设置选项。
getFaceShapeBeautyOptions [1/2]	获取当前的美颜特效设置。
getFaceShapeBeautyOptions [2/2]	获取当前的美颜特效设置。
getOptions	获取当前配置的水印显示选项。
getVideoEffectBoolParam	获取视频特效中的布尔类型参数。
getVideoEffectFloatParam	获取视频特效中指定参数的 float 类型值。
getVideoEffectIntParam	获取视频特效中的整数类型参数。
performVideoEffectAction	对指定的视频特效节点执行操作。
removeVideoEffect	移除指定节点 ID 的视频特效节点。
setBeautyEffectOptions [1/2]	设置图像增强功能及其参数。
setBeautyEffectOptions [2/2]	设置美颜特效选项并指定媒体源。
setColorEnhanceOptions [1/2]	设置色彩增强功能。
setColorEnhanceOptions [2/2]	设置色彩增强选项并指定媒体源。
setFaceShapeAreaOptions [1/2]	设置面部区域的图像增强选项并指定媒体源。
setFaceShapeAreaOptions [2/2]	设置美颜增强的面部区域选项。
setFaceShapeBeautyOptions [1/2]	设置美型效果并指定应用的媒体源。
setFaceShapeBeautyOptions [2/2]	设置美型选项。
setFilterEffectOptions [1/2]	设置滤镜特效参数并指定媒体源。
setFilterEffectOptions [2/2]	设置滤镜特效选项。
setLowlightEnhanceOptions [1/2]	设置暗光增强功能。
setLowlightEnhanceOptions [2/2]	设置低光增强选项并指定媒体源。
setVideoDenoiserOptions [1/2]	设置视频降噪功能及其选项。
setVideoDenoiserOptions [2/2]	设置视频降噪并指定媒体源。
setVideoEffectBoolParam	设置视频特效的布尔参数。
setVideoEffectFloatParam	设置视频特效的浮点参数。
setVideoEffectIntParam	设置视频特效的整数参数。

人脸检测

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

直播水印

API	描述
addVideoWatermark [3/3]	向本地视频流添加水印图像。
addVideoWatermarkEx [2/2]	向本地视频添加水印图像。
clearVideoWatermarkEx	从视频流中移除水印图像。
clearVideoWatermarks	从视频流中移除水印图像。
getBuffer	获取水印图像的数据缓冲区。
getFormat	获取水印图像的格式。
getHeight	获取水印图像的高度。
getId	获取水印的唯一标识符。
getImageUrl	获取水印图像的 URL。
getPositionInLandscapeMode	获取横屏模式下水印的位置。
getPositionInPortraitMode	获取竖屏模式下水印的位置。
getType	获取当前水印配置中的水印类型信息。
getWidth	获取水印图像的宽度。
getzOrder	获取水印图像的 Z-order 索引。
isVisibleInPreview	检查水印在本地视频预览中是否可见。
removeVideoWatermark	从本地视频中移除水印图像。
removeVideoWatermarkEx	从本地或远端视频流中移除指定的水印图像。

垫片推流

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

视频渲染

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

原始视频数据

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

已编码视频数据

API	描述
registerVideoEncodedFrameObserver	注册用于接收编码后视频帧的观察器对象。
onEncodedVideoFrameReceived	接收端收到远端编码视频帧回调。

自定义视频采集和渲染

API	描述
createCustomVideoTrack	创建一个自定义视频轨道。
destroyCustomVideoTrack	销毁指定的视频轨道。
isTextureEncodeSupported	检查视频是否支持 Texture 编码。
pushExternalVideoFrameById [1/2]	通过视频轨道向 SDK 推送外部原始视频帧。
pushExternalVideoFrameById [2/2]	通过视频轨道向 SDK 推送外部原始视频帧。
setExternalRemoteEglContext	设置用于渲染远端视频流的 EGL 上下文。
setExternalVideoSource	配置外部视频源。

音乐文件播放

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

音效文件播放

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

虚拟节拍器

API	描述
configRhythmPlayer	配置虚拟节拍器。
startRhythmPlayer	启用虚拟节拍器。
stopRhythmPlayer	禁用虚拟节拍器。
onRhythmPlayerStateChanged	虚拟节拍器状态发生变化回调。

初始化

API	描述
createMediaPlayer	创建一个 IMediaPlayer 对象。
destroy	销毁媒体播放器实例。
getMediaPlayerCacheManager	获取一个 IMediaPlayerCacheManager 实例。

媒体资源打开

API	描述
open [1/2]	打开媒体资源。
open [2/2]	通过 URI 地址打开媒体文件。
openWithMediaSource	打开媒体文件并配置播放场景。
preloadSrc	预加载媒体资源。
switchSrc	切换正在播放的媒体资源。
unloadSrc	卸载预加载的媒体资源。

媒体资源播放和渲染

API	描述
selectAudioTrack	在播放过程中选择音频轨道。
setAudioDualMonoMode	设置当前音频文件的声道模式。
setAudioPitch	设置当前媒体资源的音调。
setLoopCount	设置音效的循环播放次数。
setPlaybackSpeed	设置当前音频文件的播放速度。
setPlayerOption	设置媒体播放器选项。
setPlayerOptionString	设置媒体播放器的参数选项。
setView	设置渲染视图。

播放器控制

API	描述
adjustPlayoutVolume	调节本地播放音量。
adjustPublishSignalVolume	调节用于发布的媒体文件音量。
mute	设置是否静音媒体文件。
pause	暂停播放。
play	播放媒体文件。
playPreloadedSrc	播放预加载的媒体资源。
resume	恢复播放媒体文件。
seek	跳转到新的播放位置。
stop [1/2]	停止播放媒体轨道。
onSeek	当 SDK 定位媒体资源数据时触发的回调。

播放信息获取

API	描述
getDuration	获取媒体资源的时长。
getMediaPlayerId	获取媒体播放器的 ID。
getMute	报告媒体资源是否被静音。
getPlayoutVolume	获取本地播放音量。
getPlayPosition	获取当前本地播放进度。
getPlaySrc [1/2]	获取当前正在播放的媒体资源路径。
getPublishSignalVolume	获取用于发布的媒体文件音量。
getState	获取当前播放状态。
getStreamCount	获取媒体资源中媒体流的数量。
getStreamInfo	获取媒体流的详细信息。
onPlayerPlaybackStats	报告正在播放的媒体文件的统计信息回调。

音视频观测器

API	描述
registerAudioFrameObserver	注册音频帧观测器对象。
registerPlayerObserver	注册媒体播放器观察器。
registerVideoFrameObserver	注册视频帧观察者对象。
unRegisterPlayerObserver	释放媒体播放器观察者。
onAudioVolumeIndication	报告媒体播放器音量的回调。
onFrame	播放器接收到音频帧时触发的回调。
onFrame	播放器接收到视频帧时触发的回调。
onMetaData	接收到媒体元数据时触发的回调。
onPlayBufferUpdated	onPlayBufferUpdated 回调：报告缓冲数据可支持的播放时长。
onPlayerEvent	播放器事件回调。
onPlayerInfoUpdated	媒体播放器相关信息发生变化时的回调。
onPlayerStateChanged	播放状态发生改变回调。
onPlayerSrcInfoChanged	媒体资源视频码率发生变化回调。
onPositionChanged	播放进度回调。
onPreloadEvent	预加载媒体资源事件回调。
onReadData	SDK 读取媒体资源数据时触发的回调。

媒体播放器缓存

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

版权音乐

API	描述
createMusicPlayer	创建一个音乐播放器。
destroy	销毁 IAgoraMusicContentCenter 实例。
destroyMusicPlayer	销毁音乐播放器对象。
getCaches	获取已缓存的音乐资源信息。
getInternalSongCode	创建音乐资源副歌片段的内部标识符。
getLyric	获取音乐资源歌词的下载链接。
getMusicCharts	获取所有音乐排行榜。
getMusicCollectionByMusicChartId [1/2]	根据音乐榜单 ID 获取音乐资源列表。
getMusicCollectionByMusicChartId [2/2]	根据音乐榜单 ID 获取音乐资源列表。
getPlaySrc [2/2]	获取当前播放的音乐资源的标识符或 URL。
getSongSimpleInfo	检索特定音乐资源的详细信息。
initialize	初始化 IAgoraMusicContentCenter。
isPreloaded	检查指定音乐资源是否已预加载。
open [2/2]	通过 URL 打开音乐资源。
open [1/2]	通过资源 ID 打开音乐资源。
preload [2/2]	预加载版权音乐资源。
registerEventHandler	注册版权音乐内容中心的回调事件。
removeCache	删除已缓存的音乐资源。
renewToken	更新 Token。
searchMusic [1/2]	搜索音乐资源。
searchMusic [2/2]	搜索音乐资源。
setPlayMode	设置音乐曲目的播放模式。
stop [2/2]	停止播放音乐资源。
unregisterEventHandler	取消注册版权音乐内容中心的事件回调。
onLyricResult	歌词下载链接回调。
onMusicChartsResult	获取音乐排行榜后的回调。
onMusicCollectionResult	获取音乐资源列表的回调。
onPreLoadEvent	预加载音乐资源事件的回调。
onSongSimpleInfoResult	获取音乐资源详细信息的回调。

音视频录制

API	描述
createMediaRecorder	创建用于音视频录制的录制器实例。
destroyMediaRecorder	销毁音视频录制器实例。
setMediaRecorderObserver	注册一个用于音视频录制的回调观察者。
startAudioRecording [1/2]	开始客户端录音。
startAudioRecording [2/2]	开始客户端录制并应用录制配置。
startRecording	开始录制音频和视频流。
stopAudioRecording	停止客户端录制音频。
stopRecording	停止录制音视频流。
onRecorderInfoUpdated	录制信息更新回调。
onRecorderStateChanged	录制状态发生变化时的回调。

跨频道媒体流转发

API	描述
pauseAllChannelMediaRelay	暂停向所有目标频道的跨频道媒体流转发。
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 [2/2]	创建一个数据流。
sendStreamMessage	发送数据流消息。
sendStreamMessageEx	发送数据流消息。
onStreamMessage	远端用户发送数据流时的回调。
onStreamMessageError	onStreamMessageError 回调：本地用户未收到远端用户发送的数据流时触发。

媒体流附属信息分发

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

音频路由

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

视频设备管理

API	描述
getCameraMaxZoomFactor	获取摄像头支持的最大变焦倍数。
isCameraAutoFocusFaceModeSupported	检查设备是否支持人脸自动对焦功能。
isCameraExposurePositionSupported	检查设备是否支持手动曝光。
isCameraExposureSupported	查询当前摄像头是否支持调节曝光值。
isCameraFaceDetectSupported	检查设备摄像头是否支持人脸检测。
isCameraFocusSupported	检查设备是否支持手动对焦功能。
isCameraTorchSupported	检查设备是否支持相机闪光灯功能。
isCameraZoomSupported	检查设备是否支持摄像头变焦。
queryCameraFocalLengthCapability	查询摄像头支持的焦距能力。
queryCodecCapability	查询 SDK 的视频编解码能力。
setCameraAutoFocusFaceModeEnabled	启用或关闭摄像头人脸自动对焦功能。
setCameraCapturerConfiguration	设置摄像头采集配置。
setCameraExposureFactor	设置摄像头曝光值。
setCameraExposurePosition	设置摄像头曝光位置。
setCameraFocusPositionInPreview	设置摄像头的手动对焦位置。
setCameraTorchOn	打开或关闭摄像头闪光灯。
setCameraZoomFactor	设置摄像头的缩放因子。
switchCamera [1/2]	切换前置和后置摄像头。
switchCamera [2/2]	通过摄像头 ID 切换摄像头。
onCameraExposureAreaChanged	摄像头曝光区域发生变化回调。
onCameraFocusAreaChanged	摄像头对焦区域发生变化的回调。

音频设备管理

API	描述
getAudioDeviceInfo	获取音频设备信息。
startPlaybackDeviceTest	启动本地音频播放设备测试。
startRecordingDeviceTest	启动音频采集设备测试。
stopPlaybackDeviceTest	停止音频播放设备测试。
stopRecordingDeviceTest	停止音频采集设备测试。

插件

API	描述
addExtension	添加扩展。
enableExtension	启用或禁用扩展功能。
getExtensionProperty [1/2]	获取扩展组件的详细信息。
getExtensionProperty [2/2]	获取扩展组件的详细信息。
registerExtension	注册一个扩展。
setExtensionProperty	设置扩展组件的属性。
setExtensionProviderProperty	设置扩展提供方的属性。
onErrorWithContext	扩展运行异常时触发的回调。
onEventWithContext	扩展事件回调。
onStartedWithContext	扩展启用成功回调。
onStoppedWithContext	扩展被禁用时触发的回调。

网络及其他

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