| 名称 | 描述 |
|---|---|
| createRTCRoom() | 创建房间 多次调用此方法以创建多个 veRTCRoom 实例。分别调用各实例中的 joinRoom 方法，同时加入多个房间。多房间模式下，用户可以同时订阅各房间的音视频流。 |
| getRoomId() | 获取房间 ID |
| destroy() | 退出并销毁调用 createRTCRoom 所创建的房间。 |
| joinRoom() | 加入房间。 多房间场景下，调用 createRTCRoom 创建房间后，调用此方法加入房间，同房间内其他用户进行音视频通话。 |
| leaveRoom() | 离开房间。 用户调用此方法离开房间，结束通话过程，释放所有通话相关的资源。 调用 joinRoom 方法加入房间后，必须调用此方法结束通话，否则无法开始下一次通话。无论当前是否在房间内，都可以调用此方法。重复调用此方法没有负面影响。 此方法是异步操作，调用返回时并没有真正退出房间。真正退出房间后，本地会收到 onLeaveRoom 回调通知。 |
| setUserVisibility() | 设置用户可见性。默认可见。 |
| setMultiDeviceAVSync() | 设置发流端音画同步。 当同一用户同时使用两个通话设备分别采集发送音频和视频时，有可能会因两个设备所处的网络环境不一致而导致发布的流不同步，此时你可以在视频发送端调用该接口，SDK 会根据音频流的时间戳自动校准视频流，以保证接收端听到音频和看到视频在时间上的同步性。 |
| updateToken() | 更新 Token。 用于加入房间的 Token 有一定的有效期。在 Token 过期前 30 秒，会收到 onTokenWillExpire 回调，此时需要重新获取 Token，并调用此方法更新 Token，否则用户将因为 Token 过期被移出房间。 调用 joinRoom 方法加入房间或断网重连进入房间时，如果 Token 过期或无效，将导致加入房间失败，并会收到 onRoomStateChanged 回调通知，回调错误码为 ErrorCode} 中的 ERROR_CODE_INVALID_TOKEN。此时需要重新获取 Token，并调用此方法更新 Token。 |
| setRemoteVideoConfig() | 设置期望订阅的远端视频流的参数。 |
| publishStream() | 在当前所在房间内发布本地通过摄像头/麦克风采集的媒体流 |
| unpublishStream() | 停止将本地摄像头/麦克风采集的媒体流发布到当前所在房间中 |
| publishScreen() | 在当前所在房间内发布本地屏幕共享音视频流 |
| unpublishScreen() | 停止将本地屏幕共享音视频流发布到当前所在房间中 |
| subscribeStream() | 订阅房间内指定的通过摄像头/麦克风采集的媒体流，或更新对指定远端用户的订阅选项 |
| unsubscribeStream() | 取消订阅房间内指定的通过摄像头/麦克风采集的媒体流。 该方法对自动订阅和手动订阅模式均适用。 |
| subscribeScreen() | 订阅房间内指定的远端屏幕共享音视频流，或更新对指定远端用户的订阅选项 |
| unsubscribeScreen() | 取消订阅房间内指定的远端屏幕共享音视频流。 该方法对自动订阅和手动订阅模式均适用。 |
| pauseAllSubscribedStream() | 暂停接收来自远端的媒体流。 |
| resumeAllSubscribedStream() | 恢复接收来自远端的媒体流 |
| sendUserMessage() | 给房间内指定的用户发送点对点文本消息 |
| sendUserBinaryMessage() | 给房间内指定的用户发送点对点二进制消息。 |
| sendRoomMessage() | 给房间内的所有其他用户群发文本消息。 |
| sendRoomBinaryMessage() | 给房间内的所有其他用户群发二进制消息。 |
| startForwardStreamToRooms() | 开始跨房间转发媒体流。 在用户进入房间后调用本接口，实现向多个房间转发媒体流，适用于跨房间连麦等场景。 |
| updateForwardStreamToRooms() | 更新跨房间媒体流转发信息。 通过 startForwardStreamToRooms 发起媒体流转发后，可调用本方法增加或者减少目标房间，或更新房间密钥。 调用本方法增加或删减房间后，将在本端触发 onForwardStreamStateChanged 回调，包含发生了变动的目标房间中媒体流转发状态。 |
| stopForwardStreamToRooms() | 停止跨房间媒体流转发。 通过 startForwardStreamToRooms 发起媒体流转发后，可调用本方法停止向所有目标房间转发媒体流。 |
| pauseForwardStreamToAllRooms() | 暂停跨房间媒体流转发。 通过 startForwardStreamToRooms 发起媒体流转发后，可调用本方法暂停向所有目标房间转发媒体流。 调用本方法暂停向所有目标房间转发后，你可以随时调用 resumeForwardStreamToAllRooms(#resumeforwardstreamtoallrooms) 快速恢复转发。 |
| resumeForwardStreamToAllRooms() | 恢复跨房间媒体流转发。 调用 pauseForwardStreamToAllRooms 暂停转发之后，调用本方法恢复向所有目标房间转发媒体流。 |
| enableRangeAudio() | 游戏语音场景下，是否开启区域语音，默认开启区域语音 |
| updateReceiveRange() | 更新本地用户的音频收听范围。 |
| updateRangePosition() | 更新本地用户在房间内空间直角坐标系中的位置坐标。 |
| registerRangeAudioObserver() | 设置范围语音衰减系数监测器。 设置后，SDK 会在监测到房间内有用户更新自身位置坐标或音频收听范围后，触发 onRangeAudioInfo 回调。 |
| setAttenuationModel() | 设置范围语音的音量衰减模式。 衰减模式更改后，onRangeAudioInfo 回调将根据最后设置的衰减模式进行计算并返回音量衰减数值 |
| enableSpatialAudio() | 开启/关闭空间音频功能。 |
| updateSpatialPosition() | 更新本地用户在房间内空间直角坐标系中的位置坐标。 |
| updateSelfOrientation() | 更新本地用户在空间音频坐标系下的朝向。 |
| disableRemoteOrientation() | 参与通话的各端调用本接口后，将忽略远端用户的朝向，认为所有远端用户都面向本地用户。 如果此后调用 updateSelfOrientation 更新本地用户朝向，远端用户无法感知这些变化，但本地用户接收音频时可以感知自身朝向改变带来的音频效果变化。 |
| 名称 | 描述 |
|---|---|
| createRTCVideo() | 创建引擎对象
如果当前线程中未创建引擎实例，那么你必须先使用此方法，以使用 RTC 提供的各种音视频能力。
如果当前线程中已创建了引擎实例，再次调用此方法时，会返回已创建的引擎实例。 |
| destroyRTCVideo() | 销毁引擎实例对象 | | feedback() | 本次通话质量打分评价 | | getErrorDescription() | 获取错误码的描述 | | setBusinessId() | 设置业务标识参数 | | setEncryptInfo() | 设置传输时使用内置加密的方式 | | startAudioCapture() | 开启内部音频采集。默认为关闭状态。 | | stopAudioCapture() | 关闭内部音频采集。默认为关闭状态。 | | enumerateAudioPlaybackDevices() | 获取当前系统内音频播放设备列表。如果后续设备有变更，你会收到 onAudioDeviceStateChanged 回调通知，然后需要重新调用本接口以获得新的设备列表。 | | enumerateAudioCaptureDevices() | 获取当前系统内音频采集设备列表。如果后续设备有变更，你需要重新调用本接口以获得新的设备列表。 | | setAudioPlaybackDevice() | 设置音频播放设备。 | | setAudioCaptureDevice() | 设置音频采集设备。 | | getAudioPlaybackDevice() | 获取当前音频播放设备 ID。 | | getAudioCaptureDevice() | 获取当前音频采集设备 ID。 | | setAudioPlaybackDeviceVolume() | 设置当前音频播放设备音量 | | getAudioPlaybackDeviceVolume() | 获取当前音频播放设备音量 | | setAudioCaptureDeviceVolume() | 设置当前音频采集设备音量 | | getAudioCaptureDeviceVolume() | 获取当前音频采集设备音量 | | setAudioPlaybackDeviceMute() | 设置当前音频播放设备静音状态，默认为非静音。 | | getAudioPlaybackDeviceMute() | 获取当前音频播放设备是否静音的信息。 | | setAudioCaptureDeviceMute() | 设置当前音频采集设备静音状态，默认为非静音。 | | getAudioCaptureDeviceMute() | 获取当前音频采集设备是否静音的信息。 | | setCaptureVolume() | 调节音频采集音量 | | setPlaybackVolume() | 调节本地播放的所有远端用户混音后的音量 | | setRemoteAudioPlaybackVolume() | 调节来自远端用户的音频播放音量 | | muteAudioPlayback() | 控制本地音频流播放状态：播放/不播放 | | stopAudioPlaybackDeviceTest() | 停止音频播放设备测试。 | | setVoiceChangerType() | 设置变声特效类型 | | setVoiceReverbType() | 设置混响特效类型 | | setAudioProfile() | 设置混响特效类型 | | startAudioPlaybackDeviceTest() | 启动音频播放设备测试。 该方法测试播放设备是否能正常工作。SDK 播放指定的音频文件，测试者如果能听到声音，说明播放设备能正常工作。 | | startEchoTest() | 开始音频设备回路测试。 | | stopEchoTest() | 停止音频设备回路测试。 | | initAudioPlaybackDeviceForTest() | 尝试初始化音频播放设备，可检测出设备不存在、权限被拒绝/禁用等异常问题。 | | initAudioCaptureDeviceForTest() | 尝试初始化音频播放设备，可检测出设备不存在、权限被拒绝/禁用等异常问题。 | | enableAudioPropertiesReport() | 启用音频信息提示。 | | enableVocalInstrumentBalance() | 开启/关闭音量均衡功能。 | | startVideoCapture() | 开启内部视频采集。默认为关闭状态 | | stopVideoCapture() | 关闭内部视频采集。默认为关闭状态。 | | enumerateVideoCaptureDevices() | 获取当前系统内视频采集设备列表。 | | followSystemPlaybackDevice() | 设置音频播放路由是否跟随系统，默认跟随系统。 | | followSystemCaptureDevice() | 设置音频采集路由是否跟随系统。 | | setVideoCaptureDevice() | 设置当前视频采集设备 | | getVideoCaptureDevice() | 获取当前 SDK 正在使用的视频采集设备信息 | | setVideoEncoderConfig() | 启动推送多路视频流，设置推送多路流时的各路视频参数，包括分辨率、帧率、码率、缩放模式、网络不佳时的回退策略等。 | | setMaxVideoEncoderConfig() | 视频发布端设置期望发布的最大分辨率视频流参数，包括分辨率、帧率、码率、缩放模式、网络不佳时的回退策略等。 | | setLocalVideoMirrorType() | 设置采用前置摄像头采集时，是否开启镜像模式。 | | switchCamera() | 切换视频内部采集时使用的前置/后置摄像头。默认使用前置摄像头。 | | enableSimulcastMode() | 大小流功能控制开关 | | checkLicense() | 视频特效许可证检查 | | getAuthMessage() | 从 CV SDK 获取授权消息，用于获取在线许可证。 | | enableEffect() | 开启关闭视频特效 | | enableEffectBeauty() | 开启/关闭基础美颜 | | setBeautyIntensity() | 调整基础美颜强度 | | setAlgoModelPath() | 设置视频特效算法模型路径 | | setEffectNodes() | 设置视频特效素材包，支持同时设置多个素材包 | | updateNode() | 设置特效强度 | | setColorFilter() | 设置颜色滤镜 | | setColorFilterIntensity() | 设置已启用颜色滤镜的强度 | | startLiveTranscoding() | 开启转推直播，并设置合流的视频视图布局和音频属性。 | | stopLiveTranscoding() | 停止转推直播。会收到 onStreamMixingEvent 回调。 | | updateLiveTranscoding() | 更新转推直播参数。 | | startScreenAudioCapture() | 公共流 | | startMacScreenAudioCapture() | 在屏幕共享时，开始使用 RTC SDK 内部采集方式，采集屏幕音频 | | startScreenVideoCapture() | 采集屏幕视频流，用于共享。屏幕视频流包括：屏幕上显示的内容，应用窗口中显示的内容，或虚拟屏幕中显示的内容。其中，虚拟屏幕中显示的内容仅在 Windows 平台上支持。 | | stopScreenAudioCapture() | 在屏幕共享时，停止使用 RTC SDK 内部采集方式，采集屏幕音频。 | | stopScreenVideoCapture() | 停止屏幕视频流采集。 | | updateScreenCaptureRegion() | 更新屏幕共享区域。 | | updateScreenCaptureHighlightConfig() | 通过 RTC SDK 提供的采集模块采集屏幕视频流时，更新边框高亮设置。默认展示表框。 | | updateScreenCaptureMouseCursor() | 通过 RTC SDK 提供的采集模块采集屏幕视频流时，更新对鼠标的处理设置。默认采集鼠标。 | | updateScreenCaptureFilterConfig() | 通过 RTC SDK 提供的采集模块采集屏幕视频流时，设置需要过滤的窗口。 | | getScreenCaptureSourceList() | 获取屏幕采集对象列表。 | | getThumbnail() | 获取共享对象缩略图 | | getWindowAppIcon() | 获取应用窗体所属应用的图标。 | | setScreenAudioStreamIndex() | 在屏幕共享时，设置屏幕音频流和麦克风采集到的音频流的混流方式 | | setScreenVideoEncoderConfig() | 为发布的屏幕共享视频流设置期望的编码参数，包括分辨率、帧率、码率、缩放模式、网络不佳时的回退策略等。 | | login() | 必须先登录注册一个 uid，才能发送房间外消息和向业务服务器发送消息 | | logout() | 调用本接口登出后，无法调用房间外消息以及端到服务器消息相关的方法或收到相关回调。 | | updateLoginToken() | 更新用户用于登录的 Token Token 有一定的有效期，当 Token 过期时，需调用此方法更新登录的 Token 信息。 调用 login 方法登录时，如果使用了过期的 Token 将导致登录失败，并会收到 onLoginResult 回调通知，错误码为 kLoginErrorCodeInvalidToken。此时需要重新获取 Token，并调用此方法更新 Token。 | | setServerParams() | 设置业务服务器参数。客户端调用 sendServerMessage 或 sendServerBinaryMessage 发送消息给业务服务器之前，必须设置有效签名和业务服务器地址。 | | getPeerOnlineStatus() | 查询对端用户或本端用户的登录状态 | | sendUserMessageOutsideRoom() | 给房间外指定的用户发送文本消息（P2P） | | sendUserBinaryMessageOutsideRoom() | 给房间外指定的用户发送二进制消息（P2P） | | sendServerMessage() | 客户端给业务服务器发送文本消息（P2Server） | | sendServerBinaryMessage() | 客户端给业务服务器发送二进制消息（P2Server） | | sendSEIMessage() | 在视频通信时，通过视频帧发送 SEI 数据。 | | setVideoCaptureConfig() | 设置 RTC SDK 内部采集时的视频采集参数。指定视频采集参数包括模式、分辨率、帧率。 | | startAudioMixing() | 开始播放音乐文件及混音 | | stopAudioMixing() | 停止播放音乐文件及混音 | | pauseAudioMixing() | 暂停播放音乐文件及混音 | | resumeAudioMixing() | 恢复播放音乐文件及混音 | | preloadAudioMixing() | 预加载指定音乐文件到内存中 | | unloadAudioMixing() | 卸载指定音乐文件 | | setAudioMixingVolume() | 调节音乐文件在本地和远端播放的音量大小 | | getAudioMixingDuration() | 获取音乐文件时长 | | getAudioMixingCurrentPosition() | 获取音乐文件播放进度 | | setAudioMixingPosition() | 设置音乐文件的播放位置 | | setAudioMixingDualMonoMode() | 设置当前音频文件的声道模式 | | setAudioMixingPitch() | 开启本地播放音乐文件变调功能，多用于 K 歌场景。 | | setAudioMixingPlaybackSpeed() | 设置混音时音频文件的播放速度 | | setAudioMixingLoudness() | 如果你需要使用 enableVocalInstrumentBalance 对混音使音频文件/PCM 音频数据进行音量调整，你必须通过此接口传入其原始响度。 | | setAudioMixingProgressInterval() | 设置混音时音频文件播放进度回调的间隔 | | getAudioTrackCount() | 获取当前音频文件的音轨索引 | | selectAudioTrack() | 指定当前音频文件的播放音轨 | | setLocalVoicePitch() | 使用该方法，你可以对本地语音的音调进行升调或降调等调整。多用于 K 歌场景。 | | startASR() | 开启自动语音识别服务。该方法将识别后的用户语音转化成文字，并通过 onMessage 事件回调给用户。 | | stopASR() | 关闭语音识别服务 | | startFileRecording() | 该方法将通话过程中的音视频数据录制到本地的文件中。 | | stopFileRecording() | 停止本地录制 | | setPublishFallbackOption() | 设置发布的音视频流回退选项 。你可以调用这个接口来设置网络情况不佳或设备性能不足时只发送小流，以保证通话质量。 | | setSubscribeFallbackOption() | 设置订阅的音视频流回退选项。 你可以通过调用该接口来设置网络情况不佳或性能不足时只订阅小流或音频流，以保证通话质量。 | | setRemoteUserPriority() | 设置用户优先级 | | startNetworkDetection() | 开启通话前网络探测 | | stopNetworkDetection() | 停止通话前网络探测 |
| setBackgroundSticker() | 将摄像头采集画面中的人像背景替换为指定图片或纯色背景。
若要取消背景特效，将背景贴纸特效素材路径设置为null。 |
| setVideoWatermark() | 在指定视频流上添加水印。 |
| removeLocalVideo() | 解绑本地视频流已绑定的渲染视图 |
| setupRemoteVideo() | 为远端视频流绑定本地渲染视图 |
| removeRemoteVideo() | 解绑指定远端视频流已绑定的本地视图 |
| removeAllRemoteVideo() | 解绑所有已绑定本地视图的指定远端视频流 |
| setupLocalScreen() | 为本地屏幕共享流绑定视图 |
| removeLocalScreen() | 解绑屏幕共享流已绑定的视图 |
| setupRemoteScreen() | 为远端屏幕共享流绑定本地视图 |
| removeRemoteScreen() | 解绑远端屏幕共享流已绑定的本地视图 |
| static getSDKVersion() | 获取当前 SDK 版本信息 |
| static getCurrentProcessId() | 获取加载引擎进程的 ID 方便调试 |
| 名称 | 描述 |
|---|---|
| onLocalScreenFrame() | 本地屏幕视频流采集成功后，会收到此回调。 |
| onLocalVideoFrame() | 本地视频流数据回调 |
| onRemoteScreenFrame() | 远端屏幕共享流数据回调 |
| onRemoteVideoFrame() | 远端视频数据回调 |
| onWarning() | 当内部发生警告事件时触发该回调 |
| onError() | 当内部发生不可逆转错误时触发该回调 |
| onAudioMixingFinished() | 本地音乐文件播放已结束回调。当调用 startAudioMixing 启动的混音文件播放结束后，会触发该回调。 |
| 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() | 本地音频的状态发生改变时，该回调通知当前的本地音频状态。 |
| onRemoteAudioStateChanged() | 用户订阅来自远端的音频流状态发生改变时，会收到此回调，了解当前的远端音频流状态。 |
| onActiveSpeaker() | 调用 enableAudioPropertiesReport 后，根据设置的 config.interval，你会周期性地收到此回调，获取房间内的最活跃用户信息。 |
| onLocalVideoStateChanged() | 本地视频流的状态发生改变时，收到该事件。 |
| onRemoteVideoStateChanged() | 远端视频流的状态发生改变时，房间内订阅此流的用户会收到该事件。 |
| onAudioFrameSendStateChanged() | 音频首帧发送状态改变回调 |
| onVideoFrameSendStateChanged() | 视频首帧发送状态改变回调 |
| onScreenVideoFrameSendStateChanged() | 屏幕共享流视频首帧发送状态改变回调 |
| onAudioFramePlayStateChanged() | 音频首帧播放状态改变回调 |
| onVideoFramePlayStateChanged() | 视频首帧播放状态改变回调 |
| onScreenVideoFramePlayStateChanged() | 屏幕共享流视频首帧播放状态改变回调 |
| onUserMessageSendResult() | 当调用 sendMessageToUser 函数发送消息后，回调此条消息的发送结果（反馈）。 |
| onUserBinaryMessageReceived() | 单个用户接收到同一房间内其他 uid 所属用户发来二进制消息的回调（P2P）。 |
| onStreamSubscribed() | 当订阅一个流成功的时候回调该事件
当更新流的内容时比如增加或者减少音视频流成功更新时也会回调该事件 |
| onSEIMessageReceived() | 收到通过 sendSEIMessage 发送的带有 SEI 消息的视频帧时，收到此回调 | | onStreamMixingEvent() | 通知转推直播关键事件 | | onRecordingStateUpdate() | 获取本地录制状态回调。 该回调由 startFileRecording 或 stopFileRecording 触发。 | | onRecordingProgressUpdate() | 本地录制进度回调。 该回调由 startFileRecording 触发，录制状态正常时，系统每秒钟都会通过该回调提示录制进度。 | | 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 值，你会周期性地收到此回调，了解本地音频的相关信息。
本地音频包括使用 RTC SDK 内部机制采集的麦克风音频和屏幕音频。 |
| onRemoteAudioPropertiesReport() | 远端用户进房后，本地调用 enableAudioPropertiesReport ，根据设置的 interval 值，本地会周期性地收到此回调，了解订阅的远端用户的音频信息。
远端用户的音频包括使用 RTC SDK 采集的麦克风音频和屏幕音频。 |
| onEchoTestResult() | 通话前网络探测结束 | | onVideoDeviceStateChanged() | 视频频设备状态回调。提示摄像头视频采集、屏幕视频采集等设备的状态。 | | onAudioDeviceStateChanged() | 音频设备状态回调。提示音频采集、音频播放等设备设备的状态。 | | onAudioPlaybackDeviceTestVolume() | 回调音频设备测试时的播放音量 |
| 名称 | 描述 |
|---|---|
| onRoomStateChanged() | 房间状态改变回调，加入房间、离开房间、发生房间相关的警告或错误时会收到此回调。 |
| onStreamStateChanged() | 流状态改变回调，发生流相关的警告或错误时会收到此回调。 |
| onLeaveRoom() | 离开房间成功回调。 用户调用 leaveRoom 方法后，SDK 会停止所有的发布订阅流，并在释放所有通话相关的音视频资源后，通过此回调通知用户离开房间成功。 |
| 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() | 接收到房间内广播消息的回调。 房间内其他用户调用 sendRoomMessage 发送广播消息时，收到此回调。 |
| onRoomBinaryMessageReceived() | 接收到房间内广播二进制消息的回调。 房间内其他用户调用 sendRoomBinaryMessage 发送广播二进制消息时，收到此回调。 |
| onUserMessageReceived() | 收到来自房间中其他用户通过 sendUserMessage 发来的点对点文本消息时，会收到此回调。 |
| onUserBinaryMessageReceived() | 收到来自房间中其他用户通过 sendUserBinaryMessage 发来的点对点二进制消息时，会收到此回调。 |
| onUserMessageSendResult() | 向房间内单个用户发送点对点文本或点对点二进制消息后，消息发送方会收到该消息发送结果回调。 |
| onRoomMessageSendResult() | 调用 sendRoomMessage 或 sendRoomBinaryMessage 向房间内群发文本或二进制消息后，消息发送方会收到该消息发送结果回调。 |
| onForwardStreamStateChanged() | 跨房间媒体流转发状态和错误回调 |
| onForwardStreamEvent() | 跨房间媒体流转发事件回调 |
| onRangeAudioInfo() | 关于当前范围语音衰减系数的回调。 手动订阅的场景下，房间内任一用户调用 updateRangePosition 更新自身位置或调用 updateReceiveRange 更新语音接收范围时，该用户与房间内其他用户的相对距离都会发生改变，据此计算的衰减系数也会发生改变，并通过该回调通知用户。 你可以通过关注该回调中包含的远端用户的衰减系数决定是否订阅该远端用户的流。 |
| onNetworkQuality() | 加入房间后， 以 2 秒 1 次的频率，报告用户的网络质量信息 |