fl-content-auth/com.quickplay.vstb7.platform.model

Package-level declarations

Types

enum AdContentPosition : Enum<AdContentPosition>

enum AdInsertionType : Enum<AdInsertionType>

@JsonClass(generateAdapter = true)

data class AdMetadata(@Json(name = "start") val start: Int, @Json(name = "end") val end: Int, @Json(name = "type") val type: AdContentPosition, @Json(name = "provider") val provider: String, @Json(name = "url") val url: String)

Represents Ad metadata.

BlackoutAction

enum BlackoutAction : Enum<BlackoutAction>

ClientRegistrationToken

@JsonClass(generateAdapter = true)

data class ClientRegistrationToken(@Json(name = "secret") val jwaSecret: String, @Json(name = "expiry") val expireInSeconds: Long, @Json(name = "deviceId") val deviceID: String)

Represents client registration token

ConsumptionType

enum ConsumptionType : Enum<ConsumptionType>

ContentAuthorizationRequest

@JsonClass(generateAdapter = true)

data class ContentAuthorizationRequest

Represents content authorization request payload.

ContentAuthorizationToken

@JsonClass(generateAdapter = true)

data class ContentAuthorizationToken(@Json(name = "contentId") val contentID: String, @Json(name = "contentUrl") val contentURL: String, @Json(name = "licenseUrl") val licenseURL: String = "", @Json(name = "licenseToken") val licenseTokens: List<LicenseToken>?, @Json(name = "mediaFormat") val mediaType: MediaType, @Json(name = "drm") val drmType: DrmType = DrmType.NONE, @Json(name = "licenseProvider") val licenseProvider: LicenseProvider?, @Json(name = "rentalExpiryTime") val rentalExpiryTimeMs: Long?, @Json(name = "heartbeatFlag") val heartbeatFlag: Boolean?, @Json(name = "heartbeatToken") val heartbeatToken: String?, @Json(name = "heartbeatFreq") val heartbeatFrequencyMs: Long?, @Json(name = "blackoutUrl") val blackoutUrl: String?, @Json(name = "blackoutAction") val blackoutAction: BlackoutAction?, @Json(name = "ssaiEnabled") val ssaiEnabled: Boolean?, @Json(name = "assetKey") val assetKey: String?, @Json(name = "cmsID") val contentSourceId: String?, @Json(name = "liveStartTime") val liveStartTime: String?, @Json(name = "liveEndTime") val liveEndTime: String?, @Json(name = "pgmId") val programId: String?, @Json(name = "pgmStartTime") val programStartTime: String?, @Json(name = "pgmEndTime") val programEndTime: String?, @Json(name = "pgmBlackout") val programBlackout: Boolean = false, @Json(name = "livePlaybackMode") val livePlaybackMode: PlaybackMode?, @Json(name = "liveEventType") val liveEventType: String?, @Json(name = "preSlateStartTime") val preSlateStartTime: String?, @Json(name = "preSlateEndTime") val preSlateEndTime: String?, @Json(name = "preSlateContentUrl") val preSlateContentUrl: String?, @Json(name = "postSlateStartTime") val postSlateStartTime: String?, @Json(name = "postSlateEndTime") val postSlateEndTime: String?, @Json(name = "postSlateContentUrl") val postSlateContentUrl: String?, @Json(name = "licenseRefreshToken") val licenseRefreshToken: String?, @Json(name = "keyframe") val keyframeMetadata: KeyframeMetadata? = null, @Json(name = "streamId") val streamID: String?, @Json(name = "bumperSegment") val bumperSegment: List<Promo>? = null, @Json(name = "adType") val adType: AdInsertionType?, @Json(name = "csaiAdCuePointVmap") val csaiAdCuePointVmap: String?, @Json(name = "csaiAdCuePointVast") val csaiAdCuePointVast: List<AdMetadata>?, @Json(name = "live360Enabled") val live360Enabled: Boolean?, @Json(name = "live360StartTime") val live360StartTime: String?, @Json(name = "live360EndTime") val live360EndTime: String?, @Json(name = "live360ContentId") val live360ContentId: String?, @Json(name = "playbackDuration") val playbackExpiryDuration: Long?, @Json(name = "custom") val custom: Map<String, Any>?)

