方法

引擎管理

方法 描述
createEngine 创建引擎对象

如果当前线程中未创建引擎实例，那么你必须先使用此方法，以使用 RTC 提供的各种音视频能力。

如果当前线程中已创建了引擎实例，再次调用此方法时，会创建另一个独立的引擎实例。
destroyEngine 销毁引擎
销毁由 createEngine 所创建引擎实例，并释放所有相关资源
getSdkVersion 获取 SDK 当前的版本号。
getErrorDescription 获取SDK内各种错误码、警告码的描述文字
setRtcEngineEventHandler 设置引擎事件回调的接收类，必须继承自 IRTCEngineEventHandler 。
setBusinessId 设置业务标识参数。

可通过 businessId 区分不同的业务场景（角色/策略等）。businessId 由客户自定义，相当于一个“标签”，可以分担和细化现在 AppId 的逻辑划分的功能。
setRuntimeParameters 设置运行时的参数
feedback 通话结束，将用户反馈的问题上报到 RTC

房间管理

方法 描述
joinRoom 创建/加入房间：房间不存在时即创建房间；房间存在时即加入这个房间。

同一房间内的用户间可以相互通话。

进房后重复调用无效，用户必须调用 leaveRoom 退出当前房间后，才能加入下一个房间。
leaveRoom 离开房间。

用户调用此方法离开房间，结束通话过程，释放所有通话相关的资源。

此方法是异步操作，调用返回时并没有真正退出房间。真正退出房间后，本地会收到 onLeaveRoom 回调通知。
pauseAllSubscribedStream 暂停接收来自远端的媒体流。
resumeAllSubscribedStream 恢复接收来自远端的媒体流
updateToken 更新 Token。

用于加入房间的 Token 有一定的有效期。当 Token 过期时，需要调用此方法更新房间的 Token 信息。

调用 joinRoom 方法加入房间或断网重连进入房间时，如果 Token 过期，将导致加入房间失败，并会收到 onJoinRoomResult 回调通知，回调错误码为 ErrorCode 中的 ERROR_CODE_INVALID_TOKEN。此时需要重新获取 Token，并调用此方法更新 Token。
setUserVisibility 设置用户可见性。默认可见。

通过设置用户的可见性，可以控制用户在房间内的行为：

+ 能否发布音视频流；

+ 用户自身是否在房间中隐身。
publish 在当前所在房间内开始发布本地音视频流
unpublish 在当前所在房间内停止发布本地音视频流。
subscribeUserStream 订阅房间内指定的远端音视频流。

无论自动订阅还是手动订阅模式，你都可以调用此方法按需订阅房间中的音视频流。

该方法也可用于更新已经订阅的流的属性、媒体类型等配置。

音频管理

方法 描述
startAudioCapture 开启内部音频采集。默认为关闭状态。

开启后，本地用户会收到 onMediaDeviceStateChanged 的回调。

进房后调用该方法，房间中的其他用户会收到 onUserStartAudioCapture 的回调。
stopAudioCapture 关闭内部音频采集。默认为关闭状态。

进房前调用该方法，本地用户会收到 onMediaDeviceStateChanged 的回调。

进房后调用该方法，房间中的其他用户会收到 onUserStopAudioCapture 的回调。
setAudioScenario 设置音频场景类型
setAudioProfile 设置音质档位。你应根据业务场景需要选择适合的音质档位。
setAudioPlaybackDevice 设置音频播放设备为扬声器或者听筒，默认使用扬声器。

音频播放设备发生变化时，会收到 onAudioPlaybackDeviceChanged 事件回调。
setPlaybackVolume 调节本地播放的所有远端用户混音后的音量。
setRemoteAudioPlaybackVolume 调节来自指定远端用户的音频播放音量，默认为 100。
setEarMonitorMode 打开/关闭耳返功能。
setEarMonitorVolume 设置耳返音量。
enableAudioPropertiesReport 启用音量提示。
sendStreamSyncInfo 发送音频流同步信息。将消息通过音频流发送到远端，并实现与音频流同步，该接口调用成功后，远端用户会收到 onStreamSyncInfoReceived 回调。
enableAudioSpatialRender 开启或关闭空间音频效果。
updatePosition 更新自己的位置坐标。
updateSelfOrientation 更新自己的朝向。本地朝向的设置只影响本地听到的音频效果，不影响本地发出的音频效果。

视频管理

方法 描述
startVideoCapture 开启内部视频采集。默认为关闭状态。

