Packagecom.brightcove.api.dtos
Classpublic class VideoCuePointDTO
InheritanceVideoCuePointDTO Inheritance Object



Public Properties
 PropertyDefined By
  forceStop : Boolean
Whether hitting the cuepoint, if an ad cuepoint, will pause playback in the player.
VideoCuePointDTO
  id : Number
Unique Brightcove ID for the cuepoint.
VideoCuePointDTO
  metadata : Object
Any additional metadata stored with the cuepoint.
VideoCuePointDTO
  name : String
The name given to the cuepoint.
VideoCuePointDTO
  time : Number
The time in the video (in seconds) at which the cuepoint was inserted.
VideoCuePointDTO
  type : Number
The type of cuepoint.
VideoCuePointDTO
  videoId : Number
The ID of the video to which the cuepoint belongs.
VideoCuePointDTO
Public Methods
 MethodDefined By
  
VideoCuePointDTO(cuePoint:Object)
Constructor.
VideoCuePointDTO
Property Detail
forceStopproperty
public var forceStop:Boolean

Whether hitting the cuepoint, if an ad cuepoint, will pause playback in the player.

idproperty 
public var id:Number

Unique Brightcove ID for the cuepoint.

metadataproperty 
public var metadata:Object

Any additional metadata stored with the cuepoint.

nameproperty 
public var name:String

The name given to the cuepoint.

timeproperty 
public var time:Number

The time in the video (in seconds) at which the cuepoint was inserted. For example, if a cue point time is three seconds and 550 milliseconds, time returns 3.550

typeproperty 
public var type:Number

The type of cuepoint. 0=ad, 1=code, 2=chapter, 3=embedded.

videoIdproperty 
public var videoId:Number

The ID of the video to which the cuepoint belongs.

Constructor Detail
VideoCuePointDTO()Constructor
public function VideoCuePointDTO(cuePoint:Object)

Constructor.

Parameters
cuePoint:Object — CuePoint DTO from the player to wrap with this class.