功能总览

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

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

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

前置功能

方法名	描述
getInstance	获取 ZegoMiniGameEngine 的实例对象。
getVersion	获取 ZEGO MiniGameEngine SDK 的版本。
updateToken	更新token。
unInit	反初始化 SDK，释放资源。
startGame	主播带玩模式，设置游戏的信息和玩家的座位信息。
loadGame	加载游戏及对应的游戏模式。
unloadGame	卸载游戏。
enableGameVibrate	设置游戏震动的开/关。
muteGameSoundEffect	设置游戏音效的开/关。
muteGameMusic	设置游戏音乐的开/关。
setGameSoundEffectVolume	设置游戏音效的音量。
setGameMusicVolume	设置游戏音乐的音量。
getGameMusicSwitch	获取当前游戏音乐开关状态。
getGameMusicVolume	获取游戏音乐的音量。
getGameSoundEffectVolume	获取游戏音效的音量。
getGameSoundEffectSwitch	获取游戏音效的开/关。
getGameVibrateSwitch	获取游戏震动的开/关。
setGameLanguage	设置游戏语言。
getGameComponentList	获取当前游戏可以控制的组件列表，对于组件可以控制显示/隐藏。
getGameFunctionList	获取当前游戏可以运行的方法列表，比如显示设置菜单。
setGameComponent	设置游戏控件的显示/隐藏。
runGameFunction	执行游戏中的方法。
on	设置游戏中事件的回调接口。
off	解除on函数已绑定的回调函数。

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