调用该方法后，本地用户会收到 onMediaDeviceStateChanged 的回调。

进房后调用该方法，房间中的其他用户会收到 onUserStartVideoCapture 的回调。
stopVideoCapture 关闭本地视频采集。默认为关闭状态。

进房前调用该方法，本地用户会收到 onMediaDeviceStateChanged 的回调。

进房后调用该方法，房间中的其他用户会收到 onUserStopVideoCapture 的回调。
setLocalVideoCanvas 设置本地视频渲染时，使用的视图，并设置渲染模式。

你应在加入房间前，绑定本地视图。退出房间后，此设置仍然有效。
如果需要解除绑定，你可以调用本方法传入空视图。
setLocalVideoMirrorType 为本地采集到的视频流开启镜像
switchCamera 切换视频内部采集时使用的前置/后置摄像头

调用此接口后，在本地会触发 onMediaDeviceStateChanged 回调。
muteLocalVideo 停止/启动发送本地视频流，默认不发送。

无论你使用内部视频采集，还是自定义视频采集，你都应使用此接口启动发送本地视频流。

调用该方法后，房间中的其他用户会收到 onUserMuteVideo 的回调。
setVideoSourceType 设置向 SDK 输入的视频源
setVideoCaptureConfig 设置 RTC SDK 内部采集时的视频采集参数。

如果你的项目使用了 SDK 内部采集模块，可以通过本接口指定视频采集参数包括分辨率、帧率。
setVideoEncoderConfig 启动推送多路视频流，设置推送多路流时的各路视频参数，包括分辨率、帧率、码率、缩放模式、网络不佳时的回退策略等。
sendSEIMessage 在视频通信时，通过视频帧发送 SEI 数据。
setExternalVideoEncoderEventHandler 注册自定义编码帧推送事件回调
pushExternalEncodedVideoFrame 推送自定义编码后的视频流
setVideoDecoderConfig 在订阅远端视频流之前，设置远端视频数据解码方式
requestRemoteVideoKeyFrame 在订阅远端视频流之后，向远端请求关键帧
registerRemoteEncodedVideoFrameObserver 注册远端编码后视频数据回調。

完成注册后，当 SDK 监测到远端编码后视频帧时，会触发 OnRemoteEncodedVideoFrame 回调
isCameraTorchSupported 检测当前使用的摄像头（前置/后置），是否支持闪光灯。
isCameraZoomSupported 检测当前使用的摄像头（前置/后置），是否支持变焦（数码/光学变焦）。
setCameraZoomRatio 设置当前使用的摄像头（前置/后置）的变焦倍数
getCameraZoomMaxRatio 获取当前使用的摄像头（前置/后置）的最大变焦倍数
setCameraTorch 打开/关闭当前使用的摄像头（前置/后置）的闪光灯

屏幕共享

方法 描述
publishScreen 发布本地屏幕共享流。
unpublishScreen 停止发布本地屏幕共享流。
startScreenVideoCapture 使用 RTC SDK 提供的采集模块，采集当前屏幕视频流，用于共享。
stopScreenVideoCapture 停止屏幕视频流采集。
pushScreenFrame 发布共享屏幕视频帧
setScreenAudioSourceType 在屏幕共享时，设置屏幕音频的采集方式（内部采集/自定义采集）
setScreenAudioStreamIndex 在屏幕共享时，设置屏幕音频流和麦克风采集到的音频流的混流方式
pushScreenAudioFrame 使用自定义采集方式，采集屏幕共享时的屏幕音频时，将音频帧推送至 RTC SDK 处进行编码等处理。

实时消息通信

方法 描述
sendRoomMessage 给房间内的所有其他用户群发文本消息。
sendRoomBinaryMessage 给房间内的所有其他用户群发二进制消息。
sendUserMessage 给房间内指定的用户发送点对点文本消息。
sendUserBinaryMessage 给房间内指定的用户发送点对点二进制消息。
login 必须先登录注册一个 uid，才能发送房间外消息和向业务服务器发送消息
logout 调用本接口登出后，无法调用房间外消息以及端到服务器消息相关的方法或收到相关回调。
updateLoginToken 更新用户用于登录的 Token

Token 有一定的有效期，当 Token 过期时，需调用此方法更新登录的 Token 信息。

调用 login 方法登录时，如果使用了过期的 Token 将导致登录失败，并会收到 onLoginResult 回调通知，错误码为 LOGIN_ERROR_CODE_INVALID_TOKEN。此时需要重新获取 Token，并调用此方法更新 Token。
setServerParams 设置业务服务器参数

