ExtendedMediaSessionActionDetails interface

Details for emitted actions from LiveMediaSession.

Remarks

These types extend the default event details supported by the MediaSession specification in browsers. These additional types help with group synchronization.

Properties

action

The action type of this event.

clientId

Unique identifier of the client that triggered this action.

data

Custom data associated with this action.

fastSeek

Flag indicating whether or not this was a fast seek action.

ignoreReason

Reason an action is ignored by the local client, undefined if not ignored.

local

Flag indicating whether or not the action was triggered by the local client.

metadata

Updated session metadata that was changed via this action.

playbackRate
seekOffset

The offset of the seek.

seekTime

Timestamp of the seek event.

source

The source of the action.

suspension

Suspension associated with this action.

Property Details

action

The action type of this event.

action: ExtendedMediaSessionAction

Property Value

clientId

Unique identifier of the client that triggered this action.

clientId: string

Property Value

string

data

Custom data associated with this action.

data?: object | null

Property Value

object | null

fastSeek

Flag indicating whether or not this was a fast seek action.

fastSeek?: boolean | null

Property Value

boolean | null

ignoreReason

Reason an action is ignored by the local client, undefined if not ignored.

ignoreReason?: "localusersuspended" | null

Property Value

"localusersuspended" | null

local

Flag indicating whether or not the action was triggered by the local client.

local: boolean

Property Value

boolean

metadata

Updated session metadata that was changed via this action.

metadata?: ExtendedMediaMetadata | null

Property Value

playbackRate

playbackRate?: number | null

Property Value

number | null

seekOffset

The offset of the seek.

seekOffset?: number | null

Property Value

number | null

seekTime

Timestamp of the seek event.

seekTime?: number | null

Property Value

number | null

source

The source of the action.

source: ExtendedMediaSessionActionSource

Property Value

Remarks

Is user when the action was explicitly invoked via the LiveMediaSessionCoordinator. Is system when the action was invoked via GroupCoordinatorState when the local client is out of sync.

suspension

Suspension associated with this action.

suspension?: MediaSessionCoordinatorSuspension | null

Property Value