Type Definitions

AudioTrack

Represents audio track information associated with a media resource.

Type:
  • object
Properties
NameTypeDescription
localestring

Locale information for the audio track.

languagestring

Language of the audio track.

sourceTrackSourceType

Source of the audio track.

type'AUDIO_DESCRIPTION'

Type of the audio track.

AudioType

Audio-only or includes video

Type:
  • 'AUDIO' | 'VIDEO'

BlockReason

Reasons for content blocking

Type:
  • 'GEOBLOCK' | 'LEGAL' | 'COMMERCIAL' | 'AGERATING18' | 'AGERATING12' | 'STARTDATE' | 'ENDDATE' | 'UNKNOWN'

BroadcastInformation

Represents broadcast information.

Type:
  • object
Properties
NameTypeDescription
hintTextstring

The hint text associated with the broadcast.

urlstring

The URL associated with the broadcast.

startDatestring

The start date and time of the broadcast in ISO 8601 format.

endDatestring

The end date and time of the broadcast in ISO 8601 format.

Channel

Represents a channel.

Type:
  • object
Properties
NameTypeDescription
idstring

Unique identifier for the channel.

vendorVendorType

Vendor of the channel.

titlestring

Title of the channel.

leadstring

Lead description of the channel.

descriptionstring

Detailed description of the channel.

imageUrlstring

URL of the image associated with the channel.

imageUrlRawstring

Raw URL of the image associated with the channel.

imageTitlestring

Title of the image associated with the channel.

imageCopyrightstring

Copyright information for the channel image.

transmissionTransmissionType

Type of transmission for the channel.

timeTableUrlstring

URL for the channel's timetable.

presenterPresenter

Information about the presenter associated with the channel.

nowProgram

Information about the currently airing program on the channel.

nextProgram

Information about the next scheduled program on the channel.

urnstring

URN (Uniform Resource Name) for the channel.

Chapter

Represents a chapter of media content.

Type:
  • object
Properties
NameTypeDescription
idstring

Unique identifier for the chapter.

mediaTypeAudioType

Type of media content (AUDIO or VIDEO).

vendorVendorType

Vendor associated with the chapter.

urnstring

URN (Uniform Resource Name) for the chapter.

titlestring

Title of the chapter.

leadstring

Lead information for the chapter.

descriptionstring

Description of the chapter.

mediaDescriptionstring

Media description of the chapter.

imageUrlstring

URL of the image associated with the chapter.

imageTitlestring

Title of the image associated with the chapter.

imageCopyrightstring

Copyright information for the image.

blockReasonBlockReason

Reason for blocking the chapter.

youthProtectionColor'YELLOW' | 'RED'

Youth protection color code.

type'EPISODE' | 'EXTRACT' | 'TRAILER' | 'CLIP' | 'LIVESTREAM' | 'SCHEDULED_LIVESTREAM'

Type of the chapter.

datestring

Date and time information for the chapter.

durationnumber

Duration of the chapter in seconds.

podcastSdUrlstring

URL for the standard-definition podcast.

podcastHdUrlstring

URL for the high-definition podcast.

validFromstring

Validity start date and time for the chapter.

validTostring

Validity end date and time for the chapter.

assignedBy'EDITOR' | 'TRENDING' | 'RECOMMENDATION'

User who assigned the chapter.

playableAbroadboolean

Indicates if the chapter is playable abroad.

relatedContentListArray.<RelatedContent>

List of related content for the chapter.

socialCountListArray.<SocialCountEntry>

List of social media counts for the chapter.

displayableboolean

Indicates if the chapter is displayable.

fullLengthUrnstring

URN for the full-length version of the chapter.

positionnumber

Position of the chapter.

noEmbedboolean

Indicates if the chapter can be embedded.

subtitleListArray.<Subtitle>

List of subtitles for the chapter.

analyticsDataobject

Analytics data for the chapter.

Properties
NameTypeDescription
x:string

string

analyticsMetadataobject

Metadata for analytics associated with the chapter.

Properties
NameTypeDescription
x:string

string

eventDatastring

Event data associated with the chapter.

playerPropertiesArray.<PlayerProperty>

List of player properties for the chapter.

tagListArray.<string>

List of tags associated with the chapter.

labelstring

Label information for the chapter.

fullLengthMarkInnumber

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

fullLengthMarkOutnumber

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