客户端调用 sendServerMessage 或 sendServerBinaryMessage 发送消息给业务服务器之前，必须需要设置有效签名和业务服务器地址。
getPeerOnlineStatus 查询对端用户或本端用户的登录状态
sendUserMessageOutsideRoom 给房间外指定的用户发送文本消息（P2P）
sendUserBinaryMessageOutsideRoom 给房间外指定的用户发送二进制消息（P2P）
sendServerMessage 客户端给业务服务器发送文本消息（P2Server）
sendServerBinaryMessage 客户端给业务服务器发送二进制消息（P2Server）

美声特效管理

方法 描述
setVoiceChangerType 设置变声特效类型
setVoiceReverbType 设置混响特效类型

自定义视频采集渲染

方法 描述
setLocalVideoSink 将本地视频流与自定义渲染器绑定。
setRemoteVideoSink 将远端视频流与自定义渲染器绑定。
setRemoteVideoCanvas 渲染来自指定远端用户的视频流时，设置使用的视图和渲染模式。

如果需要解除视频的绑定视图，把 videoCanvas 设置为空。
pushExternalVideoFrame 推送外部视频帧。
pushExternalVideoFrame 推送外部视频帧。

媒体流管理

方法 描述
muteLocalAudio 控制本地音频流的发送状态：发送/不发送。

使用此方法后，房间中的其他用户会收到回调 onUserMuteAudio。

音量管理

方法 描述
setCaptureVolume 调节音频采集音量

通话前网络探测

方法 描述
startNetworkDetection 开启通话前网络探测
stopNetworkDetection 停止通话前网络探测

音频数据回调

方法 描述
setRecordingAudioFrameParameters 设置本地麦克风录制的音频数据回调参数
setPlaybackAudioFrameParameters 设置远端所有用户音频数据混音后的音频数据回调参数
setMixedAudioFrameParameters 设置本地麦克风录制音频数据和远端所有用户音频数据混音后的音频数据回调参数
registerAudioFrameObserver 注册音频数据回调观察者

音频处理

方法 描述
registerLocalAudioProcessor 设置自定义音频处理器。

使用该处理器，你可以调用 processAudioFrame 对 RTC SDK 采集得到的音频帧进行自定义处理，并将处理后的音频帧用于 RTC 音视频通信。

SDK 只持有 processor 的弱引用，你应保证其生命周期。

视频处理

方法 描述
registerLocalVideoProcessor 设置自定义视频前处理器。

使用这个视频前处理器，你能够调用 processVideoFrame 对 RTC SDK 采集得到的视频帧进行前处理，并将处理后的视频帧用于 RTC 音视频通信。
processVideoFrame 获取 RTC SDK 采集得到的视频帧，根据 registerLocalVideoProcessor 设置的视频前处理器，进行视频前处理，最终将处理后的视频帧给到 RTC SDK 用于编码传输。
onGLEnvInitiated OpenGL 环境创建完成时，收到此回调。
onGLEnvRelease OpenGL 环境即将销毁时，收到此回调。此时，你可以释放纹理等资源。

视频数据回调

方法 描述
registerLocalEncodedVideoFrameObserver 注册本地视频帧监测器。

无论使用内部采集还是自定义采集，调用该方法后，SDK 每监测到一帧本地视频帧时，都会将视频帧信息通过 onLocalEncodedVideoFrame 回调给用户

转推直播

方法 描述
startLiveTranscoding 开启转推直播，并设置合流的视频视图布局和音频属性。
stopLiveTranscoding 停止转推直播。

关于启动转推直播，参看 startLiveTranscoding。
updateLiveTranscoding 更新转推直播参数。

使用 startLiveTranscoding 启用转推直播功能后，使用此方法更新功能配置参数。

自定义音频采集渲染

方法 描述
enableExternalAudioDevice 启用自定义音频采集和渲染。
disableExternalAudioDevice 禁用已开启的自定义音频采集和渲染。
pushExternalAudioFrame 推送外部采集的音频数据到 RTC SDK。
pullExternalAudioFrame 拉取音频数据，用于外部播放。

多房间

方法 描述
createRoom 创建房间
destroy 销毁房间
joinRoom 加入房间。

多房间场景下，调用 createRoom 创建房间后，调用此方法加入房间，同房间内其他用户进行音视频通话。
setRTCRoomEventHandler 设置房间事件回调 handler
leaveRoom 离开房间。

用户调用此方法离开房间，结束通话过程，释放所有通话相关的资源。

