API 概览

AR云平台通过全球部署的虚拟网络，提供可以灵活搭配的 API 组合，为移动端到移动端以及移动端到 Web 端提供质量可靠的实时音视频通信。

• RtcEngine 类包含应用程序调用的主要方法。
• IRtcEngineEventHandler 类用于向应用程序发送回调通知。
• IAudioEffectManager 类提供管理音效文件的方法。

频道管理

方法	描述
create	创建 RtcEngine 实例
destroy	销毁 RtcEngine 实例
setChannelProfile	设置频道场景
setClientRole	设置直播场景下的用户角色
joinChannel	加入频道
switchChannel	快速切换直播频道
leaveChannel	离开频道
renewToken	更新 Token
getConnectionState	获取网络连接状态

频道事件

事件	描述
onConnectionStateChanged	网络连接状态已改变回调
onJoinChannelSuccess	加入频道回调
onRejoinChannelSuccess	重新加入频道回调
onLeaveChannel	离开频道回调
onClientRoleChanged	用户角色已切换回调
onUserJoined	远端用户加入当前频道回调
onUserOffline	远端用户离开当前频道回调
onNetworkTypeChanged	本地网络类型发生改变回调
onConnectionLost	网络连接丢失回调
onTokenPrivilegeWillExpire	Token 服务即将过期回调
onRequestToken	Token 已过期回调

音频管理

方法	描述
enableAudio	启用音频模块
disableAudio	关闭音频模块
setAudioProfile	设置音频编码配置
adjustRecordingSignalVolume	调节录音音量
adjustUserPlaybackSignalVolume	调节本地播放的指定远端用户音量
adjustPlaybackSignalVolume	调节本地播放的所有远端用户音量
enableLocalAudio	开关本地音频采集
muteLocalAudioStream	停止/恢复发送本地音频流
muteRemoteAudioStream	停止/恢复接收指定音频流
muteAllRemoteAudioStreams	停止/恢复接收所有音频流
setDefaultMuteAllRemoteAudioStreams	设置是否默认接收音频流

视频管理

方法	描述
enableVideo	启用视频模块
disableVideo	关闭视频模块
setVideoEncoderConfiguration	设置视频编码配置
setupLocalVideo	初始化本地视图
setupRemoteVideo	初始化远端用户视图
setLocalRenderMode	更新本地视图显示模式
setRemoteRenderMode	更新远端视图显示模式
CreateRendererView	创建渲染视图
startPreview	开启视频预览
stopPreview	停止视频预览
enableLocalVideo	开关本地视频采集
muteLocalVideoStream	停止/恢复发送本地视频流
muteRemoteVideoStream	停止/恢复接收指定视频流
muteAllRemoteVideoStreams	停止/恢复接收所有视频流
setDefaultMuteAllRemoteVideoStreams	设置是否默认接收视频流

视频截图

方法	描述
takeSnapshot	获取视频截图。

事件	描述
onSnapshotTaken	视频截图结果回调。

直播水印

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

本地媒体事件

事件	描述
onLocalAudioStateChanged	本地音频状态改变回调
onLocalVideoStateChanged	本地视频状态改变回调
onFirstLocalAudioFrame	已发送本地音频首帧回调
onFirstLocalVideoFrame	已显示本地视频首帧回调

远端媒体事件

事件	描述
onRemoteAudioStateChanged	远端用户音频状态已改变回调
onRemoteVideoStateChanged	远端用户视频状态已变化回调
onFirstRemoteVideoFrame	已显示远端视频首帧回调

数据统计事件

• 加入频道后，SDK 每隔 2 秒自动触发本组回调。
• 我们为这些回调提供了详细的功能描述、实现方法文档，详情请参考检测通话质量。

事件	描述
onRtcStats	当前通话统计回调
onLocalAudioStats	通话中本地音频流统计信息回调
onLocalVideoStats	通话中本地视频流统计信息回调
onRemoteAudioStats	通话中远端音频流的统计信息回调
onRemoteVideoStats	通话中远端视频流统计信息回调

音乐文件播放及混音

方法	描述
startAudioMixing	开始播放音乐文件
stopAudioMixing	停止播放音乐文件
pauseAudioMixing	暂停播放音乐文件
resumeAudioMixing	恢复播放音乐文件
adjustAudioMixingVolume	调节音乐文件播放音量
adjustAudioMixingPlayoutVolume	调节音乐文件的本地播放音量
adjustAudioMixingPublishVolume	调节音乐文件的远端播放音量
getAudioMixingPlayoutVolume	获取音乐文件的本地播放音量
getAudioMixingPublishVolume	获取音乐文件的远端播放音量

音效文件播放管理

