OGPlayer Web SDK
    Preparing search index...

    Interface OGPlayerOptions

    OGPlayer web SDK. A product of Inverse DOO.

    interface OGPlayerOptions {
        autoEnterPip?: boolean;
        dashjs?: unknown;
        fallbackToMutedAutoplay?: boolean;
        hlsConfig?: Partial<HlsConfig>;
        licenseAppId?: string;
        licenseKey?: string;
        platformProfile?: PlatformProfile;
        preload?: "" | "none" | "auto" | "metadata";
        progressUpdateIntervalMs?: number;
        seekBackwardIncrementMs?: number;
        seekForwardIncrementMs?: number;
    }
    Index
    autoEnterPip? dashjs? fallbackToMutedAutoplay? hlsConfig? licenseAppId? licenseKey? platformProfile? preload? progressUpdateIntervalMs? seekBackwardIncrementMs? seekForwardIncrementMs?
    autoEnterPip?: boolean

    Lets the browser put the video into picture-in-picture on its own, where the browser offers that: Safari on a tab or app switch (autoPictureInPicture), Chrome on a tab switch for sites it deems eligible (the media-session enterpictureinpicture action, which the SDK registers). Nothing else simulates it: where the browser offers no auto-enter, PiP starts only from enterPip(). Disarmed during ad breaks. Explicit only — default false; there is no PiP button in the chrome.

    dashjs?: unknown

    The dash.js module to play DASH items with (import * as dashjs from "dashjs" in a host that bundles its own build). Optional: without it the SDK uses a dashjs global (ogplayer.dash.global.js or any dash.js <script>), and the ES module bundles fall back to the engine chunk they ship, loaded on the first DASH item. Typed unknown so the SDK's types never depend on dash.js's.

    fallbackToMutedAutoplay?: boolean

    When the browser blocks autoplay-with-audio (NotAllowedError), retry muted instead of staying paused. Fires onMutedAutoplayFallback and a MutedAutoplayFallback analytics event so the UI can offer unmute. Default false — the standard player shows the big play button instead.

    hlsConfig?: Partial<HlsConfig>

    Extra hls.js configuration merged over the SDK's defaults — buffer targets, ABR knobs, anything hls.js accepts. SDK-managed fields (EME/DRM wiring, text-track rendering) win over conflicting keys.

    licenseAppId?: string

    License subject for packaged apps. A web page binds its license to location.hostname; a Tizen / webOS app runs from file:// and has none, so it declares an id instead — e.g. "tizen:ABCDEFGHIJ.MyApp" or "webos:com.example.player" — which must appear in the license's apps list exactly. Consulted ONLY for a page without a hostname (a packaged file:// app): wherever the browser enforces a hostname, that hostname is the subject and this option is ignored — an id can never stand in for an origin the key was not issued for. Ignored when unset.

    licenseKey?: string

    Offline license key (OGP2.…); without one the watermark shows.

    platformProfile?: PlatformProfile

    Platform defaults layer. "tv" applies the smart-TV hls.js profile (bounded buffers, worker on, no low-latency mode — see tvHlsProfile) UNDER hlsConfig, so any single key can still be overridden. Explicit only: the SDK never infers a TV from the user agent or the page origin. Default "default" = today's behaviour.

    preload?: "" | "none" | "auto" | "metadata"

    <video preload> hint, default "auto". "metadata" defers segment loading until play — the standby setting for pooled players.

    progressUpdateIntervalMs?: number

    onProgress cadence, default 250ms.

    seekBackwardIncrementMs?: number
    seekForwardIncrementMs?: number

    Seek button increments, default 10s each way.

    Settings
    Member Visibility

    On This Page
    Properties