Packageorg.openvideoplayer.net
Classpublic class OvpCuePointManager
InheritanceOvpCuePointManager Inheritance flash.events.EventDispatcher
Subclasses OvpCCManager

The OvpCuePointManager class allows you to add cue points with ActionScript and have them fire at specified times in the stream. This type of cue point is considered an ActionScript cue point, as opposed to an embedded cue point added at encoding time.



Public Properties
 PropertyDefined By
  cuePoints : Array
[read-only] Get the sorted, cue point array.
OvpCuePointManager
  netStream : OvpNetStream
[write-only] Set the OvpNetStream object this class will use.
OvpCuePointManager
Public Methods
 MethodDefined By
  
Constructs a new OvpCuePointManager object, with the OvpNetStream object it will use.
OvpCuePointManager
  
addCuePoint(cuePoint:Object):Boolean
Add a single cue point as an object.
OvpCuePointManager
  
addCuePoints(cuePoints:Array):Boolean
Add an array of cue points.
OvpCuePointManager
  
enableCuePoints(enable:Boolean):void
Enables/disables cue point events.
OvpCuePointManager
  
Removes all cue points.
OvpCuePointManager
Events
 Event Summary Defined By
  Dispatched when an OVP error condition has occurred.OvpCuePointManager
Property Detail
cuePointsproperty
cuePoints:Array  [read-only]

Get the sorted, cue point array. Please consider the returned array to be "read-only", modifying this array directly will lead to unexpected behavior.


Implementation
    public function get cuePoints():Array
netStreamproperty 
netStream:OvpNetStream  [write-only]

Set the OvpNetStream object this class will use.


Implementation
    public function set netStream(value:OvpNetStream):void
Constructor Detail
OvpCuePointManager()Constructor
public function OvpCuePointManager(ns:OvpNetStream = null)

Constructs a new OvpCuePointManager object, with the OvpNetStream object it will use. The OvpNetStream object can also be set via the netStream property.

Parameters
ns:OvpNetStream (default = null) — The OvpNetStream object the class should use.
Method Detail
addCuePoint()method
public function addCuePoint(cuePoint:Object):Boolean

Add a single cue point as an object. The object must contain the following properties:

Parameters

cuePoint:Object

Returns
Boolean — True if the cue point passed in is valid and was successfully added to the class' internal collection of cue points. Otherwise, returns False.

See also

addCuePoints()method 
public function addCuePoints(cuePoints:Array):Boolean

Add an array of cue points. Each object in the array must contain the following properties:

Parameters

cuePoints:Array

Returns
Boolean — True if the array of cue points passed in is valid and each object in the array was successfully added. Otherwise, returns False.

See also

enableCuePoints()method 
public function enableCuePoints(enable:Boolean):void

Enables/disables cue point events. Useful for features such as toggling closed captioning.

Parameters

enable:Boolean

removeAllCuePoints()method 
public function removeAllCuePoints():void

Removes all cue points.

Event Detail
error Event
Event Object Type: org.openvideoplayer.events.OvpEvent

Dispatched when an OVP error condition has occurred. The OvpEvent object contains a data property. The contents of the data property will contain the error number and a description.

See also