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
getInstance	Get the ZegoMiniGameEngine object.
getVersion	Get the version of ZEGO MiniGameEngine SDK.
init	Initializing ZEGO MiniGameEngine SDK.
unInit	Uninitialize the SDK and release resources.
updateToken	Update token.

Get game list and game details.

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

Loading and starting the game.

Method	Description
setGameContainer	Set the parent container View for the game.
loadGame	Load game.
unloadGame	Unload the game.
setGameEngineHandler	Set the callback interface for events in the game.

Anchor’s play interface

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

Universal interface

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

Game audio interface

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

Cloud broadcast SDK unique interface

Method	Description
destroyInstance	Destroy the ZegoCloudGameEngine object.
getInstance	Get the ZegoCloudGameEngine object.
getPlayVolume	Get cloud gaming volume.
sendKeyboardEvent	Send keyboard events.
setCloudGameContainer	Set the parent container View for the cloud game.
setCloudGameEngineHandler	Set the callback interface for events in the cloud game.
setPlayVolume	Adjusting the volume of cloud gaming.
setStreamProfile	Cloud gaming settings for streaming parameters.
startCloudGame	Start cloud gaming.
startPublishCloudGameStream	Cloud gaming starts streaming.
stopCloudGame	Stop cloud gaming.
stopPublishCloudGameStream	Cloud gaming stop streaming.