OptiView Ads SDK for React Native
    Preparing search index...

    Interface AdBreakStatus

    Playback-gated snapshot of an ad break for UI countdowns (adbreakstatus event, sdk.getAdBreakStatus()).

    interface AdBreakStatus {
        adIndex?: number;
        adsRemaining?: number;
        break: Break | null;
        breakRemainingSec?: number;
        deliveryMode?: SessionDeliveryMode;
        externalPlaybackAllowed?: boolean;
        format?: BreakFormat;
        phase: AdBreakPhase;
        secondsUntilBreak?: number;
        ticking: boolean;
        totalAds?: number;
        warningSec?: number;
    }
    Index
    adIndex? adsRemaining? break breakRemainingSec? deliveryMode? externalPlaybackAllowed? format? phase secondsUntilBreak? ticking totalAds? warningSec?
    adIndex?: number

    0-based index of the ad currently playing within the break.

    adsRemaining?: number

    Number of ads remaining including the currently playing one; after an ad ends, the ads still to come.

    break: Break | null

    The break this status describes; null when phase is idle.

    breakRemainingSec?: number

    Estimated seconds left in the active break; undefined when not yet derivable (e.g. a backdrop break with no per-ad timeupdate).

    deliveryMode?: SessionDeliveryMode

    Delivery mode of the active session; ssb while AirPlay plays the server-side beaconing stream. Absent between sessions.

    externalPlaybackAllowed?: boolean

    Whether the content player may start AirPlay right now: false during a break and in the seconds before one. Present only when the SDK manages the AirPlay gate (the manifest carries a server-side beaconing stream and the adapter can gate external playback).

    format?: BreakFormat

    Declared format of the break's selected variant, when known.

    phase: AdBreakPhase

    Current lifecycle phase of the ad break.

    secondsUntilBreak?: number

    Seconds until the break starts; for a pre-break warning, the countdown value when it fired.

    ticking: boolean

    Whether the countdown is advancing (ad rendered, playback progressing). false while buffering or before a held pre-roll's first frame.

    totalAds?: number

    Total number of ads in the break, when known.

    warningSec?: number

    The configured warning second that was crossed, when a pre-break warning triggered this status.

    Settings
    Member Visibility

    On This Page
    Properties