Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
VideoEvent

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The VideoEvent class represents the event object passed to the event listener for events dispatched by the VideoDisplay control, and defines the values of the `VideoDisplay.state` property.

See also

mx.controls.VideoDisplay

Public Properties

| Property | Defined By
--- | --- | ---
|  | playheadTime : Number The location of the playhead of the VideoDisplay control when the event occurs. | VideoEvent
|  | state : String The value of the VideoDisplay.state property when the event occurs. | VideoEvent
|  | stateResponsive : Boolean [read-only] The value of the VideoDisplay.stateResponsive property when the event occurs. | VideoEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | VideoEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, state:String = null, playheadTime:Number) Constructor. | VideoEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | BUFFERING : String = buffering [static] The value of the VideoDisplay.state property immediately after a call to the play() or load() method. | VideoEvent
|  | CLOSE : String = close [static] The VideoEvent.CLOSE constant defines the value of the type property of the event object for a close event. | VideoEvent
|  | COMPLETE : String = complete [static] The VideoEvent.COMPLETE constant defines the value of the type property of the event object for a complete event. | VideoEvent
|  | CONNECTION_ERROR : String = connectionError [static] The value of the VideoDisplay.state property when the VideoDisplay control was unable to load the video stream. | VideoEvent
|  | DISCONNECTED : String = disconnected [static] The value of the VideoDisplay.state property when the video stream has timed out or is idle. | VideoEvent
|  | EXEC_QUEUED_CMD : String = execQueuedCmd [static] The value of the VideoDisplay.state property during execution of queued command. | VideoEvent
|  | LOADING : String = loading [static] The value of the VideoDisplay.state property immediately after a call to the play() or load() method. | VideoEvent
|  | PAUSED : String = paused [static] The value of the VideoDisplay.state property when an FLV file is loaded, but play is paused. | VideoEvent
|  | PLAYHEAD_UPDATE : String = playheadUpdate [static] The VideoEvent.PLAYHEAD_UPDATE constant defines the value of the type property of the event object for a playheadUpdate event. | VideoEvent
|  | PLAYING : String = playing [static] The value of the VideoDisplay.state property when an FLV file is loaded and is playing. | VideoEvent
|  | READY : String = ready [static] The VideoEvent.READY constant defines the value of the type property of the event object for a ready event. | VideoEvent
|  | RESIZING : String = resizing [static] The value of the VideoDisplay.state property when the VideoDisplay control is resizing. | VideoEvent
|  | REWIND : String = rewind [static] The VideoEvent.REWIND constant defines the value of the type property of the event object for a rewind event. | VideoEvent
|  | REWINDING : String = rewinding [static] The value of the VideoDisplay.state property during an autorewind triggered when play stops. | VideoEvent
|  | SEEKING : String = seeking [static] The value of the VideoDisplay.state property for a seek occurring due to the VideoDisplay.playHeadTime property being set. | VideoEvent
|  | STATE_CHANGE : String = stateChange [static] The VideoEvent.STATE_CHANGE constant defines the value of the type property of the event object for a stateChange event. | VideoEvent
|  | STOPPED : String = stopped [static] The value of the VideoDisplay.state property when an FLV file is loaded but play has stopped. | VideoEvent

Property Detail

playheadTime | property

`public var playheadTime:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The location of the playhead of the VideoDisplay control when the event occurs.

state | property |

`public var state:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The value of the `VideoDisplay.state` property when the event occurs.

See also

mx.controls.VideoDisplay.state

stateResponsive | property |

`stateResponsive:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The value of the `VideoDisplay.stateResponsive` property when the event occurs.

Implementation
`public function get stateResponsive():Boolean`

See also

mx.controls.VideoDisplay.stateResponsive
Constructor Detail

VideoEvent | () | Constructor

`public function VideoEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, state:String = null, playheadTime:Number)`

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.
| `state:String` (default = `null`)`` — The value of the `VideoDisplay.state` property when the event occurs.
| `playheadTime:Number` (default = `NaN`)`` — The location of the playhead when the event occurs.

Constant Detail

BUFFERING | Constant

`public static const BUFFERING:String = buffering`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The value of the `VideoDisplay.state` property immediately after a call to the `play()` or `load()` method.

This is a responsive state. In the responsive state, calls to the `play()`, `load()`, `stop()`, and `pause()` methods are executed immediately.

CLOSE | Constant |

`public static const CLOSE:String = close`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The `VideoEvent.CLOSE` constant defines the value of the `type` property of the event object for a `close` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`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`.
`playheadTime` | The location of the playhead when the event occurs.
`state` | The value of the `VideoDisplay.state` property when the event occurs.
`stateResponsive` | The value of the `VideoDisplay.stateResponsive` property when the event occurs.
`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.

COMPLETE | Constant |

