Share via

Player (JSON)

  • Article

Contains data for a player in a game session.

Player

The Player object has the following specification.

Member Type Description
customData array of 8-bit unsigned integer 1024 bytes of Base64 encoded game-specific player data. This value is opaque to the server.
gamertag string Gamertag—a maximum of 15 characters—of the player. The client should use this value in the UI when identifying the player.
isCurrentlyInSession Boolean value Indicates if the player is currently in the session or left the session.
seatIndex 32-bit signed integer The index of the player in the session.
xuid 64-bit unsigned integer The Xbox User ID (XUID) of the player.

Sample JSON syntax

{
    "xuid": 2533274790412952,
    "gamertag":"MyTestUser",
    "seatindex": 3
    "customData":"AIHJ2?iE?/jiKE!l5S=T..."
    "isCurrentlyInSession":"true"
}

See also

Parent

JavaScript Object Notation (JSON) Object Reference

Reference

GameSession (JSON)