调用 joinRoom 方法加入房间后，必须调用此方法结束通话，否则无法开始下一次通话。无论当前是否在房间内，都可以调用此方法。重复调用此方法没有负面影响。

此方法是异步操作，调用返回时并没有真正退出房间。真正退出房间后，本地会收到 onLeaveRoom 回调通知。
setUserVisibility 设置用户可见性。默认可见。

通过设置用户的可见性，可以控制用户在房间内的行为：

+ 能否发布音视频流；

+ 用户自身是否在房间中隐身。
updateToken 更新 Token。

用于加入房间的 Token 有一定的有效期。当 Token 过期时，需要调用此方法更新房间的 Token 信息。

调用 joinRoom 方法加入房间或断网重连进入房间时，如果 Token 过期，将导致加入房间失败，并会收到 onError 回调通知，回调错误码为 ErrorCode 中的 ERROR_CODE_INVALID_TOKEN。此时需要重新获取 Token，并调用此方法更新 Token。
sendUserMessage 给房间内指定的用户发送点对点文本消息
sendUserBinaryMessage 给房间内指定的用户发送点对点二进制消息。
sendRoomMessage 给房间内的所有其他用户群发文本消息。
sendRoomBinaryMessage 给房间内的所有其他用户群发二进制消息。
publish 发布本地视频流。
unpublish 取消发布本地视频流。
publishScreen 发布本地屏幕共享流。
unpublishScreen 停止发布本地屏幕共享流。
subscribeUserStream 订阅房间内指定的远端音视频流。

无论自动订阅还是手动订阅模式，用户都可以调用此方法按需订阅房间中的音视频流。

该方法也可用于更新已经订阅的流的属性、媒体类型等配置。
pauseAllSubscribedStream 暂停接收来自远端的媒体流。
resumeAllSubscribedStream 恢复接收来自远端的媒体流
startLiveTranscoding 开启转推直播，并设置合流的视频视图布局和音频属性。
stopLiveTranscoding 停止转推直播。

关于启动转推直播，参看 startLiveTranscoding。
updateLiveTranscoding 更新转推直播参数。

使用 startLiveTranscoding 启用转推直播功能后，使用此方法更新功能配置参数。

音视频回退

方法 描述
setPublishFallbackOption 设置发布的音视频流回退选项。

你可以调用这个接口来设置网络情况不佳或性能不足时只发送小流，以保证通话质量。
setRemoteSubscribeFallbackOption 设置订阅的音视频流回退选项。
setRemoteUserPriority 设置用户优先级。

加密

方法 描述
setEncryptInfo 设置AES加密算法和加密密钥

有四种内置的加密算法，为 AES-128-CBC，AES-256-CBC，AES-128-ECB，AES-256-ECB
setCustomizeEncryptHandler 设置自定义加密方法
自定义加密方法需要实现对应的加密/解密方法

视频特效

方法 描述
checkVideoEffectLicense 视频特效许可证检查
setVideoEffectAlgoModelPath 设置视频特效算法模型路径
enableVideoEffect 创建/销毁视频特效引擎
setVideoEffectNodes 设置视频特效素材包，支持同时设置多个素材包
updateVideoEffectNode 设置特效强度
setVideoEffectColorFilter 设置颜色滤镜
setVideoEffectColorFilterIntensity 设置已启用的颜色滤镜强度

云端渲染

方法 描述
startCloudRendering
updateCloudRendering
stopCloudRendering

语音识别服务

方法 描述
startASR 开启自动语音识别服务。该方法将识别后的用户语音转化成文字，并通过 onMessage 事件回调给用户。
stopASR 关闭语音识别服务

本地录制

方法 描述
startFileRecording 该方法将通话过程中的音视频数据录制到本地的文件中。
stopFileRecording 停止本地录制

混音

方法 描述
getAudioMixingManager 混音管理接口创建
startAudioMixing 开始播放音频文件及混音。

可以通过传入不同的 ID 和 filepath 多次调用本方法，以实现同时播放多个混音文件，实现混音叠加。
stopAudioMixing 停止播放音频文件及混音
pauseAudioMixing 暂停播放音频文件及混音
resumeAudioMixing 恢复播放音频文件及混音
preloadAudioMixing 预加载指定音频文件到内存中
unloadAudioMixing 卸载指定音频文件
setAudioMixingVolume 调节音频文件在本地和远端播放的音量大小
getAudioMixingDuration 获取音频文件时长
getAudioMixingCurrentPosition 获取音频文件播放进度
setAudioMixingPosition 设置音频文件的播放位置
setAudioMixingDualMonoMode 设置当前音频文件的声道模式
enableAudioMixingFrame 启动外部音频流混音
disableAudioMixingFrame 关闭外部音频流混音
pushAudioMixingFrame 向 SDK 推送外部音频帧数据

