Session properties
Understand the data stored in a session, which fields are managed by the SDK, and which fields you set as the host or application.
読み終わるまでの所要時間 3 分最終更新 4時間前
A session contains built-in fields that the SDK manages and custom fields that the host or service stores as session properties.
Session data
The following table describes the built-in session data fields exposed by the Multiplayer Services SDK. Some values are set when the session is created, some are updated as players join or leave, and some are managed automatically by the SDK.
Field | Description | Set by hostㅤ | Set by service | Notes |
|---|---|---|---|---|
| The unique identifier of the session. | ✓ | ✓ | Generated by the SDK when the session is created or assigned by the user when using |
| The join code players use to enter the session. | ✗ | ✓ | Generated by the SDK during session creation. |
| The user-facing or game-facing name of the session. | ✓ | ✓ | Set when the session is created or configured by the host or application. |
| The session type used to distinguish different session contexts and reconnect flows. | ✓ | ✗ | Defined by the user or application when the session is created. |
| The player ID of the player currently holding host authority over the session. | ✓ | ✓ | Updated by the SDK and the host election flow. |
| The players currently in the session. | ✗ | ✓ | Updated by the SDK as players join and leave. |
| Session-level metadata and state that the host or service can read and update. | ✓ | ✓ | Custom data is set by the host or application; system-managed values can be maintained by the service. |
| The current lifecycle state of the session. | ✗ | ✓ | Updated automatically by the SDK as the session changes state. |
| The maximum number of players allowed in the session. | ✓ | ✓ | Set by the session host or service when the session is configured. |
| The number of players currently in the session. | ✗ | ✓ | Derived automatically from the current member list. |
| The remaining number of player slots available in the session. | ✗ | ✓ | Derived automatically from |
| Whether the session is hidden from public queries. | ✓ | ✗ | Set by the host and can be changed during the session lifetime. |
| Whether the session prevents additional players from joining. | ✓ | ✗ | Controlled by the host or application during session management. |
| Whether a password is required to join the session. | ✓ | ✗ | Set by the host when configuring the session. |
| The connection information and lifecycle state used for the networking setup. | ✓ | ✓ | The host configures the network type; the SDK manages the runtime connection data. |
Built-in fields versus custom session properties
The session model includes both built-in data and custom property data.
Built-in fields such as , , , , , and are managed by the SDK as the session evolves. These fields are central to session lifecycle, matchmaking, and connection setup.
IdCodeHostPlayersStateNetworkCustom session properties are application-defined metadata you store on the session. These properties are useful for session state, game configuration, matchmaking flags, and match-specific values. The host manages them using and then persists them with .
SetPropertySavePropertiesAsyncRefer to Manage properties as a host for details on how to use these properties.