Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
CuePointEvent

Package | mx.events
Class | public class CuePointEvent
Inheritance | CuePointEvent flash.events.Event

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The CuePointEvent class represents the event object passed to the event listener for cue point events dispatched by the VideoDisplay control.

See also

mx.controls.VideoDisplay

Public Properties

| Property | Defined By
--- | --- | ---
|  | cuePointName : String The name of the cue point that caused the event. | CuePointEvent
|  | cuePointTime : Number The time of the cue point that caused the event, in seconds. | CuePointEvent
|  | cuePointType : String The string "actionscript". | CuePointEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | CuePointEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, cuePointName:String = null, cuePointTime:Number, cuePointType:String = null) Constructor. | CuePointEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | CUE_POINT : String = cuePoint [static] The CuePointEvent.CUE_POINT constant defines the value of the type property of the event object for a cuePoint event. | CuePointEvent

Property Detail

cuePointName | property

`public var cuePointName:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The name of the cue point that caused the event.

cuePointTime | property |

`public var cuePointTime:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The time of the cue point that caused the event, in seconds.

cuePointType | property |

`public var cuePointType:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The string `"actionscript"`.

Constructor Detail

CuePointEvent | () | Constructor

`public function CuePointEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, cuePointName:String = null, cuePointTime:Number, cuePointType:String = null)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Parameters

| `type:String` — The event type; indicates the action that caused the event.
| `bubbles:Boolean` (default = `false`)`` — Specifies whether the event can bubble up the display list hierarchy.
| `cancelable:Boolean` (default = `false`)`` — Specifies whether the behavior associated with the event can be prevented.
| `cuePointName:String` (default = `null`)`` — The name of the cue point.
| `cuePointTime:Number` (default = `NaN`)`` — The time of the cue point, in seconds.
| `cuePointType:String` (default = `null`)`` — The string `"actionscript"`.

Constant Detail

CUE_POINT | Constant

`public static const CUE_POINT:String = cuePoint`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The `CuePointEvent.CUE_POINT` constant defines the value of the `type` property of the event object for a `cuePoint` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`cuePointName` | The name of the cue point.
`cuePointTime` | The time of the cue point, in seconds.
`cuePointType` | The string `"actionscript"`.
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

Sun Mar 5 2017, 03:42 PM +11:00