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

    Interface TimelineApi

    interface TimelineApi {
        descriptionPaneVisible: boolean;
        id: string;
        onEvent$: Observable<TimelineEvent>;
        scrubberLane: ScrubberLane;
        state: TimelineState;
        style: TimelineStyle;
        addTimelineLane(
            timelineLane: TimelineLaneApi,
            options?: { index?: number; slot?: TimelineSlotType },
        ): TimelineLaneApi;
        addTimelineLanes(
            timelineLanes: TimelineLaneApi<TimelineLaneStyle>[],
            options?: { index?: number; slot?: TimelineSlotType },
        ): TimelineLaneApi<TimelineLaneStyle>[];
        destroy(): void;
        evictLiveHistory(): void;
        getSlot(type: TimelineSlotType): TimelineSlotApi;
        getTimelineLane<T extends TimelineLaneApi<TimelineLaneStyle>>(
            id: string,
        ): T | undefined;
        getTimelineLanes(
            slot?: TimelineSlotType,
        ): TimelineLaneApi<TimelineLaneStyle>[];
        getZoomPercent(): number;
        maximizeTimelineLanes(
            timelineLanes: TimelineLaneApi<TimelineLaneStyle>[],
        ): void;
        minimizeTimelineLanes(
            timelineLanes: TimelineLaneApi<TimelineLaneStyle>[],
        ): void;
        removeAllTimelineLanes(): void;
        removeTimelineLane(id: string): void;
        removeTimelineLanes(ids: string[]): void;
        scrollToEased(percent: number): Observable<number>;
        scrollToLane(
            laneId: string,
            options?: VerticalScrollOptions,
        ): Observable<number>;
        scrollToPlayheadEased(): Observable<number>;
        setDescriptionPaneVisible(visible: boolean): void;
        setDescriptionPaneVisibleEased(visible: boolean): Observable<void>;
        setStyle(style: Partial<TimelineStyle>): void;
        setThumbnailTrack(track: ThumbnailTrack): void;
        settleLayout(): void;
        toggleDescriptionPaneVisible(): void;
        toggleDescriptionPaneVisibleEased(): Observable<void>;
        toggleTimecodeEdit(): void;
        zoomInEased(): Observable<number>;
        zoomOutEased(): Observable<number>;
        zoomTo(percent: number): number;
        zoomTo(percent: number, zoomFocusPercent: number | undefined): number;
        zoomToEased(percent: number): Observable<number>;
        zoomToEased(
            percent: number,
            zoomFocusPercent: number | undefined,
        ): Observable<number>;
        zoomToMaxEased(): Observable<number>;
    }

    Hierarchy

    • Destroyable
      • TimelineApi

    Implemented by

    Index

    Properties

    descriptionPaneVisible id onEvent$ scrubberLane state style

    Methods

    addTimelineLane addTimelineLanes destroy evictLiveHistory getSlot getTimelineLane getTimelineLanes getZoomPercent maximizeTimelineLanes minimizeTimelineLanes removeAllTimelineLanes removeTimelineLane removeTimelineLanes scrollToEased scrollToLane scrollToPlayheadEased setDescriptionPaneVisible setDescriptionPaneVisibleEased setStyle setThumbnailTrack settleLayout toggleDescriptionPaneVisible toggleDescriptionPaneVisibleEased toggleTimecodeEdit zoomInEased zoomOutEased zoomTo zoomToEased zoomToMaxEased

    Properties

    descriptionPaneVisible: boolean

    true if visible, false if not visible

    id: string

    Unique identifier for this timeline instance.

    onEvent$: Observable<TimelineEvent>

    Stream of all events emitted by this timeline instance, including lifecycle events (TimelineEventType.TIMELINE_READY), viewport changes (TimelineEventType.TIMELINE_SCROLL, TimelineEventType.TIMELINE_ZOOM, TimelineEventType.TIMELINE_SLOT_SCROLL), and interaction events (TimelineEventType.TIMELINE_TIMECODE_CLICK, TimelineEventType.TIMELINE_SCRUBBER_MOVE, TimelineEventType.TIMELINE_PLAYHEAD_MOVE).

    scrubberLane: ScrubberLane

    ScrubberLane instance.

    state: TimelineState

    Current runtime state of the timeline.

    TimelineState

    style: TimelineStyle

    Current style configuration of the timeline. Reflects the active visual settings such as dimensions, colours, and playhead appearance.

    TimelineStyle

    Methods

    • Live mode only. Forces the rendered left bound to fully catch up to the true, current live start — unlike TimelineConfig.liveHistoryRetention's automatic behavior, which only ever maintains a bounded (at-most-threshold) trailing gap and never fully closes it by itself. A no-op if there's nothing to evict, including whenever no threshold is configured (the left bound already tracks the true live start exactly in that case).

      Returns void

    • Scrolls timeline

      Parameters

      • percent: number

        in range from 0 - timeline start or first timestamp, to 100 - timeline end or last timestamop

      Returns Observable<number>

    • Shows or hides Timeline description pane

      Parameters

      • visible: boolean

      Returns void

    • Shows or hides Timeline description pane

      Parameters

      • visible: boolean

      Returns Observable<void>

    • Zoom in. Zoom scale in single method call is defined with TimelineConfig.zoomScale

      Returns Observable<number>

    • Timeline zoom

      Parameters

      • percent: number

        number between 100 and TimelineConfig.zoomMax

      Returns number

    • Timeline zoom

      Parameters

      • percent: number

        number between 100 and TimelineConfig.zoomMax

      • zoomFocusPercent: number | undefined

        in range from 0 - timeline start or first timestamp, to 100 - timeline end or last timestamop

      Returns number

    • Timeline zoom

      Parameters

      Returns Observable<number>

    • Timeline zoom

      Parameters

      • percent: number

        number between 100 and TimelineConfig.zoomMax

      • zoomFocusPercent: number | undefined

        in range from 0 - timeline start or first timestamp, to 100 - timeline end or last timestamop

      Returns Observable<number>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods