GameManager

Kotlin |Java

public final class GameManager
extends Object

java.lang.Object
↳	android.app.GameManager

The GameManager allows system apps to modify and query the game mode of apps.

Summary

Constants
`int`	`GAME_MODE_BATTERY` Battery game mode will save battery and give longer game play time.
`int`	`GAME_MODE_PERFORMANCE` Performance game mode maximizes the game's performance.
`int`	`GAME_MODE_STANDARD` Standard game mode means the platform will use the game's default performance characteristics.
`int`	`GAME_MODE_UNSUPPORTED` Game mode is not supported for this application.

Public methods
`int`	`getGameMode()` Return the user selected game mode for this application.
`void`	`setGameState(GameState gameState)` Called by games to communicate the current state to the platform.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Constants

GAME_MODE_BATTERY

Added in API level 31

public static final int GAME_MODE_BATTERY

Battery game mode will save battery and give longer game play time.

Constant Value: 3 (0x00000003)

GAME_MODE_PERFORMANCE

Added in API level 31

public static final int GAME_MODE_PERFORMANCE

Performance game mode maximizes the game's performance.

This game mode is highly likely to increase battery consumption.

Constant Value: 2 (0x00000002)

GAME_MODE_STANDARD

Added in API level 31

public static final int GAME_MODE_STANDARD

Standard game mode means the platform will use the game's default performance characteristics.

Constant Value: 1 (0x00000001)

GAME_MODE_UNSUPPORTED

Added in API level 31

public static final int GAME_MODE_UNSUPPORTED

Game mode is not supported for this application.

Constant Value: 0 (0x00000000)

Public methods

getGameMode

Added in API level 31

public int getGameMode ()

Return the user selected game mode for this application.

An application can use android:isGame="true" or android:appCategory="game" to indicate that the application is a game. If an application is not a game, always return GAME_MODE_UNSUPPORTED.

Developers should call this API every time the application is resumed.

Returns
`int`	Value is `GAME_MODE_UNSUPPORTED`, `GAME_MODE_STANDARD`, `GAME_MODE_PERFORMANCE`, or `GAME_MODE_BATTERY`

setGameState

Added in API level 33

public void setGameState (GameState gameState)

Called by games to communicate the current state to the platform.

Parameters
`gameState`	`GameState`: An object set to the current state. This value cannot be `null`.