Global

Type Definitions

AudioTrack

Represents audio track information associated with a media resource.

Type:

object

Properties

Name	Type	Description
`locale`	string	Locale information for the audio track.
`language`	string	Language of the audio track.
`source`	TrackSourceType	Source of the audio track.
`type`	'AUDIO_DESCRIPTION'	Type of the audio track.

Source: dataProvider/model/typedef.ts, line 175

AudioType

Audio-only or includes video

Type:

'AUDIO' | 'VIDEO'

Source: dataProvider/model/typedef.ts, line 418

BlockReason

Reasons for content blocking

Type:

'GEOBLOCK' | 'LEGAL' | 'COMMERCIAL' | 'AGERATING18' | 'AGERATING12' | 'STARTDATE' | 'ENDDATE' | 'UNKNOWN'

Source: dataProvider/model/typedef.ts, line 422

BroadcastInformation

Represents broadcast information.

Type:

object

Properties

Name	Type	Description
`hintText`	string	The hint text associated with the broadcast.
`url`	string	The URL associated with the broadcast.
`startDate`	string	The start date and time of the broadcast in ISO 8601 format.
`endDate`	string	The end date and time of the broadcast in ISO 8601 format.

Source: dataProvider/model/typedef.ts, line 337

Channel

Represents a channel.

Type:

object

Properties

Name	Type	Description
`id`	string	Unique identifier for the channel.
`vendor`	VendorType	Vendor of the channel.
`title`	string	Title of the channel.
`lead`	string	Lead description of the channel.
`description`	string	Detailed description of the channel.
`imageUrl`	string	URL of the image associated with the channel.
`imageUrlRaw`	string	Raw URL of the image associated with the channel.
`imageTitle`	string	Title of the image associated with the channel.
`imageCopyright`	string	Copyright information for the channel image.
`transmission`	TransmissionType	Type of transmission for the channel.
`timeTableUrl`	string	URL for the channel's timetable.
`presenter`	Presenter	Information about the presenter associated with the channel.
`now`	Program	Information about the currently airing program on the channel.
`next`	Program	Information about the next scheduled program on the channel.
`urn`	string	URN (Uniform Resource Name) for the channel.

Source: dataProvider/model/typedef.ts, line 266

Chapter

Represents a chapter of media content.

Type:

object

Properties

Name Type Description

id

string

Unique identifier for the chapter.

mediaType

AudioType

Type of media content (AUDIO or VIDEO).

vendor

VendorType

Vendor associated with the chapter.

urn

string

URN (Uniform Resource Name) for the chapter.

title

string

Title of the chapter.

lead

string

Lead information for the chapter.

description

string

Description of the chapter.

mediaDescription

string

Media description of the chapter.

imageUrl

string

URL of the image associated with the chapter.

imageTitle

string

Title of the image associated with the chapter.

imageCopyright

string

blockReason

BlockReason

Reason for blocking the chapter.

youthProtectionColor

'YELLOW' | 'RED'

Youth protection color code.

type

Type of the chapter.

date

string

Date and time information for the chapter.

duration

number

Duration of the chapter in seconds.

podcastSdUrl

string

URL for the standard-definition podcast.

podcastHdUrl

string

URL for the high-definition podcast.

validFrom

string

Validity start date and time for the chapter.

validTo

string

Validity end date and time for the chapter.

assignedBy

'EDITOR' | 'TRENDING' | 'RECOMMENDATION'

User who assigned the chapter.

playableAbroad

boolean

Indicates if the chapter is playable abroad.

relatedContentList

Array.<RelatedContent>

List of related content for the chapter.

socialCountList

Array.<SocialCountEntry>

List of social media counts for the chapter.

displayable

boolean

Indicates if the chapter is displayable.

fullLengthUrn

string

URN for the full-length version of the chapter.

position

number

Position of the chapter.

noEmbed

boolean

Indicates if the chapter can be embedded.

subtitleList

Array.<Subtitle>

List of subtitles for the chapter.

analyticsData

object

Analytics data for the chapter.

Properties

Name	Type	Description
`x:`	string	string

analyticsMetadata

object

Metadata for analytics associated with the chapter.

Properties

Name	Type	Description
`x:`	string	string

eventData

string

