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

    Interface ChromingCommonApi

    interface ChromingCommonApi {
        chromingSession: ChromingState;
        helpMenuGroups: HelpMenuGroup[];
        isFloatingTimeVisible: boolean | undefined;
        onEvent$: Observable<ChromingEvent>;
        state: ChromingState;
        timeFormat: ChromingTimeFormat | undefined;
        videoSafeZones: VideoSafeZone[];
        addHelpMenuGroup(
            helpMenuGroup: HelpMenuGroup,
            insertPosition: HelpMenuGroupInsertPosition,
        ): Observable<HelpMenuGroup>;
        addSafeZone(
            videoSafeZone: Partial<VideoSafeZone>,
        ): Observable<VideoSafeZone>;
        clearHelpMenuGroups(): Observable<void>;
        deleteMarkerBar(id: string): Observable<void>;
        getMarkerBar(id: string): ChromingMarkerBarHandlerApi | undefined;
        getMarkerBars(): ChromingMarkerBarHandlers;
        removeAllSafeZones(): Observable<void>;
        removeSafeZone(id: string): Observable<void>;
        restoreChromingSession(chromingSession: ChromingState): Observable<void>;
        setFloatingTimeVisible(visible: boolean): Observable<void>;
        setFloatingVuMeterVisible(visible: boolean): Observable<void>;
        setThemeConfig(
            themeConfig: Partial<ChromingThemeConfigTypes>,
        ): 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

    Properties

    chromingSession helpMenuGroups isFloatingTimeVisible onEvent$ state timeFormat videoSafeZones

    Methods

    addHelpMenuGroup addSafeZone clearHelpMenuGroups deleteMarkerBar getMarkerBar getMarkerBars removeAllSafeZones removeSafeZone restoreChromingSession setFloatingTimeVisible setFloatingVuMeterVisible setThemeConfig 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

    • Removes all help menu groups from the player chroming.

      Returns Observable<void>

    • Removes a marker bar from chroming.

      Parameters

      • id: string

        Send id to remove the marker bar from the marker bars area or progress bar

      Returns Observable<void>

    • Gets a marker bar handler by the marker bar id. Marker bar handler can be used to update the marker bar presentation and visibility and to add or remove marker tracks from the marker bar.

      Parameters

      • id: string

        Send id to get the marker bar from the marker bars area or progress bar

      Returns ChromingMarkerBarHandlerApi | undefined

    • Removes all video safe zones from the player chroming.

      Returns Observable<void>

    • Removes a video safe zone from the player chroming.

      Parameters

      • id: string

        Video safe zone id

      Returns Observable<void>

    • Shows or hides the floating time display in the player chroming.

      Parameters

      • visible: boolean

      Returns Observable<void>

    • Shows or hides the floating VU meter in the player chroming.

      Parameters

      • visible: boolean

      Returns Observable<void>

    • Changes the theme configuration of the player chroming. Theme configuration includes settings such as control visibility, floating control configuration and action icon configuration for each theme.

      Parameters

      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