API 概览 - 互动直播 - 文档中心

频道管理

方法	描述
create [1/2]	创建并初始化 RtcEngine。
create [2/2]	创建并初始化 RtcEngine。
destroy	销毁 RtcEngine 对象。
setChannelProfile	设置频道场景。
joinChannel [1/2]	加入频道。
joinChannel [2/2]	设置媒体选项并加入频道。
updateChannelMediaOptions	加入频道后更新频道媒体选项。
leaveChannel [1/2]	离开频道。
leaveChannel [2/2]	设置频道选项并离开频道。
renewToken	更新 Token。
setClientRole [1/2]	设置用户角色。
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	关闭音频模块。
setAudioProfile [2/2]	设置音频编码属性。
setAudioScenario	设置音频场景。
adjustRecordingSignalVolume	调节音频采集信号音量。
adjustUserPlaybackSignalVolume	调节本地播放的指定远端用户信号音量。
adjustPlaybackSignalVolume	调节本地播放的所有远端用户信号音量。
adjustCustomAudioPublishVolume	调节自定义采集的音频轨道在远端播放的音量。
muteRecordingSignal	是否将录音信号静音。
enableLocalAudio	开关本地音频采集。
getAudioDeviceInfo	获取音频设备信息。

视频管理

方法	描述
enableVideo	启用视频模块。
disableVideo	关闭视频模块。
setRenderMode	设置播放器视图的渲染模式。
setView	设置播放器渲染视图。
setVideoEncoderConfiguration	设置视频编码属性。
startPreview [1/2]	开启视频预览。
stopPreview [1/2]	停止视频预览。
startPreview [2/2]	开启视频预览并指定预览的视频源。
stopPreview [2/2]	停止视频预览。
setupLocalVideo	初始化本地视图。
setupRemoteVideo	初始化远端用户视图。
setLocalRenderMode [2/2]	更新本地视图显示模式。
setRemoteRenderMode [2/2]	更新远端视图显示模式。
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	该类提供管理媒体播放器中缓存媒体文件的方法。
IMediaPlayerObserver	提供媒体播放器的回调。

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	设置视频降噪功能。

人脸检测

方法	描述
enableFaceDetection	开启/关闭本地人脸检测。

事件	描述
onFacePositionChanged	报告本地人脸检测结果。

耳返

方法	描述
enableInEarMonitoring [2/2]	开启耳返功能。
setInEarMonitoringVolume	设置耳返音量。
setEarMonitoringAudioFrameParameters	设置耳返的音频数据格式。

事件	描述
onEarMonitoringAudioFrame	获得耳返的原始音频数据。
getEarMonitoringAudioParams	设置 onEarMonitoringAudioFrame 回调数据的格式。

音乐文件播放及混音

方法	描述
startAudioMixing [1/2]	开始播放音乐文件。
startAudioMixing [2/2]	开始播放音乐文件。
stopAudioMixing	停止播放音乐文件。
pauseAudioMixing	暂停播放音乐文件。
resumeAudioMixing	恢复播放音乐文件。
adjustAudioMixingVolume	调节音乐文件的播放音量。
adjustAudioMixingPlayoutVolume	调节音乐文件在本地播放的音量。
adjustAudioMixingPublishVolume	调节音乐文件远端播放音量。
getAudioMixingPlayoutVolume	获取音乐文件的本地播放音量。
getAudioMixingPublishVolume	获取音乐文件的远端播放音量。
getAudioMixingDuration	获取音乐文件总时长。
getAudioMixingCurrentPosition	获取音乐文件的播放进度。
setAudioMixingPitch	调整本地播放的音乐文件的音调。
setAudioMixingPosition	设置音乐文件的播放位置。
setAudioMixingDualMonoMode	设置当前音频文件的声道模式。

事件	描述
onAudioMixingStateChanged	音乐文件的播放状态已改变回调。
onAudioMixingPositionChanged	音乐文件播放进度回调。

音效文件播放管理

方法	描述
getEffectsVolume	获取音效文件的播放音量。
setEffectsVolume	设置音效文件的播放音量。
getVolumeOfEffect	获取指定音效文件的播放音量。
setVolumeOfEffect	实时调整音效文件的播放音量。
preloadEffect	将音效文件加载至内存。
playEffect [2/2]	播放指定的本地或在线音效文件。
pauseEffect	暂停音效文件播放。
pauseAllEffects	暂停所有音效文件播放。
resumeEffect	恢复播放指定音效文件。
resumeAllEffects	恢复播放所有音效文件。
stopEffect	停止播放指定音效文件。
stopAllEffects	停止播放所有音效文件。
unloadEffect	从内存释放某个预加载的音效文件。
getEffectDuration	获取指定音效文件总时长。
getEffectCurrentPosition	获取指定音效文件的播放进度。
setEffectPosition	设置指定音效文件的播放位置。

