Packagecom.brightcove.api.dtos
Classpublic class MediaDTO
InheritanceMediaDTO Inheritance Object
Subclasses AudioTrackDTO, VideoDTO

Represents a media in the player. See VideoDTO for the most-common subclass.



Public Properties
 PropertyDefined By
  adKeys : String
Key/value pairs appended to any ad requests during media's playback.
MediaDTO
  allowViralSyndication : Boolean
Whether the media is allowed to be virally distributed to other sites.
MediaDTO
  customFields : Object
Publisher-defined fields for media.
MediaDTO
  displayName : String
Name of media item in the player.
MediaDTO
  economics : Number
Flag indicating if ads are permitted for this media item.
MediaDTO
  endDate : BrightcoveDateDTO
The date media item is set to expire.
MediaDTO
  forceAds : Boolean
Whether ads will always be requested for the media item, despite ad policy.
MediaDTO
  id : Number
Unique Brightcove ID for the media item.
MediaDTO
  length : Number
The duration on the media item.
MediaDTO
  lineupId : Number
The ID of the media collection in the player containing the media, if any.
MediaDTO
  linkText : String
The text for a related link for the media item.
MediaDTO
  linkURL : String
The URL for a related link for the media item.
MediaDTO
  longDescription : String
Longer text description of the media item.
MediaDTO
  publisherId : Number
The ID of the publisher to which the media item belongs.
MediaDTO
  referenceId : String
Publisher-defined ID for the media item.
MediaDTO
  sharedBy : Number
The publisher ID of the publisher who shared this media.
MediaDTO
  shortDescription : String
Short text description of the media item.
MediaDTO
  startDate : BrightcoveDateDTO
The date the media item was set to go live.
MediaDTO
  tags : Array
Publisher-defined lists of key/value tags for the media item, returned as array of strings.
MediaDTO
  thumbnailURL : String
URL of the thumbnail image for the media item.
MediaDTO
Public Methods
 MethodDefined By
  
MediaDTO(media:Object)
Constructor.
MediaDTO
Property Detail
adKeysproperty
public var adKeys:String

Key/value pairs appended to any ad requests during media's playback.

allowViralSyndicationproperty 
public var allowViralSyndication:Boolean

Whether the media is allowed to be virally distributed to other sites.

customFieldsproperty 
public var customFields:Object

Publisher-defined fields for media.

displayNameproperty 
public var displayName:String

Name of media item in the player.

economicsproperty 
public var economics:Number

Flag indicating if ads are permitted for this media item. 1 = Ads Allowed, 0 = Ads Forbidden

endDateproperty 
public var endDate:BrightcoveDateDTO

The date media item is set to expire.

forceAdsproperty 
public var forceAds:Boolean

Whether ads will always be requested for the media item, despite ad policy.

idproperty 
public var id:Number

Unique Brightcove ID for the media item.

lengthproperty 
public var length:Number

The duration on the media item.

lineupIdproperty 
public var lineupId:Number

The ID of the media collection in the player containing the media, if any.

linkTextproperty 
public var linkText:String

The text for a related link for the media item.

linkURLproperty 
public var linkURL:String

The URL for a related link for the media item.

longDescriptionproperty 
public var longDescription:String

Longer text description of the media item.

publisherIdproperty 
public var publisherId:Number

The ID of the publisher to which the media item belongs.

referenceIdproperty 
public var referenceId:String

Publisher-defined ID for the media item.

sharedByproperty 
public var sharedBy:Number

The publisher ID of the publisher who shared this media. If the value is NaN, then this is not media shared from another publisher.

shortDescriptionproperty 
public var shortDescription:String

Short text description of the media item.

startDateproperty 
public var startDate:BrightcoveDateDTO

The date the media item was set to go live.

tagsproperty 
public var tags:Array

Publisher-defined lists of key/value tags for the media item, returned as array of strings.

thumbnailURLproperty 
public var thumbnailURL:String

URL of the thumbnail image for the media item.

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

Constructor.

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