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

    Interface SidecarDomController

    Owns sidecar media element and everything needed for its playback, mounted into host element.

    interface SidecarDomController {
        visible: boolean;
        destroy(): void;
        loadDuration(url: string | undefined): Observable<number>;
        loadSource(url: string | undefined, startTime?: number): Observable<void>;
        release(): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    visible

    Methods

    destroy loadDuration loadSource release

    Properties

    visible: boolean

    Sidecar element visibility. Hidden element keeps its layout box, so it's not painted but keeps its size and becomes visible without re-layout.

    Methods

    • Resolves source duration without loading media data. Element is left without source.

      Parameters

      • url: string | undefined

        Source url, not set when source is held by track state itself

      Returns Observable<number>

    • Loads source, completes when media data needed to show sidecar is loaded.

      Parameters

      • url: string | undefined

        Source url, not set when source is held by track state itself, ie. frame images of frame image track

      • OptionalstartTime: number

        Sidecar time loading should start from, so the first fetched data is the one that will be played. Defaults to 0.

      Returns Observable<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods