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.

Preposition function

Method	Description
init	Initialize the instance.
getAllGameList	Get a list of games.
getGameList	According to the game mode, obtain the list of games.
getGameInfo	Get game details.
setGameContainer	Set the container to load the game

Ordinary mini-games

Method	Description
getInstance	Get the instance object of ZegoMiniGameEngine.
getVersion	Get the version of ZEGO MiniGameEngine SDK.
updateToken	Update the token.
unInit	Deinitialize the SDK and release resources.
startGame	The anchor plays the mode, sets the game information and the player's seat information.
loadGame	Load the game and its corresponding game mode.
unloadGame	unload the game.
enableGameVibrate	Set the on/off of game vibration.
muteGameSoundEffect	Set the on/off of game sound effects.
muteGameMusic	Set game music on/off.
setGameSoundEffectVolume	Sets the volume of game sound effects.
setGameMusicVolume	Set the volume of the game music.
getGameMusicSwitch	Get the current game music switch status.
getGameMusicVolume	Get the volume of game music.
getGameSoundEffectVolume	Gets the volume of game sound effects.
getGameSoundEffectSwitch	Get the on/off of game sound effects.
getGameVibrateSwitch	Get the on/off of game vibration.
setGameLanguage	Set the game language.
getGameComponentList	Get the list of components that can be controlled by the current game, and control the display/hide of the components.
getGameFunctionList	Get a list of methods that the current game can run, such as displaying the settings menu.
setGameComponent	Sets the show/hide of game controls.
runGameFunction	Execute the method in the game.
on	Set the callback interface for in-game events.
off	Unbind the callback function of the on function.

Cloud broadcast SDK unique interface

Method	Description
getPlayVolume	Get cloud gaming volume.
sendKeyboardEvent	Send keyboard events.
setCloudGameContainer	Set the parent container View for 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.