resourceListArray.<Resource>

List of resources associated with the chapter.

segmentListArray.<Segment>

List of segments associated with the chapter.

preTrailerStartstring

Start time for the pre-trailer content.

postTrailerStopstring

Stop time for the post-trailer content.

cesimIdstring

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

hbbtvPropertiesArray.<HbbtvProperties>

List of HbbtvProperties for the chapter.

creatorNamestring

Name of the creator of the chapter.

creatorUserstring

User associated with the creator of the chapter.

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

Aspect ratio of the chapter.

dvrReferenceDatestring

DVR reference date and time for the chapter.

timeIntervalListArray.<TimeInterval>

List of time intervals associated with the chapter.

spriteSheetSpriteSheet

Sprite sheet information for the chapter.

ComposedSrcMediaData

Represents the result of composing source media data.

Type:
  • object
Properties
NameTypeDescription
srcstring

The URL of the source media.

typestring

The MIME type of the source media.

keySystemsKeySystems

A mapping of DRM types to their corresponding key systems information.

disableTrackersboolean

Indicates whether trackers are disabled for the source media.

mediaDataMainResource

The merged media data from the source and additional media data.

Credit

Represents credit information.

Type:
  • object
Properties
NameTypeDescription
realNamestring

The real name associated with the credit.

rolestring

The role of the individual associated with the credit.

namestring

The name associated with the credit.

DrmMetadata

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

Type:
  • object
Properties
NameTypeDescription
type'FAIRPLAY' | 'WIDEVINE' | 'PLAYREADY'

Type of DRM used for the resource.

licenseUrlstring

URL for the DRM license.

certificateUrlstring

URL for the DRM certificate.

Episode

Represents an episode of media content.

Type:
  • object
Properties
NameTypeDescription
idstring

Unique identifier for the episode.

titlestring

Title of the episode.

leadstring

Lead description of the episode.

descriptionstring

Detailed description of the episode.

publishedDatestring

Date and time when the episode was published.

imageUrlstring

URL of the image associated with the episode.

imageTitlestring

Title of the image associated with the episode.

imageCopyrightstring

Copyright information for the episode image.

fullLengthUrnstring

URN (Uniform Resource Name) for the full-length version of the episode.

seasonNumbernumber

Season number to which the episode belongs.

numbernumber

Episode number.

socialCountSocialCountEntry

Social count entry for the episode.

HbbtvProperties

Represents HbbTV properties associated with a chapter.

Type:
  • object
Properties
NameTypeDescription
redButtonboolean

Indicates the availability of the red button feature.

imageLinkstring

URL link associated with the image for HbbTV.

Headline

Represents headline information.

Type:
  • object
Properties
NameTypeDescription
titlestring

The title of the headline.

descriptionstring

The description of the headline.

Language

Represents a language.

Type:
  • object
Properties
NameTypeDescription
localestring

The locale of the language.

languagestring

The language code.

Represents a link.

Type:
  • object
Properties
NameTypeDescription
titlestring

The title of the link.

linkstring

The URL link.

MainResource

Type:

PlayerProperty

Represents a player property associated with a media segment.

Type:
  • object
Properties
NameTypeDescription
key'iFrameUrl' | 'playerUrl' | 'playerRelativeIconImageUrl' | 'playerWidth' | 'playerHeight'

Key identifying the type of player property.

valuestring

Value of the player property.

PresentationType

Presentation format

Type:
  • 'DEFAULT' | 'VIDEO_360'

Presenter

Represents a presenter.

Type:
  • object
Properties
NameTypeDescription
namestring

The name of the presenter.

urlstring

The URL associated with the presenter.

imageUrlstring

The URL of the image associated with the presenter.

imageTitlestring

The title of the image associated with the presenter.

imageCopyrightstring

The copyright information of the image associated with the presenter.

Program

Represents a program.

Type:
  • object
Properties
NameTypeDescription
titlestring

The title of the program.

startTimestring

The start time of the program in ISO 8601 format.

endTimestring

The end time of the program in ISO 8601 format.

leadstring

The lead information of the program.

descriptionstring

The description of the program.

imageUrlstring

The URL of the image associated with the program.

imageIsFallbackUrlboolean

Indicates whether the image is a fallback URL.

imageTitlestring

The title of the image associated with the program.

imageCopyrightstring

