Class: ContainerMetadata

  • ContainerMetadata is a class within the cast framework that stores common metadata for media containers like audiobooks or TV channels.

  • It includes properties like containerType, title, containerImages, containerDuration, and sections to describe the container's content.

  • containerType specifies the type of container (e.g., AUDIOBOOK, TV_SERIES), while sections can be used to define segments within the container, like chapters in an audiobook.

  • Developers can use ContainerMetadata to provide detailed information about media containers to the Cast platform.

cast.framework.messages.ContainerMetadata

class   static

Common container metadata used as part of QueueData.

Constructor

ContainerMetadata

new ContainerMetadata(type)

Parameter

type

Optional

cast.framework.messages.ContainerType

Type of container object.

Value must not be null.

Properties

containerDuration

(number or undefined)

Container duration in seconds, for example an audiobook playback time.

containerImages

(non-null Array of non-null cast.framework.messages.Image or undefined)

Container images, such as a live TV channel logo, audiobook cover, or album cover art.

containerType

non-null cast.framework.messages.ContainerType

The type of container object.

sections

(non-null Array of non-null cast.framework.messages.MediaMetadata or undefined)

An array of media metadata objects that lists the sections of a media item. Sections are used to divide live TV streams into programs and audiobooks into chapters.

title

(string or undefined)

The title of the container, such as an audiobook title, or a TV channel name.