实时互动 API

本页展示 PaaS 方案中高频调用的实时互动 SDK API。

API 名称	描述
create [1/2]	创建并初始化 RtcEngine。
create [2/2]	创建并初始化 RtcEngine。
destroy	销毁 RtcEngine 对象。
joinChannel [1/2]	加入频道。
joinChannel [2/2]	设置媒体选项并加入频道。
joinChannelEx	加入多个频道。
updateChannelMediaOptions	加入频道后更新频道媒体选项。
updateChannelMediaOptionsEx	加入多个频道后更新频道媒体选项 。
leaveChannel [2/2]	设置频道选项并离开频道。
leaveChannelEx [2/2]	设置频道选项并离开多个频道。
renewToken	更新 Token。
setClientRole [1/2]	设置用户角色。
setClientRole [2/2]	设置直播场景下的用户角色和观众端延时级别。
enableAudio	启用音频模块。
enableAudioVolumeIndication	启用用户音量提示。
setAudioProfile [2/2]	设置音频编码属性。
setAudioScenario	设置音频场景。
muteLocalAudioStream	取消或恢复发布本地音频流。
adjustRecordingSignalVolume	调节音频采集信号音量。
enableInEarMonitoring [2/2]	开启耳返功能。
sendStreamMessage	发送数据流。
createDataStream [1/2]	创建数据流。
createDataStream [2/2]	创建数据流。
setAudioDualMonoMode	设置当前音频文件的声道模式。
setAudioEffectPreset	设置 SDK 预设的人声音效。
createMediaPlayer	创建媒体播放器对象。媒体播放器全部接口详见 IMediaPlayer。
selectAudioTrack	指定当前音频文件的播放音轨。
initialize	初始化音乐内容中心。音乐内容中心全部接口详见 IAgoraMusicContentCenter。
setPlayMode	设置音乐资源的播放模式。音乐播放器全部接口详见 IAgoraMusicPlayer。
onJoinChannelSuccess	成功加入频道回调。
onRejoinChannelSuccess	成功重新加入频道回调。
onClientRoleChanged	用户角色、观众端延时级别已切换回调。
onLeaveChannel	离开频道回调。
onUserJoined	远端用户（通信场景）/主播（直播场景）加入当前频道回调。
onUserOffline	远端用户（通信场景）/主播（直播场景）离开当前频道回调。
onRequestToken	Token 已过期回调。
onTokenPrivilegeWillExpire	Token 即将在 30s 内过期回调。
onAudioVolumeIndication	用户音量提示回调。
onStreamMessage	接收到对方数据流消息的回调。
onStreamMessageError	接收对方数据流消息发生错误的回调。