位置语音

方法 描述
getPositionAudioRender 获取位置音频接口实例，包括范围语音、空间语音等和位置相关的音频接口。

回调

视频管理

回调 描述
OnStart 提示自定义编码帧可以开始推送的回调。

收到该回调后，你即可调用 pushExternalEncodedVideoFrame 向 SDK 推送自定义编码视频帧
OnStop 当收到该回调时，你需停止向 SDK 推送自定义编码视频帧
OnRateUpdate 当自定义编码流的帧率或码率发生变化时，触发该回调
OnRequestKeyFrame 调用 requestRemoteVideoKeyFrame 请求远端关键帧时，会触发该回调
onUserMuteVideo 房间内用户暂停/恢复发送视频流时，房间内其他用户将收到此回调。

参看 muteLocalVideo。
onUserStartVideoCapture 房间内的用户调用 startVideoCapture 开启内部视频采集时，房间内其他用户会收到此回调。
onUserStopVideoCapture 房间内的用户调用 stopVideoCapture 关闭内部视频采集时，房间内其他用户会收到此回调。
onLocalVideoStateChanged 本地视频流的状态发生改变时，收到该事件。
onRemoteVideoStateChanged 远端视频流的状态发生改变时，房间内订阅此流的用户会收到该事件。
onFirstRemoteVideoFrameRendered 第一帧远端视频流在视图上渲染成功后，收到此回调。
onFirstLocalVideoFrameCaptured RTC SDK 在本地完成第一帧视频帧或屏幕视频帧采集时，收到此回调。
onLocalVideoSizeChanged 本地视频大小或旋转信息发生改变时，收到此回调。
onRemoteVideoSizeChanged 远端视频大小或旋转信息发生改变时，房间内订阅此视频流的用户会收到此回调。
onSEIMessageReceived 收到通过调用 sendSEIMessage 发送带有 SEI 消息的视频帧时，收到此回调
onVideoStreamBanned 通过调用服务端 MuteUser/UnmuteUser 方法禁用/解禁指定房间内指定用户视频流的发送时，触发此回调。
onVideoStreamBanned 通过调用服务端 MuteUser/UnmuteUser 方法禁用/解禁指定房间内指定用户视频流的发送时，触发此回调。

房间管理

回调 描述
onJoinRoomResult 首次加入房间/重连加入房间的回调。此回调表示调用 joinRoom 的结果，根据错误码判断成功/失败以及区别是否为重连。
onLeaveRoom 离开房间成功回调。

用户调用 leaveRoom 方法后，SDK 会停止所有的发布订阅流，并在释放所有通话相关的音视频资源后，通过此回调通知用户离开房间成功。
onUserJoined 远端可见用户加入房间，或房内隐身用户切换为可见的回调。

1.远端可见用户调用 setUserVisibility 方法将自身设为可见后加入房间时，房间内其他用户将收到该事件。

2.远端可见用户断网后重新连入房间时，房间内其他用户将收到该事件。

3.房间内隐身远端用户调用 setUserVisibility 方法切换至可见时，房间内其他用户将收到该事件。

4.新进房用户也会收到进房前已在房内的主播角色用户的进房回调通知。
onUserLeave 远端可见用户离开房间，或从可见切换为隐身的回调。

发生以下情形时，房间内其他用户会收到此事件：

1.远端可见用户调用 leaveRoom 方法离开房间时；

2.远端可见用户调用 setUserVisibility 方法切换至隐身时。

3.远端主播角色用户断网，且一直未恢复。
onStreamAdd 房间内新流发布回调。

房间内的远端用户发布新的音视频流时，本地用户会收到此回调通知。
onStreamRemove 房间内远端流移除回调。

房间内的远端用户停止发布音视频流时，本地用户会收到此回调通知。
onAudioFrameSendStateChanged 本地音频首帧发送状态发生改变时，收到此回调
onVideoFrameSendStateChanged 本地视频首帧发送状态发生改变时，收到此回调
onScreenVideoFrameSendStateChanged 屏幕共享流的视频首帧发送状态发生改变时，收到此回调
onAudioFramePlayStateChanged 音频首帧播放状态发生改变时，收到此回调
onVideoFramePlayStateChanged 视频首帧播放状态发生改变时，收到此回调
onScreenVideoFramePlayStateChanged 屏幕共享流视频首帧播放状态发生改变时，收到此回调

