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

    Interface BaseTimelineLane<C, S>Abstract

    interface BaseTimelineLane<
        C extends TimelineLaneConfig,
        S extends TimelineLaneStyle,
    > {
        get id(): string;
        get style(): S;
        addTimelineNode(config: TimelineLaneComponentConfig): TimelineNode;
        clearContent(): void;
        destroy(): void;
        isMinimized(): boolean;
        maximize(args?: TimelineLaneMinimizeMaximizeArgs): void;
        minimize(args?: TimelineLaneMinimizeMaximizeArgs): void;
        prepareForTimeline(
            timeline: TimelineImpl,
            player: PlayerApi,
            ompProvider: OmpProvider,
        ): void;
        setStyle(style: Partial<S>): void;
        toggleMinimizeMaximize(args?: TimelineLaneMinimizeMaximizeArgs): void;
        updateAttrs(attrs: TimelineLaneUpdateableAttrs): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Implements

    Index

    Accessors

    id style

    Methods

    addTimelineNode clearContent destroy isMinimized maximize minimize prepareForTimeline setStyle toggleMinimizeMaximize updateAttrs

    Accessors

    • get style(): S

      Current resolved style for this lane. Reflects style defaults merged with any overrides applied via setStyle.

      Returns S

    Methods

    • Removes all visual content from the lane's timecoded area without destroying the lane itself. Useful for clearing stale data before reloading (e.g. when the main media changes).

      Returns void

    • Returns true when the lane is currently collapsed to zero height.

      Returns boolean

    • Expands the lane back to its configured height.

      Pass args.easing: true for an animated transition. When args is provided, args.complete is set to an Observable<void> that completes when the operation finishes (immediately for non-eased, after the animation for eased). Subscribe to args.complete after calling this method.

      Parameters

      Returns void

    • Collapses the lane to zero height.

      Pass args.easing: true for an animated transition. When args is provided, args.complete is set to an Observable<void> that completes when the operation finishes (immediately for non-eased, after the animation for eased). Subscribe to args.complete after calling this method.

      Parameters

      Returns void

    • Merges style into the lane's current style and triggers a visual refresh. Only the properties present in style are changed; omitted properties retain their current values.

      Parameters

      • style: Partial<S>

        Partial style object containing only the properties to update.

      Returns void

    • Collapses the lane if it is expanded, or expands it if it is collapsed.

      Pass args.easing: true for an animated transition. When args is provided, args.complete is set to an Observable<void> that completes when the operation finishes. Subscribe to args.complete after calling this method.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods