Packagecom.brightcove.api.modules
Classpublic class CuePointsModule
InheritanceCuePointsModule Inheritance APIModule Inheritance flash.events.EventDispatcher

API class for handling cue points in video.


Public Properties
 PropertyDefined By
 Inheritedmodule : Object
[read-only] Returns the instance of the module that is wrapped by this instance.
APIModule
Public Methods
 MethodDefined By
  
CuePointsModule(module:Object)
Constructor.
CuePointsModule
  
addCuePoints(videoID:Number, cuePoints:Array):Boolean
Adds a set of cuepoints to a specified video.
CuePointsModule
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void
[override] Adds a listener for an event.
APIModule
  
clearAdCuePoints(videoID:Number):Boolean
Clears all ad cuepoints for a specified video.
CuePointsModule
  
clearCodeCuePoints(videoID:Number):Boolean
Clears all code cuepoints for a specified video.
CuePointsModule
  
getCuePoints(videoID:Number):Array
Returns cuepoints for the specified video.
CuePointsModule
  
removeAdCuePointsAtTime(videoID:Number, time:Number):Boolean
Removes ad cuepoints at the specified time for the specified video.
CuePointsModule
  
removeCodeCuePointsAtTime(videoID:Number, time:Number):Boolean
Removes code cuepoints at the specified time for the specified video.
CuePointsModule
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[override] Removes a listener for an event.
APIModule
Events
 Event Summary Defined By
  
cuePoint
Dispatched when a cue point is reached within a video currently playing back.CuePointsModule
Constructor Detail
CuePointsModule()Constructor
public function CuePointsModule(module:Object)

Constructor.

Parameters
module:Object — module to wrap with this API class.
Method Detail
addCuePoints()method
public function addCuePoints(videoID:Number, cuePoints:Array):Boolean

Adds a set of cuepoints to a specified video. These cuepoints will cause cuePoint events to fire at the times specified, which the user can subscribe to.

Parameters

videoID:Number — id for the video to have cuepoints added to.
 
cuePoints:Array — array of objects defining points in time. Each index of the array can either be a number, specifying the time in seconds for the cue, or each index can contain a complex object with time (in seconds), type and description properties.

Returns
Boolean — Whether the specified video can be found in the current lineups of the player.
clearAdCuePoints()method 
public function clearAdCuePoints(videoID:Number):Boolean

Clears all ad cuepoints for a specified video.

Parameters

videoID:Number — id for the video to remove cuepoints from.

Returns
Boolean — Whether the specified video can be found in the current lineups of the player.
clearCodeCuePoints()method 
public function clearCodeCuePoints(videoID:Number):Boolean

Clears all code cuepoints for a specified video.

Parameters

videoID:Number — id for the video to remove cuepoints from.

Returns
Boolean — Whether the specified video can be found in the current lineups of the player.
getCuePoints()method 
public function getCuePoints(videoID:Number):Array

Returns cuepoints for the specified video. If no cue points have been added, but advertising is turned on for the video, the returned array will contain the ad cue points at the beginning and end of the video. If advertising is turned off, and no cue points were set for the video, null will be returned.

Parameters

videoID:Number — id for the video to retrieve cuepoints from.

Returns
Array — An array of VideoCuePointDTOs.
removeAdCuePointsAtTime()method 
public function removeAdCuePointsAtTime(videoID:Number, time:Number):Boolean

Removes ad cuepoints at the specified time for the specified video.

Parameters

videoID:Number — id for the video to remove cuepoints from.
 
time:Number — time of the cuepoint to remove.

Returns
Boolean — Whether the specified video can be found in the current lineups of the player and whether cuepoints existed and were removed at the specified time.
removeCodeCuePointsAtTime()method 
public function removeCodeCuePointsAtTime(videoID:Number, time:Number):Boolean

Removes code cuepoints at the specified time for the specified video.

Parameters

videoID:Number — id for the video to remove cuepoints from.
 
time:Number — time of the cuepoint to remove.

Returns
Boolean — Whether the specified video can be found in the current lineups of the player and whether cuepoints existed and were removed at the specified time.
Event Detail
cuePoint Event
Event Object Type: com.brightcove.api.events.CuePointEvent
CuePointEvent.type property = com.brightcove.api.events.CuePointEvent.CUE

Dispatched when a cue point is reached within a video currently playing back.

The CuePointEvent.CUE constant defines the value of the type property of the event object for a cuePoint event.



Generated by Flexmojos

Mon Oct 22 2012, 10:57 AM -04:00