Class: BrowseContent

  • The BrowseContent class is used to provide content for the media browse carousel on both idle and related content screens.

  • A BrowseContent object is constructed with an array of BrowseItem objects (up to 30) and an optional title.

  • The items property holds the list of BrowseItem objects for the carousel.

  • The targetAspectRatio property defines the desired aspect ratio for images within the carousel, affecting how images are displayed if their aspect ratio doesn't match.

  • The title property provides a title for the list of browse items.

cast.framework.ui.BrowseContent

class   static

Content for the media browse carousel. This content should be used for both media browse UI on IDLE screen and related content screen during playback.

Constructor

BrowseContent

new BrowseContent(browseItems, title)

Parameter

browseItems

Array of non-null cast.framework.ui.BrowseItem

List of browse items. Maximum items count is 30. Excess items will be truncated.

Value must not be null.

title

Optional

string

Title of the list.

Properties

items

non-null Array of non-null cast.framework.ui.BrowseItem

List of browse items. Maximum items count is 30. Excess items will be truncated.

targetAspectRatio

(non-null cast.framework.ui.BrowseImageAspectRatio or undefined)

Aspect ratio of all images in the media browse carousel. It's highly recommended to have browse item image provided in BrowseContentItem#image matching targetAspectRatio value. If image is too narrow/tall, it will be pillarboxed. If image is too wide/short, it will be letterboxed.

title

(string or undefined)

Title of the list.