Package | com.brightcove.api.modules |
Class | public class CuePointsModule |
Inheritance | CuePointsModule ![]() ![]() |
Method | Defined By | ||
---|---|---|---|
CuePointsModule(module:Object)
Constructor. | CuePointsModule | ||
addCuePoints(videoID:Number, cuePoints:Array):Boolean
Adds a set of cuepoints to a specified video. | CuePointsModule | ||
![]() | 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 | ||
![]() | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override]
Removes a listener for an event. | APIModule |
Event | Summary | Defined By | ||
---|---|---|---|---|
Dispatched when a cue point is reached within a video currently playing back. | CuePointsModule |
CuePointsModule | () | Constructor |
public function CuePointsModule(module:Object)
Constructor.
Parametersmodule:Object — module to wrap with this API class.
|
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.
|
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.
|
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.
|
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.
Parameters
videoID:Number — id for the video to retrieve cuepoints from.
|
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.
|
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.
|
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.
|
cuePoint | Event |
com.brightcove.api.events.CuePointEvent
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 thetype
property of the event object for a
cuePoint
event.