Event data associated with the chapter.

playerProperties

Array.<PlayerProperty>

List of player properties for the chapter.

tagList

Array.<string>

List of tags associated with the chapter.

label

string

Label information for the chapter.

fullLengthMarkIn

number

Mark in time for the full-length version of the chapter.

fullLengthMarkOut

number

Mark out time for the full-length version of the chapter.

resourceList

Array.<Resource>

List of resources associated with the chapter.

segmentList

Array.<Segment>

List of segments associated with the chapter.

preTrailerStart

string

Start time for the pre-trailer content.

postTrailerStop

string

Stop time for the post-trailer content.

cesimId

string

CESIM (Content, Episode, Segment, Image, Module) identifier for the chapter.

hbbtvProperties

Array.<HbbtvProperties>

List of HbbtvProperties for the chapter.

creatorName

string

Name of the creator of the chapter.

creatorUser

string

User associated with the creator of the chapter.

aspectRatio

'1:1' | '4:5' | '4:3' | '9:16' | '16:9'

Aspect ratio of the chapter.

dvrReferenceDate

string

DVR reference date and time for the chapter.

timeIntervalList

Array.<TimeInterval>

List of time intervals associated with the chapter.

spriteSheet

SpriteSheet

Sprite sheet information for the chapter.

Source: dataProvider/model/typedef.ts, line 55

ComposedSrcMediaData

Represents the result of composing source media data.

Type:

object

Properties

Name	Type	Description
`src`	string	The URL of the source media.
`type`	string	The MIME type of the source media.
`keySystems`	KeySystems	A mapping of DRM types to their corresponding key systems information.
`disableTrackers`	boolean	Indicates whether trackers are disabled for the source media.
`mediaData`	MainResource	The merged media data from the source and additional media data.

Source: middleware/typedef.ts, line 10

Credit

Represents credit information.

Type:

object

Properties

Name	Type	Description
`realName`	string	The real name associated with the credit.
`role`	string	The role of the individual associated with the credit.
`name`	string	The name associated with the credit.

Source: dataProvider/model/typedef.ts, line 401

DrmMetadata

Represents Digital Rights Management (DRM) information associated with a media resource.

Type:

object

Properties

Name	Type	Description
`type`	'FAIRPLAY' \| 'WIDEVINE' \| 'PLAYREADY'	Type of DRM used for the resource.
`licenseUrl`	string	URL for the DRM license.
`certificateUrl`	string	URL for the DRM certificate.

Source: dataProvider/model/typedef.ts, line 168

Episode

Represents an episode of media content.

Type:

object

Properties

Name	Type	Description
`id`	string	Unique identifier for the episode.
`title`	string	Title of the episode.
`lead`	string	Lead description of the episode.
`description`	string	Detailed description of the episode.
`publishedDate`	string	Date and time when the episode was published.
`imageUrl`	string	URL of the image associated with the episode.
`imageTitle`	string	Title of the image associated with the episode.
`imageCopyright`	string	Copyright information for the episode image.
`fullLengthUrn`	string	URN (Uniform Resource Name) for the full-length version of the episode.
`seasonNumber`	number	Season number to which the episode belongs.
`number`	number	Episode number.
`socialCount`	SocialCountEntry	Social count entry for the episode.

Source: dataProvider/model/typedef.ts, line 208

HbbtvProperties

Represents HbbTV properties associated with a chapter.

Type:

object

Properties

Name	Type	Description
`redButton`	boolean	Indicates the availability of the red button feature.
`imageLink`	string	URL link associated with the image for HbbTV.

Source: dataProvider/model/typedef.ts, line 191

Headline

Represents headline information.

Type:

object

Properties

Name	Type	Description
`title`	string	The title of the headline.
`description`	string	The description of the headline.

Source: dataProvider/model/typedef.ts, line 408

Language

Represents a language.

Type:

object

Properties

Name	Type	Description
`locale`	string	The locale of the language.
`language`	string	The language code.

Source: dataProvider/model/typedef.ts, line 307

Link

Represents a link.

Type:

object

Properties

Name	Type	Description
`title`	string	The title of the link.
`link`	string	The URL link.

Source: dataProvider/model/typedef.ts, line 301

MainResource

Type:

