文档中心
小游戏平台
客户端 API
功能总览

功能总览

更新时间：2024-06-07 11:58

ZEGO SDK 拥有全面覆盖全球重点区域的网络节点，通过客户端 API 为多端提供丰富的游戏内容及个性化能力。

API 返回的错误码请参考：https://doc-zh.zego.im/article/17798。

获取和配置SDK实例

方法名	描述
getInstance	获取 ZegoMiniGameEngine 对象。
getVersion	获取 ZEGO MiniGameEngine SDK 的版本。
init	初始化 ZegoMiniGameEngine SDK。
unInit	反初始化 SDK，释放资源。
updateToken	更新 Token。

获取游戏列表和游戏详情

方法名	描述
getAllGameList	获取完整的游戏列表（包含所有模式）。
getGameList	根据游戏模式获取游戏列表。
getGameInfo	获取游戏详细信息。

加载和启动游戏

方法名	描述
setGameContainer	设置游戏的父容器 View。
loadGame	加载游戏。
unloadGame	反加载游戏。
setGameEngineHandler	设置游戏中事件的回调接口。

主播带玩接口

方法名	描述
startGame	主播带玩模式，设置游戏的信息和玩家的座位信息。

通用接口

方法名	描述
setGameLanguage	设置游戏语言。
getGameComponentList	获取当前游戏可以控制（显示/隐藏）的组件列表。
getGameFunctionList	获取当前游戏可以运行的方法列表，比如显示设置菜单。
setGameComponent	显示/隐藏游戏控件。
runGameFunction	执行游戏中的方法。

游戏音频类接口

方法名	描述
muteGameMusic	设置游戏音乐的开/关。
muteGameSoundEffect	开启/关闭游戏音效。
enableGameVibrate	设置游戏震动的开/关。
getGameMusicSwitch	获取当前游戏音乐开关状态。
getGameSoundEffectSwitch	获取游戏音效的开关状态。
getGameVibrateSwitch	获取游戏震动的开关状态。
getGameMusicVolume	获取游戏音乐的音量。
getGameSoundEffectVolume	获取游戏音效的音量。
setGameMusicVolume	设置游戏音乐的音量。
setGameSoundEffectVolume	设置游戏音效的音量。

云开播SDK特有接口

方法名	描述
destroyInstance	销毁 ZegoCloudGameEngine 对象。
getInstance	获取 ZegoCloudGameEngine 对象。
getPlayVolume	获取弹幕游戏音量。
sendKeyboardEvent	发送键盘事件。
setCloudGameContainer	设置弹幕游戏的父容器 View。
setCloudGameEngineHandler	设置接收弹幕游戏事件的回调接口。
setPlayVolume	设置弹幕游戏音量。
setStreamProfile	弹幕游戏设置码流参数。
startCloudGame	开始弹幕游戏。
startPublishCloudGameStream	转推弹幕游戏视频流至 RTC 房间。
stopCloudGame	停止弹幕游戏。
stopPublishCloudGameStream	停止转推弹幕游戏到 RTC 房间。

本篇目录