pillarbox-core-business/ch.srgssr.pillarbox.core.business.integrationlayer.data

Package-level declarations

Types

Represents the reason why a Chapter is blocked.

@Serializable

data class Chapter(val urn: String, val title: String, val imageUrl: String, val mediaType: MediaType, val type: Type, val lead: String? = null, val description: String? = null, val blockReason: BlockReason? = null, val fullLengthUrn: String? = null, val fullLengthMarkIn: Long? = null, val fullLengthMarkOut: Long? = null, val listSegment: List<Segment>? = null, val listResource: List<Resource>? = null, val comScoreAnalyticsLabels: Map<String, String>? = null, val analyticsLabels: Map<String, String>? = null, val timeIntervalList: List<TimeInterval>? = null, val validFrom: Instant? = null, val validTo: Instant? = null, val spriteSheet: SpriteSheet? = null) : DataWithAnalytics

Represents a Chapter within a media.

DataWithAnalytics

interface DataWithAnalytics

Represents data that can be associated with analytics tracking information.

Drm

@Serializable

data class Drm(val type: Drm.Type, val licenseUrl: String, val certificateUrl: String? = null)

Represents Digital Rights Management (DRM) information for a media stream.

MediaComposition

@Serializable

data class MediaComposition(val chapterUrn: String, val listChapter: List<Chapter>, val comScoreAnalyticsLabels: Map<String, String>? = null, val analyticsLabels: Map<String, String>? = null) : DataWithAnalytics

Represents a media composition.

MediaType

enum MediaType : Enum<MediaType>

Represents the type of media.

MediaUrn

object MediaUrn

This object provides functionality to validate whether a given String is a valid media URN.

Resource

@Serializable

data class Resource(val url: String, val type: Resource.Type, val tokenType: Resource.TokenType = TokenType.NONE, val drmList: List<Drm>? = null, val comScoreAnalyticsLabels: Map<String, String>? = null, val analyticsLabels: Map<String, String>? = null) : DataWithAnalytics

Represents a media resource.

Segment

@Serializable

data class Segment(val urn: String, val title: String, val markIn: Long, val markOut: Long, val blockReason: BlockReason? = null)

Represents a segment of a media item.

SpriteSheet

@Serializable

data class SpriteSheet(val urn: String, val rows: Int, val columns: Int, val thumbnailHeight: Int, val thumbnailWidth: Int, val interval: Long, val url: String)

Represents a sprite sheet containing multiple thumbnail images arranged in a grid.

TimeInterval

@Serializable

data class TimeInterval(val markIn: Long?, val markOut: Long?, val type: TimeIntervalType?)

Represents a time interval.

TimeIntervalType

enum TimeIntervalType : Enum<TimeIntervalType>

Represents the type of time interval.

Type

enum Type : Enum<Type>

Type of the media. This is different to MediaType.

Functions

isValidMediaUrn

fun String?.isValidMediaUrn(): Boolean

Checks if this is a valid media URN.