Main Page | Packages | Class Tree | Index | Help

mx.controls.streamingmedia

interface ICuePointHolder

All Known Implementing Classes:
MediaDisplay, MediaPlayback

interface ICuePointHolder

ICuePointHolder defined the functions that a holder of cue points must implement.

Streaming media players will implement this interface.


Author:
Andrew Guldman


Method Summary


addCuePoint ( aName: String, aTime: Number ): Void
Add the given cue point.


addCuePointObject ( aCuePoint: CuePoint ): Void
Add the given cue point.


getCuePoint ( pointName: String ): CuePoint



getCuePoints ( ): Array



removeAllCuePoints ( ): Void
Remove all the CuePoints.


removeCuePoint ( aCuePoint: CuePoint ): Void
Remove the given cue point.


setCuePoints ( cps: Array ): Void




Method Documentation

addCuePoint

function addCuePoint(aName: String,
 aTime: Number): Void
Add the given cue point.

Parameters:
aName
The name of the CuePoint to add.
aTime
The time of the CuePoint to add.

addCuePointObject

function addCuePointObject(aCuePoint: CuePoint): Void
Add the given cue point.

Parameters:
aCuePoint
The CuePoint to add.

getCuePoint

function getCuePoint(pointName: String): CuePoint
Parameters:
pointName
The name of the cue point to find.
Returns:
The CuePoint associated with this object that has the given name.

getCuePoints

function getCuePoints(): Array
Returns:
An array of CuePoint objects. All the CuePoints associated with this object.

removeAllCuePoints

function removeAllCuePoints(): Void
Remove all the CuePoints.

removeCuePoint

function removeCuePoint(aCuePoint: CuePoint): Void
Remove the given cue point.

Parameters:
aCuePoint
The CuePoint to remove.

setCuePoints

function setCuePoints(cps: Array): Void
Returns:
An array of CuePoint objects. All the CuePoints associated with this object.


The documentation was generated from the following file:


Copyright © 1997-2005 Macromedia, Inc. All rights reserved. Generated with AS2Doc