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

BreakManifest

data class BreakManifest(val version: String, val timebase: Timebase, val breaks: List<Break>, val polling: Polling? = null, val adStartDelay: Double? = null, val organizationId: String? = null, val channelId: String? = null, val eventId: String? = null, val vendorConfiguration: List<VendorConfiguration> = emptyList(), val delivery: List<DeliveryRule>? = null)

The root Break Manifest structure.

Constructors

constructor(version: String, timebase: Timebase, breaks: List<Break>, polling: Polling? = null, adStartDelay: Double? = null, organizationId: String? = null, channelId: String? = null, eventId: String? = null, vendorConfiguration: List<VendorConfiguration> = emptyList(), delivery: List<DeliveryRule>? = null)

Properties

val adStartDelay: Double?

Played seconds (>= 0) before any break may start; null means 0.

val breaks: List<Break>

The scheduled breaks, in manifest order.

val channelId: String?

Identifier of the channel the stream belongs to; a change between polls is a channel switch.

val delivery: List<DeliveryRule>?

Ordered delivery-steering rules (first match wins), resolved once per session on the first manifest fetch; absent means sgai.

val eventId: String?

Identifier of the event being streamed.

val organizationId: String?

Identifier of the organization owning the stream (ADS-303), surfaced on the CMCD ad telemetry.

val polling: Polling?

Optional manifest-driven poll cadence; null means fetch-once (no polling).

val timebase: Timebase

Which time reference Break.start values use.

vendorConfiguration

val vendorConfiguration: List<VendorConfiguration>

Session-level configuration per vendor integration (spec 1.1.0).

val version: String

Manifest version (semver, e.g. 1.4.0); the SDK checks the major version.