Class

• 业务场景：不再需要使用实时音视频功能时。
• 调用时机：同一个引擎实例最后一个调用的接口。

• 业务场景：用于判断版本和权限的场景。
• 默认值：none
• 调用时机：初始化之后，推（拉）流之前调用。
• 影响范围：无
• 相关回调：无
• 相关接口：无
• 平台差异：无

• 业务场景：通用接口，必选。

支

• 默认值：无
• 调用时机：注册之后，退出房间之前。
• 影响范围：无
• 相关回调：无
• 相关接口：无
• 平台差异：无

• 业务场景：通用接口，用于监听 SDK 的业务事件。
• 调用时机：初始化实例之后，调用接口 loginRoom 登录房间之前。
• 相关接口：调用接口 off 来注销对应回调事件处理。

• 业务场景：推流时必选。
• 调用时机：调用接口 loginRoom 登录房间成功后。
• 相关回调：推流质量回调 publishQualityUpdate，推流状态回调 publisherStateUpdate（可通过该接口来判断推流是否成功）。
• 相关接口：通过调用接口 stopPublishingStream 结束推流。

• 业务场景：可以用于实时连麦、直播等场景下停止推流。
• 默认值：无
• 调用时机：推流成功后。
• 影响范围：无
• 相关回调：推流质量回调 publishQualityUpdate，推流状态回调 publisherStateUpdate。
• 相关接口：开始推流 startPublishingStream。
• 平台差异：无

• 业务场景：需要对推流进行更丰富的描述，且希望拉流端能接受到这些信息时使用。
• 默认值：无
• 调用时机：推流成功后。
• 影响范围：无
• 相关回调：初次登录房间用户可通过 roomStreamUpdate 获取流附加信息，已经在房间拉流的用户通过流附加信息更新回调 streamExtraInfoUpdate 获取更新后的流附加消息。
• 相关接口：无
• 平台差异：无

• 平台差异：不支持支付宝小程序平台。
• 业务场景：单向直播场景，拉流端使用 CDN 拉流。
• 默认值：无
• 调用时机：推流成功后。
• 影响范围：无
• 相关回调：无
• 相关接口：通知即构服务器停止将流转推到 CDN removePublishCdnUrl。

• 平台差异：不支持支付宝小程序平台。
• 业务场景：单向直播场景，拉流端使用 CDN 拉流。
• 默认值：无
• 调用时机：转推成功后
• 影响范围：无
• 相关回调：无
• 相关接口：通知即构服务器将流转推到 CDN addPublishCdnUrl。

• 业务场景：拉流时必选。
• 调用时机：收到新增拉流，即 roomStreamUpdate 回调后。
• 相关回调：拉流质量回调 playQualityUpdate，拉流状态回调 playerStateUpdate （可通过该回调来判断拉流是否成功）。
• 相关接口：调用接口 stopPlayingStream 结束拉流。

• 业务场景：拉流必选。
• 默认值：无
• 调用时机：拉流成功后。
• 影响范围：无
• 相关回调：拉流质量回调 playQualityUpdate，拉流状态回调 playerStateUpdate。
• 相关接口：开始拉流 startPlayingStream。
• 平台差异：无

• 业务场景：常用于语聊房场景下，需要由客户端发起自动混流任务时。
• 调用时机：在创建引擎后，如果目标房间已经创建，可调用该函数在目标房间开启自动混流。
• 相关接口：可调用 [stopAutoMixerTask] 函数，停止自动混流任务。

• 平台差异：不支持支付宝小程序平台。
• 业务场景：通常用于多个主播连麦PK的场景，将多个主播的音视频流混合成一条流，观众端只需要拉这一条流。
• 调用时机：调用接口 startPublishingStream 推流成功后。
• 相关接口：使用接口 stopMixerTask 来停止服务端混流，未及时停止混流功能会影响计费。

• 业务场景：常用于语聊房场景下，需要由客户端发起自动混流任务时。
• 调用时机：在调用 [startAutoMixerTask] 函数开启自动混流任务后可调用该函数。

安全性提醒：请勿在此接口填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

• 相关接口：开始混流任务接口 [startAutoMixerTask]。

• 平台差异：不支持支付宝小程序平台。
• 业务场景：通常用于多个主播连麦 PK 的场景，混流画面使用结束后停止混流。
• 调用时机：调用接口 startMixerTask 混流成功之后。
• 相关接口：开始混流任务接口 startMixerTask

• 平台差异：不支持支付宝小程序平台。
• 业务场景：1. 设置混流画面背景；2. 视频编码转换来兼容部分浏览器的播放。
• 调用时机：推流成功后，而且需在使用 startMixerTask 之前调用才能生效。

