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

    Interface ChromingApi

    Public API for chroming the player

    interface ChromingApi {
        chromingSession: ChromingState;
        helpMenuGroups: HelpMenuGroup[];
        isFloatingTimeVisible: boolean | undefined;
        onEvent$: Observable<ChromingEvent>;
        state: ChromingState;
        timeFormat: ChromingTimeFormat | undefined;
        videoSafeZones: VideoSafeZone[];
        addHelpMenuGroup(
            helpMenuGroup: HelpMenuGroup,
            insertPosition: HelpMenuGroupInsertPosition,
        ): Observable<HelpMenuGroup>;
        addMarkerBar(
            url: string,
            destination: ChromingTrackDestination,
            options?: TrackLoadOptions,
            config?: Partial<ChromingMarkerBarConfig>,
        ): Observable<ChromingMarkerBarHandlerApi>;
        addMarkerBar(
            source: Source,
            destination: ChromingTrackDestination,
            options?: TrackLoadOptions,
            config?: Partial<ChromingMarkerBarConfig>,
        ): Observable<ChromingMarkerBarHandlerApi>;
        addSafeZone(
            videoSafeZone: Partial<VideoSafeZone>,
        ): Observable<VideoSafeZone>;
        clearHelpMenuGroups(): Observable<void>;
        deleteMarkerBar(id: string): Observable<void>;
        getMarkerBar(id: string): ChromingMarkerBarHandlerApi | undefined;
        getMarkerBars(): ChromingMarkerBarHandlers;
        getPlayerChromingElement<T>(querySelector: string): T;
        getVuMeterConfig(position?: ChromingVuMeterPosition): ChromingVuMeterConfig;
        removeAllSafeZones(): Observable<void>;
        removeSafeZone(id: string): Observable<void>;
        restoreChromingSession(chromingSession: ChromingState): Observable<void>;
        setFloatingTimeVisible(
            visible: boolean,
            isInteractive?: boolean,
            openEditMode?: boolean,
        ): Observable<void>;
        setFloatingVuMeterVisible(visible: boolean): Observable<void>;
        setThemeConfig(
            themeConfig: Partial<ChromingThemeConfigTypes>,
        ): Observable<void>;
        setThumbnailTrack(
            url: string,
            options?: TrackLoadOptions,
        ): Observable<void>;
        setThumbnailTrack(
            source: Source,
            options?: TrackLoadOptions,
        ): Observable<void>;
        setThumbnailTrack(empty: undefined): Observable<void>;
        setTimeFormat(timeFormat: ChromingTimeFormat): Observable<void>;
        setVuMeterConfig(
            config: Partial<ChromingVuMeterConfig>,
            position?: ChromingVuMeterPosition,
        ): Observable<void>;
        setWatermark(watermark: string | undefined): Observable<void>;
        toggleFullScreen(): Observable<void>;
    }

    Hierarchy (View Summary)

    Index

    Documents

    README

    Properties

    chromingSession helpMenuGroups isFloatingTimeVisible onEvent$ state timeFormat videoSafeZones

    Methods

    addHelpMenuGroup addMarkerBar addSafeZone clearHelpMenuGroups deleteMarkerBar getMarkerBar getMarkerBars getPlayerChromingElement getVuMeterConfig removeAllSafeZones removeSafeZone restoreChromingSession setFloatingTimeVisible setFloatingVuMeterVisible setThemeConfig setThumbnailTrack setTimeFormat setVuMeterConfig setWatermark toggleFullScreen

    Properties

    chromingSession: ChromingState

    Current chroming session of the player. Should not be edited externally.

    helpMenuGroups: HelpMenuGroup[]

    Current help menu groups configured in the player chroming.

    isFloatingTimeVisible: boolean | undefined

    Whether the floating time display is visible in the player chroming.

    onEvent$: Observable<ChromingEvent>

    Observable that emits chroming events such as theme change, safe zones change, help menu change, marker track change, thumbnail track change and theme config change.

    state: ChromingState

    Current chroming state of the player. Should not be edited externally.

    timeFormat: ChromingTimeFormat | undefined

    Current time format used in the player chroming.

    videoSafeZones: VideoSafeZone[]

    Current video safe zones configured in the player chroming.

    Methods

    • Gets the HTML element from the player chroming DOM

      Type Parameters

      • T

      Parameters

      • querySelector: string

        HTML query selector

      Returns T

    • Shows or hides and optionally sets the interactivity of the floating time display in the player chroming.

      Parameters

      • visible: boolean

        is floating time shown

      • OptionalisInteractive: boolean

        sets timeInteractive property in theme config to true/false

      • OptionalopenEditMode: boolean

        if true, changes the time to edit mode and focuses the input (only applicable if timeInteractive property is true)

      Returns Observable<void>

    • Sets the watermark text in the player chroming. Sending undefined will remove the watermark.

      Parameters

      • watermark: string | undefined

      Returns Observable<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods