文档中心
ZegoMiniGameEngine 小游戏平台
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
中文站 English
  • 文档中心
  • 小游戏平台
  • 客户端 API
  • 功能总览

功能总览

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

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

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

获取和配置SDK实例

方法名 描述
sharedEngine 获取 ZegoMiniGameEngine 对象。
getVersion 获取 ZEGO MiniGameEngine SDK 的版本。
init:appID:token:userInfo:callback: 初始化 ZegoMiniGameEngine SDK。
unInit 反初始化 SDK,释放资源。
updateToken:token: 更新 Token。

获取游戏列表和游戏详情

方法名 描述
getAllGameList:callback: 获取完整的游戏列表(包含所有模式)。
getGameList:gameMode:callback: 根据游戏模式获取游戏列表。
getGameInfo:gameID:callback: 获取游戏详细信息。

加载和启动游戏

方法名 描述
setGameContainer:gameContainer: 设置游戏的父容器 View。
loadGame:gameID:gameMode:gameConfig:callback: 加载游戏。
unloadGame:forceQuit: 反加载游戏。
setGameEngineHandler:handler: 设置游戏中事件的回调接口。

主播带玩接口

方法名 描述
startGame:gameConfig:userSeatInfoList:robotSeatInfoList:callback: 主播带玩模式,设置游戏的信息和玩家的座位信息。

通用接口

方法名 描述
setGameLanguage:language: 设置游戏语言。
getGameComponentList:callback: 获取当前游戏可以控制(显示/隐藏)的组件列表。
getGameFunctionList:callback: 获取当前游戏可以运行的方法列表,比如显示设置菜单。
setGameComponent:componentName:isVisible:callback: 显示/隐藏游戏控件。
runGameFunction:functionName:callback: 执行游戏中的方法。

游戏音频类接口

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

云开播SDK特有接口

方法名 描述
destroyInstance 销毁 ZegoCloudGameEngine 对象。
getPlayVolume:callback: 获取弹幕游戏音量。
sendKeyboardEvent:key: 发送键盘事件。
setCloudGameContainer:gameContainer: 设置弹幕游戏的父容器 View。
setCloudGameEngineHandler:handler: 设置接收弹幕游戏事件的回调接口。
setPlayVolume:volume: 设置弹幕游戏音量。
setStreamProfile:streamProfile: 弹幕游戏设置码流参数。
sharedEngine 获取 ZegoCloudGameEngine 对象。
startCloudGame:gameID:roomID:gameConfig:callback: 开始弹幕游戏。
startPublishCloudGameStream:gameID:roomID:streamID:callback: 转推弹幕游戏视频流至 RTC 房间。
stopCloudGame:gameID:roomID:callback: 停止弹幕游戏。
stopPublishCloudGameStream:gameID:roomID:streamID:callback: 停止转推弹幕游戏到 RTC 房间。
本篇目录
  • 免费试用
  • 提交工单
    咨询集成、功能及报价等问题
    电话咨询
    400 1006 604
    咨询客服
    微信扫码,24h在线

    联系我们

  • 文档反馈