Uplynk Connector/com.theoplayer.android.connector.uplynk/UplynkSsaiDescription

UplynkSsaiDescription

@Serializable

data class UplynkSsaiDescription(val prefix: String? = null, val assetIds: List<String> = listOf(), val externalIds: List<String> = listOf(), val userId: String? = null, val contentProtected: Boolean = false, val preplayParameters: LinkedHashMap<String, String> = linkedMapOf(), val assetInfo: Boolean = false, val assetType: UplynkAssetType = UplynkAssetType.ASSET, val pingConfiguration: UplynkPingConfiguration = UplynkPingConfiguration()) : CustomSsaiDescription

The configuration for server-side ad insertion using the UplynkConnector.

Constructors

UplynkSsaiDescription

constructor(prefix: String? = null, assetIds: List<String> = listOf(), externalIds: List<String> = listOf(), userId: String? = null, contentProtected: Boolean = false, preplayParameters: LinkedHashMap<String, String> = linkedMapOf(), assetInfo: Boolean = false, assetType: UplynkAssetType = UplynkAssetType.ASSET, pingConfiguration: UplynkPingConfiguration = UplynkPingConfiguration())

Types

A builder for a UplynkSsaiDescription.

Properties

val assetIds: List<String>

Sets a list of asset IDs for Uplynk Media Platform Preplay API.

val assetInfo: Boolean = false

Sets flag to request asset info.

val assetType: UplynkAssetType

Sets the asset type.

contentProtected

val contentProtected: Boolean = false

Sets whether the assets of the source are content protected.

customIntegration

open override val customIntegration: String

val externalIds: List<String>

Sets a list of external IDs for Uplynk Media Platform Preplay API. If assetIds have at least one value this property is ignored and could be empty

pingConfiguration

val pingConfiguration: UplynkPingConfiguration

Sets the ping request configuration

val prefix: String? = null

Sets the prefix to use for Uplynk Media Platform Preplay API and Asset Info API requests.

preplayParameters

val preplayParameters: LinkedHashMap<String, String>

Sets the parameters.

val userId: String? = null

Sets a User ID for Uplynk Media Platform Preplay API. If assetIds have at least one value this property is ignored and could be empty