EOS API reference page for EOS_Metrics_BeginPlayerSession

This function is part of the Metrics Interface.


Logs the start of a new game session for a local player. The game client should call this function whenever it joins into a new multiplayer, peer-to-peer or single player game session. Each call to BeginPlayerSession must be matched with a corresponding call to EndPlayerSession.

Return Value

Returns EOS_Success on success, or an error code if the input parameters are invalid or an active session for the player already exists.


Parameter Type And Name

Usage Information

EOS_HMetrics Handle

const EOS_Metrics_BeginPlayerSessionOptions* Options

Structure containing the local player's game account and the game session information.

Related API Members