概览

核心方法

名称	描述
RTCEngine()	引擎创建
initWithToken()	初始化token接口
init()	引擎初始化
setRole()	设置直播场景下的用户角色
joinRoom()	加入频道。
leaveRoom()	离开频道。
destroy()	销毁 RtcEngine 实例。
getConnectionState()	获取连接状态
switchChannelWithRealToken()	快速切换直播频道

核心事件

名称	描述
onLeaveChannel()	用户离开房间成功
localUserJoindWithUid()	加入频道回调。
remoteUserJoinWitnUid()	远端用户（通信场景）/主播（直播场景）加入当前频道回调。
didOfflineOfUid()	远端用户（通信场景）/主播（直播场景）离开当前频道回调。
didOccurError()	发生错误回调。
connectionChangedToState()	网络连接状态已改变回调。

音频管理

名称	描述
enableLocalAudio()	开启/关闭本地音频采集。
muteLocalAudio()	取消或恢复发布本地音频流。
muteRemoteAudio()	取消或恢复订阅指定远端用户的音频流。
muteAllRemoteAudio()	取消或恢复订阅所有远端用户的音频流。
setDefaultMuteAllRemoteAudioStreams()	设置是否默认接收音频流。 - 后续通过 mute false打开
setRemoteMixedVolume()	调节本地播放的所有远端用户信号音量。

视频管理

名称	描述
enableVideo()	启用视频模块。
enableLocalVideo()	开启/关闭本地视频采集。
muteLocalVideo()	取消或恢复发布本地视频流。
muteRemoteVideo()	取消或恢复订阅指定远端用户的视频流。
muteAllRemoteVideo()	取消或恢复订阅所有远端用户的视频流。
setLocalRenderMode()	设置本地视频显示模式。
setRemoteRenderMode()	设置远端渲染方式
setRemoteRenderMode()	设置远端视频显示模式。
createRendererView()	创建 RendererView。
startPreview()	开启视频预览。
stopPreview()	停止本地视频预览。
setDefaultMuteAllRemoteVideoStreams()	设置是否默认接收视频流。 - 后续通过 mute false打开
createTextureView()	该方法创建 TextureView，适用于需要对视频画面进行缩放、旋转和平移的场景，如屏幕共享

本地媒体事件

名称	描述
onLocalVideoStateChanged()	本地视频状态改变回调
onLocalAudioStateChanged()	本地音频状态改变回调
onPublishVideoStateChanged()	发布视频状态变化回调
onPublishAudioStateChanged()	发布音频状态变化回调

远端媒体事件

名称	描述
onSubscribeVideoStateChanged()	订阅视频状态通知回调
onSubscribeAudioStateChanged()	订阅音频状态通知回调
remotefirstVideoRecvWithUid()	已完成远端视频首帧解码回调。
remotefirstAudioRecvWithUid()	已接收远端音频首帧回调。
didAudioMuted()	远端用户停止/恢复发送音频流回调。
didVideoMuted()	远端用户取消或恢复发布视频流回调。

数据统计事件

名称	描述
onLocalVideoStats()	本地视频状态回调
onLocalAudioStats()	本地音频状态回调
onRemoteVideoStats()	远端视频状态回调
onRemoteAudioStats()	远端音频状态回调
reportRtcStats()	当前通话统计回调。 该回调在通话中每两秒触发一次。

音乐播放

名称	描述
startPlayMusic()	播放本地音乐
startPlayMusic()	开始播放音乐文件，该方法支持将本地或在线音乐文件和麦克风采集的音频进行混音或替换
stopPlayMusic()	停止播放音乐文件及混音。
pauseAudioMusic()	暂停播放音乐文件及混音。
resumeAudioMusic()	恢复播放音乐文件及混音。
getAudioMusicDuration()	获取音乐文件的时长。
getAudioMusicCurrentPosition()	获取音乐文件的播放进度。
setAudioMusicPosition()	设置音乐文件的播放位置。
playMusicVolume()	调节音乐文件的播放音量。

旁路转推

名称	描述
addPublishStreamUrl()	推流到CDN,增加旁路推流地址
removePublishStreamUrl()	移除CDN推流，删除旁路推流地址
setRtmpConfig()	设置rmpt配置，该方法用于旁路推流的视图布局及音频设置等。

跨频道媒体流转发

名称	描述
startChannelMediaRelay()	开始跨房间转推流
stopChannelMediaRelay()	停止跨房间转推流
updateChannelMediaRelay()	更新转推流信息

事件监听

名称	描述
setRtcEngineEventListener()	设置engine事件监听
setRtcEngineEventObserver()	设置补充回调
setAudioObserver()	设置混音后音视频裸数据回调
setMediaVideoProcessListener()	设置视频采集/播放回调