Interface

ActiveClipQuery

Filters for selecting active clips at a timeline time.

Usage notes

Use `ActiveClipQuery` when an integration needs one matching clip, such as a focused preview thumbnail, inspector, subtitle renderer, or source-specific media control. For named multi-layer playback surfaces, prefer ActiveLayerOptions and TimelineEngine.getActiveLayers.

Signature

Type Definition
Interface ActiveClipQuery

Type parameters

NameConstraintDefaultDescription
TrackKindNonestringApp-defined track kind values used by your timeline, such as `"visual"`, `"audio"`, or `"subtitle"`.

Properties

NameSignatureDescription
predicate?(activeClip: ActiveClip<TrackKind>): booleanOptional app predicate for custom selection logic.
sourceId?sourceId?: stringSource asset id to match.
time?time?: RationalTimeTimeline time to inspect. Defaults to the current playhead.
trackKind?trackKind?: TrackKindApp-defined track kind to match, such as "visual", "audio", or "subtitle".