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

SessionConfig

data class SessionConfig(val manifestUrl: String, val assetParameters: Map<String, String> = emptyMap(), val assetParameterMacros: Map<String, () -> String?> = emptyMap(), val assetParameterMacroValues: Map<String, AssetParameterMacro> = emptyMap(), val adInsertionType: AdInsertionType? = null)

Per-session configuration passed to OptiViewAds.startSession. Changes per piece of content / channel switch.

Constructors

SessionConfig

constructor(manifestUrl: String, assetParameters: Map<String, String> = emptyMap(), assetParameterMacros: Map<String, () -> String?> = emptyMap(), assetParameterMacroValues: Map<String, AssetParameterMacro> = emptyMap(), adInsertionType: AdInsertionType? = null)

Properties

adInsertionType

val adInsertionType: AdInsertionType?

How this session's breaks relate to the content timeline, which decides where content resumes after a break: com.dolby.optiview.ads.core.AdInsertionType.REPLACEMENT (DAR) skips the replaced window; com.dolby.optiview.ads.core.AdInsertionType.INSERTION (DAI) resumes at the cue. When null, the manifest's resumeOffset drives the portable resolveResumePoint.

assetParameterMacros

val assetParameterMacros: Map<String, () -> String?>

Customer macros for the $ tokens in asset-parameter values. Keys are the $-prefixed names as they appear in the break manifest; each callback is invoked when an ad request is built and its result replaces every occurrence of the name inside a value, so "\$OPTIVIEW_PLAYER_WIDTH\$x\$OPTIVIEW_PLAYER_HEIGHT\$" becomes "1920x1080". A fixed value is a constant callback: mapOf("\$SEGMENT\$" to { "sports" }). Returning null omits the parameter that contains the macro (or only its & pair), the same as AssetParameterMacroValue.Empty. Use assetParameterMacroValues to keep a token literally with AssetParameterMacroValue.Unresolved.

assetParameterMacroValues

val assetParameterMacroValues: Map<String, AssetParameterMacro>

Macro callbacks with explicit AssetParameterMacroValue.Text, AssetParameterMacroValue.Empty, and AssetParameterMacroValue.Unresolved states. Uses the same $-prefixed names as assetParameterMacros. When a name is in both maps, this map wins.

assetParameters

val assetParameters: Map<String, String>

Ad parameters for the assets played in this session — targeting, custom params, anything the ad server keys on.

manifestUrl

val manifestUrl: String

Full URL of the break manifest for this content. Fetched and polled exactly as given — the SDK never composes, rewrites or appends to it, so the URL structure is entirely the backend's to decide.