User Guide

590 FLVPlayback Component (Flash Professional Only)
cuePoint An object that is a cue point object containing time and name properties for
which to search. If you provide a time and the
name property has no value or is null, the
search behaves as if the parameter is a number representing the time for which to search. If
you provide a name and the
time property has no value, is null, or is less than zero, the
search behaves as if the parameter is a string containing a name for which to search. If you
provide both the
time and name properties and a cue point exists that matches those values,
the method returns it. If it does not find a match for both the time and name, it returns the
first cue point that matches the name and has an earlier time. If there is no earlier cue point
with that name, it returns the first cue point that matches that name. Otherwise, the method
returns
null.
type Optional. A string that specifies the type of cuepoint for which to search. The possible
values for this parameter are:
"actionscript", "all", "event", "flv", or "navigation".
You can specify these values using the following class properties:
FLVPlayback.ACTIONSCRIPT, FLVPlayback.ALL, FLVPlayback.EVENT, FLVPlayback.FLV,
and
FLVPlayback.NAVIGATION.If this parameter is not specified, the default is "all", which
means the method will search all cue point types.
Returns
An object that is a copy of the found cue point object with the following additional
properties:
array The array of cue points searched. Treat this array as read-only as adding,
removing or editing objects within it can cause cue points to malfunction.
index The index into the array for the returned cue point.
Returns
null if no match was found.
Description
Method; finds a cue point of the specified type that matches or is earlier than the time that
you specify, or that matches the name that you specify, if you specify both a time and a name
and no earlier cue point matches that name. Otherwise, it returns
null.
The method includes disabled cue points in the search. Use the
isFLVCuePointEnabled()
method to determine if a cue point is disabled.
If the time is
null, undefined, or less than 0 and the name is null or undefined, the method
throws a VideoError error (1002).