客户端API

产品 / 插件
平台 / 框架
语言

功能总览

更新时间:2021-04-29 21:16

ZEGO SDK 拥有全面覆盖全球重点区域的网络节点,提供丰富的 API,为多端提供清晰稳定的实时语音视频云服务。

以下为基本 API 的简要介绍。

初始化相关的前置功能

方法名 描述
constructor 初始化Engine
checkSystemRequirements 支持能力检测接口
off 删除注册过的回调事件
on 注册回调事件
setLogConfig 日志高级配置
setDebugVerbose 错误日志信息 alert 提示,默认测试环境下都是开启状态
getVersion 获取当前SDK版本

房间功能

方法名 描述
loginRoom 登录房间
logoutRoom 退出房间,不再接受各种房间内状态
setRoomExtraInfo 设置房间附加消息

推流功能

方法名 描述
getNextUrl 获取新的流地址
updatePlayerNetStatus 小程序组件网络状态通知事件
updatePlayerState 推流状态更新回调
startPublishingStream 将本地流推送到远端(即构服务器)
stopPublishingStream 停止将本地流推送到远端(即构服务器)
addPublishCdnUrl 通知即构服务器将流转推到CDN
removePublishCdnUrl 通知即构服务器停止将流转推到CDN
setStreamExtraInfo 设置流的附加信息

拉流功能

方法名 描述
startPlayingStream 通过流ID获取远端流
stopPlayingStream 停止拉取远端流(即构服务器)

信令消息功能

方法名 描述
sendBarrageMessage 发送消息给房间内所有用户,消息不保证可靠
sendBroadcastMessage 发送消息给房间内所有用户,消息保证可靠
sendCustomCommand 发送消息给房间内指定用户,消息可靠

混流功能

方法名 描述
setMixerTaskConfig 混流高级配置
startMixerTask 将多条流按照调用要求合成一条流。 由于实际动作是在服务端操作,没有浏览器性能上的限制,且各个流之间延迟低,可以保证被混的多条流画面和声音同步
stopMixerTask 停止服务端混流