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

    Interface CustomChroming

    interface CustomChroming {
        fullscreenChroming?: FullscreenChroming;
        styleUrl?: string | string[];
        theme: Custom;
        themeConfig?: { htmlTemplateId: string };
        thumbnailSelectionFn?: (time: number) => string;
        thumbnailUrl?: string;
        watermark?: string;
        watermarkVisibility?: WatermarkVisibility;
    }

    Hierarchy

    • BasePlayerChroming<Custom>
      • CustomChroming
    Index

    Properties

    fullscreenChroming? styleUrl? theme themeConfig? thumbnailSelectionFn? thumbnailUrl? watermark? watermarkVisibility?

    Properties

    fullscreenChroming?: FullscreenChroming

    Specifies if chroming is enabled in fullscreen

    styleUrl?: string | string[]

    CSS file url(s) for player chroming styling

    theme: Custom

    Chroming theme determines how the player will be chromed.

    themeConfig?: { htmlTemplateId: string }

    Type Declaration

    • htmlTemplateId: string

      Id of the custom web component used for Player chroming

    thumbnailSelectionFn?: (time: number) => string

    Function that allows custom handler for getting a thumbnail for given time

    Type Declaration

      • (time: number): string

      • Parameters

        • time: number

          time in seconds

        Returns string

        thumbnail url

    thumbnailUrl?: string

    URL for the thumbnails (used for preview in media chrome time range)

    watermark?: string

    Watermark text or svg

    watermarkVisibility?: WatermarkVisibility

    Specifies if watermark is shown when the video is playing

    Settings

    Member Visibility

    On This Page

    Properties