警告码

回调 描述
onWarning 发生警告回调。
onError 发生错误回调。

数据统计

回调 描述
onRoomStats 房间通话统计信息回调。

用户进房开始通话后，每 2s 收到一次本回调。
onSysStats 每2秒发生回调，通知当前cpu，内存使用的信息。
onLocalStreamStats 发布流成功后，每隔 2s 收到此回调，了解发布的流在此周期内的网络质量信息。
onRemoteStreamStats 每隔 2s 收到此回调，了解订阅的远端用户发布的流在此周期内的网络质量信息。

引擎管理

回调 描述
onNetworkTypeChanged SDK 当前网络连接类型改变回调。当 SDK 的当前网络连接类型发生改变时回调该事件。
onConnectionStateChanged 回调 SDK 与信令服务器连接状态相关事件。当 SDK 与信令服务器的网络连接状态改变时回调该事件。
onLogReport 上报日志时回调该事件。
onMediaDeviceStateChanged 媒体设备状态回调。提示音频采集、音频渲染、视频采集三种媒体设备的状态。
onHttpsProxyState HTTPS 代理连接状态改变时，收到该回调。
onSocks5ProxyState SOCKS5 代理状态改变时，收到该回调。

音频事件回调

回调 描述
onUserMuteAudio 房间内某用户调用 muteLocalAudio
改变本地音频发送状态时，房间内其他用户会收到此回调。
onLocalAudioStateChanged 本地音频流的状态发生改变时，该回调通知当前的本地音频流状态。
onRemoteAudioStateChanged 用户订阅来自远端的音频流状态发生改变时，会收到此回调，了解当前的远端音频流状态。
onAudioPlaybackDeviceChanged 音频播放设备变化时，收到该回调。
onFirstLocalAudioFrame 本地采集到第一帧音频帧时，收到该回调。
onFirstRemoteAudioFrame 接收到来自远端某音频流的第一帧时，收到该回调。
onAudioStreamBanned 通过调用服务端 MuteUser/UnmuteUser 方法禁用/解禁指定房间内指定用户视音频流的发送时，触发此回调。
onAudioStreamBanned 通过调用服务端 MuteUser/UnmuteUser 方法禁用/解禁指定房间内指定用户视音频流的发送时，触发此回调。

音频管理

回调 描述
onUserStartAudioCapture 房间内的用户调用 startAudioCapture 开启音频采集时，房间内其他用户会收到此回调。
onUserStopAudioCapture 房间内的用户调用 stopAudioCapture 开启音频采集时，房间内其他用户会收到此回调。
onLocalAudioPropertiesReport 调用 enableAudioPropertiesReport 后，根据设置的 interval 值，你会周期性地收到此回调，了解本地音频的相关信息。
onRemoteAudioPropertiesReport 远端用户进房后，本地调用 enableAudioPropertiesReport ，根据设置的 interval 值，本地会周期性地收到此回调，了解订阅的远端用户的音频信息。
onStreamSyncInfoReceived 音频流同步信息回调。可以通过此回调，在远端用户调用 sendStreamSyncInfo 发送音频流同步消息后，收到远端发送的音频流同步信息。

音视频回退

回调 描述
onSimulcastSubscribeFallback 因发布/订阅性能回退或退出回退状态，订阅的音视频流，发生流的切换时，收到该回调。
onPerformanceAlarms 本地未开启发布性能回退，检测到设备性能不足时，收到此回调。

本地开启发布性能回退，因设备性能/网络原因，造成发布性能回退/恢复时，收到此回调。

实时消息通信

回调 描述
onRoomMessageReceived 接收到房间内广播消息的回调。

房间内其他用户调用 sendRoomMessage 发送广播消息时，收到此回调。
onRoomBinaryMessageReceived 接收到房间内广播二进制消息的回调。

