OGPlayer Web SDK
    Preparing search index...

    Interface FreewheelConfig

    FreeWheel ad configuration — the web counterpart of the Android/iOS FreewheelConfig, field-for-field. Pure data: no FreeWheel SDK dependency.

    Two integration options, mirroring the mobile SDKs: (a) FreeWheel as VMAP through IMA — freewheelVmapTagUrl(config) builds the network's /ad/g/1 VMAP request; play it with ImaAdsProvider via adBreaks: { adTagUri }. Works today. (b) A native FreeWheel HTML5 provider (their customer-licensed AdManager.js) — ships later as an adapter, like the iOS one.

    Consent and identity parameters (_fw_gdpr, _fw_gdpr_consent, device ids…) are the HOST's responsibility via globalParameters — the SDK never fabricates consent; it adds only the pvrn/vprn randomizers.

    interface FreewheelConfig {
        adStartTimeoutMs?: number;
        fallbackAdDurationMs?: number;
        globalParameters?: Record<string, string>;
        midrollToleranceMs?: number;
        networkId: number;
        profile: string;
        requestTimeoutMs?: number;
        seekCatchUpPolicy?: "NONE" | "MOST_RECENT" | "ALL_MOST_RECENT_FIRST";
        seekThresholdMs?: number;
        serverUrl: string;
        siteSectionId: string;
        videoAssetId: string;
        videoDurationMs: number;
    }

    Hierarchy (View Summary)

    Index
    adStartTimeoutMs? fallbackAdDurationMs? globalParameters? midrollToleranceMs? networkId profile requestTimeoutMs? seekCatchUpPolicy? seekThresholdMs? serverUrl siteSectionId videoAssetId videoDurationMs
    adStartTimeoutMs?: number

    Renderer start watchdog before a slot is abandoned, default 10000.

    fallbackAdDurationMs?: number

    AdInfo duration when FW doesn't expose one, default 15000.

    globalParameters?: Record<string, string>

    GLOBAL-level request parameters, host-supplied verbatim. NOTE: FreeWheel's flag list is space-separated — pass real spaces (" play sltp …"); they encode to the + signs FreeWheel expects.

    midrollToleranceMs?: number

    How close content time must get to a midroll cue, default 1000.

    networkId: number
    profile: string

    FreeWheel profile, e.g. <networkId>:<your_profile>.

    requestTimeoutMs?: number

    Ad request timeout, default 5000.

    seekCatchUpPolicy?: "NONE" | "MOST_RECENT" | "ALL_MOST_RECENT_FIRST"

    What plays after seeking across midroll cues, default "MOST_RECENT".

    seekThresholdMs?: number

    Seeks shorter than this never trigger midroll catch-up, default 2000.

    serverUrl: string

    FreeWheel ad server base URL, e.g. https://<your-network>.v.fwmrm.net.

    siteSectionId: string
    videoAssetId: string
    videoDurationMs: number

    Content duration in ms — explicit, never inferred.

    Settings
    Member Visibility

    On This Page
    Properties