OGPlayer Web SDK
    Preparing search index...

    Interface AdInfo

    interface AdInfo {
        adId: string;
        adPlaysInContentElement?: boolean;
        adSystem?: string;
        advertiser?: string;
        breakType: AdBreakType;
        clickThroughUrl?: string;
        description?: string;
        durationMs: number;
        isSkippable: boolean;
        podSize: number;
        positionInPod: number;
        providerRendersUi: boolean;
        skipOffsetMs: number;
        title?: string;
    }
    Index
    adId adPlaysInContentElement? adSystem? advertiser? breakType clickThroughUrl? description? durationMs isSkippable podSize positionInPod providerRendersUi skipOffsetMs title?
    adId: string
    adPlaysInContentElement?: boolean

    The creative plays in the host's content video element (IMA's custom playback), so the ad container the SDK was given holds nothing but the SDK's own UI layer (skip, icons). The remote chrome may then inset that container without shrinking any video; undefined = unknown.

    adSystem?: string
    advertiser?: string

    What the ad is about, when the provider knows (IMA: the VAST's advertiser, title, description, ad system). Hosts may show them — the TV demos log them on onAdStarted.

    breakType: AdBreakType
    clickThroughUrl?: string
    description?: string
    durationMs: number
    isSkippable: boolean
    podSize: number
    positionInPod: number
    providerRendersUi: boolean
    skipOffsetMs: number
    title?: string

    Settings
    Member Visibility

    On This Page
    Properties