Interface: MediaItem

Properties

id

id: string

Unique identifier of the media item.

poster

poster: string

Poster image of the media item.

sources

sources: MediaSource[]

Sources of the media item.

title

title: string

Title of the media item.

ageRatingDetails?

optional ageRatingDetails: string[]

Additional details to show for the age rating (e.g. ['Alcohol']) next to the minimum age.

aspectRatio?

optional aspectRatio: string

Aspect ratio of the media item. Useful when vertical variants are used.

Default Value

16:9

category?

optional category: object

Category id and name of the media item

name

name: string

id?

optional id: string

channel?

optional channel: Channel

Channel of the media item.

contentOwner?

optional contentOwner: object

Content owner id and name of the media item

name

name: string

id?

optional id: string

description?

optional description: string

Description of the media item.

duration?

optional duration: number

Duration of the media item in seconds. Not defined when livestream.

endDate?

optional endDate: number

Time when the media item expires. Unix timestamp in milliseconds. Useful for JSON-LD generation.

error?

optional error: MediaItemError

Error information if the media item is not available upfront.

externalChannelName?

optional externalChannelName: string

An additional external channel name. Often the name the channel was imported from.

externalEpisodeId?

optional externalEpisodeId: string

An external episode identifier. Often the id the episode was imported from.

externalShowId?

optional externalShowId: string

An additional external show identifier. Often the id the show was imported from.

externalShowName?

optional externalShowName: string

An additional external show name. Often the name the show was imported from.

genre?

optional genre: string

Genre of the media item (e.g. Documentary)

hasProductPlacement?

optional hasProductPlacement: boolean

Whether the media item has product placements. Shows a product placement indicator in the UI.

iabCategories?

optional iabCategories: string[]

IAB categories (as iabCategoryTaxonomy) of the media item. Used for monetization.

iabCategoryTaxonomy?

optional iabCategoryTaxonomy: number

IAB category taxonomy used for iabCategories (see IAB spec for details )

Default Value

9 for IAB Tech Lab Content Taxonomy 3.1

isRecommendation?

optional isRecommendation: boolean

Mark this media item as a recommendation.

isWebExclusive?

optional isWebExclusive: boolean

Whether the media item is exclusive for the web.

keywords?

optional keywords: string[]

Keywords of the media item

labels?

optional labels: object[]

Additional labels for this media item.

id

id: string

name

name: string

language?

optional language: string

Language of the media item. 2-letter ISO language code.

Default Value

de (German)

livestream?

optional livestream: object

Livestream details

startTime

startTime: number

UTC start time of the livestream in milliseconds

endTime?

optional endTime: number

UTC end time of the livestream in milliseconds

markers?

optional markers: (Marker | CustomMarker)[]

Markers of the media item.

Default Value

[{ name: KnownMarkerName.PREROLL, type: MarkerType.TIME_IN_SECONDS, threshold: 0 }]

minimumAge?

optional minimumAge: number

Minimum age to watch the media item. Shows a minimum age indicator in the UI.

Default Value

0 (no minimum age)

regionsAllowed?

optional regionsAllowed: string[]

In which country can this media item be played (e.g. ['de', 'at'])? Useful for JSON-LD generation.

Default Value

['all'] (worldwide)

releaseDate?

optional releaseDate: number

Release date of the media item. Unix timestamp in milliseconds. Useful for JSON-LD generation.

seoContentUrl?

optional seoContentUrl: string

JSON-LD contentUrl that allows search engines to crawl the media source. You should only allow known crawlers (how to verify Googlebot & Crawler ) to access those media sources.

show?

optional show: object

Show id and name of the media item

name

name: string

id?

optional id: string

teaser?

optional teaser: object

Additional teaser options that improve the loading experience and enable additional integration variants.

firstFrame?

optional firstFrame: string

Image of the first frame of the media item. Used for initially showing the first frame of the media item.

firstFrameBlurHash?

optional firstFrameBlurHash: null | string

Blurhash  of the first frame of the media item. Used for coloring the background.

firstFrameBlurred?

optional firstFrameBlurred: string

Blurred version of the first frame of the media item. Used to show something early while loading.

posterBlurHash?

optional posterBlurHash: null | string

Blurhash  of the poster of the media item. Used for coloring the background.

posterBlurred?

optional posterBlurred: string

Blurred version of the poster of the media item. Used to show something early while loading.

video?

optional video: string

Teaser video URL which is used for previewing the media item for some integrations.