Channel

Source: dataProvider/model/MediaComposition.js, line 329

PlayerProperty

Represents a player property associated with a media segment.

Type:

object

Properties

Name	Type	Description
`key`	'iFrameUrl' \| 'playerUrl' \| 'playerRelativeIconImageUrl' \| 'playerWidth' \| 'playerHeight'	Key identifying the type of player property.
`value`	string	Value of the player property.

Source: dataProvider/model/typedef.ts, line 162

PresentationType

Presentation format

Type:

'DEFAULT' | 'VIDEO_360'

Source: dataProvider/model/typedef.ts, line 438

Presenter

Represents a presenter.

Type:

object

Properties

Name	Type	Description
`name`	string	The name of the presenter.
`url`	string	The URL associated with the presenter.
`imageUrl`	string	The URL of the image associated with the presenter.
`imageTitle`	string	The title of the image associated with the presenter.
`imageCopyright`	string	The copyright information of the image associated with the presenter.

Source: dataProvider/model/typedef.ts, line 328

Program

Represents a program.

Type:

object

Properties

Name	Type	Description
`title`	string	The title of the program.
`startTime`	string	The start time of the program in ISO 8601 format.
`endTime`	string	The end time of the program in ISO 8601 format.
`lead`	string	The lead information of the program.
`description`	string	The description of the program.
`imageUrl`	string	The URL of the image associated with the program.
`imageIsFallbackUrl`	boolean	Indicates whether the image is a fallback URL.
`imageTitle`	string	The title of the image associated with the program.
`imageCopyright`	string	The copyright information of the image associated with the program.
`url`	string	The URL associated with the program.
`show`	Show	The show associated with the program.
`programTitle`	string	The title of the program.
`programUrl`	string	The URL associated with the program.
`episodeTitle`	string	The title of the episode.
`episodeUrl`	string	The URL associated with the episode.
`episodeImageTitle`	string	The title of the image associated with the episode.
`episodeImageUrl`	string	The URL of the image associated with the episode.
`mediaUrn`	string	The URN (Uniform Resource Name) associated with the media.
`genre`	string	The genre of the program.
`seasonNumber`	number	The season number of the program.
`episodeNumber`	number	The episode number of the program.
`episodesTotal`	number	The total number of episodes.
`productionYear`	number	The production year of the program.
`productionCountry`	string	The production country of the program.
`youthProtectionColor`	string	The color code for youth protection.
`subtitle`	string	The subtitle information of the program.
`blockTitle`	string	The title of the block associated with the program.
`originalTitle`	string	The original title of the program.
`creditList`	Array.<Credit>	The list of credits associated with the program.
`subProgramList`	Array.<Program>	The list of sub-programs associated with the program.
`subtitlesAvailable`	boolean	Indicates whether subtitles are available.
`isLive`	boolean	Indicates whether the program is live.
`hasTwoLanguages`	boolean	Indicates whether the program has two languages.
`hasSignLanguage`	boolean	Indicates whether the program has sign language.
`hasVisualDescription`	boolean	Indicates whether the program has visual description.
`isFollowUp`	boolean	Indicates whether the program is a follow-up.
`isDolbyDigital`	boolean	Indicates whether the program is in Dolby Digital.
`isRepetition`	boolean	Indicates whether the program is a repetition.
`repetitionDescription`	string	The description of the repetition.
`broadcastInfo`	string	The broadcast information associated with the program.
`channelTitle`	string	The title of the channel associated with the program.
`channelUrn`	string	The URN (Uniform Resource Name) associated with the channel.
`headlineList`	Array.<Headline>	The list of headlines associated with the program.

Source: dataProvider/model/typedef.ts, line 354

QualityType

Content quality

Type:

'SD' | 'HD' | 'HQ'

Source: dataProvider/model/typedef.ts, line 430

RelatedContent

Represents related content associated with a media segment.

Type:

object

Properties

Name	Type	Description
`id`	string	Unique identifier for the related content.
`title`	string	Title of the related content. Limited to 2000 characters.
`lead`	string	Lead information for the related content.
`description`	string	Description of the related content.
`url`	string	URL of the related content.
`contentType`	string	Type of content.
`isExternal`	boolean	Indicates if the related content is external.

