Packagecom.brightcove.api.dtos
Classpublic class VideoDTO
InheritanceVideoDTO Inheritance MediaDTO Inheritance Object

Represents a video in the player. See the class that is extended, MediaDTO, for more properties that can be accessed. See VideoModule.getCurrentVideo() and ContentModule for getting this DTO.



Public Properties
 PropertyDefined By
 InheritedadKeys : String
Key/value pairs appended to any ad requests during media's playback.
MediaDTO
 InheritedallowViralSyndication : Boolean
Whether the media is allowed to be virally distributed to other sites.
MediaDTO
  captions : Array
The array of captions available for the video (if any)
VideoDTO
 InheritedcustomFields : Object
Publisher-defined fields for media.
MediaDTO
 InheriteddisplayName : String
Name of media item in the player.
MediaDTO
 Inheritedeconomics : Number
Flag indicating if ads are permitted for this media item.
MediaDTO
  encodingRate : Number
The rate at which the media was encoded, in average bits per second.
VideoDTO
 InheritedendDate : BrightcoveDateDTO
The date media item is set to expire.
MediaDTO
  FLVFullCodec : Number
The codec for the video.
VideoDTO
  FLVFullLengthStreamed : Boolean
Whether the video is a streaming video.
VideoDTO
  FLVFullLengthURL : String
The URL of the video asset.
VideoDTO
  FLVFullSize : Number
The size, in bytes, of the video.
VideoDTO
 InheritedforceAds : Boolean
Whether ads will always be requested for the media item, despite ad policy.
MediaDTO
 Inheritedid : Number
Unique Brightcove ID for the media item.
MediaDTO
 Inheritedlength : Number
The duration on the media item.
MediaDTO
 InheritedlineupId : Number
The ID of the media collection in the player containing the media, if any.
MediaDTO
 InheritedlinkText : String
The text for a related link for the media item.
MediaDTO
 InheritedlinkURL : String
The URL for a related link for the media item.
MediaDTO
 InheritedlongDescription : String
Longer text description of the media item.
MediaDTO
  publishedDate : Date
The date the video was last made active.
VideoDTO
 InheritedpublisherId : Number
The ID of the publisher to which the media item belongs.
MediaDTO
 InheritedreferenceId : String
Publisher-defined ID for the media item.
MediaDTO
  renditions : Array
The array of renditions available for the video.
VideoDTO
 InheritedsharedBy : Number
The publisher ID of the publisher who shared this media.
MediaDTO
 InheritedshortDescription : String
Short text description of the media item.
MediaDTO
 InheritedstartDate : BrightcoveDateDTO
The date the media item was set to go live.
MediaDTO
 Inheritedtags : Array
Publisher-defined lists of key/value tags for the media item, returned as array of strings.
MediaDTO
 InheritedthumbnailURL : String
URL of the thumbnail image for the media item.
MediaDTO
  videoStillURL : String
URL of the video still image for the video.
VideoDTO
Public Methods
 MethodDefined By
  
VideoDTO(video:Object)
Constructor.
VideoDTO
Property Detail
captionsproperty
public var captions:Array

The array of captions available for the video (if any)

encodingRateproperty 
public var encodingRate:Number

The rate at which the media was encoded, in average bits per second.

FLVFullCodecproperty 
public var FLVFullCodec:Number

The codec for the video. 0=Sorenson, 1=On2, 2=H264.

FLVFullLengthStreamedproperty 
public var FLVFullLengthStreamed:Boolean

Whether the video is a streaming video.

FLVFullLengthURLproperty 
public var FLVFullLengthURL:String

The URL of the video asset.

FLVFullSizeproperty 
public var FLVFullSize:Number

The size, in bytes, of the video.

publishedDateproperty 
public var publishedDate:Date

The date the video was last made active.

renditionsproperty 
public var renditions:Array

The array of renditions available for the video.

videoStillURLproperty 
public var videoStillURL:String

URL of the video still image for the video.

Constructor Detail
VideoDTO()Constructor
public function VideoDTO(video:Object)

Constructor.

Parameters
video:Object — Video DTO from the player to wrap with this class.