Documentation
Mini Game Engine
Function Overview
Function Overview

Function Overview

Last updated：2024-06-13 16:13

ZEGO MiniGameEngine SDK is supported on network nodes that are deployed in key regions across the world. The SDK provides rich games and custom capabilities for various terminals by using the client API operations.

For more information about the error codes that may be returned after you call the API operations, see Common error codes.

Get and configure an SDK instance.

Method	Description
sharedEngine	Gets the ZegoMiniGameEngine object.
getVersion	Get the version of ZEGO MiniGameEngine SDK.
init:appID:token:userInfo:callback:	Initializing ZEGO MiniGameEngine SDK.
unInit	Uninitialize the SDK and release resources.
updateToken:token:	Update token.

Get game list and game details.

Method	Description
getAllGameList:callback:	Get the complete list of games (including all modes).
getGameList:gameMode:callback:	According to the game mode, obtain the list of games.
getGameInfo:gameID:callback:	Obtain detailed information about the game.

Loading and starting the game.

Method	Description
setGameContainer:gameContainer:	Set the parent container View for the game.
loadGame:gameID:gameMode:gameConfig:callback:	Load game.
unloadGame:forceQuit:	Unload the game.
setGameEngineHandler:handler:	Set the callback interface for events in the game.

Anchor’s play interface

Method	Description
startGame:gameConfig:userSeatInfoList:robotSeatInfoList:callback:	The mode that the anchor plays with the viewers, setting the game information and the players' seat information.

Universal interface

Method	Description
setGameLanguage:language:	Setting game language.
getGameComponentList:callback:	Get a list of components that the current game can control (show / hide).
getGameFunctionList:callback:	Get a list of methods that can be run in the current game, such as the display settings menu.
setGameComponent:componentName:isVisible:callback:	Show / hide game control.
runGameFunction:functionName:callback:	Perform the methods in the game.

Game audio interface

Method	Description
muteGameMusic:mute:	Set the game music on/off.
muteGameSoundEffect:mute:	Turn on/off game sound effects.
enableGameVibrate:isVibrate:	Enable/disable game vibration.
getGameMusicSwitch:callback:	Get the current status of the game music switch.
getGameSoundEffectSwitch:callback:	Get the on/off status of the game sound effects.
getGameVibrateSwitch:callback:	Get the switch status of game vibration.
getGameMusicVolume:callback:	Get the volume of game music.
getGameSoundEffectVolume:callback:	Get the volume of the game sound effect.
setGameMusicVolume:volume:	Set the volume of the game music.
setGameSoundEffectVolume:volume:	Set the volume of the game sound effect.

Cloud broadcast SDK unique interface

Method	Description
destroyInstance	Destroy the ZegoCloudGameEngine object.
getPlayVolume:callback:	Get cloud gaming volume.
sendKeyboardEvent:key:	Send keyboard events.
setCloudGameContainer:gameContainer:	Set the parent container View for the cloud game.
setCloudGameEngineHandler:handler:	Set the callback interface for events in the cloud game.
setPlayVolume:volume:	Adjusting the volume of cloud gaming.
setStreamProfile:streamProfile:	Cloud gaming settings for streaming parameters.
sharedEngine	Gets the ZegoCloudGameEngine object.
startCloudGame:gameID:roomID:gameConfig:callback:	Start cloud gaming.
startPublishCloudGameStream:gameID:roomID:streamID:callback:	Cloud gaming starts streaming.
stopCloudGame:gameID:roomID:callback:	Stop cloud gaming.
stopPublishCloudGameStream:gameID:roomID:streamID:callback:	Cloud gaming stop streaming.