ads-sdk-core/com.dolby.optiview.ads.core/Break

Break

data class Break(val id: String, val start: Any, val duration: Double, val resumeOffset: Double? = null, val controls: Controls? = null, val variants: List<BreakVariant> = emptyList(), val position: String? = null, val delay: Double? = null)

A single ad break. The portable brain (BreakScheduler) reads only id, start, and duration; the SDK orchestrator additionally uses controls (snapback/seek policy) and variants (to build the sequencer's SeqBreak).

Constructors

Break

constructor(id: String, start: Any, duration: Double, resumeOffset: Double? = null, controls: Controls? = null, variants: List<BreakVariant> = emptyList(), position: String? = null, delay: Double? = null)

Properties

controls

val controls: Controls?

What the viewer may do during the break; null leaves the defaults (no skip, no snapback).

delay

val delay: Double?

Legacy pre-roll delay in seconds of played content (default 0).

duration

val duration: Double

Planned length of the break in seconds.

val id: String

Unique id of the break within the manifest; carried on every event for this break.

position

val position: String?

SDK-private legacy shape: "pre" is a START pre-roll (ignores start).

resumeOffset

val resumeOffset: Double?

Where content resumes after the break, in seconds from the break start; null resumes after duration.

start

val start: Any

Wallclock ISO string, PTS number, or an EventTrigger (spec 1.1.0 start.type: "event").

variants

val variants: List<BreakVariant>

The variants the SDK selects from; see resolveBreakFormat.