@byomakase/omakase-player
    Preparing search index...

    Interface ObservationTrack<S, E>

    An observation track — a timed-items track carrying Observation entries.

    interface ObservationTrack<
        S extends ObservationTrackState = ObservationTrackState,
        E extends OmpEventGroup<any, any> = never,
    > {
        areTimedItemsFetched: boolean;
        areTimedItemsLocked: boolean;
        id: string;
        label: string | undefined;
        loadStage: OpStage;
        mediaType: MediaEntityType;
        observationTrackType: OBSERVATION_TRACK_FILE;
        onEvent$: Observable<TimedItemsTrackEvent | E | TrackEvent<S>>;
        relations: Relation[];
        source: Source | undefined;
        sourceFileFormatType: FileFormatType | undefined;
        state: S;
        timedItems: Observation[];
        timedItemsSorted: Observation[];
        trackType: TrackType;
        addRelation(relation: Relation): void;
        addTimedItems(timedItems: Observation | Observation[]): void;
        deleteTimedItems(id: string | string[]): void;
        findFirstTimedItemAtTime(time: number): Observation | undefined;
        findNearestTimedItem(time: number): Observation | undefined;
        findTimedItemsAtTime(time: number): Observation[];
        findTimedItemsInRange(start: number, end: number): Observation[];
        getTimedItem(id: string): Observation | undefined;
        hasRelation(relation: Relation): boolean;
        loadError(error: string | undefined): void;
        loadStart(): void;
        loadSuccess(): void;
        updateAttrs(attrs: TrackUpdateableAttrs): void;
        updateTimedItem(id: string, attrs: ObservationUpdateableAttrs): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    areTimedItemsFetched areTimedItemsLocked id label loadStage mediaType observationTrackType onEvent$ relations source sourceFileFormatType state timedItems timedItemsSorted trackType

    Methods

    addRelation addTimedItems deleteTimedItems findFirstTimedItemAtTime findNearestTimedItem findTimedItemsAtTime findTimedItemsInRange getTimedItem hasRelation loadError loadStart loadSuccess updateAttrs updateTimedItem

    Properties

    areTimedItemsFetched: boolean
    areTimedItemsLocked: boolean
    id: string

    Unique identifier (UUID).

    label: string | undefined

    Human-readable label for this track.

    loadStage: OpStage

    Current load lifecycle stage (idle → loading → success / failure).

    mediaType: MediaEntityType

    Discriminator indicating whether this entity is a main media or a track.

    observationTrackType: OBSERVATION_TRACK_FILE
    onEvent$: Observable<TimedItemsTrackEvent | E | TrackEvent<S>>

    Observable stream of track lifecycle events.

    relations: Relation[]

    Directed relations to other MediaEntity instances (e.g. RelationType.PART_OF, RelationType.DERIVED_FROM).

    source: Source | undefined

    The data source backing this track, if any.

    sourceFileFormatType: FileFormatType | undefined

    The resolved file format type of the source.

    state: S

    Serializable state snapshot.

    timedItems: Observation[]
    timedItemsSorted: Observation[]

    Returns the timed items sorted by their start time.

    trackType: TrackType

    The kind of track (VIDEO, AUDIO, TEXT_TRACK, MARKER_TRACK, etc.).

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods