API 概览

最近更新时间:2021-05-27 07:24:21

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

频道管理

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

频道事件

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

音频管理

方法描述
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设置是否默认接收视频流

本地媒体事件

事件描述
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旁路推流状态改变回调
onRtmpStreamingEventRTMP/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发生错误回调