Usage notes
The `layers` record names the media outputs your adapter can synchronize.
Those names flow through `LayerName`, allowing `activeLayers.primary.visuals`
or `activeLayers.layers.audio` to stay typed from the same object.
Each value is an ActiveLayerSelector passed through active layer
lookup before adapter callbacks receive an ActiveLayerResult.
Signature
Interface UseTimelineMediaSyncOptionsType parameters
| Name | Constraint | Default | Description |
|---|---|---|---|
LayerName | string | string | Named media layer keys inferred from `layers`. |
Properties
| Name | Signature | Description |
|---|---|---|
adapter | adapter: TimelineMediaSyncAdapter<LayerName> | External media adapter callbacks. |
adapterIdentity? | adapterIdentity?: object | Stable identity for the adapter resource lifetime. |
frameRate? | frameRate?: TimecodeFrameRate | Optional sequence frame rate used to lock media playback to project frames. |
layers | layers: Record<LayerName, ActiveLayerSelector> | Named active layer selectors used by the external media surface. |
onError? | (error: TimelineMediaError): void | Receives structured media failures with a stable machine-readable reason. |
playbackOptions? | playbackOptions?: Omit<PlaybackOptions, "clock"> | Core playback range and looping policy captured when each playback run begins. |
ready? | ready?: boolean | Whether the external adapter can accept a playback request for configured media. |