安全性提醒：请勿在此接口填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

• 相关接口：开始混流接口 startMixerTask

• 平台差异：不支持支付宝小程序平台。
• 业务场景：推拉流功能需要。
• 调用时机：在小程序 <live-player> 和 <live-pusher> 组件触发 bindaudiovolumenotify 事件时调用。

• 平台差异：不支持支付宝小程序平台。
• 业务场景：用于跨房间连麦和在线教育的超级小班场景。
• 默认值：默认不开启多房间。
• 调用时机：需要在初始化 SDK 后，第一次登录房间 loginRoom 前调用。
• 相关接口：可调用 loginRoom 登录房间，调用 logoutRoom 退出房间，调用 startPublishingStream 开始推流。

• 业务场景：在多数场景下，客户不用调用该接口，使用默认配置即可。
• 默认值：本地日志和上传级别均为 info。
• 调用时机：在初始化之后，其他任何接口之前调用。
• 相关回调：无
• 相关接口：无

• 业务场景：用于开发环节提示错误。
• 默认值：测试环境默认值为 “true“， 可以手动关闭。
• 调用时机：初始化后，立刻调用。
• 影响范围：所有 SDK 内部错误，都会弹框提示，中断整个进程。
• 相关回调：无
• 相关接口：无
• 平台差异：无

• 业务场景：日志收集时建议使用。
• 默认值：无
• 调用时机：初始化后任意时机可调用。
• 影响范围：无
• 相关回调：无
• 相关接口：无
• 平台差异：无

• 业务场景：通过登录房间来获取与其他用户进行音视频或消息互动的接口权限。
• 调用时机：初始化且获取到 token 之后。
• 隐私保护声明： 请勿在此接口填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
• 影响范围：大部分接口都需要在登录房间后才能调用。
• 相关回调：房间状态回调 roomStateUpdate
• 相关接口：可调用 logoutRoom 接口退出房间。

• 业务场景：结束音视频通话或其他功能后需要调用该接口退出房间，以保证对端能及时同步本端当前状态。调用该接口后会向 ZEGO 服务器发送退出房间信令，然后重置当前房间中用户与 ZEGO 服务器进行交互所需的关键数据，并置空 websocket 对象。
• 默认值：无
• 调用时机：登录房间成功后。
• 影响范围：大部分接口都在退出房间后，不能再调用。
• 相关回调：房间状态回调 roomStateUpdate
• 相关接口：可调用 loginRoom 接口登录房间。
• 平台差异：无

• 业务场景：登录权限和推流权限隔离时使用, 利用token控制权限
• 默认值：无
• 调用时机：登录房间后,主动变更用户在房间内的权限; 登录房间后,收到token将要过期回调;
• 影响范围：token内包含的过期时间,在过期前30s会触发tokenWillExpire回调
• 相关回调：房间token将要过期回调tokenWillExpire
• 相关接口：无
• 平台差异：无

• 业务场景：开发者可用于实现各种业务逻辑，如房间公告等等。
• 默认值：无
• 调用时机：登录房间成功之后。
• 影响范围：大部分接口都需要在登录房间后才能调用。
• 相关回调：房间附加信息回调 roomExtraInfoUpdate。
• 相关接口：无
• 平台差异：无

• 业务场景：房间内用户发送弹幕消息互动。
• 调用时机：调用接口 loginRoom 登录房间成功之后。
• 相关回调：房间内用户可以通过房间弹幕消息通知回调 IMRecvBarrageMessage 来接收消息。

• 业务场景：房间内用户发送消息聊天互动，例如语聊房。
• 调用时机：调用接口 loginRoom 登录房间成功之后。
• 影响范围：需要在登录房间后才能调用。
• 相关回调：其他房间用户可以通过广播消息通知回调 IMRecvBroadcastMessage 来接收消息。

• 业务场景：私聊个别用户。
• 调用时机：登录房间成功之后。
• 影响范围：大部分接口都需要在登录房间后才能调用。
• 相关回调：房间内用户可以通过监听自定义命令信令回调 IMRecvCustomCommand 来接收消息。

• 业务场景：一般用于远程控制信令或用户与用户之间的消息发送。
• 调用时机：登录房间成功之后。
• 影响范围：大部分接口都需要在登录房间后才能调用。
• 相关回调：当发送的消息， mode 指定为 ZegoRoomTransparentMessageModeOnlyClient 或者 ZegoRoomTransparentMessageModeClientAndServer 可通过 [recvRoomTransparentMessage] 接收到发送消息的内容。