Optional image URL to be shown when video is loading.
queueItemId
(number or undefined)
The queue item that include this media section.
This is only relevant if used in container sections, and if there are
multiple media items for the container.
sectionDuration
(number or undefined)
The media section duration in seconds. This is only required if the
metadata describes a section of the media file that has a different
duration value.
sectionStartAbsoluteTime
(number or undefined)
Alternative way to provide the section start time for live media.
Provides the start time in UNIX Epoch time (seconds since the Unix
epoch).
sectionStartTimeInContainer
(number or undefined)
The media section start time offset within the container, in seconds.
If not provided, the framework assumes that it's the same as the offset
within the media.
sectionStartTimeInMedia
(number or undefined)
The media section start time within the media file, in seconds.
This can be negative if a section started in previous file.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003e\u003ccode\u003eMediaMetadata\u003c/code\u003e is a class used to describe common media information like title, artist, images, and more, within the Cast framework.\u003c/p\u003e\n"],["\u003cp\u003eIt can represent metadata for the entire media or for individual sections within a media file, like chapters or segments.\u003c/p\u003e\n"],["\u003cp\u003eYou can specify the type of metadata, poster image URL, section duration, start times, and queue item ID using its properties.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003emetadataType\u003c/code\u003e property is required and determines the kind of media being described (e.g., movie, TV show, music track).\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eMediaMetadata\u003c/code\u003e objects are used as part of \u003ccode\u003eMediaInformation\u003c/code\u003e or to define sections in container metadata.\u003c/p\u003e\n"]]],["The `MediaMetadata` class, part of the Cast framework, describes media and container sections. It's instantiated with a `MetadataType`. Key properties include `metadataType`, `posterUrl`, `queueItemId`, `sectionDuration`, `sectionStartAbsoluteTime` (for live media), `sectionStartTimeInContainer`, and `sectionStartTimeInMedia`. These properties define the type, loading image, related queue item, duration, and start times of media sections, including offsets within a container or the media file itself.\n"],null,["# Class: MediaMetadata\n\ncast.[framework](/cast/docs/reference/web_receiver/cast.framework).[messages](/cast/docs/reference/web_receiver/cast.framework.messages).MediaMetadata\n======================================================================================================================================================\n\nclass static\n\nCommon media metadata used as part of `MediaInformation` or to describe\na media section as part of the container metadata.\n\nConstructor\n-----------\n\n### MediaMetadata\n\nnew\nMediaMetadata(type)\n\n| #### Parameter ||\n|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| type | [cast.framework.messages.MetadataType](/cast/docs/reference/web_receiver/cast.framework.messages#.MetadataType) Type of metadata. Value must not be null. |\n\nProperties\n----------\n\n### metadataType\n\nnon-null [cast.framework.messages.MetadataType](/cast/docs/reference/web_receiver/cast.framework.messages#.MetadataType)\n\nThe type of metadata.\n\n### posterUrl\n\n(string or undefined)\n\nOptional image URL to be shown when video is loading.\n\n### queueItemId\n\n(number or undefined)\n\nThe queue item that include this media section.\nThis is only relevant if used in container sections, and if there are\nmultiple media items for the container.\n\n### sectionDuration\n\n(number or undefined)\n\nThe media section duration in seconds. This is only required if the\nmetadata describes a section of the media file that has a different\nduration value.\n\n### sectionStartAbsoluteTime\n\n(number or undefined)\n\nAlternative way to provide the section start time for live media.\nProvides the start time in UNIX Epoch time (seconds since the Unix\nepoch).\n\n### sectionStartTimeInContainer\n\n(number or undefined)\n\nThe media section start time offset within the container, in seconds.\nIf not provided, the framework assumes that it's the same as the offset\nwithin the media.\n\n### sectionStartTimeInMedia\n\n(number or undefined)\n\nThe media section start time within the media file, in seconds.\nThis can be negative if a section started in previous file."]]