版权音乐

方法	描述
initialize	初始化 IAgoraMusicContentCenter。
createMusicPlayer	创建音乐播放器。
preload	预加载音乐资源。
open	通过音乐资源编号打开音乐资源。
registerEventHandler	注册音乐内容中心回调事件。
getCaches	获取已缓存的音乐资源信息。
removeCache	删除已缓存的音乐资源。

事件	描述
onPreLoadEvent	报告预加载音乐资源的事件。
onLyricResult	歌词下载地址回调。
onMusicChartsResult	获取音乐榜单回调。
onMusicCollectionResult	获取音乐资源列表回调。

虚拟节拍器

方法	描述
startRhythmPlayer	开启虚拟节拍器。
stopRhythmPlayer	关闭虚拟节拍器。
configRhythmPlayer	配置虚拟节拍器。

事件	描述
onRhythmPlayerStateChanged	虚拟节拍器状态发生改变回调。

变声与混响

方法	描述
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 质量探测报告回调。

屏幕共享

方法	描述
queryScreenCaptureCapability	查询设备在屏幕共享时支持的最高帧率。
startScreenCapture	开始屏幕采集。
updateScreenCaptureParameters	更新屏幕采集的参数配置。
stopScreenCapture	停止屏幕采集。

视频双流

方法	描述
setRemoteVideoStreamType	设置订阅的视频流类型。
setRemoteDefaultVideoStreamType	设置默认订阅的视频流类型。
setDualStreamMode [2/2]	在发送端设置双流模式并设置视频小流。

直播水印

方法	描述
addVideoWatermark [2/2]	添加本地视频水印。
clearVideoWatermarks	删除已添加的视频水印。

加密

方法	描述
enableEncryption	开启或关闭内置加密。

事件	描述
onEncryptionError	内置加密出错回调。

听声辨位

方法	描述
enableSoundPositionIndication	开启/关闭远端用户的语音立体声。
setRemoteVoicePosition	设置远端用户声音的 2D 位置，即水平面位置。

空间音效

本地直角坐标系计算方法	描述
create	创建 ILocalSpatialAudioEngine。
initialize	初始化 ILocalSpatialAudioEngine。
destroy	销毁 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 [2/2]	设置外部音频采集参数。
pushExternalAudioFrame [2/2]	推送外部音频数据。

自定义音频渲染

方法	描述
setExternalAudioSink	设置外部音频渲染。
pullPlaybackAudioFrame [1/2]	拉取远端音频数据。
pullPlaybackAudioFrame [2/2]	拉取远端音频数据。

原始音频数据

方法	描述
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	设置外部视频源。
pushExternalVideoFrame [1/2]	推送外部原始视频帧到 SDK。
pushExternalVideoFrame [2/2]	推送外部视频帧。

原始视频数据

方法	描述
registerVideoFrameObserver	注册原始视频观测器对象。

事件	描述
onCaptureVideoFrame	获取本地摄像头采集到的视频数据。
onPreEncodeVideoFrame	获取本地视频编码前的视频数据。
onRenderVideoFrame	获取远端发送的视频数据。
getObservedFramePosition	设置视频观测位置。
getVideoFrameProcessMode	设置视频处理模式。
getMirrorApplied	设置视频数据镜像。
getRotationApplied	设置视频数据旋转。
getVideoFormatPreference	设置 SDK 输出的原始视频数据格式。

视频编码数据

方法	描述
registerVideoEncodedFrameObserver	为编码后的视频图像注册视频帧接收观测器。

事件	描述
onEncodedVideoFrameReceived	报告接收端已收到远端发送的待解码视频帧。

插件

方法	描述
enableExtension	启用/禁用插件。
setExtensionProperty	设置插件的属性。
setExtensionProviderProperty	设置插件服务商的属性。
getExtensionProperty [1/2]	获取插件的详细信息。
getExtensionProperty [2/2]	获取插件的详细信息。

事件	描述
onEvent	插件事件回调。
onStarted	插件启用回调。
onStopped	插件禁用回调。
onError	插件出错回调。

媒体附属信息

