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

BreakVariant

data class BreakVariant(val format: BreakFormat, val assets: List<Asset> = emptyList(), val position: OverlayPosition? = null, val size: OverlaySize? = null, val opacity: Double? = null, val targeting: Targeting? = null, val rawFormat: String = format.value)

A break variant (format + ordered assets). The portable brain reads format/rawFormat/targeting/assets (variant selection — see selectVariantDetailed); the overlay layout fields (position/size/opacity) are resolved by the platform renderer and are populated only for BreakFormat.OVERLAY variants (null otherwise). Companion remains out of the portable model.

Constructors

BreakVariant

constructor(format: BreakFormat, assets: List<Asset> = emptyList(), position: OverlayPosition? = null, size: OverlaySize? = null, opacity: Double? = null, targeting: Targeting? = null, rawFormat: String = format.value)

Properties

assets

val assets: List<Asset>

The ordered assets to play in this variant.

format

val format: BreakFormat

The layout this variant renders in; see rawFormat for the uncollapsed manifest string.

opacity

val opacity: Double?

Overlay opacity 0.0-1.0; null defaults to fully opaque (BreakFormat.OVERLAY only).

position

val position: OverlayPosition?

Overlay placement within the player surface (BreakFormat.OVERLAY only).

rawFormat

val rawFormat: String

The UNCOLLAPSED manifest format string. BreakFormat.from maps an unknown format to BreakFormat.SINGLE (forward-compatible parsing), but variant selection must treat an unknown format as NEVER playable — so the raw value survives here. Defaults to the enum's value.

size

val size: OverlaySize?

Overlay size within the player surface (BreakFormat.OVERLAY only).

targeting

val targeting: Targeting?

Variant-level targeting (manifest spec): a variant without a targeted deviceType is a default. Targeting.deviceType stays a raw string so an unrecognised value is targeted-but-unmatched (see Targeting).