| 名称 | 描述 |
|---|---|
| createRTCRoom() | 创建房间实例 |
| getRoomId() | 获取房间 ID |
| destroy() | 退出并销毁房间。 |
| joinRoom() | 加入房间。 |
| leaveRoom() | 离开房间。 |
| setUserVisibility() | 设置用户可见性。未调用该接口前，本地用户默认对他人可见。 |
| setMultiDeviceAVSync() | 设置发流端音画同步。 |
| updateToken() | 更新 Token。 Token 中同时包含进房、发布和订阅权限，各权限有一定的有效期，并且到期前 30 秒会触发回调，提示用户更新 Token 相关权限。此时需要重新获取 Token，并调用此方法更新 Token，以保证通话的正常进行。 |
| setRemoteVideoConfig() | 设置期望订阅的远端视频流的参数。 |
| publishStream() | 在当前所在房间内发布本地通过摄像头/麦克风采集的媒体流 |
| unpublishStream() | 停止将本地摄像头/麦克风采集的媒体流发布到当前所在房间中 |
| publishScreen() | 在当前所在房间内发布本地屏幕共享音视频流 |
| unpublishScreen() | 停止将本地屏幕共享音视频流发布到当前所在房间中 |
| subscribeStream() | 订阅房间内指定的通过摄像头/麦克风采集的媒体流，或更新对指定远端用户的订阅选项 |
| unsubscribeStream() | 取消订阅房间内指定的通过摄像头/麦克风采集的媒体流。该方法对自动订阅和手动订阅模式均适用。 |
| subscribeAllStreams() | 订阅房间内所有通过摄像头/麦克风采集的媒体流，或更新订阅选项。 |
| unsubscribeAllStreams() | 取消订阅房间内所有的通过摄像头/麦克风采集的媒体流。 |
| subscribeScreen() | 订阅房间内指定的远端屏幕共享音视频流，或更新对指定远端用户的订阅选项 |
| unsubscribeScreen() | 取消订阅房间内指定的远端屏幕共享音视频流。 |
| pauseAllSubscribedStream() | 暂停接收来自远端的媒体流。 |
| resumeAllSubscribedStream() | 恢复接收来自远端的媒体流 |
| sendUserMessage() | 给房间内指定的用户发送点对点文本消息 |
| sendUserBinaryMessage() | 给房间内指定的用户发送点对点二进制消息。 |
| sendRoomMessage() | 给房间内的所有其他用户群发文本消息。 |
| sendRoomBinaryMessage() | 给房间内的所有其他用户群发二进制消息。 |
| startForwardStreamToRooms() | 开始跨房间转发媒体流。 |
| updateForwardStreamToRooms() | 更新跨房间媒体流转发信息。 |
| stopForwardStreamToRooms() | 停止跨房间媒体流转发。 |
| pauseForwardStreamToAllRooms() | 暂停跨房间媒体流转发。 |
| resumeForwardStreamToAllRooms() | 恢复跨房间媒体流转发。 |
| enableRangeAudio() | 开启/关闭范围语音功能。 |
| updateReceiveRange() | 更新本地用户的音频收听范围。 |
| updateRangePosition() | 更新本地用户在房间内空间直角坐标系中的位置坐标。 |
| setAttenuationModel() | 设置范围语音的音量衰减模式。 |
| setNoAttenuationFlags() | 添加标签组，用于标记相互之间通话不衰减的用户组。 在同一个 RTC 房间中，如果多个用户的标签组之间有交集，那么，他们之间互相通话时，通话不衰减。 比如，用户身处多个队伍，队伍成员间通话不衰减。那么，可以为每个队伍绑定专属标签，每个用户的标签组包含用户所属各个队伍的标签。 |
| enableSpatialAudio() | 开启/关闭空间音频功能。 |
| updateSpatialPosition() | 更新本地用户在房间内空间直角坐标系中的位置坐标。 |
| updateSelfOrientation() | 更新本地用户在空间音频坐标系下的朝向。 |
| disableRemoteOrientation() | 参与通话的各端调用本接口后，将忽略远端用户的朝向，认为所有远端用户都面向本地用户。 |
| updateListenerPosition() | 更新在房间内收听音频时的位置。 通过此接口，你可以设定本地发声位置和收听位置不同。 |
| updateListenerOrientation() | 更新在房间内收听音频时的朝向。 通过此接口，你可以设定本地用户的发声朝向和收听朝向不同。 |
| setRemoteRoomAudioPlaybackVolume() | 调节某个房间内所有远端用户的音频播放音量。 |
| 名称 | 描述 |
|---|---|
| onRoomStateChanged() | 房间状态改变回调，加入房间、离开房间、发生房间相关的警告或错误时会收到此回调。 |
| onStreamStateChanged() | 流状态改变回调，发生流相关的警告或错误时会收到此回调。 |
| onLeaveRoom() | 离开房间成功回调。 |
| onUserJoined() | 可见用户加入房间，或房内隐身用户切换为可见的回调。 1.远端可见用户调用 setUserVisibility 方法将自身设为可见后加入房间时，房间内其他用户将收到该事件。2.远端可见用户断网后重新连入房间时，房间内其他用户将收到该事件。 3.房间内隐身远端用户调用 setUserVisibility 方法切换至可见时，房间内其他用户将收到该事件。4.新进房用户也会收到进房前已在房内的可见角色用户的进房回调通知。 |
| onUserLeave() | 远端用户离开房间，或切至不可见时，本地用户会收到此事件 |
| onTokenWillExpire() | Token 过期前 30 秒将触发该回调。 |
| onAVSyncStateChange() | 发布端调用 setMultiDeviceAVSync 后音视频同步状态发生改变时，会收到此回调。 |
| onRoomStats() | 房间通话统计信息回调。 用户进房开始通话后，每 2s 收到一次本回调。 |
| onLocalStreamStats() | 反映通话中本地设备发送音/视频流的统计信息以及网络状况的回调。 本地用户发布音视频流成功后，每隔 2s 收到此回调。 |
| onRemoteStreamStats() | 反映通话中本地设备接收订阅的远端音/视频流的统计信息以及网络状况的回调。每隔 2s 收到此回调。 |
| onUserPublishStream() | 房间内新增远端麦克风采集的音频流的回调。 |
| onUserUnpublishStream() | 房间内远端麦克风采集的音频流移除的回调。 |
| onUserPublishScreen() | 房间内新增远端屏幕共享音视频流的回调。 |
| onUserUnpublishScreen() | 房间内远端屏幕共享音视频流移除的回调。 |
| onStreamSubscribed() | 关于订阅媒体流状态改变的回调 |
| onVideoStreamBanned() | 通过调用服务端 BanUserStream/UnbanUserStream 方法禁用/解禁指定房间内指定用户视频流的发送时，触发此回调。 |
| onAudioStreamBanned() | 通过调用服务端 BanUserStream/UnbanUserStream 方法禁用/解禁指定房间内指定用户音频流的发送时，触发此回调。 |
| onRoomMessageReceived() | 接收到房间内广播消息的回调。 |
| onRoomBinaryMessageReceived() | 接收到房间内广播二进制消息的回调。 |
| onUserMessageReceived() | 收到来自房间中其他用户通过 sendUserMessage 发来的点对点文本消息时，会收到此回调。 |
| onUserBinaryMessageReceived() | 收到来自房间中其他用户通过 sendUserBinaryMessage 发来的点对点二进制消息时，会收到此回调。 |
| onUserMessageSendResult() | 向房间内单个用户发送点对点文本或点对点二进制消息后，消息发送方会收到该消息发送结果回调。 |
| onRoomMessageSendResult() | 调用 sendRoomMessage 或 sendRoomBinaryMessage 向房间内群发文本或二进制消息后，消息发送方会收到该消息发送结果回调。 |
| onForwardStreamStateChanged() | 跨房间媒体流转发状态和错误回调 |
| onForwardStreamEvent() | 跨房间媒体流转发事件回调 |
| onNetworkQuality() | 加入房间后， 以 2 秒 1 次的频率，报告用户的网络质量信息 |
| onPublishPrivilegeTokenWillExpire() | Token 发布权限过期前 30 秒将触发该回调。 |
| onSubscribePrivilegeTokenWillExpire() | Token 订阅权限过期前 30 秒将触发该回调。 |
| 名称 | 描述 |
|---|---|
| onLogReport() | 端监控日志回调。当产生一个端监控事件时触发该回调。 |
| onMusicListResult() | 歌曲列表回调。 |
| onSearchMusicResult() | 搜索歌曲结果回调。 |
| onHotMusicResult() | 热榜歌曲结果回调。 |
| onMusicDetailResult() | 歌曲详细信息回调。 |
| onDownloadSuccess() | 下载成功回调。 |
| onDownloadFailed() | 下载失败回调。 |
| onDownloadMusicProgress() | 歌曲文件下载进度回调。 |
| onPlayProgress() | 音乐播放进度回调。 |
| onPlayStateChange() | 音乐播放状态改变回调。 |
| onRemoteVideoSuperResolutionModeChanged() | 远端视频流的超分状态发生改变时，房间内订阅此流的用户会收到该回调。 |
| onTakeLocalSnapshotResult() | 调用 takeLocalSnapshot 截取视频画面时，收到此回调。 |
| onTakeRemoteSnapshotResult() | 调用 takeRemoteSnapshot 截取视频画面时，收到此回调。 |
| onCreateRoomStateChanged() | 创建房间失败回调。 |
| onHttpProxyState() | HTTP 代理连接状态改变时，收到该回调。 |
| onHttpsProxyState() | HTTPS 代理连接状态改变时，收到该回调。 |
| onSocks5ProxyState() | SOCKS5 代理状态改变时，收到该回调。 |
| onStreamSyncInfoReceived() | 音频流同步信息回调。可以通过此回调，在远端用户调用 sendStreamSyncInfo 发送音频流同步消息后，收到远端发送的音频流同步信息。 |
| onScreenAudioFrameSendStateChanged() | 屏幕音频首帧发送状态改变回调 |
| onScreenAudioFramePlayStateChanged() | 屏幕音频首帧播放状态改变回调 |
| onCloudProxyConnected() | 调用 startCloudProxy 开启云代理，SDK 首次成功连接云代理服务器时，回调此事件。 |
| onNetworkTimeSynchronized() | 首次调用 getNetworkTimeInfo 后，SDK 内部启动网络时间同步，同步完成时会触发此回调。 |
| onLicenseWillExpire() | license过期时间提醒 |
| onMixingVideoFrame() | 合流视频回调，运行在视频回调线程 |
| onMixingAudioFrame() | 合流音频回调，运行在音频回调线程 |
| onMixingDataFrame() | 视频 SEI 帧回调，运行在视频回调线程 |
| onFaceDetectResult() | 特效 SDK 进行人脸检测结果的回调。 调用 enableFaceDetection 注册了回调，并使用 RTC SDK 中包含的特效 SDK 进行视频特效处理时，你会收到此回调。 |
| onAudioDeviceVolumeChanged() | 音频设备音量改变回调。当通过系统设置，改变音频设备音量或静音状态时，触发本回调。本回调无需手动开启。 |
| onCurrentScoringInfo() | 实时评分信息回调。 |
| onAudioRecordingStateUpdate() | 调用 startAudioRecording 或 stopAudioRecording 改变音频文件录制状态时，收到此回调。 |
| onFirstPublicStreamAudioFrame() | 公共流的音频首帧解码成功 |
| onPushPublicStreamResult() | 公共流发布结果回调。 调用 startPushPublicStream 接口发布公共流后，启动结果通过此回调方法通知用户。 |
| onFirstPublicStreamVideoFrameDecoded() | 公共流的首帧视频解码成功 |
| onPublicStreamSEIMessageReceived() | 回调公共流中包含的 SEI 信息 |
| onPlayPublicStreamResult() | 订阅公共流的结果回调 通过 startPlayPublicStream 订阅公共流后，可以通过本回调获取订阅结果。 |
| onLocalScreenFrame() | 获取采集成功的本地屏幕视频帧，用于自定义处理或渲染。 |
| onLocalVideoFrame() | 获取采集成功的本地摄像头流视频帧，用于自定义处理或渲染。 |
| onRemoteScreenFrame() | 视频管理获取采集成功的远端屏幕视频帧，用于自定义处理或渲染。 |
| onRemoteVideoFrame() | 获取采集成功的远端摄像头流视频帧，用于自定义处理或渲染。 |
| onPublicStreamVideoFrame() | 公共流视频数据回调，绑定公共流到自定义渲染器后，通过该回调获取公共流视频数据。 |
| onWarning() | 当内部发生警告事件时触发该回调 |
| onError() | 当内部发生不可逆转错误时触发该回调 |
| onAudioMixingFinished() | 本地音乐文件播放已结束回调。 |
| onAudioMixingStateChanged() | 音频混音文件播放状态改变时回调 |
| onAudioMixingPlayingProgress() | 混音音频文件播放进度回调 |
| onConnectionStateChanged() | SDK 与信令服务器连接状态改变回调。连接状态改变时触发。 |
| onNetworkTypeChanged() | SDK 当前网络连接类型改变回调。当 SDK 的当前网络连接类型发生改变时回调该事件。 |
| onPerformanceAlarms() | 本地未开启发布性能回退，检测到设备性能不足时，收到此回调。本地开启发布性能回退，因设备性能/网络原因，造成发布性能回退/恢复时，收到此回调。 |
| onSysStats() | 周期性地发出回调，报告当前cpu与memory使用率 |
| onUserStartAudioCapture() | 房间内的用户调用 startAudioCapture 开启音频采集时，房间内其他用户会收到此回调。 |
| onUserStopAudioCapture() | 房间内的用户调用 stopAudioCapture 关闭音频采集时，房间内其他用户会收到此回调。 |
| onFirstLocalAudioFrame() | 本地采集到第一帧音频帧时，收到该回调 |
| onFirstRemoteAudioFrame() | 收到房间内每一路音频流的第一帧时，收到该回调。 |
| onSimulcastSubscribeFallback() | 因发布/订阅性能回退或退出回退状态，订阅的音视频流，发生流的切换时，收到该回调。 |
| onFirstLocalVideoFrameCaptured() | 第一帧本地采集的视频/屏幕共享画面在本地视图渲染完成时，收到此回调。 |
| onLocalVideoSizeChanged() | 本地视频大小或旋转配置发生改变时，收到此回调。 |
| onRemoteVideoSizeChanged() | 远端视频大小或旋转配置发生改变时，房间内订阅此视频流的用户会收到此回调。 |
| onFirstRemoteVideoFrameRendered() | 第一帧远端视频流在视图上渲染成功后，收到此回调。 |
| onFirstRemoteVideoFrameDecoded() | SDK 接收并解码远端视频流首帧后，收到此回调。 |
| onUserStartVideoCapture() | 房间内的用户调用 startVideoCapture 开启视频采集时，房间内其他用户会收到此回调。 |
| onUserStopVideoCapture() | 房间内的用户调用 stopVideoCapture 关闭视频采集时，房间内其他用户会收到此回调。 |
| onLocalAudioStateChanged() | 本地音频的状态发生改变时，该回调通知当前的本地音频状态。 |
| onActiveSpeaker() | 调用 enableAudioPropertiesReport 后，根据设置的 config.interval，你会周期性地收到此回调，获取房间内的最活跃用户信息。 |
| onLocalVideoStateChanged() | 本地视频流的状态发生改变时，收到该事件。 |
| onAudioFrameSendStateChanged() | 音频首帧发送状态改变回调 |
| onVideoFrameSendStateChanged() | 视频首帧发送状态改变回调 |
| onScreenVideoFrameSendStateChanged() | 屏幕共享流视频首帧发送状态改变回调 |
| onAudioFramePlayStateChanged() | 音频首帧播放状态改变回调 |
| onVideoFramePlayStateChanged() | 视频首帧播放状态改变回调 |
| onScreenVideoFramePlayStateChanged() | 屏幕共享流视频首帧播放状态改变回调 |
| onUserMessageSendResult() | 当调用 sendMessageToUser 函数发送消息后，回调此条消息的发送结果（反馈）。 |
| onUserBinaryMessageReceived() | 单个用户接收到同一房间内其他 uid 所属用户发来二进制消息的回调（P2P）。 |
| onStreamSubscribed() | 当订阅一个流成功的时候回调该事件 |
| onSEIMessageReceived() | 收到通过 sendSEIMessage 发送的带有 SEI 消息的视频帧时，收到此回调 |
| onStreamMixingEvent() | 通知转推直播关键事件 |
| onStreamPushEvent() | 单流转推直播状态回调 |
| onRecordingStateUpdate() | 获取本地录制状态回调。 |
| onRecordingProgressUpdate() | 本地录制进度回调。 |
| onLoginResult() | 调用 login 后，会收到此回调。 |
| onLogout() | 登出结果回调 |
| onServerParamsSetResult() | 设置业务服务器参数的返回结果 |
| onGetPeerOnlineStatus() | 查询对端或本端用户登录状态的返回结果 |
| onUserMessageReceivedOutsideRoom() | 收到房间外用户调用 sendUserMessageOutsideRoom 发来的文本消息时，会收到此回调 |
| onUserBinaryMessageReceivedOutsideRoom() | 收到房间外用户调用 sendUserBinaryMessageOutsideRoom 发来的二进制消息时，会收到此回调 |
| onUserMessageSendResultOutsideRoom() | 给房间外指定的用户发送消息的回调 |
| onServerMessageSendResult() | 给业务服务器发送消息的回调 |
| onRecordAudioFrame() | 返回麦克风录制的音频数据 |
| onPlaybackAudioFrame() | 返回远端所有用户混音后的音频数据 |
| onMixedAudioFrame() | 返回本地麦克风录制和远端所有用户混音后的音频数据 |
| onASRSuccess() | 语音识别服务开启成功回调 |
| onMessage() | 语音转文字成功回调，该回调返回识别后的全量消息。 |
| onASRError() | 当语音识别服务内部发生错误事件时触发该回调。 |
| onNetworkDetectionResult() | 成功调用 startNetworkDetection 接口开始探测后，会在 3s 内首次收到该回调，之后每 2s 收到一次该回调。 |
| onNetworkDetectionStopped() | 通话前网络探测结束 |
| onLocalAudioPropertiesReport() | 调用 enableAudioPropertiesReport 后，根据设置的 interval 值，你会周期性地收到此回调，了解本地音频的相关信息。 |
| onRemoteAudioPropertiesReport() | 远端用户进房后，本地调用 enableAudioPropertiesReport，根据设置的 interval 值，本地会周期性地收到此回调，了解订阅的远端用户的音频信息。 |
| onEchoTestResult() | 通话前网络探测结束 |
| onVideoDeviceStateChanged() | 视频频设备状态回调。提示摄像头视频采集、屏幕视频采集等设备的状态。 |
| onAudioDeviceStateChanged() | 音频设备状态回调。提示音频采集、音频播放等设备设备的状态。 |
| onAudioPlaybackDeviceTestVolume() | 回调音频设备测试时的播放音量 |