LiveMediaSessionCoordinatorSuspension class

Package:

@microsoft/live-share-media

Suspension object for when group synchronization is suspended for the local user.

Constructors

LiveMediaSessionCoordinatorSuspension(undefined | CoordinationWaitPoint, (seekTo?: number) => void)

Properties

waitPoint

Returns an optional wait point associated with the suspension.

Methods

end(number)

Ends the suspension and optionally proposes a time to seek to.

Constructor Details

LiveMediaSessionCoordinatorSuspension(undefined | CoordinationWaitPoint, (seekTo?: number) => void)

new LiveMediaSessionCoordinatorSuspension(waitPoint: undefined | CoordinationWaitPoint, onEnd: (seekTo?: number) => void)

Parameters

waitPoint

undefined | CoordinationWaitPoint

onEnd

(seekTo?: number) => void

Property Details

waitPoint

Returns an optional wait point associated with the suspension.

undefined | CoordinationWaitPoint waitPoint

Property Value

undefined | CoordinationWaitPoint

Remarks

If undefined, the suspension was not created with a wait point.

Method Details

end(number)

Ends the suspension and optionally proposes a time to seek to.

function end(seekTo?: number)

Parameters

seekTo

number

Optional. Proposed time to seek to. Ignored for suspensions at wait points.