Package | com.brightcove.api.dtos |
Class | public class MediaDTO |
Inheritance | MediaDTO ![]() |
Subclasses | AudioTrackDTO, VideoDTO |
Property | Defined 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 |
Method | Defined By | ||
---|---|---|---|
MediaDTO(media:Object)
Constructor. | MediaDTO |
adKeys | property |
public var adKeys:String
Key/value pairs appended to any ad requests during media's playback.
allowViralSyndication | property |
public var allowViralSyndication:Boolean
Whether the media is allowed to be virally distributed to other sites.
customFields | property |
public var customFields:Object
Publisher-defined fields for media.
displayName | property |
public var displayName:String
Name of media item in the player.
economics | property |
public var economics:Number
Flag indicating if ads are permitted for this media item. 1 = Ads Allowed, 0 = Ads Forbidden
endDate | property |
public var endDate:BrightcoveDateDTO
The date media item is set to expire.
forceAds | property |
public var forceAds:Boolean
Whether ads will always be requested for the media item, despite ad policy.
id | property |
public var id:Number
Unique Brightcove ID for the media item.
length | property |
public var length:Number
The duration on the media item.
lineupId | property |
public var lineupId:Number
The ID of the media collection in the player containing the media, if any.
linkText | property |
public var linkText:String
The text for a related link for the media item.
linkURL | property |
public var linkURL:String
The URL for a related link for the media item.
longDescription | property |
public var longDescription:String
Longer text description of the media item.
publisherId | property |
public var publisherId:Number
The ID of the publisher to which the media item belongs.
referenceId | property |
public var referenceId:String
Publisher-defined ID for the media item.
sharedBy | property |
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.
shortDescription | property |
public var shortDescription:String
Short text description of the media item.
startDate | property |
public var startDate:BrightcoveDateDTO
The date the media item was set to go live.
tags | property |
public var tags:Array
Publisher-defined lists of key/value tags for the media item, returned as array of strings.
thumbnailURL | property |
public var thumbnailURL:String
URL of the thumbnail image for the media item.
MediaDTO | () | Constructor |
public function MediaDTO(media:Object)
Constructor.
Parametersmedia:Object — Media DTO from the player to wrap with this class.
|