GCKPlayerState.h File

  • This documentation details the GCKPlayerState enum, which describes the various states a player can be in within the Google Cast framework.

  • The GCKPlayerState enum is deprecated and will be removed in a future release as the Game Manager API is no longer supported.

  • The enum includes states like Unknown, Dropped, Quit, Available, Ready, Idle, and Playing, each representing a different stage of a player's connection and interaction with a Cast receiver.

  • Developers can use this enum to understand and respond to changes in a player's state during a Cast session, although alternative solutions should be considered due to its deprecation.

GCKPlayerState.h File Reference

GCKPlayerState enum. More...

Enumerations

enum  GCKPlayerState {
  GCKPlayerStateUnknown = 0, GCKPlayerStateDropped = 1, GCKPlayerStateQuit = 2, GCKPlayerStateAvailable = 3,
  GCKPlayerStateReady = 4, GCKPlayerStateIdle = 5, GCKPlayerStatePlaying = 6
}
 An enum describing player states. More...
 

Detailed Description

GCKPlayerState enum.

Enumeration Type Documentation

An enum describing player states.

Deprecated:
The Game Manager API is no longer supported and will be removed in a future release.
Enumerator
GCKPlayerStateUnknown 

Unknown player state.

GCKPlayerStateDropped 

The player is no longer connected to the receiver because of a network drop.

GCKPlayerStateQuit 

The player has manually chosen to disconnect from the receiver.

GCKPlayerStateAvailable 

The player is connected to the receiver and available to join a game.

GCKPlayerStateReady 

The player is connected to the receiver, and ready to enter the game.

GCKPlayerStateIdle 

The player is connected to the receiver, in the game, and idle.

GCKPlayerStatePlaying 

The player is connected to the receiver, in the game, and actively playing.