mx.events

# VideoEvent - AS3 Flex

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

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.

More examples

Manually dispatching events

Learn more

About Flex events

Related API Elements

mx.controls.VideoDisplay

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented. | Event
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener. | Event
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | 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
|  | target : Object [read-only] The event target. | Event
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | VideoEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, state:String = null, playheadTime:Number = NaN) Constructor. | VideoEvent
|  | clone():Event Duplicates an instance of an Event subclass. | Event
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns a string containing all the properties of the Event object. | Event
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited 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.

Related API Elements

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`

Related API Elements

mx.controls.VideoDisplay.stateResponsive
Constructor Detail

### VideoEvent

()
Constructor

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

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.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00