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

Chapter

@Serializable
data class Chapter(val urn: String, val title: String, val imageUrl: String, val mediaType: MediaType, 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.

Constructors

Link copied to clipboard
constructor(urn: String, title: String, imageUrl: String, mediaType: MediaType, lead: String? = null, description: String? = null, blockReason: BlockReason? = null, fullLengthUrn: String? = null, fullLengthMarkIn: Long? = null, fullLengthMarkOut: Long? = null, listSegment: List<Segment>? = null, listResource: List<Resource>? = null, comScoreAnalyticsLabels: Map<String, String>? = null, analyticsLabels: Map<String, String>? = null, timeIntervalList: List<TimeInterval>? = null, validFrom: Instant? = null, validTo: Instant? = null, spriteSheet: SpriteSheet? = null)

Properties

Link copied to clipboard
@SerialName(value = "analyticsMetadata")
open override val analyticsLabels: Map<String, String>? = null

Labels for Commanders Act analytics.

Link copied to clipboard
val blockReason: BlockReason? = null

Reason for blocking the chapter, if applicable.

Link copied to clipboard
@SerialName(value = "analyticsData")
open override val comScoreAnalyticsLabels: Map<String, String>? = null

Labels for ComScore analytics.

Link copied to clipboard
val description: String? = null

A detailed description of the chapter.

Link copied to clipboard
val fullLengthMarkIn: Long? = null

Start time of the chapter within the full-length media (in milliseconds).

Link copied to clipboard
val fullLengthMarkOut: Long? = null

End time of the chapter within the full-length media (in milliseconds).

Link copied to clipboard
val fullLengthUrn: String? = null

URN of the full-length media this chapter is a part of.

Link copied to clipboard
val imageUrl: String

URL of an image representing the chapter.

Link copied to clipboard
val isFullLengthChapter: Boolean

Indicates whether this represents a full-length chapter.

Link copied to clipboard
val lead: String? = null

A short introductory text for the chapter.

Link copied to clipboard
@SerialName(value = "resourceList")
val listResource: List<Resource>? = null

List of resources associated with this chapter.

Link copied to clipboard
@SerialName(value = "segmentList")
val listSegment: List<Segment>? = null

List of segments within this chapter.

Link copied to clipboard
val mediaType: MediaType

The type of media this chapter represents.

Link copied to clipboard
val spriteSheet: SpriteSheet? = null

The SpriteSheet information if available.

Link copied to clipboard
val timeIntervalList: List<TimeInterval>? = null

List of time intervals relevant to the chapter.

Link copied to clipboard
val title: String

Title of the chapter.

Link copied to clipboard
val urn: String

Unique identifier for the chapter.

Link copied to clipboard
val validFrom: Instant? = null

The Instant when the Chapter becomes valid.

Link copied to clipboard
val validTo: Instant? = null

The Instant until when the Chapter is valid.