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;
    playerClickHandler?: () => void;
    playerHTMLElementId?: string;
    thumbnailFn?: (time: number) => undefined | string;
    thumbnailVttUrl?: string;
    vttDownsamplePeriod?: number;
}

Properties

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

Properties

Optionalauthentication

authentication?: AuthenticationData

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

Optionalcrossorigin

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

OptionaldetachedPlayer

detachedPlayer?: boolean

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

OptionaldetachedPlayerUrlFn

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

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

OptionalhlsConfig

hlsConfig?: Partial<OmpHlsConfig>

HLS configuration

OptionalmediaChrome

mediaChrome?: MediaChromeVisibility

Show player with or without media chrome controls

OptionalmediaChromeHTMLElementId

mediaChromeHTMLElementId?: string

OptionalplayerClickHandler

playerClickHandler?: () => void

Custom video player click handler

OptionalplayerHTMLElementId

playerHTMLElementId?: string

OptionalthumbnailFn

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

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

OptionalthumbnailVttUrl

thumbnailVttUrl?: string

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

OptionalvttDownsamplePeriod

vttDownsamplePeriod?: number

Settings

Member Visibility

On This Page

Properties