功能总览
ZEGO SDK 拥有全面覆盖全球重点区域的网络节点，提供丰富的 API，为多端提供清晰稳定的实时语音视频云服务。
以下为基本 API 的简要介绍。
初始化相关的前置功能
| 方法名 | 描述 |
|---|---|
| destroyEngine | 销毁引擎实例。 |
| checkSystemRequirements | 支持能力检测接口 |
| off | 删除注册过的回调事件 |
| on | 注册回调事件 |
| initContext | 初始化小程序上下文 |
| enableMultiRoom | 是否开启多房间模式 |
| setLogConfig | 日志高级配置 |
| setDebugVerbose | 是否开启Debug模式，打开时错误信息 alert 提示，默认测试环境开启 |
| getVersion | 获取当前SDK版本 |
房间功能
| 方法名 | 描述 |
|---|---|
| loginRoom | 登录房间 |
| logoutRoom | 退出房间，不再接受各种房间内状态 |
| renewToken | 更新房间权限token |
| setRoomExtraInfo | 设置房间附加消息 |
推流功能
| 方法名 | 描述 |
|---|---|
| startPublishingStream | 开始推流 |
| stopPublishingStream | 停止将本地流推送到远端（即构服务器） |
| setStreamExtraInfo | 设置流的附加信息 |
| addPublishCdnUrl | 通知即构服务器将流转推到CDN |
| removePublishCdnUrl | 通知即构服务器停止将流转推到 CDN |
| createPusher | 创建推流实例 |
| getNextUrl | 获取新的流地址 |
| getPusherInstance | 获取推流组件实例 |
| setPusherAttributes | 设置推流属性 |
| updateAudioVolumeNotify | 更新流音量 |
| updatePlayerNetStatus | 小程序组件网络状态通知事件 |
| updatePlayerState | 推拉流状态更新回调处理 |
| mutePublishStreamVideo | 关闭/打开正在推流的流画面 |
| mutePublishStreamAudio | 打开/关闭正在推流的流声音 |
| start | 开始推流 |
| stop | 停止推流 |
| pause | 暂停推流 |
| resume | 恢复推流 |
| startPreview | 开始预览 |
| stopPreview | 停止预览 |
| snapshot | 截图 |
拉流功能
| 方法名 | 描述 |
|---|---|
| startPlayingStream | 开始拉流 |
| stopPlayingStream | 停止拉取远端流（即构服务器） |
| getPlayerInstance | 获取拉流组件实例 |
| getPlayerList | 获取拉流属性列表 |
| setPlayerAttributes | 修改拉流属性 |
| mutePlayStreamVideo | 停止或恢复拉取视频流 |
| mutePlayStreamAudio | 停止或恢复拉取音频流 |
| play | 开始拉流 |
| pause | 暂停拉流 |
| stop | 停止拉流 |
| mute | 静音 |
| resume | 恢复拉流 |
信令消息功能
| 方法名 | 描述 |
|---|---|
| sendBarrageMessage | 发送房间弹幕消息（消息不保证可靠） |
| sendBroadcastMessage | 发送房间广播消息（消息保证可靠） |
| sendCustomCommand | 发送自定义信令（消息可靠） |
| sendTransparentMessage | 发送透传消息 |
混流功能
| 方法名 | 描述 |
|---|---|
| startAutoMixerTask | 开始自动混流任务 |
| startMixerTask | 开始混流任务 |
| stopAutoMixerTask | 停止服务端自动混流任务 |
| stopMixerTask | 停止服务端混流 |
| setMixerTaskConfig | 混流高级配置 |
混音功能
| 方法名 | 描述 |
|---|---|
| playBGM | 播放 BGM |
| pauseBGM | 暂停 BGM |
| resumeBGM | 恢复 BGM |
| stopBGM | 停止背景音乐 |
| setBGMVolume | 设置 BGM 音量大小 |
设备管理
| 方法名 | 描述 |
|---|---|
| setMICVolume | 设置麦克风音量大小 |
| switchCamera | 切换前后摄像头 |
| toggleTorch | 切换手电筒 |
媒体流播放组件
| 方法名 | 描述 |
|---|---|
| requestFullScreen | 进入全屏 |
| exitFullScreen | 退出全屏 |
| exitPictureInPicture | 退出小窗 |
| requestPictureInPicture | 进入小窗口 |
| snapshot | 截图 |