public function CuePointManager(owner:VideoPlayer, id:uint = 0)
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Constructor.
Parameters
owner:VideoPlayer — The VideoPlayer instance that is the parent of this CuePointManager.
id:uint (default = 0) — This parameter is ignored; it is provided only for backwards compatibility.
Method Detail
addCuePoint
()
method
public function addCuePoint(cuePoint:Object):Object
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Adds a cue point.
You can add multiple cue points with the same
name and time. When you call the removeCuePoint() method
with the name and time, it removes the first matching cue point.
To remove all matching cue points, you have to make additional calls to
the removeCuePoint() method.
Parameters
cuePoint:Object — The Object describes the cue
point. It must contain the properties name:String
and time:Number (in seconds).
If the Object does not conform to these
conventions, it throws a VideoError error.
Returns
Object — A copy of the cue point Object added. The copy has the
following additional properties:
array - the Array of all cue points. Treat
this Array as read only because adding, removing or editing objects
within it can cause cue points to malfunction.
index - the index into the Array for the
returned cue point.
public function getCuePointByName(name:String):Object
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Search for a cue point with specified name.
Parameters
name:String — The name of the cue point.
Returns
Object — null if no match was found, or
a copy of the matching cue point Object with additional properties:
array - the Array of cue points searched. Treat
this array as read only because adding, removing or editing objects
within it can cause cue points to malfunction.
index - the index into the Array for the
returned cue point.
getCuePoints
()
method
public function getCuePoints():Array
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Returns an Array of all cue points.
Returns
Array — An Array of cue point objects.
Each cue point object describes the cue
point, and contains the properties name:String
and time:Number (in seconds).
removeAllCuePoints
()
method
public function removeAllCuePoints():void
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Removes all cue points.
removeCuePoint
()
method
public function removeCuePoint(cuePoint:Object):Object
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Removes a cue point from the currently
loaded FLV file. Only the name and time
properties are used from the cuePoint argument to
determine the cue point to be removed.
If multiple cue points match the search criteria, only
one will be removed. To remove all cue points, call this function
repeatedly in a loop with the same arguments until it returns
null.
Parameters
cuePoint:Object — The Object must contain at least one of
name:String and time:Number properties, and
removes the cue point that matches the specified properties.
Returns
Object — An object representing the cue point removed. If there was no
matching cue point, then it returns null.
setCuePoints
()
method
public function setCuePoints(cuePointArray:Array):void
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Set the array of cue points.
You can add multiple cue points with the same
name and time. When you call the removeCuePoint() method
with this name, only the first one is removed.
Parameters
cuePointArray:Array — An Array of cue point objects.
Each cue point object describes the cue
point. It must contain the properties name:String
and time:Number (in seconds).
Object