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

OptiViewAdsExternalVendors

class OptiViewAdsExternalVendors(config: OptiViewAdsExternalVendorsConfig, scope: CoroutineScope = CoroutineScope(SupervisorJob() + Dispatchers.Default), manifestSource: ManifestSource = HttpManifestSource(scope), clock: Clock = systemClock)

Fetches and tracks external vendor parameters without starting playback.

Constructors

OptiViewAdsExternalVendors

constructor(config: OptiViewAdsExternalVendorsConfig, scope: CoroutineScope = CoroutineScope(SupervisorJob() + Dispatchers.Default), manifestSource: ManifestSource = HttpManifestSource(scope), clock: Clock = systemClock)

Functions

addEventListener

fun addEventListener(event: OptiViewAdsEventType, handler: OptiViewAdsEventListener)

Registers a listener for external vendor configuration changes.

Stops polling and removes all event and diagnostic listeners.

exportDiagnostics

fun exportDiagnostics(): DiagnosticReport

Produce a self-contained, redacted report for support and troubleshooting.

getExternalVendorConfiguration

fun getExternalVendorConfiguration(): List<ExternalVendorConfiguration>

Returns defensive copies of all configurations in manifest order.

fun getExternalVendorConfiguration(provider: String): ExternalVendorConfiguration?

Returns a defensive copy of one exact, case-sensitive provider configuration.

fun offDiagnostic(handler: DiagnosticHandler)

Removes a previously registered diagnostic listener.

fun onDiagnostic(handler: DiagnosticHandler)

Registers a listener for SDK diagnostics.

removeEventListener

fun removeEventListener(event: OptiViewAdsEventType, handler: OptiViewAdsEventListener)

Removes a previously registered event listener.

suspend fun start()

Fetches the initial manifest and starts manifest polling when configured.

fun stop()

Stops polling and clears current vendor configurations without emitting changes.

updateAssetParameterMacros

fun updateAssetParameterMacros(updates: Map<String, () -> String??>)

Merges or removes lazy macro callbacks by name.

updateAssetParameterMacroValues

fun updateAssetParameterMacroValues(updates: Map<String, AssetParameterMacro?>)

Merges or removes typed macro callbacks by name.

updateAssetParameters

fun updateAssetParameters(params: Map<String, String>)

Replaces application-supplied asset parameters.