Source: dataProvider/model/typedef.ts, line 135

Resource

Represents a resource associated with a media segment.

Type:

object

Properties

Name Type Description

url

string

URL of the resource.

drmList

Array.<DrmMetadata>

List of Digital Rights Management (DRM) information for the resource.

quality

QualityType

Quality of the resource.

protocol

Protocol used for streaming the resource.

encoding

'H264' | 'VP6F' | 'MPEG2' | 'WMV3' | 'AAC' | 'AAC-HE' | 'MP3' | 'MP2' | 'WMAV2'

Encoding used for the resource.

mimeType

string

MIME type of the resource.

presentation

PresentationType

Presentation mode of the resource.

streaming

StreamingType

Streaming type of the resource.

dvr

boolean

Indicates if the resource supports Digital Video Recorder (DVR).

live

boolean

Indicates if the resource is a live stream.

mediaContainer

'MP4' | 'MKV' | 'MPEG2_TS' | 'FMP4' | 'NONE' | 'UNKNOWN'

Media container type of the resource.

audioCodec

'AAC' | 'AAC-HE' | 'MP3' | 'MP2' | 'WMAV2' | 'UNKNOWN'

Audio codec used for the resource.

videoCodec

'H264' | 'VP6F' | 'MPEG2' | 'WMV3' | 'NONE' | 'UNKNOWN'

Video codec used for the resource.

tokenType

TokenType

Token type used for the resource.

audioTrackList

Array.<AudioTrack>

List of audio tracks associated with the resource.

subtitleInformationList

Array.<SubtitleInformation>

List of subtitle information associated with the resource.

analyticsData

object

Analytics data for the resource.

Properties

Name	Type	Description
`x:`	string	string

analyticsMetadata

object

Metadata for analytics purposes.

Properties

Name	Type	Description
`x:`	string	string

streamOffset

number

Stream offset for the resource.

Source: dataProvider/model/typedef.ts, line 110

ScheduledBroadcast

Represents a scheduled broadcast.

Type:

object

Properties

Name	Type	Description
`title`	string	The title of the scheduled broadcast.
`startTime`	string	The start time of the scheduled broadcast in ISO 8601 format.
`endTime`	string	The end time of the scheduled broadcast in ISO 8601 format.
`channelTitle`	string	The title of the channel associated with the scheduled broadcast.
`channelUrn`	string	The URN (Uniform Resource Name) associated with the channel.

Source: dataProvider/model/typedef.ts, line 345

Segment

Represents a media segment with detailed metadata.

Type:

object

Properties

Name Type Description

id

string

Unique identifier for the segment.

mediaType

AudioType

Type of media.

vendor

VendorType

Vendor of the segment.

urn

string

URN (Uniform Resource Name) specifying the segment details.

title

string

Title of the segment. Limited to 2000 characters.

lead

string

Lead information for the segment.

description

string

Description of the segment.

mediaDescription

string

Media description for the segment.

imageUrl

string

URL of the image associated with the segment.

imageTitle

string

Title of the image associated with the segment. Limited to 2000 characters.

imageCopyright

string

blockReason

BlockReason

Reason for blocking.

youthProtectionColor

'YELLOW' | 'RED'

Youth protection color. Allowed values: 'YELLOW', 'RED'.

type

Type of the segment. Allowed values: 'EPISODE', 'EXTRACT', 'TRAILER', 'CLIP', 'LIVESTREAM', 'SCHEDULED_LIVESTREAM'.

date

string

Date and time information in ISO8601 format.

duration

number

Duration of the segment in seconds.

podcastSdUrl

string

URL for the standard definition podcast.

podcastHdUrl

string

URL for the high definition podcast.

validFrom

string

Start date and time for the validity period in ISO8601 format.

validTo

string

End date and time for the validity period in ISO8601 format.

assignedBy

'EDITOR' | 'TRENDING' | 'RECOMMENDATION'

Entity responsible for the assignment. Allowed values: 'EDITOR', 'TRENDING', 'RECOMMENDATION'.

playableAbroad

boolean

Indicates if the segment is playable abroad.

relatedContentList

Array.<RelatedContent>

List of related content items.

socialCountList

Array.<SocialCountEntry>

List of social count entries.