房间内其他用户调用 sendRoomBinaryMessage 发送广播二进制消息时，收到此回调。
onUserMessageReceived 收到来自房间中其他用户通过 sendUserMessage 发来的点对点文本消息时，会收到此回调。
onUserBinaryMessageReceived 收到来自房间中其他用户通过 sendUserBinaryMessage 发来的点对点二进制消息时，会收到此回调。
onUserMessageSendResult 向房间内单个用户发送点对点文本或点对点二进制消息后，消息发送方会收到该消息发送结果回调。
onRoomMessageSendResult 向房间内群发文本或二进制消息后，消息发送方会收到该消息发送结果回调。
onLoginResult 登录结果回调
onLogout 登出结果回调
onServerParamsSetResult 设置业务服务器参数的返回结果
onGetPeerOnlineStatus 查询对端或本端用户登录状态的返回结果
onUserMessageReceivedOutsideRoom 收到房间外用户调用 sendUserMessageOutsideRoom 发来的文本消息时，会收到此回调
onUserBinaryMessageReceivedOutsideRoom 收到房间外用户调用 sendUserBinaryMessageOutsideRoom 发来的二进制消息时，会收到此回调
onUserMessageSendResultOutsideRoom 给房间外指定的用户发送消息的回调
onServerMessageSendResult 给业务服务器发送消息的回调

转推直播

回调 描述
onLiveTranscodingResult 转推直播错误回调。

调用 startLiveTranscoding 接口或直接在服务端启动转推直播功能后，你会通过此回调收到启动结果和推流过程中的错误。
isSupportClientPushStream 是否具有推流能力。

+ false：不具备推流能力（默认值）

+ true：具备推流能力
onStreamMixingEvent 转推直播状态回调
onMixingAudioFrame 端云一体合流音频 PCM 回调
onMixingVideoFrame 端云一体合流视频 YUV 回调
onDataFrame 端云一体合流视频 SEI 数据

通话前网络探测

回调 描述
onNetworkDetectionResult 通话前网络探测结果
成功调用 startNetworkDetection 接口开始探测后，会每 2s 收到一次此回调。
onNetworkDetectionStopped 通话前网络探测结束
以下情况将停止探测并收到本一次本回调：

1. 当调用 stopNetworkDetection 接口停止探测后，会收到一次该回调；
2. 当收到远端/本端音频首帧后，停止探测；
3. 当探测超过3分钟后，停止探测；
4. 当探测链路断开一定时间之后，停止探测。

代理回调

回调 描述
onHttpProxyState HTTP 代理连接状态改变时，收到该回调。

本地录制

回调 描述
onRecordingStateUpdate 获取本地录制状态回调。

该回调由 startFileRecording 或 stopFileRecording 触发。
onRecordingProgressUpdate 本地录制进度回调。

该回调由 startFileRecording 触发，录制状态正常时，系统每秒钟都会通过该回调提示录制进度。

混音

回调 描述
onAudioMixingStateChanged 音频混音文件播放状态改变时回调

加密

回调 描述
onEncryptData
onDecryptData

视频数据回调

回调 描述
onLocalEncodedVideoFrame 调用 registerLocalEncodedVideoFrameObserver 后，SDK 收到本地视频帧信息时，回调该事件
OnRemoteEncodedVideoFrame 调用 registerRemoteEncodedVideoFrameObserver 后，SDK 监测到远端编码后视频数据时，触发该回调

音频数据回调

回调 描述
onRecordAudioFrame 返回麦克风录制的音频数据
onPlaybackAudioFrame 返回远端所有用户混音后的音频数据
onMixedAudioFrame 返回本地麦克风录制和远端所有用户混音后的音频数据

多房间

回调 描述
onLeaveRoom 离开房间成功回调。

用户调用 leaveRoom 方法后，SDK 会停止所有的发布订阅流，并在释放所有通话相关的音视频资源后，通过此回调通知用户离开房间成功。
onJoinRoomResult 首次加入房间/重连加入房间的回调。此回调表示调用 joinRoom 的结果，根据错误码判断成功/失败以及区别是否为重连。
onRoomWarning 发生警告回调。
onRoomError 发生错误回调。
onRtcStats 房间通话统计信息回调。

用户进房开始通话后，每 2s 收到一次本回调。
onUserJoined 可见用户加入房间，或房内隐身用户切换为可见的回调。

1.远端可见用户调用 setUserVisibility 方法将自身设为可见后加入房间时，房间内其他用户将收到该事件。

2.远端可见用户断网后重新连入房间时，房间内其他用户将收到该事件。

3.房间内隐身远端用户调用 setUserVisibility 方法切换至可见时，房间内其他用户将收到该事件。

4.新进房用户也会收到进房前已在房内的主播角色用户的进房回调通知。
onUserLeave 远端见用户离开房间，或从可见切换为隐身的回调。

发生以下情形时，房间内其他用户会收到此事件：

1. 远端可见用户调用 leaveRoom 方法离开房间时。

