体验 App SDK 中心 API 中心常见问题代码市场

中文

客户端 API

文档中心
客户端 API
API 概览

功能总览

更新时间：2023-09-20 19:14

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

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

初始化相关的前置功能

方法名	描述	支持小程序平台
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	打开/关闭正在推流的流声音。	微信

拉流功能

方法名	描述	支持平台
startPlayingStream	开始拉流。	微信、支付宝
stopPlayingStream	停止拉取远端流（即构服务器）。	微信、支付宝
getPlayerInstance	获取拉流组件实例。	微信
getPlayerList	获取拉流属性列表。	微信
setPlayerAttributes	修改拉流属性。	微信
mutePlayStreamVideo	停止或恢复拉取视频流。	微信
mutePlayStreamAudio	停止或恢复拉取音频流。	微信

信令消息功能

方法名	描述	支持平台
sendBarrageMessage	发送房间弹幕消息（消息不保证可靠）。	微信、支付宝
sendBroadcastMessage	发送房间广播消息（消息保证可靠）。	微信、支付宝
sendCustomCommand	发送自定义信令（消息可靠）。	微信、支付宝

混流功能

方法名	描述	支持平台
startMixerTask	开始混流任务。	微信
stopMixerTask	停止服务端混流。	微信
setMixerTaskConfig	混流高级配置。	微信

混音功能

方法名	描述	支持平台
playBGM	播放 BGM。	微信
pauseBGM	暂停 BGM。	微信
resumeBGM	恢复 BGM。	微信
stopBGM	停止背景音乐。	微信
setBGMVolume	设置 BGM 音量大小。	微信

设备管理

方法名	描述	支持平台
setMICVolume	设置麦克风音量大小。	微信
switchCamera	切换前后摄像头。	微信
toggleTorch	切换手电筒。	微信

本篇目录