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

    Interface ChromingApi

    interface ChromingApi {
        get alerts(): AlertsApi;
        get progressMarkerTrack(): TimeRangeMarkerTrackApi | undefined;
        addSafeZone(videoSafeZone: VideoSafeZone): Observable<VideoSafeZone>;
        appendHelpMenuGroup(helpMenuGroup: HelpMenuGroup): Observable<void>;
        clearHelpMenuGroups(): Observable<void>;
        clearSafeZones(): Observable<void>;
        createMarkerTrack(config: MarkerTrackConfig): Observable<MarkerTrackApi>;
        getHelpMenuGroups(): HelpMenuGroup[];
        getPlayerChromingElement<T>(querySelector: string): T;
        getSafeZones(): VideoSafeZone[];
        isFloatingTimeVisible(): boolean | undefined;
        prependHelpMenuGroup(helpMenuGroup: HelpMenuGroup): Observable<void>;
        removeSafeZone(id: string): Observable<void>;
        setFloatingTimeVisible(visible: boolean): void;
        setThumbnailVttUrl(thumbnailVttUrl: string): void;
        setWatermark(watermark: string): void;
    }

    Hierarchy (View Summary)

    Index

    Accessors

    alerts progressMarkerTrack

    Methods

    addSafeZone appendHelpMenuGroup clearHelpMenuGroups clearSafeZones createMarkerTrack getHelpMenuGroups getPlayerChromingElement getSafeZones isFloatingTimeVisible prependHelpMenuGroup removeSafeZone setFloatingTimeVisible setThumbnailVttUrl setWatermark

    Accessors

    • get progressMarkerTrack(): TimeRangeMarkerTrackApi | undefined

      Returns TimeRangeMarkerTrackApi | undefined

      TimeRangeMarkerTrackApi

    Methods

    • Returns the current visibility value of the floating time (BITC) control

      Returns boolean | undefined

    • Sets the visibility of the floating time (BITC) control

      Parameters

      • visible: boolean

        visibility value

      Returns void

    • Set thumbnail vtt url for player chroming thumbnail preview

      Parameters

      • thumbnailVttUrl: string

        Thumbnail Vtt Url

      Returns void

    • Set watermark text or svg for player chroming

      Parameters

      • watermark: string

        Watermark text or svg

      Returns void

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods