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

    Interface OmakasePlayerConfig

    interface OmakasePlayerConfig {
        authentication?: AuthenticationData;
        crossorigin?: "anonymous" | "use-credentials";
        detachedPlayer?: boolean;
        detachedPlayerUrlFn?: (
            video: Video,
            videoLoadOptions?: VideoLoadOptions,
        ) => string;
        hlsConfig?: Partial<OmpHlsConfig>;
        mediaChrome?: MediaChromeVisibility;
        mediaChromeHTMLElementId?: string;
        playbackRateOptions?: number[];
        playerClickHandler?: () => void;
        playerHTMLElementId?: string;
        thumbnailFn?: (time: number) => undefined | string;
        thumbnailVttUrl?: string;
        vttDownsamplePeriod?: number;
        watermark?: string;
    }
    Index

    Properties

    authentication? crossorigin? detachedPlayer? detachedPlayerUrlFn? hlsConfig? mediaChrome? mediaChromeHTMLElementId? playbackRateOptions? playerClickHandler? playerHTMLElementId? thumbnailFn? thumbnailVttUrl? vttDownsamplePeriod? watermark?

    Properties

    authentication?: AuthenticationData

    Authentication data for HLS.js, VTT and thumbnail image requests

    crossorigin?: "anonymous" | "use-credentials"
    detachedPlayer?: boolean

    Is this OmakasePlayer instance a detached player instance. Property is set on detached player.

    detachedPlayerUrlFn?: (
        video: Video,
        videoLoadOptions?: VideoLoadOptions,
    ) => string

    Function that will return URL where detached player resides. Property is set on non-detached (local) player side.

    hlsConfig?: Partial<OmpHlsConfig>

    HLS configuration

    mediaChrome?: MediaChromeVisibility

    Show player with or without media chrome controls

    mediaChromeHTMLElementId?: string
    playbackRateOptions?: number[]

    Custom options for playback speed rate

    playerClickHandler?: () => void

    Custom video player click handler

    playerHTMLElementId?: string
    thumbnailFn?: (time: number) => undefined | string

    Function to get thumbnail url from time (used for preview in media chrome time range)

    thumbnailVttUrl?: string

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

    vttDownsamplePeriod?: number
    watermark?: string

    Watermark text or svg

    Settings

    Member Visibility

    On This Page

    Properties