displayable

boolean

Indicates if the segment is displayable.

fullLengthUrn

string

Full-length URN specifying the segment details.

position

number

Position of the segment.

noEmbed

boolean

Indicates if the segment should not be embedded.

subtitleList

Array.<Subtitle>

List of subtitle entries.

analyticsData

object

Analytics data for the segment.

Properties

Name	Type	Description
`x:`	string	string

analyticsMetadata

object

Metadata for analytics purposes.

Properties

Name	Type	Description
`x:`	string	string

eventData

string

Event data associated with the segment.

playerProperties

Array.<PlayerProperty>

List of player properties.

tagList

Array.<string>

List of tags associated with the segment.

label

string

Label for the segment.

markIn

number

Integer representing the mark in time.

markOut

number

Integer representing the mark out time.

Source: dataProvider/model/typedef.ts, line 12

Show

Represents a show.

Type:

object

Properties

Name	Type	Description
`id`	string	Unique identifier for the show.
`vendor`	VendorType	Vendor of the show.
`transmission`	TransmissionType	Type of transmission for the show.
`urn`	string	URN (Uniform Resource Name) for the show.
`title`	string	Title of the show.
`lead`	string	Lead description of the show.
`description`	string	Detailed description of the show.
`imageUrl`	string	URL of the image associated with the show.
`imageTitle`	string	Title of the image associated with the show.
`imageCopyright`	string	Copyright information for the show image.
`bannerImageUrl`	string	URL of the banner image for the show.
`posterImageUrl`	string	URL of the poster image for the show.
`posterImageIsFallbackUrl`	boolean	Indicates if the poster image is a fallback URL.
`podcastImageUrl`	string	URL of the podcast image for the show.
`podcastImageIsFallbackUrl`	boolean	Indicates if the podcast image is a fallback URL.
`homepageUrl`	string	URL of the show's homepage.
`podcastSubscriptionUrl`	string	URL for podcast subscription.
`podcastFeedSdUrl`	string	URL for podcast feed (SD).
`podcastFeedHdUrl`	string	URL for podcast feed (HD).
`podcastDeezerUrl`	string	URL for podcast on Deezer.
`podcastSpotifyUrl`	string	URL for podcast on Spotify.
`timeTableUrl`	string	URL for the show's timetable.
`links`	Array.<Link>	List of links associated with the show.
`primaryChannelId`	string	ID of the primary channel for the show.
`viewedMedias`	number	Number of times the show has been viewed.
`numberOfEpisodes`	number	Number of episodes available for the show.
`availableAudioLanguageList`	Array.<Language>	List of available audio languages for the show.
`availableSubtitleLanguageList`	Array.<Language>	List of available subtitle languages for the show.
`availableVideoQualityList`	Array.<QualityType>	List of available video quality options for the show.
`audioDescriptionAvailable`	boolean	Indicates if audio description is available for the show.
`subtitlesAvailable`	boolean	Indicates if subtitles are available for the show.
`multiAudioLanguagesAvailable`	boolean	Indicates if multiple audio languages are available for the show.
`topicList`	Array.<Topic>	List of topics associated with the show.
`broadcastInformation`	BroadcastInformation	Information about the show's broadcast.
`allowIndexing`	boolean	Indicates if the show is allowed to be indexed.
`nextScheduledBroadcast`	ScheduledBroadcast	Information about the next scheduled broadcast for the show.
`nextScheduledBroadcastList`	Array.<Program>	List of programs for the next scheduled broadcasts.
`primaryChannelUrn`	string	URN of the primary channel for the show.

Source: dataProvider/model/typedef.ts, line 224

SocialCountEntry

Represents a social media count entry associated with a media segment.

Type:

object

Properties

Name	Type	Description
`key`	'srgView' \| 'srgLike' \| 'fbShare' \| 'googleShare' \| 'twitterShare' \| 'whatsAppShare'	Key identifying the type of social media count.
`value`	number	Count value for the social media entry.

Source: dataProvider/model/typedef.ts, line 156

SpriteSheet

Represents a sprite sheet associated with a chapter.

Type:

object

Properties

