Interface

TimelineLayerSyncDetails

Details passed to external media sync callbacks.

Usage notes

`TimelineLayerSyncDetails` is emitted when playback starts, ticks, pauses, crosses a content gap, or changes rate. Adapter code should use `reason` to decide whether work can be skipped. For example, an audio adapter usually reschedules on `"play"` and `"rate"`, but can ignore ordinary `"tick"` calls while the same clip remains active.

Signature

Type Definition
Interface TimelineLayerSyncDetails

Type parameters

NameConstraintDefaultDescription
LayerNamestringstringNamed media layer keys from UseTimelineMediaPlaybackOptions.layers.

Properties

NameSignatureDescription
activeLayersactiveLayers: ActiveLayerResult<LayerName>Active clips grouped by the configured layer selectors.
reasonreason: TimelineMediaSyncReasonReason the external layer callback is being synchronized.
timelineTimetimelineTime: RationalTimeTimeline time being synchronized.