Represents content authorization data.

Delivery

enum Delivery : Enum<Delivery>

DrmType

enum DrmType : Enum<DrmType>

KeyframeMetadata

@JsonClass(generateAdapter = true)

data class KeyframeMetadata(@Json(name = "name") val genericName: String? = null, @Json(name = "ia") val spriteSuffixes: List<String>, @Json(name = "frequency") val thumbnailFrequency: Int, @Json(name = "width") val thumbnailWidth: Int, @Json(name = "height") val thumbnailHeight: Int, @Json(name = "rows") val numberOfRows: Int, @Json(name = "columns") val numberOfColumns: Int)

Data containing required information for Thumbnail Preview.

LicenseProvider

@JsonClass(generateAdapter = true)

data class LicenseProvider(@Json(name = "provider") val provider: String, @Json(name = "version") val version: String)

The License provider information.

LicenseRefreshAsset

@JsonClass(generateAdapter = true)

data class LicenseRefreshAsset(val contentId: String, val drm: DrmType? = DrmType.WIDEVINE, val delivery: Delivery? = Delivery.STREAMING, val licenseUrl: String, val licenseRefreshToken: String, var drmLicenseRetryCount: Int? = DEFAULT_DRM_LICENSE_RETRY)

Represents the license refresh request payload.

LicenseRefreshRequest

@JsonClass(generateAdapter = true)

data class LicenseRefreshRequest

Represents the license refresh request.

LicenseRefreshResponse

@JsonClass(generateAdapter = true)

data class LicenseRefreshResponse(@Json(name = "licenseUrl") val licenseUrl: String)

Data containing refreshed license URL.

LicenseToken

@JsonClass(generateAdapter = true)

data class LicenseToken(@Json(name = "type") val type: String, @Json(name = "name") val name: String, @Json(name = "value") val value: String)

License token item that could be added with license fetching requests.

MediaType

enum MediaType : Enum<MediaType>

PartnerAuthorizationData

@JsonClass(generateAdapter = true)

data class PartnerAuthorizationData(@Json(name = "contentId") val contentId: String, @Json(name = "deeplinkUrl") val deeplinkUrl: String, @Json(name = "deeplinkToken") val deeplinkToken: String?)

Represents Partner Authorization Data.

PartnerContentAuthorizationRequest

@JsonClass(generateAdapter = true)

data class PartnerContentAuthorizationRequest

Partner content authorization request

PartnerPlatformAsset

data class PartnerPlatformAsset(val mediaID: String, val consumptionType: ConsumptionType, val catalogType: String)

Represents a Unique Partner Platform Asset, which a user could use for requesting Partner content authorization.

PlatformAsset

@JsonClass(generateAdapter = true)

data class PlatformAsset(val mediaID: String, val mediaType: MediaType, val consumptionType: ConsumptionType, val catalogType: String, val drmType: DrmType = DrmType.WIDEVINE, val delivery: Delivery = Delivery.STREAMING, val quality: Quality? = Quality.MEDIUM, val playbackMode: PlaybackMode? = null, val primaryContentId: String? = null, val eventId: String? = null, val startTime: String? = null, val endTime: String? = null, val disableSsai: Boolean = false, val urlParameters: Map<String, String>? = null, val custom: Map<String, Any>? = null)

Represents a Unique Platform Asset, which a user could use for requesting content authorization.

PlaybackMode

enum PlaybackMode : Enum<PlaybackMode>

Quality

enum Quality : Enum<Quality>

Properties

DEFAULT_DRM_LICENSE_RETRY

const val DEFAULT_DRM_LICENSE_RETRY: Int = 1

Represents the license refresh default retry count