playbackSession > sessionInfo

The sessionInfo event in the playbackSession namespace indicates whether a specified session is suspended or not. Players send this event when they go in or out of a suspended state. This event is also delivered upon initially subscribing to a playbackSession.

When an action causes a playbackSession to be suspended, players deliver a suspended value of true to indicate this transition.

Parameters

See Control for descriptions of parameters in the header. See the table below for descriptions of parameters in the body.

Parameters Type Value
suspended Boolean The field is true when the session becomes suspended and false after the user requests to resume the session.

Example