`public static const COMPLETE:String = complete`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The `VideoEvent.COMPLETE` constant defines the value of the `type` property of the event object for a `complete` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`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`.
`playheadTime` | The location of the playhead when the event occurs.
`state` | The value of the `VideoDisplay.state` property when the event occurs.
`stateResponsive` | The value of the `VideoDisplay.stateResponsive` property when the event occurs.
`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.

CONNECTION_ERROR | Constant |

`public static const CONNECTION_ERROR:String = connectionError`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The value of the `VideoDisplay.state` property when the VideoDisplay control was unable to load the video stream. This state can occur when there is no connection to a server, the video stream is not found, or for other reasons.

This is a unresponsive state. If the control is unresponsive, calls to the `play()`, `load()`, `stop()`, and `pause()` methods are queued, and then executed when the control changes to the responsive state.

DISCONNECTED | Constant |

`public static const DISCONNECTED:String = disconnected`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The value of the `VideoDisplay.state` property when the video stream has timed out or is idle.

This is a responsive state. In the responsive state, calls to the `play()`, `load()`, `stop()`, and `pause()` methods are executed immediately.

EXEC_QUEUED_CMD | Constant |

`public static const EXEC_QUEUED_CMD:String = execQueuedCmd`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The value of the `VideoDisplay.state` property during execution of queued command. There will never be a `stateChange` event dispatched for this state; it is for internal use only.

This is a unresponsive state. If the control is unresponsive, calls to the `play()`, `load()`, `stop()`, and `pause()` methods are queued, and then executed when the control changes to the responsive state.

LOADING | Constant |

`public static const LOADING:String = loading`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The value of the `VideoDisplay.state` property immediately after a call to the `play()` or `load()` method.

This is a unresponsive state. If the control is unresponsive, calls to the `play()`, `load()`, `stop()`, and `pause()` methods are queued, and then executed when the control changes to the responsive state.

PAUSED | Constant |

`public static const PAUSED:String = paused`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The value of the `VideoDisplay.state` property when an FLV file is loaded, but play is paused. This state is entered when you call the `pause()` or `load()` method.

This is a responsive state. In the responsive state, calls to the `play()`, `load()`, `stop()`, and `pause()` methods are executed immediately.

PLAYHEAD_UPDATE | Constant |

`public static const PLAYHEAD_UPDATE:String = playheadUpdate`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The `VideoEvent.PLAYHEAD_UPDATE` constant defines the value of the `type` property of the event object for a `playheadUpdate` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`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`.
`playheadTime` | The location of the playhead when the event occurs.
`state` | The value of the `VideoDisplay.state` property when the event occurs.
`stateResponsive` | The value of the `VideoDisplay.stateResponsive` property when the event occurs.
`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.

PLAYING | Constant |

`public static const PLAYING:String = playing`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The value of the `VideoDisplay.state` property when an FLV file is loaded and is playing. This state is entered when you call the `play()` method.

This is a responsive state. In the responsive state, calls to the `play()`, `load()`, `stop()`, and `pause()` methods are executed immediately.

READY | Constant |

`public static const READY:String = ready`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The `VideoEvent.READY` constant defines the value of the `type` property of the event object for a `ready` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`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`.
`playheadTime` | The location of the playhead when the event occurs.
`state` | The value of the `VideoDisplay.state` property when the event occurs.
`stateResponsive` | The value of the `VideoDisplay.stateResponsive` property when the event occurs.
`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.

RESIZING | Constant |

`public static const RESIZING:String = resizing`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The value of the `VideoDisplay.state` property when the VideoDisplay control is resizing.

This is a unresponsive state. If the control is unresponsive, calls to the `play()`, `load()`, `stop()`, and `pause()` methods are queued, and then executed when the control changes to the responsive state.

REWIND | Constant |

`public static const REWIND:String = rewind`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The `VideoEvent.REWIND` constant defines the value of the `type` property of the event object for a `rewind` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`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`.
`playheadTime` | The location of the playhead when the event occurs.
`state` | The value of the `VideoDisplay.state` property when the event occurs.
`stateResponsive` | The value of the `VideoDisplay.stateResponsive` property when the event occurs.
`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.

REWINDING | Constant |

`public static const REWINDING:String = rewinding`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The value of the `VideoDisplay.state` property during an autorewind triggered when play stops. After the rewind completes, the state changes to `STOPPED`.

This is a unresponsive state. If the control is unresponsive, calls to the `play()`, `load()`, `stop()`, and `pause()` methods are queued, and then executed when the control changes to the responsive state.

SEEKING | Constant |

`public static const SEEKING:String = seeking`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The value of the `VideoDisplay.state` property for a seek occurring due to the `VideoDisplay.playHeadTime` property being set.

This is a unresponsive state. If the control is unresponsive, calls to the `play()`, `load()`, `stop()`, and `pause()` methods are queued, and then executed when the control changes to the responsive state.

STATE_CHANGE | Constant |

`public static const STATE_CHANGE:String = stateChange`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The `VideoEvent.STATE_CHANGE` constant defines the value of the `type` property of the event object for a `stateChange` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`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`.
`playheadTime` | The location of the playhead when the event occurs.
`state` | The value of the `VideoDisplay.state` property when the event occurs.
`stateResponsive` | The value of the `VideoDisplay.stateResponsive` property when the event occurs.
`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.

STOPPED | Constant |

`public static const STOPPED:String = stopped`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The value of the `VideoDisplay.state` property when an FLV file is loaded but play has stopped. This state is entered when you call the `stop()` method or when the playhead reaches the end of the video stream.

This is a responsive state. In the responsive state, calls to the `play()`, `load()`, `stop()`, and `pause()` methods are executed immediately.

Wed Nov 15 2017, 09:50 AM +01:00