User Guide

FLVPlayback class 587
Parameters
time A number that is the time, in seconds, of the cue point for which to search. The
method uses only the first three decimal places and rounds any additional decimal places that
you provide. The method returns the cue point that matches this time. If multiple
ActionScript cue points have the same time, the method returns only the name that is first in
alphabetical order. It returns
null if it does not find a match.
name A string that is the name of the cue point for which to search. The method returns the
first cue point that matches this name, or it returns
null if it does not find a match.
cuePoint An object that is a cue point object containing time and name properties for
which to search. If 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 the
time property has no
value, is
null, or is less than zero, then 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. Otherwise, the method
returns
null.
type Optional. A string that specifies the type of cue point 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 that were 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.
Returns
null if no match is found.
Description
Method; finds the cue point of the type specified by the type parameter and having the time,
name, or combination of time and name that you specify through the parameters.
If you do not provide a value for either the time or name of the cue point, or if the time is
null, undefined, or less than zero and the name is null or undefined, the method throws
VideoError error 1002. For more information, see “VideoError class” on page 698.