方法	描述
registerMediaMetadataObserver	注册媒体 metadata 观测器用于接收或发送 metadata。
unregisterMediaMetadataObserver	取消注册媒体 metadata 观测器。

事件	描述
onReadyToSendMetadata	发送端已准备好发送 metadata。
onMetadataReceived	接收端已收到 metadata。

录音

方法	描述
startAudioRecording [2/2]	开始客户端录音并进行录音配置。
stopAudioRecording	停止客户端录音。

音视频录制

方法	描述
createMediaRecorder	创建音视频录制对象。
setMediaRecorderObserver	注册 IMediaRecorderCallback 观测器。
startRecording	开启音视频流录制。
stopRecording	停止音视频流录制。
destroyMediaRecorder	销毁音视频录制对象。

事件	描述
onRecorderStateChanged	录制状态发生改变回调。
onRecorderInfoUpdated	录制信息更新回调。

摄像头管理

方法	描述
switchCamera	切换前置/后置摄像头。
setCameraCapturerConfiguration	设置摄像头采集配置。
startCameraCapture	开始通过摄像头采集视频。
stopCameraCapture	停止通过摄像头采集视频。
isCameraZoomSupported	检测设备是否支持摄像头缩放功能。
getCameraMaxZoomFactor	获取摄像头支持最大缩放比例。
setCameraZoomFactor	设置摄像头缩放比例。
isCameraTorchSupported	检测设备是否支持闪光灯常开。
setCameraTorchOn	设置是否打开闪光灯。
isCameraFaceDetectSupported	检查设备摄像头是否支持人脸检测。
isCameraFocusSupported	检测设备是否支持手动对焦功能。
setCameraFocusPositionInPreview	设置手动对焦位置，并触发对焦。
isCameraAutoFocusFaceModeSupported	检测设备是否支持人脸对焦功能。
setCameraAutoFocusFaceModeEnabled	设置是否开启人脸对焦功能。
isCameraExposurePositionSupported	检测设备是否支持手动曝光功能。
setCameraExposurePosition	设置手动曝光位置。

事件	描述
onCameraFocusAreaChanged	相机对焦区域已改变回调。
onCameraExposureAreaChanged	摄像头曝光区域已改变回调。

多频道

更多有关多频道的方法，详见多频道管理。

方法	描述
joinChannelEx	使用连接 ID 加入频道。
leaveChannelEx [2/2]	设置频道选项并离开频道。

音频路由

方法	描述
setDefaultAudioRouteToSpeakerphone	设置默认的音频路由。
setEnableSpeakerphone	开启或关闭扬声器播放。
isSpeakerphoneEnabled	检查扬声器状态启用状态。

事件	描述
onAudioRouteChanged	音频路由已发生变化回调。

音量提示

方法	描述
enableAudioVolumeIndication	启用用户音量提示。

事件	描述
onAudioVolumeIndication	用户音量提示回调。
onActiveSpeaker	监测到远端最活跃用户回调。

数据流

方法	描述
createDataStream [2/2]	创建数据流。
sendStreamMessage	发送数据流。

事件	描述
onStreamMessage	接收到对方数据流消息的回调。
onStreamMessageError	接收对方数据流消息发生错误的回调。

音频设备管理器

方法	描述
startRecordingDeviceTest	启动音频采集设备测试。
stopRecordingDeviceTest	停止音频采集设备测试。

其他方法

方法	描述
getCurrentMonotonicTimeInMs	获取 SDK 当前的 Monotonic Time。
setAVSyncSource	设置发流端音画同步。
setCloudProxy	设置云代理服务。
setLocalAccessPoint	配置与声网私有媒体服务器 Native 接入模块的连接。
setParameters	SDK 的 JSON 配置信息，用于提供技术预览或特别定制功能。
getCallId	获取通话 ID。
rate	给通话评分。
complain	投诉通话质量。
getSdkVersion	获取 SDK 版本。
getErrorDescription	获取警告或错误描述。
addHandler	添加主回调事件。
removeHandler	删除指定的回调句柄。
enableVideoImageSource	设置是否开启垫片推流功能。
getNetworkType	获取本地网络连接类型。
getNtpWallTimeInMs	获取当前的 NTP (网络时间协议) 时间。
setHeadphoneEQPreset	设置预设的耳机均衡效果。
setHeadphoneEQParameters	设置耳机均衡器的低频和高频参数。

其他事件

事件	描述
onProxyConnected	代理连接状态回调。