Type Definitions
AudioTrack
Represents audio track information associated with a media resource.
- object
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. |
AudioType
Audio-only or includes video
- 'AUDIO' |
'VIDEO'
BlockReason
Reasons for content blocking
- 'GEOBLOCK' |
'LEGAL' | 'COMMERCIAL' | 'AGERATING18' | 'AGERATING12' | 'STARTDATE' | 'ENDDATE' | 'UNKNOWN'
BroadcastInformation
Represents broadcast information.
- object
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. |
Channel
Represents a channel.
- object
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. |
Chapter
Represents a chapter of media content.
- object
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 | Copyright information for the image. | ||||||
blockReason | BlockReason | Reason for blocking the chapter. | ||||||
youthProtectionColor | 'YELLOW' | | Youth protection color code. | ||||||
type | 'EPISODE' | | 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' | | 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
| ||||||
analyticsMetadata | object | Metadata for analytics associated with the chapter. Properties
| ||||||
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' | | 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. |
ComposedSrcMediaData
Represents the result of composing source media data.
- object
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
Credit
Represents credit information.
- object
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. |
DrmMetadata
Represents Digital Rights Management (DRM) information associated with a media resource.
- object
Name | Type | Description |
---|---|---|
type | 'FAIRPLAY' | | Type of DRM used for the resource. |
licenseUrl | string | URL for the DRM license. |
certificateUrl | string | URL for the DRM certificate. |
Episode
Represents an episode of media content.
- object
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. |
HbbtvProperties
Represents HbbTV properties associated with a chapter.
- object
Name | Type | Description |
---|---|---|
redButton | boolean | Indicates the availability of the red button feature. |
imageLink | string | URL link associated with the image for HbbTV. |
Headline
Represents headline information.
- object
Name | Type | Description |
---|---|---|
title | string | The title of the headline. |
description | string | The description of the headline. |
Language
Represents a language.
- object
Name | Type | Description |
---|---|---|
locale | string | The locale of the language. |
language | string | The language code. |
Link
Represents a link.
- object
Name | Type | Description |
---|---|---|
title | string | The title of the link. |
link | string | The URL link. |
MainResource
PlayerProperty
Represents a player property associated with a media segment.
- object
Name | Type | Description |
---|---|---|
key | 'iFrameUrl' | | Key identifying the type of player property. |
value | string | Value of the player property. |
PresentationType
Presentation format
- 'DEFAULT' |
'VIDEO_360'
Presenter
Represents a presenter.
- object
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. |
Program
Represents a program.
- object
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. |
QualityType
Content quality
- 'SD' |
'HD' | 'HQ'
RelatedContent
Represents related content associated with a media segment.
- object
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. |
Resource
Represents a resource associated with a media segment.
- object
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 | 'HLS' | | Protocol used for streaming the resource. | ||||||
encoding | 'H264' | | 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' | | Media container type of the resource. | ||||||
audioCodec | 'AAC' | | Audio codec used for the resource. | ||||||
videoCodec | 'H264' | | 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
| ||||||
analyticsMetadata | object | Metadata for analytics purposes. Properties
| ||||||
streamOffset | number | Stream offset for the resource. |
ScheduledBroadcast
Represents a scheduled broadcast.
- object
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. |
Segment
Represents a media segment with detailed metadata.
- object
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 | Copyright information for the image. | ||||||
blockReason | BlockReason | Reason for blocking. | ||||||
youthProtectionColor | 'YELLOW' | | Youth protection color. Allowed values: 'YELLOW', 'RED'. | ||||||
type | 'EPISODE' | | 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' | | 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
| ||||||
analyticsMetadata | object | Metadata for analytics purposes. Properties
| ||||||
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. |
Show
Represents a show.
- object
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. |
SocialCountEntry
Represents a social media count entry associated with a media segment.
- object
Name | Type | Description |
---|---|---|
key | 'srgView' | | Key identifying the type of social media count. |
value | number | Count value for the social media entry. |
SpriteSheet
Represents a sprite sheet associated with a chapter.
- object
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. |
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.
- object
Name | Type | Description |
---|---|---|
dataProvider | undefined | | A function returning an object representing a mediaComposition. |
dataProviderHost | undefined | | A specific host for a different IL environment. |
dataProviderUrlHandler | undefined | | A function for handling a custom data source. |
tagCommanderScriptURL | undefined | | The URL of the TagCommander script. |
- Source
StreamingType
Enumerates various streaming methods
- 'PROGRESSIVE' |
'M3UPLAYLIST' | 'HLS' | 'HDS' | 'RTMP' | 'DASH' | 'UNKNOWN'
SubTopic
Represents a subtopic.
- object
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. |
Subtitle
Represents subtitle information for a media segment.
- object
Name | Type | Description |
---|---|---|
locale | string | Locale information for the subtitle. |
language | string | Language of the subtitle. |
source | 'EXTERNAL' | | Source of the subtitle. |
type | 'SDH' | Type of the subtitle. |
url | string | URL of the subtitle. |
format | 'TTML' | | Format of the subtitle. |
SubtitleInformation
Represents subtitle information associated with a media resource.
- object
Name | Type | Description |
---|---|---|
locale | string | Locale information for the subtitle. |
language | string | Language of the subtitle. |
source | 'EXTERNAL' | | Source of the subtitle information. |
type | 'SDH' | Type of the subtitle information. |
TimeInterval
Represents a time interval metadata used to mark the beginning and ending of opening or closing credits.
- object
Name | Type | Description |
---|---|---|
type | 'OPENING_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. |
TokenType
Represents different token types for authentication
- 'AKAMAI' |
'NONE'
Topic
Represents a topic.
- object
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. |
TrackSelector
The track to select
- object
Name | Type | Description |
---|---|---|
language | string | The track language |
kind | string | The track kind |
- Source
TrackSourceType
Source type for audio/video tracks
- 'HLS' |
'HDS' | 'DASH'
TransmissionType
Medium of transmission
- 'TV' |
'RADIO' | 'ONLINE'
VendorType
Broadcasting organizations
- 'SRF' |
'RTR' | 'RTS' | 'RSI' | 'SWI' | 'SSATR'