OGPlayer Web SDK
    Preparing search index...

    Interface AdsProvider

    SPI for a client-side ads integration (Google IMA HTML5, future slot providers) — the web mirror of the mobile AdsProvider SPI. Opt-in: apps that never touch ads load none of this.

    interface AdsProvider {
        usesContentVideoElement?: boolean;
        attach(
            video: HTMLVideoElement,
            adContainer: HTMLElement,
            callbacks: AdsProviderCallbacks,
        ): void;
        click(): void;
        contentDidComplete(): void;
        destroy(): void;
        focusUi?(): boolean;
        pause(): void;
        requestAds(config: AdBreakConfig, autostart: boolean): void;
        resize(width: number, height: number, fullscreen: boolean): void;
        resume(): void;
        setVolume?(volume: number, muted: boolean): void;
        skip(): void;
        startPendingBreak(): boolean;
    }

    Implemented by

    Index
    usesContentVideoElement?
    attach click contentDidComplete destroy focusUi? pause requestAds resize resume setVolume? skip startPendingBreak
    usesContentVideoElement?: boolean

    True when the provider plays its ads IN the content video element (FreeWheel's HTML5 SDK design — it swaps the src and the player restores content afterwards). The engine then releases the media element around each break and reloads content at the saved position when the break completes.

    • Wire the provider to the content element and the ad UI container. Called before the first requestAds, and again whenever the host's video element or ad container changes (a re-mounted ad layer) — a provider must adopt the new nodes and release anything bound to the old ones.

      Parameters

      Returns void

    • Content reached its end (so VMAP postrolls fire).

      Returns void

    • Move focus into the provider's own ad UI — the skip button when present, else its interactive elements (icons, an interactive creative). The remote-control chrome calls it on a deliberate step (Right or Up during a break); Back returns focus to the chrome. Return true when focus was taken. Optional: a provider that draws no UI of its own omits it and the chrome keeps the keys (the mobile focusUi()).

      Returns boolean

    • Request ads for the item's config. autostart carries the content's autoplay intent: false = hold the break until startPendingBreak().

      Parameters

      Returns void

    • The player/container was resized (fullscreen, layout).

      Parameters

      • width: number
      • height: number
      • fullscreen: boolean

      Returns void

    • The viewer changed the volume while this provider's ad is on screen. A provider that renders the creative in its OWN element (IMA) must apply it there — the engine's content element is paused under the break, so changing its volume is inaudible. Optional: a provider that plays ads in the content element already follows it and can omit this.

      Parameters

      • volume: number
      • muted: boolean

      Returns void

    • Start a loaded-but-held break. True if one was started.

      Returns boolean

    Settings
    Member Visibility

    On This Page
    Properties
    Methods