Media cards

vod

epg

recording

series

tvshow

movie

episode

movie

episode

movie

id

The ID of the content

For live (epg), this is the same as the eventId.

For vod, this is the same as the contentId.

✅

✅

✅

✅

✅

✅

✅

contentLinkId

contentLinkId provides the link between an event and the editorial content that it corresponds to.

When an editorial content is created from an event (for catch-up or recording), this value is copied to the editorial content’s contentLinkId field.

For deep linking, this specifies the ID of the same editorial content from a different content provider.

If this field has a value, and if other playout variants are available for the same content, these will be available in linkedContent (see below).

This is only relevant in deployments that use the one-to-one event/editorial content model (the default for new deployments)

See Selecting an event-to-editorial-content mapping model.

✅

✅

✅

✅

type

The content type – one of programme, catchup, vod, series, recording

✅

✅

✅

✅

✅

✅

✅

Title

The title of the content

✅

✅

✅

✅

✅

✅

✅

Description

The content description

✅

✅

✅

✅

✅

✅

✅

image

A link to the media card image

broadcast

The broadcast start and end times (epoch time) and the duration (in minutes)

✅

✅

✅

✅

Actors

The actors

✅

✅

✅

✅

✅

✅

Categories

The categories that the content belongs to

✅

✅

✅

✅

✅

✅

Ratings

The parental rating(s) for the content. There can be multiple ratings, one per rating body.

✅

✅

✅

✅

✅

✅

✅

eventId

The ID of the broadcast event

✅

✅

✅

✅

contentId

The content ID

✅

✅

✅

✅

✅

✅

isStartOver

Whether start-over is enabled for the content/event

✅

✅

✅

✅

isCatchUp

Whether catch-up is enabled for the content/event

✅

✅

✅

✅

isLTCU

Whether long-term catch-up (LTCU) is enabled for the content/event

✅

✅

✅

✅

✅

✅

isSTCU

Whether short-term catch-up (STCU) is enabled for the content/event

✅

✅

✅

✅

✅

✅

isNPVR

Whether NPVR (recording) is enabled for the content/event

✅

✅

✅

✅

channel

Details of the channel on which the event is broadcast

✅

✅

✅

✅

products

Details of the product(s) that the content belongs to.

This allows you to display the different ways that the user can purchase the content.

✅

✅

✅

✅

✅

✅

episodeNumber

The episode number within the season

✅

✅

✅

Episode

The episode name

Year

The year of release

✅

✅

✅

✅

period

The validity period of the account’s entitlement to consume the content

✅

✅

SeasonNumber

For episodes, the number of the season that the episode belongs to

✅

✅

(null)

✅

✅

(null)

✅

✅

(null)

duration

The duration of the content in minutes

✅

✅

contentType

The content type – one of movie, trailer, tvshow, episode, sports, match, race, highlight, music, podcast, news, link, SHORT_FORM, or unknown

✅

✅

✅

✅

✅

✅

media

Links to the playback manifests

✅

✅

✅

✅

✅

✅

series

Information about the available seasons and episodes for the series that the episode belongs to.

✅

✅

✅

(null)

✅

✅

(null)

✅

sportingEvent

If the event is a sporting event, details of the event (tournament, match time period, details of home and away teams, round, status, and so on

✅

✅

✅

✅

csaiAdCueTimes

The time slots when ads are to be inserted into the content (if any)

✅

✅

✅

✅

✅

✅

links

Deep links, that is, links to content from other providers (e.g., Disney+ or Netflix)

✅

✅

✅

✅

✅

✅

Audio

Language(s) in which audio tracks are available

✅

✅

✅

✅

✅

✅

AudioMode

The audio mode

✅

✅

✅

✅

Subtitles

Language(s) in which subtitles are available

✅

✅

✅

✅

✅

✅

cast

Information about cast and crew members.

This is an array that includes some of all of the following:

• The id of the person. This can be used in a call to ImageService to get an image of the person.

• One or more roles for the person (e.g., actor and executive producer)

• images for the person
  These may or may not be available, and even if they are available, they may not be a suitable size. So you are recommended to request images from ImageService instead.

• externalIds – the ID(s) of the person in external provider systems (e.g., Gracenote)

• The role type (cast or persona)

• The person's name

• The person’s bio

• The person’s dateOfBirth

• For each role, one or more of the following:

  • An id

  • The role name (e.g. Actor, Narrator, or the name of the character)

  • The billingOrder

  • images
    Again, you are recommended to request images from ImageService.

✅

✅

✅

✅

✅

✅

linkedContent

If contentLinkId (see above) has a value, and if other playout variants are available for the same content, these will be available here.

✅

✅

✅

✅

guardTimeStart

Buffer added to the start of the recording (in seconds)

guardTimeEnd

Buffer added to the end of the recording (in seconds)

favourite

If the content has been favourited by the user, details of the favourite

bookmark

If the content has been bookmarked by the user (that is, the user started watching the content, but stopped part way through), details of the bookmark

recordings

Any recording the user has made of this content

recommendations

Any recommendations associated with this content