OptiView Ads SDK
    Preparing search index...

    Interface AdBreakBeginEvent

    Emitted when an ad break starts.

    interface AdBreakBeginEvent {
        break: Break;
        elapsedSec: number;
        format?: BreakFormat;
        remainingSec: number;
        timestamp: number;
        tuneIn?: { elapsedSec: number; remainingSec: number };
        type: "adbreakbegin";
    }

    Hierarchy (View Summary)

    Index
    break elapsedSec format? remainingSec timestamp tuneIn? type
    break: Break
    elapsedSec: number

    Seconds elapsed since the break's start when this viewer joined; zero only at the exact start.

    format?: BreakFormat

    Declared format of the break's selected variant.

    remainingSec: number

    Seconds the break is presented for. Always reported: a viewer can be part-way into a break without a tune-in classification (inside the scheduler's start tolerance).

    timestamp: number
    tuneIn?: { elapsedSec: number; remainingSec: number }

    Present when the viewer joined a break already in progress (tune-in).

    Type Declaration

    • elapsedSec: number

      Seconds already elapsed since the break's start when the viewer joined.

    • remainingSec: number

      Effective remaining duration, in seconds, the break is presented for.

    Read the top-level elapsedSec / remainingSec; use this only as the join classification, since part-way joins inside the start tolerance do not set it.

    type: "adbreakbegin"

    Settings
    Member Visibility

    On This Page
    Properties