Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Media

Response indicating a set of media to be played.

Represents one media object. Contains information about the media, such as name, description, url, etc.

Hierarchy

Implemented by

Properties

Optional firstMediaObjectIndex

firstMediaObjectIndex: number

0-based index of the first Media Object in media_objects to play. If unspecified, zero or out-of-bounds, playback starts at the first media object in media_objects.

Optional mediaObjects

mediaObjects: MediaObject[]

List of Media Objects

Optional mediaType

Optional optionalMediaControls

optionalMediaControls: OptionalMediaControl[]

Optional media control types this media response session can support. If set, request will be made to 3p when a certain media event happens. If not set, 3p must still handle two default control type, FINISHED and FAILED.

Optional repeatMode

repeatMode: All | Off | RepeatModeUnspecified

Repeat mode for the list of Media Objects.

Optional startOffset

startOffset: string

Start offset of the first media object.

Generated using TypeDoc