The copyright information of the image associated with the program.

urlstring

The URL associated with the program.

showShow

The show associated with the program.

programTitlestring

The title of the program.

programUrlstring

The URL associated with the program.

episodeTitlestring

The title of the episode.

episodeUrlstring

The URL associated with the episode.

episodeImageTitlestring

The title of the image associated with the episode.

episodeImageUrlstring

The URL of the image associated with the episode.

mediaUrnstring

The URN (Uniform Resource Name) associated with the media.

genrestring

The genre of the program.

seasonNumbernumber

The season number of the program.

episodeNumbernumber

The episode number of the program.

episodesTotalnumber

The total number of episodes.

productionYearnumber

The production year of the program.

productionCountrystring

The production country of the program.

youthProtectionColorstring

The color code for youth protection.

subtitlestring

The subtitle information of the program.

blockTitlestring

The title of the block associated with the program.

originalTitlestring

The original title of the program.

creditListArray.<Credit>

The list of credits associated with the program.

subProgramListArray.<Program>

The list of sub-programs associated with the program.

subtitlesAvailableboolean

Indicates whether subtitles are available.

isLiveboolean

Indicates whether the program is live.

hasTwoLanguagesboolean

Indicates whether the program has two languages.

hasSignLanguageboolean

Indicates whether the program has sign language.

hasVisualDescriptionboolean

Indicates whether the program has visual description.

isFollowUpboolean

Indicates whether the program is a follow-up.

isDolbyDigitalboolean

Indicates whether the program is in Dolby Digital.

isRepetitionboolean

Indicates whether the program is a repetition.

repetitionDescriptionstring

The description of the repetition.

broadcastInfostring

The broadcast information associated with the program.

channelTitlestring

The title of the channel associated with the program.

channelUrnstring

The URN (Uniform Resource Name) associated with the channel.

headlineListArray.<Headline>

The list of headlines associated with the program.

QualityType

Content quality

Type:
  • 'SD' | 'HD' | 'HQ'

RelatedContent

Represents related content associated with a media segment.

Type:
  • object
Properties
NameTypeDescription
idstring

Unique identifier for the related content.

titlestring

Title of the related content. Limited to 2000 characters.

leadstring

Lead information for the related content.

descriptionstring

Description of the related content.

urlstring

URL of the related content.

contentTypestring

Type of content.

isExternalboolean

Indicates if the related content is external.

Resource

Represents a resource associated with a media segment.

Type:
  • object
Properties
NameTypeDescription
urlstring

URL of the resource.

drmListArray.<DrmMetadata>

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

qualityQualityType

Quality of the resource.

protocol'HLS' | 'HLS-DVR' | 'HDS' | 'HDS-DVR' | 'RTMP' | 'HTTP' | 'HTTPS' | 'HTTP-M3U' | 'HTTP-MP3-STREAM' | 'DASH' | 'DASH-DVR'

Protocol used for streaming the resource.

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

Encoding used for the resource.

mimeTypestring

MIME type of the resource.

presentationPresentationType

Presentation mode of the resource.

streamingStreamingType

Streaming type of the resource.

dvrboolean

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

liveboolean

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.

tokenTypeTokenType

Token type used for the resource.

audioTrackListArray.<AudioTrack>

List of audio tracks associated with the resource.

subtitleInformationListArray.<SubtitleInformation>

List of subtitle information associated with the resource.

analyticsDataobject

Analytics data for the resource.

Properties
NameTypeDescription
x:string

string

analyticsMetadataobject

Metadata for analytics purposes.

Properties
NameTypeDescription
x:string

string

streamOffsetnumber

Stream offset for the resource.

ScheduledBroadcast

Represents a scheduled broadcast.

Type:
  • object
Properties
NameTypeDescription
titlestring

The title of the scheduled broadcast.

startTimestring

The start time of the scheduled broadcast in ISO 8601 format.

endTimestring

The end time of the scheduled broadcast in ISO 8601 format.

channelTitlestring

The title of the channel associated with the scheduled broadcast.

channelUrnstring

The URN (Uniform Resource Name) associated with the channel.

Segment

Represents a media segment with detailed metadata.

Type:
  • object
Properties
NameTypeDescription
idstring

Unique identifier for the segment.

mediaTypeAudioType

Type of media.

vendorVendorType

Vendor of the segment.

urnstring

