Packagecom.brightcove.api.dtos
Classpublic class MediaCollectionDTO
InheritanceMediaCollectionDTO Inheritance Object
Subclasses AudioTrackPlaylistDTO, PlaylistDTO

Represents a media collection in the player. See ContentModule for getting media collections.



Public Properties
 PropertyDefined By
  displayName : String
Name of playlist displayed in player.
MediaCollectionDTO
  id : Number
Unique Brightcove ID for playlist.
MediaCollectionDTO
  mediaCount : Number
The total number of media items in the playlist.
MediaCollectionDTO
  mediaIds : Array
Array of media IDs, representing each media item in the playlist.
MediaCollectionDTO
  referenceId : String
Publisher-defined ID for playlist.
MediaCollectionDTO
  shortDescription : String
Descriptive text for playlist.
MediaCollectionDTO
  thumbnailURL : String
URL to thumbnail asset for playlist.
MediaCollectionDTO
Public Methods
 MethodDefined By
  
MediaCollectionDTO(media:Object)
Constructor.
MediaCollectionDTO
Property Detail
displayNameproperty
public var displayName:String

Name of playlist displayed in player.

idproperty 
public var id:Number

Unique Brightcove ID for playlist.

mediaCountproperty 
public var mediaCount:Number

The total number of media items in the playlist.

mediaIdsproperty 
public var mediaIds:Array

Array of media IDs, representing each media item in the playlist. See ContentModule for getting the MediaDTO or VideoDTO objects from the IDs.

referenceIdproperty 
public var referenceId:String

Publisher-defined ID for playlist.

shortDescriptionproperty 
public var shortDescription:String

Descriptive text for playlist.

thumbnailURLproperty 
public var thumbnailURL:String

URL to thumbnail asset for playlist.

Constructor Detail
MediaCollectionDTO()Constructor
public function MediaCollectionDTO(media:Object)

Constructor.

Parameters
media:Object — Media Collection DTO from the player to wrap with this class.