ExtendedMediaSessionActionDetails interface

Package:

@microsoft/live-share-media

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

ExtendedMediaSessionAction

clientId

Unique identifier of the client that triggered this action.

clientId: string

Property Value

string

data

Custom data associated with this action.

data?: null | object

Property Value

null | object

fastSeek

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

fastSeek?: null | boolean

Property Value

null | boolean

ignoreReason

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

ignoreReason?: null | "localusersuspended"

Property Value

null | "localusersuspended"

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?: null | ExtendedMediaMetadata

Property Value

null | ExtendedMediaMetadata

playbackRate

playbackRate?: null | number

Property Value

null | number

seekOffset

The offset of the seek.

seekOffset?: null | number

Property Value

null | number

seekTime

Timestamp of the seek event.

seekTime?: null | number

Property Value

null | number

source

The source of the action.

source: ExtendedMediaSessionActionSource

Property Value

ExtendedMediaSessionActionSource

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?: null | MediaSessionCoordinatorSuspension

Property Value

null | MediaSessionCoordinatorSuspension