URN (Uniform Resource Name) specifying the segment details.

titlestring

Title of the segment. Limited to 2000 characters.

leadstring

Lead information for the segment.

descriptionstring

Description of the segment.

mediaDescriptionstring

Media description for the segment.

imageUrlstring

URL of the image associated with the segment.

imageTitlestring

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

imageCopyrightstring

Copyright information for the image.

blockReasonBlockReason

Reason for blocking.

youthProtectionColor'YELLOW' | 'RED'

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

type'EPISODE' | 'EXTRACT' | 'TRAILER' | 'CLIP' | 'LIVESTREAM' | 'SCHEDULED_LIVESTREAM'

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

datestring

Date and time information in ISO8601 format.

durationnumber

Duration of the segment in seconds.

podcastSdUrlstring

URL for the standard definition podcast.

podcastHdUrlstring

URL for the high definition podcast.

validFromstring

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

validTostring

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'.

playableAbroadboolean

Indicates if the segment is playable abroad.

relatedContentListArray.<RelatedContent>

List of related content items.

socialCountListArray.<SocialCountEntry>

List of social count entries.

displayableboolean

Indicates if the segment is displayable.

fullLengthUrnstring

Full-length URN specifying the segment details.

positionnumber

Position of the segment.

noEmbedboolean

Indicates if the segment should not be embedded.

subtitleListArray.<Subtitle>

List of subtitle entries.

analyticsDataobject

Analytics data for the segment.

Properties
NameTypeDescription
x:string

string

analyticsMetadataobject

Metadata for analytics purposes.

Properties
NameTypeDescription
x:string

string

eventDatastring

Event data associated with the segment.

playerPropertiesArray.<PlayerProperty>

List of player properties.

tagListArray.<string>

List of tags associated with the segment.

labelstring

Label for the segment.

markInnumber

Integer representing the mark in time.

markOutnumber

Integer representing the mark out time.

Show

Represents a show.

Type:
  • object
Properties
NameTypeDescription
idstring

Unique identifier for the show.

vendorVendorType

Vendor of the show.

transmissionTransmissionType

Type of transmission for the show.

urnstring

URN (Uniform Resource Name) for the show.

titlestring

Title of the show.

leadstring

Lead description of the show.

descriptionstring

Detailed description of the show.

imageUrlstring

URL of the image associated with the show.

imageTitlestring

Title of the image associated with the show.

imageCopyrightstring

Copyright information for the show image.

bannerImageUrlstring

URL of the banner image for the show.

posterImageUrlstring

URL of the poster image for the show.

posterImageIsFallbackUrlboolean

Indicates if the poster image is a fallback URL.

podcastImageUrlstring

URL of the podcast image for the show.

podcastImageIsFallbackUrlboolean

Indicates if the podcast image is a fallback URL.

homepageUrlstring

URL of the show's homepage.

podcastSubscriptionUrlstring

URL for podcast subscription.

podcastFeedSdUrlstring

URL for podcast feed (SD).

podcastFeedHdUrlstring

URL for podcast feed (HD).

podcastDeezerUrlstring

URL for podcast on Deezer.

podcastSpotifyUrlstring

URL for podcast on Spotify.

timeTableUrlstring

URL for the show's timetable.

linksArray.<Link>

List of links associated with the show.

primaryChannelIdstring

ID of the primary channel for the show.

viewedMediasnumber

Number of times the show has been viewed.

numberOfEpisodesnumber

Number of episodes available for the show.

availableAudioLanguageListArray.<Language>

List of available audio languages for the show.

availableSubtitleLanguageListArray.<Language>

List of available subtitle languages for the show.

availableVideoQualityListArray.<QualityType>

List of available video quality options for the show.

audioDescriptionAvailableboolean

Indicates if audio description is available for the show.

subtitlesAvailableboolean

Indicates if subtitles are available for the show.

multiAudioLanguagesAvailableboolean

Indicates if multiple audio languages are available for the show.

topicListArray.<Topic>

List of topics associated with the show.

broadcastInformationBroadcastInformation

Information about the show's broadcast.

allowIndexingboolean

Indicates if the show is allowed to be indexed.

nextScheduledBroadcastScheduledBroadcast

Information about the next scheduled broadcast for the show.

nextScheduledBroadcastListArray.<Program>

List of programs for the next scheduled broadcasts.

