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

    Interface HlsMainMediaLoadOptions

    Configuration provided when loading a main media source via OmakasePlayerApi.loadMainMedia or PlayerApi.loadMainMedia.

    interface HlsMainMediaLoadOptions {
        data?: Record<string, any>;
        dropFrame?: boolean;
        duration?: number;
        ffom?: string;
        fileFormatType?: FileFormatType;
        forceSkipMetadataResolution?: boolean;
        frameRate?: string | number;
        mainMediaType?: MainMediaType;
        mediaRotation?: MediaRotationValue;
        poster?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    data? dropFrame? duration? ffom? fileFormatType? forceSkipMetadataResolution? frameRate? mainMediaType? mediaRotation? poster?

    Properties

    data?: Record<string, any>

    Arbitrary key-value data provided on media load. Can be used to store values such as DRM tokens.

    dropFrame?: boolean

    Whether the frame rate uses drop-frame counting.

    duration?: number

    Explicit media duration in seconds. Overrides the duration reported by the source.

    ffom?: string

    FFOM (First Frame of Media) timecode string used to offset time display.

    fileFormatType?: FileFormatType

    Explicitly set the file format instead of auto-detecting from the source URL. Takes precedence over mainMediaType for resolving both format and media type.

    forceSkipMetadataResolution?: boolean

    When true, disables all automatic media probing / metadata HTTP requests (file format detection, HLS init segment time offset, audio channel count/codec, etc.). mainMediaType and/or fileFormatType must be provided explicitly, or loading fails — anything else that would normally be probed falls back to a default value instead.

    frameRate?: string | number

    Media frame rate. Can be a numeric value or a fraction string in the form "numerator/denominator".

    mainMediaType?: MainMediaType

    Explicitly set the media type instead of auto-detecting from the source URL.

    mediaRotation?: MediaRotationValue

    Number of degrees by which the video should be rotated (0, 90, 180 or 270)

    poster?: string

    URL for a poster image displayed before the video starts playing.

    Settings

    Member Visibility

    On This Page

    Properties