logo
当前页

功能总览


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

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

初始化相关的前置功能

方法名描述
destroyEngine销毁引擎实例。
checkSystemRequirements支持能力检测接口
off删除注册过的回调事件
on注册回调事件
enableMultiRoom是否开启多房间模式
setLogConfig日志高级配置
setDebugVerbose是否开启Debug模式,打开时错误信息 alert 提示,默认测试环境开启
getVersion获取当前SDK版本

房间功能

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

推流功能

方法名描述
startPublishingStream开始推流
stopPublishingStream停止将本地流推送到远端(即构服务器)
setStreamExtraInfo设置流的附加信息
addPublishCdnUrl通知即构服务器将流转推到CDN
removePublishCdnUrl通知即构服务器停止将流转推到 CDN
updateAudioVolumeNotify更新流音量

拉流功能

方法名描述
startPlayingStream开始拉流
stopPlayingStream停止拉取远端流(即构服务器)

信令消息功能

方法名描述
sendBarrageMessage发送房间弹幕消息(消息不保证可靠)
sendBroadcastMessage发送房间广播消息(消息保证可靠)
sendCustomCommand发送自定义信令(消息可靠)
sendTransparentMessage发送透传消息

混流功能

方法名描述
startAutoMixerTask开始自动混流任务
startMixerTask开始混流任务
stopAutoMixerTask停止服务端自动混流任务
stopMixerTask停止服务端混流
setMixerTaskConfig混流高级配置

Previous

CDN 直播价格说明

Next

Class

当前页

返回到顶部