2. 远端可见用户调用 setUserVisibility 方法切换至隐身时。

3. 远端主播角色用户断网，且一直未恢复。
onUserMuteAudio 房间内某用户调用 muteLocalAudio
改变本地音频发送状态时，房间内其他用户会收到此回调。
onLocalStreamStats 反映通话中本地设备发送音/视频流的统计信息以及网络状况的回调。

本地用户发布音视频流成功后，每隔 2s 收到此回调。
onRemoteStreamStats 反映通话中本地设备接收订阅的远端音/视频流的统计信息以及网络状况的回调。每隔 2s 收到此回调。
onFirstLocalAudioFrame 本地采集到第一帧音频帧时，收到该回调。
onFirstRemoteAudioFrame 接收到来自远端某音频流的第一帧时，收到该回调。
onStreamRemove 房间内远端流移除回调。

房间内的远端用户停止发布音视频流时，本地用户会收到此回调通知。
onStreamAdd 房间内新流发布回调。

房间内的远端用户发布新的音视频流时，本地用户会收到此回调通知。
onRoomMessageReceived 接收到房间内广播消息的回调。

房间内其他用户调用 sendRoomMessage 发送广播消息时，收到此回调。
onRoomBinaryMessageReceived 接收到房间内广播二进制消息的回调。

房间内其他用户调用 sendRoomBinaryMessage 发送广播二进制消息时，收到此回调。
onUserMessageReceived 收到来自房间中其他用户通过 sendUserMessage 发来的点对点文本消息时，会收到此回调。
onUserBinaryMessageReceived 收到来自房间中其他用户通过 sendUserBinaryMessage 发来的点对点二进制消息时，会收到此回调。
onUserMessageSendResult 向房间内单个用户发送点对点文本或点对点二进制消息后，消息发送方会收到该消息发送结果回调。
onRoomMessageSendResult 向房间内群发文本或二进制消息后，消息发送方会收到该消息发送结果回调。
onLiveTranscodingResult 合流转推错误回调。

调用 startLiveTranscoding 接口或直接在服务端启动合流转推功能后，你会通过此回调收到启动结果和推流过程中的错误。
onFirstLocalVideoFrameCaptured 第一帧本地采集的视频/屏幕共享画面采集完成时，收到此回调。
onLocalVideoSizeChanged 本地视频大小或旋转信息发生改变时，收到此回调。
onRemoteVideoSizeChanged 远端视频大小或旋转信息发生改变时，房间内订阅此视频流的用户会收到此回调。
onFirstRemoteVideoFrameRendered 第一帧远端视频流在视图上渲染成功后，收到此回调。
onUserMuteVideo 房间内用户调用 muteLocalVideo 暂停/恢复发送视频流时，房间内其他用户将收到此回调。
onUserStartVideoCapture 房间内的用户调用 startVideoCapture 开启视频采集时，房间内其他用户会收到此回调。
onUserStopVideoCapture 房间内的用户调用 stopVideoCapture 关闭视频采集时，房间内其他用户会收到此回调。
onUserStartAudioCapture 房间内的用户调用 startAudioCapture 开启音频采集时，房间内其他用户会收到此回调。
onUserStopAudioCapture 房间内的用户调用 stopAudioCapture 关闭音频采集时，房间内其他用户会收到此回调。
onLocalAudioStateChanged 本地音频流的状态发生改变时，该回调通知当前的本地音频流状态。
onRemoteAudioStateChanged 用户订阅来自远端的音频流状态发生改变时，会收到此回调，了解当前的远端音频流状态。
onLocalVideoStateChanged 本地视频流的状态发生改变时，收到该事件。
onRemoteVideoStateChanged 远端视频流的状态发生改变时，房间内订阅此流的用户会收到该事件。
onSimulcastSubscribeFallback 因发布/订阅性能回退或退出回退状态，订阅的音视频流，发生流的切换时，收到该回调。
onAudioFrameSendStateChanged 本地音频首帧发送状态发生改变时，收到此回调
onVideoFrameSendStateChanged 本地视频首帧发送状态发生改变时，收到此回调
onScreenVideoFrameSendStateChanged 屏幕共享流的视频首帧发送状态发生改变时，收到此回调
onAudioFramePlayStateChanged 音频首帧播放状态发生改变时，收到此回调
onVideoFramePlayStateChanged 视频首帧播放状态发生改变时，收到此回调
onScreenVideoFramePlayStateChanged 屏幕共享流视频首帧播放状态发生改变时，收到此回调