ads-sdk/com.dolby.optiview.ads.sdk/AdBreakBeginEvent

AdBreakBeginEvent

data class AdBreakBeginEvent(val break_: Break, val timestamp: Long, val tuneIn: TuneInInfo? = null, val format: BreakFormat? = null, val elapsedSec: Double = 0.0, val remainingSec: Double = break_.duration) : OptiViewAdsEvent

An ad break starts and content is paused (or, for lshape_content and overlay breaks, keeps playing).

Constructors

AdBreakBeginEvent

constructor(break_: Break, timestamp: Long, tuneIn: TuneInInfo? = null, format: BreakFormat? = null, elapsedSec: Double = 0.0, remainingSec: Double = break_.duration)

Properties

break_

val break_: Break

The break that starts.

elapsedSec

val elapsedSec: Double

Seconds already elapsed since the break's start when this viewer joined it. Zero only for a break caught at its exact start.

format

val format: BreakFormat?

Declared format of the break's selected variant (PLAYG-182).

remainingSec

val remainingSec: Double

Effective duration, in seconds, the break is presented for. ALWAYS reported: a viewer can be part-way into a break without the join being classified as a tune-in, because inside the start tolerance the flag is false while several seconds may already have passed.

timestamp

open override val timestamp: Long

When the event was emitted, in milliseconds since the Unix epoch.

tuneIn

val tuneIn: TuneInInfo?

Present when the viewer joined a break already in progress, absent for an on-time trigger. Its presence is the join CLASSIFICATION; the durations below are the measurement and are always correct.

type

open override val type: OptiViewAdsEventType

Which event this is.