Class: BrowseItem

  • BrowseItem objects represent individual items within a media browse list displayed on the Cast receiver.

  • Each BrowseItem requires either a title or subtitle and can optionally include an image, entity information, and duration.

  • Images associated with BrowseItems should ideally match the aspect ratio specified by BrowseContent#targetAspectRatio for optimal display.

  • Placeholder images can be customized using the imageType property when an image is unavailable for a browse item.

  • Additional badges can be displayed over the browse item image using the mediaBadge property.

cast.framework.ui.BrowseItem

class   static

Content for the individual browse item in the media browse list.

Constructor

BrowseItem

new BrowseItem(entity, title, subtitle, image)

Parameter

entity

string

Content entity information.

title

Optional

string

Main text of the browse item.

subtitle

Optional

string

Secondary text of the element. Both title and subtitle can be provided, but at least one of them is required.

image

Optional

cast.framework.messages.Image

Image displayed for browse item.

Value must not be null.

Properties

duration

(number or undefined)

Content duration in seconds. If provided, duration indicator will be displayed over media browse item image. For example, if duration = 150, label will be 2:30. If duration is 0, no label will be displayed.

entity

string

Content entity information.

image

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

Image displayed for browse item. It's highly recommended to have image aspect ratio matching BrowseContent#targetAspectRatio value. If image is too narrow/tall, it will be pillarboxed. If image is too wide/short, it will be letterboxed.

imageType

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

Type of placeholder that will be used if image is not available for the browse item.

mediaBadge

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

Additional badge to be displayed over the browse item image.

subtitle

(string or undefined)

Secondary text of the element. Both title and subtitle can be provided, but at least one of them is required.

title

(string or undefined)

Main text of the browse item.