Name	Type	Description
`urn`	string	URN (Uniform Resource Name) for the sprite sheet.
`rows`	number	Number of rows in the sprite sheet.
`columns`	number	Number of columns in the sprite sheet.
`thumbnailHeight`	number	Height of each thumbnail in the sprite sheet.
`thumbnailWidth`	number	Width of each thumbnail in the sprite sheet.
`interval`	number	Interval between frames in milliseconds.
`url`	string	URL link to the sprite sheet.

Source: dataProvider/model/typedef.ts, line 197

SrgOptions

Represents a set of options specific to the SRG SSR.

Note:

All these options have a default value and can therefore be undefined.
DataProvider options cannot be combined with each other.

Type:

object

Properties

Name	Type	Description
`dataProvider`	undefined \| function	A function returning an object representing a mediaComposition.
`dataProviderHost`	undefined \| string	A specific host for a different IL environment.
`dataProviderUrlHandler`	undefined \| function	A function for handling a custom data source.
`tagCommanderScriptURL`	undefined \| string	The URL of the TagCommander script.

Source: middleware/typedef.ts, line 19

StreamingType

Enumerates various streaming methods

Type:

'PROGRESSIVE' | 'M3UPLAYLIST' | 'HLS' | 'HDS' | 'RTMP' | 'DASH' | 'UNKNOWN'

Source: dataProvider/model/typedef.ts, line 442

SubTopic

Represents a subtopic.

Type:

object

Properties

Name	Type	Description
`id`	string	The unique identifier for the subtopic.
`vendor`	VendorType	The vendor of the subtopic.
`transmission`	TransmissionType	The transmission type of the subtopic.
`urn`	string	The URN of the subtopic.
`title`	string	The title of the subtopic.
`lead`	string	The lead information for the subtopic.
`description`	string	The description of the subtopic.
`viewedMedias`	number	The number of viewed medias for the subtopic.
`imageUrl`	string	The URL of the image associated with the subtopic.
`imageTitle`	string	The title of the image associated with the subtopic.
`imageCopyright`	string	The copyright information of the image associated with the subtopic.

Source: dataProvider/model/typedef.ts, line 313

Subtitle

Represents subtitle information for a media segment.

Type:

object

Properties

Name	Type	Description
`locale`	string	Locale information for the subtitle.
`language`	string	Language of the subtitle.
`source`	'EXTERNAL' \| TrackSourceType	Source of the subtitle.
`type`	'SDH'	Type of the subtitle.
`url`	string	URL of the subtitle.
`format`	'TTML' \| 'VTT'	Format of the subtitle.

Source: dataProvider/model/typedef.ts, line 146

SubtitleInformation

Represents subtitle information associated with a media resource.

Type:

object

Properties

Name	Type	Description
`locale`	string	Locale information for the subtitle.
`language`	string	Language of the subtitle.
`source`	'EXTERNAL' \| TrackSourceType	Source of the subtitle information.
`type`	'SDH'	Type of the subtitle information.

Source: dataProvider/model/typedef.ts, line 183

TimeInterval

Represents a time interval metadata used to mark the beginning and ending of opening or closing credits.

Type:

object

Properties

Name	Type	Description
`type`	'OPENING_CREDITS' \| 'CLOSING_CREDITS'	The type of the time interval.
`markIn`	number	An integer representing the mark in time.
`markOut`	number	An integer representing the mark out time.

Source: dataProvider/model/typedef.ts, line 4

TokenType

Represents different token types for authentication

Type:

'AKAMAI' | 'NONE'

Source: dataProvider/model/typedef.ts, line 446

Topic

Represents a topic.

Type:

object

Properties

Name	Type	Description
`id`	string	Unique identifier for the topic.
`vendor`	VendorType	Vendor of the topic.
`transmission`	TransmissionType	Type of transmission for the topic.
`urn`	string	URN (Uniform Resource Name) for the topic.
`title`	string	Title of the topic.
`lead`	string	Lead description of the topic.
`description`	string	Detailed description of the topic.
`viewedMedias`	number	Number of viewed medias related to the topic.
`imageUrl`	string	URL of the image associated with the topic.
`imageTitle`	string	Title of the image associated with the topic.
`imageCopyright`	string	Copyright information for the topic image.
`subTopicList`	Array.<SubTopic>	List of subtopics associated with the main topic.