fl-player-ads-ima/com.quickplay.vstb7.player.ima.model.ssai.live/LiveSSAIAdsRequest

LiveSSAIAdsRequest

data class LiveSSAIAdsRequest(val adsId: String? = null, val apiKey: String? = null, val streamActivityMonitorId: String? = null, val adTagParameters: Map<String, String>? = emptyMap(), val manifestSuffix: String? = null, val contentUrl: String? = null, var adTagUrl: String? = null, val adOverlayUIScopes: List<AdOverlayUIScope>? = emptyList(), val loadMediaTimeoutMs: Int = DEFAULT_LOAD_MEDIA_TIMEOUT_MS, val format: MediaType = MediaType.DASH, val languageTag: String? = null, val networkCode: String? = null, val assetKey: String, val authToken: String? = null) : SSAIAdsRequest

Represents the IMA Ads request specific for Server Side Ads Insertion (SSAI) with Live stream use cases.

Constructors

LiveSSAIAdsRequest

constructor(adsId: String? = null, apiKey: String? = null, streamActivityMonitorId: String? = null, adTagParameters: Map<String, String>? = emptyMap(), manifestSuffix: String? = null, contentUrl: String? = null, adTagUrl: String? = null, adOverlayUIScopes: List<AdOverlayUIScope>? = emptyList(), loadMediaTimeoutMs: Int = DEFAULT_LOAD_MEDIA_TIMEOUT_MS, format: MediaType = MediaType.DASH, languageTag: String? = null, networkCode: String? = null, assetKey: String, authToken: String? = null)

Properties

adOverlayUIScopes

open override val adOverlayUIScopes: List<AdOverlayUIScope>?

adsId

open override val adsId: String? = null

An opaque identifier for associated ad playback state, or null if assetKey (for live) or videoId (for VOD) should be used as the ads identifier.

adTagParameters

open override val adTagParameters: Map<String, String>?

A map of extra parameters to pass to the ad server. Sets the overridable ad tag parameters on the stream request. Supply targeting parameters to your stream provides more information.

adTagUrl

open override var adTagUrl: String?

apiKey

open override val apiKey: String? = null

The stream request API key. This is used for content authentication. The API key is provided to the publisher to unlock their content. It's a security measure used to verify the applications that are attempting to access the content.

assetKey

val assetKey: String

The stream request asset key used for live streams.

authToken

val authToken: String? = null

The Live stream authorization token. Used in place of apiKey for stricter content authorization. The publisher can control individual content streams authorizations based on this token.

contentUrl

open override val contentUrl: String? = null

The deep link to the content's screen. If provided, this parameter is passed to the OM SDK. See Android documentation for more information.

format

open override val format: MediaType

The format MediaType.DASH or MediaType.HLS of the stream request.

languageTag

open override val languageTag: String? = null

loadMediaTimeoutMs

open override val loadMediaTimeoutMs: Int

manifestSuffix

open override val manifestSuffix: String? = null

The optional stream manifest's suffix, which will be appended to the stream manifest's URL. The provided string must be URL-encoded and must not include a leading question mark.

networkCode

open override val networkCode: String? = null

(optional but recommended) The network code for the Ad Manager account that owns the stream and is used to apply settings configured in the Ad Manager UI, such as programmatic limited ads enablement. To find the network code, see Find Ad Manager account information. (Your network code is a unique, numeric identifier for your Ad Manager network. This network code is not confidential as it appears in your page's Google Publisher Tags (GPT).)

streamActivityMonitorId

open override val streamActivityMonitorId: String? = null

The ID for debugging the stream with the stream activity monitor. This is used to provide a convenient way to allow publishers to find a stream log in the stream activity monitor tool.