方法	描述
getAudioEffectManager	获取 IAudioEffectManager 类，以管理音效文件
getEffectsVolume	获取播放音效文件音量
setEffectsVolume	设置播放音效文件音量
setVolumeOfEffect	实时调整播放音效文件音量
playEffect	播放指定音效文件
stopEffect	停止播放指定音效文件
stopAllEffects	停止播放所有音效文件
preloadEffect	将音效文件加载至内存
unloadEffect	从内存释放某个预加载的音效文件
pauseEffect	暂停音效文件播放
pauseAllEffects	暂停所有音效文件播放
resumeEffect	恢复播放指定音效文件
resumeAllEffects	恢复播放所有音效文件

CDN 推流

该组方法仅适用于互动直播。

方法	描述
setLiveTranscoding	设置直播转码
addPublishStreamUrl	增加旁路推流地址
removePublishStreamUrl	删除旁路推流地址

事件	描述
onRtmpStreamingStateChanged	旁路推流状态改变回调
onRtmpStreamingEvent	RTMP/RTMPS 推流事件回调
onTranscodingUpdated	旁路推流设置已被更新回调

跨频道媒体流转发

方法	描述
startChannelMediaRelay	开始跨频道媒体流转发
updateChannelMediaRelay	更新媒体流转发的频道
stopChannelMediaRelay	停止跨频道媒体流转发

事件	描述
onChannelMediaRelayStateChanged	跨频道媒体流转发状态发生改变回调
onChannelMediaRelayEvent	跨频道媒体流转发事件回调

直播导入在线媒体流

• 该组方法仅适用于互动直播。
• 我们为该组接口提供了详细的场景描述、实现方法及开发注意事项文档。

方法	描述
addInjectStreamUrl	导入在线媒体流
removeInjectStreamUrl	删除导入的在线媒体流

事件	描述
onStreamInjectedStatus	导入在线媒体流状态回调

音量提示

方法	描述
enableAudioVolumeIndication	启用说话者音量提示

事件	描述
onAudioVolumeIndication	提示频道内谁正在说话及说话者音量的回调
onActiveSpeaker	监测到活跃用户回调

语音播放路由

方法	描述
setDefaultAudioRoutetoSpeakerphone	设置默认的音频播放路由
setEnableSpeakerphone	启用/关闭扬声器播放
isSpeakerphoneEnabled	查询扬声器启用状态

事件	描述
onAudioRouteChanged	语音路由已改变回调

耳返控制

方法	描述
enableInEarMonitoring	开启耳返功能
setInEarMonitoringVolume	设置耳返音量

视频双流模式

方法	描述
enableDualStreamMode	开关视频双流模式
setRemoteVideoStreamType	设置订阅的视频流类型
setRemoteDefaultVideoStreamType	设置默认订阅的视频流类型

自定义视频模块

方法	描述
setVideoSource	设置自定义视频源

视频自采集（仅适用于 Push 模式）

方法	描述
setExternalVideoSource	配置外部视频源
pushExternalVideoFrame	推送外部视频帧

音频自采集（仅适用于 Push 模式）

方法	描述
setExternalAudioSource	设置外部音频采集参数
pushExternalAudioFrame	推送外部音频帧

音频自渲染

方法	描述
setExternalAudioSink	设置外部音频渲染
pullPlaybackAudioFrame	拉取外部音频数据

原始音频数据

你可以使用 C++ 的原始音频数据接口，实现相关功能。

原始视频数据

你可以使用 C++ 的原始视频数据接口，实现相关功能。

摄像头控制

方法	描述
switchCamera	切换前置/后置摄像头
isCameraZoomSupported	检测设备是否支持摄像头缩放功能
isCameraTorchSupported	检测设备是否支持闪光灯常开
isCameraFocusSupported	检测设备是否支持手动对焦功能
isCameraExposurePositionSupported	检测设备是否支持手动曝光功能
isCameraAutoFocusFaceModeSupported	检测设备是否支持人脸对焦功能
setCameraZoomFactor	设置摄像头缩放比例
getCameraMaxZoomFactor	获取摄像头支持最大缩放比例
setCameraFocusPositionInPreview	设置手动对焦位置，并触发对焦
setCameraExposurePosition	设置手动曝光位置
setCameraTorchOn	设置是否打开闪光灯
setCameraAutoFocusFaceModeEnabled	设置是否开启人脸对焦功能

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

音频录制

方法	描述
startAudioRecording	开始客户端录音
stopAudioRecording	停止客户端录音

其他视频控制

方法	描述
setCameraCapturerConfiguration	设置摄像头的采集偏好

其他方法

方法	描述
getCallId	获取通话 ID
getSdkVersion	查询 SDK 版本号
getErrorDescription	获取警告或错误描述
setLogFile	设置日志文件
setLogFilter	设置日志输出等级
setLogFileSize	设置日志文件大小

其他事件

事件	描述
onWarning	发生警告回调
onError	发生错误回调