Contents

Content

A description of a piece of playback content, such as a song, podcast, or advertisement.

Declaration

object Content

Properties

NameTypeDescription
attributesContentAttributes

The content’s metadata.

controlstring

The set of controls the user may access while the client is playing this content. Define controls in the QueueControlMapping object.

identifier RequiredContentIdentifier

A stable identifier for this content. Content identifiers must be unique within a Queue. Minimum length: 1. Maximum Length: 1000.

isLiveboolean

true for a live stream, false for prerecorded content.

playIndexuint64

This content’s position within the playback queue.

urlstring

A URL to request the audio or video data.

Discussion

If you provide a playIndex for any content, you must provide a playIndex for each Content object in the Queue. These indices must have a strong ordering. If your Queue also provides a contentItemsCount, the client may use these values to display or announce playback progress to the user. For example, if a queue’s contentItemsCount is 7 and the playIndex for the current content is 3, the client might present the playback progress as 3 of 7.

See Also

Providing Queue Items