primaryChannelUrnstring

URN of the primary channel for the show.

SocialCountEntry

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

Type:
  • object
Properties
NameTypeDescription
key'srgView' | 'srgLike' | 'fbShare' | 'googleShare' | 'twitterShare' | 'whatsAppShare'

Key identifying the type of social media count.

valuenumber

Count value for the social media entry.

SpriteSheet

Represents a sprite sheet associated with a chapter.

Type:
  • object
Properties
NameTypeDescription
urnstring

URN (Uniform Resource Name) for the sprite sheet.

rowsnumber

Number of rows in the sprite sheet.

columnsnumber

Number of columns in the sprite sheet.

thumbnailHeightnumber

Height of each thumbnail in the sprite sheet.

thumbnailWidthnumber

Width of each thumbnail in the sprite sheet.

intervalnumber

Interval between frames in milliseconds.

urlstring

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.
Type:
  • object
Properties
NameTypeDescription
dataProviderundefined | function

A function returning an object representing a mediaComposition.

dataProviderHostundefined | string

A specific host for a different IL environment.

dataProviderUrlHandlerundefined | function

A function for handling a custom data source.

tagCommanderScriptURLundefined | string

The URL of the TagCommander script.

StreamingType

Enumerates various streaming methods

Type:
  • 'PROGRESSIVE' | 'M3UPLAYLIST' | 'HLS' | 'HDS' | 'RTMP' | 'DASH' | 'UNKNOWN'

SubTopic

Represents a subtopic.

Type:
  • object
Properties
NameTypeDescription
idstring

The unique identifier for the subtopic.

vendorVendorType

The vendor of the subtopic.

transmissionTransmissionType

The transmission type of the subtopic.

urnstring

The URN of the subtopic.

titlestring

The title of the subtopic.

leadstring

The lead information for the subtopic.

descriptionstring

The description of the subtopic.

viewedMediasnumber

The number of viewed medias for the subtopic.

imageUrlstring

The URL of the image associated with the subtopic.

imageTitlestring

The title of the image associated with the subtopic.

imageCopyrightstring

The copyright information of the image associated with the subtopic.

Subtitle

Represents subtitle information for a media segment.

Type:
  • object
Properties
NameTypeDescription
localestring

Locale information for the subtitle.

languagestring

Language of the subtitle.

source'EXTERNAL' | TrackSourceType

Source of the subtitle.

type'SDH'

Type of the subtitle.

urlstring

URL of the subtitle.

format'TTML' | 'VTT'

Format of the subtitle.

SubtitleInformation

Represents subtitle information associated with a media resource.

Type:
  • object
Properties
NameTypeDescription
localestring

Locale information for the subtitle.

languagestring

Language of the subtitle.

source'EXTERNAL' | TrackSourceType

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.

Type:
  • object
Properties
NameTypeDescription
type'OPENING_CREDITS' | 'CLOSING_CREDITS'

The type of the time interval.

markInnumber

An integer representing the mark in time.

markOutnumber

An integer representing the mark out time.

TokenType

Represents different token types for authentication

Type:
  • 'AKAMAI' | 'NONE'

Topic

Represents a topic.

Type:
  • object
Properties
NameTypeDescription
idstring

Unique identifier for the topic.

vendorVendorType

Vendor of the topic.

transmissionTransmissionType

Type of transmission for the topic.

urnstring

URN (Uniform Resource Name) for the topic.

titlestring

Title of the topic.

leadstring

Lead description of the topic.

descriptionstring

Detailed description of the topic.

viewedMediasnumber

Number of viewed medias related to the topic.

imageUrlstring

URL of the image associated with the topic.

imageTitlestring

Title of the image associated with the topic.

imageCopyrightstring

Copyright information for the topic image.

subTopicListArray.<SubTopic>

List of subtopics associated with the main topic.

TrackSelector

The track to select

Type:
  • object
Properties
NameTypeDescription
languagestring

The track language

kindstring

The track kind

TrackSourceType

Source type for audio/video tracks

Type:
  • 'HLS' | 'HDS' | 'DASH'

TransmissionType

Medium of transmission

Type:
  • 'TV' | 'RADIO' | 'ONLINE'

VendorType

Broadcasting organizations

Type:
  • 'SRF' | 'RTR' | 'RTS' | 'RSI' | 'SWI' | 'SSATR'