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

    Interface TamsMainMediaLoadOptions

    Load options for TAMS media.

    timerange and BaseMainMediaLoadOptions.duration select the playback mode:

    • timerange with start and end — VOD over that range.
    • timerange with start only (ie. "[3600:0_") — start-over live (LiveMode.EVENT): a fixed start that grows towards the flow head, which is polled for new segments.
    • duration only — sliding-window live (LiveMode.CONTINUOUS): a duration seconds long window that follows the flow head, with back buffer eviction.
    • neither — VOD over a default window resolved from the flow timerange.

    timerange takes precedence over duration.

    interface TamsMainMediaLoadOptions {
        additionalFlowUrls?: string[];
        data?: Record<string, any>;
        dropFrame?: boolean;
        duration?: number;
        ffom?: string;
        ffomTimeZoneOffset?: number;
        fileFormatType?: FileFormatType;
        forceSkipMetadataResolution?: boolean;
        frameRate?: string | number;
        mainMediaType?: MainMediaType;
        mediaRotation?: MediaRotationValue;
        poster?: string;
        returnTamsMediaData?: boolean;
        timerange?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    additionalFlowUrls? data? dropFrame? duration? ffom? ffomTimeZoneOffset? fileFormatType? forceSkipMetadataResolution? frameRate? mainMediaType? mediaRotation? poster? returnTamsMediaData? timerange?

    Properties

    additionalFlowUrls?: string[]

    Flow URLs to play alongside the flow being loaded. Allows on the fly multi flow creation as long as additional flows are compatible. This is incompatible if the main TAMS resource provided is muxed, source or a multiflow.

    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.

    ffomTimeZoneOffset?: number

    Whole hours to shift the derived FFOM timecode by, -23 to 23.

    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.

    returnTamsMediaData?: boolean

    Keeps the flows and segments the manifest was built from on the loaded media, readable through TamsMainMedia.tamsMediaData. Defaults to false.

    timerange?: string

    TAMS timerange to load, in TAMS timerange notation (ie. "[0:0_600:0)", "[3600:0_"). Open bounds are resolved from the flow timerange. Takes precedence over BaseMainMediaLoadOptions.duration.

    Settings

    Member Visibility

    On This Page

    Properties