Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.events 
VideoEvent 
Packagemx.events
Classpublic class VideoEvent
InheritanceVideoEvent Inheritance Event Inheritance 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.

See also



Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : 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
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  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
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
VideoEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, state:String = null, playheadTime:Number = NaN)
Constructor.
VideoEvent
 Inherited
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
 InheritedACTIVATE : String = "activate"
[static] The ACTIVATE constant defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] The Event.ADDED constant defines the value of the type property of an added event object.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] The Event.ADDED_TO_STAGE constant defines the value of the type property of an addedToStage event object.
Event
  BUFFERING : String = "buffering"
[static] The value of the VideoDisplay.state property immediately after a call to the play() or load() method.
VideoEvent
 InheritedCANCEL : String = "cancel"
[static] The Event.CANCEL constant defines the value of the type property of a cancel event object.
Event
 InheritedCHANGE : String = "change"
[static] The Event.CHANGE constant defines the value of the type property of a change event object.
Event
 InheritedCLEAR : String = "clear"
[static] The Event.CLEAR constant efines the value of the type property of a clear event object.
Event
  CLOSE : String = "close"
[static] The VideoEvent.CLOSE constant defines the value of the type property of the event object for a close event.
VideoEvent
 InheritedAIR-only CLOSING : String = "closing"
[static] The Event.CLOSING constant defines the value of the type property of a closing event object.
Event
  COMPLETE : String = "complete"
[static] The VideoEvent.COMPLETE constant defines the value of the type property of the event object for a complete event.
VideoEvent
 InheritedCONNECT : String = "connect"
[static] The Event.CONNECT constant defines the value of the type property of a connect event object.
Event
  CONNECTION_ERROR : String = "connectionError"
[static] The value of the VideoDisplay.state property when the VideoDisplay control was unable to load the video stream.
VideoEvent
 InheritedCOPY : String = "copy"
[static] Defines the value of the type property of a copy event object.
Event
 InheritedCUT : String = "cut"
[static] Defines the value of the type property of a cut event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
Event
  DISCONNECTED : String = "disconnected"
[static] The value of the VideoDisplay.state property when the video stream has timed out or is idle.
VideoEvent
 InheritedDISPLAYING : String = "displaying"
[static] The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
Event
  EXEC_QUEUED_CMD : String = "execQueuedCmd"
[static] The value of the VideoDisplay.state property during execution of queued command.
VideoEvent
 InheritedEXIT_FRAME : String = "exitFrame"
[static] The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
Event
 InheritedAIR-only EXITING : String = "exiting"
[static] The Event.EXITING constant defines the value of the type property of an exiting event object.
Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
Event
 InheritedAIR-only HTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
Event
 InheritedAIR-only HTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] The Event.HTML_DOM_INITIALIZE constant defines the value of the type property of an htmlDOMInitialize event object.
Event
 InheritedAIR-only HTML_RENDER : String = "htmlRender"
[static] The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
Event
 InheritedID3 : String = "id3"
[static] The Event.ID3 constant defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] The Event.INIT constant defines the value of the type property of an init event object.
Event
  LOADING : String = "loading"
[static] The value of the VideoDisplay.state property immediately after a call to the play() or load() method.
VideoEvent
 InheritedAIR-only LOCATION_CHANGE : String = "locationChange"
[static] The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
Event
 InheritedAIR-only NETWORK_CHANGE : String = "networkChange"
[static] The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
Event
 InheritedOPEN : String = "open"
[static] The Event.OPEN constant defines the value of the type property of an open event object.
Event
 InheritedPASTE : String = "paste"
[static] The Event.PASTE constant defines the value of the type property of a paste event object.
Event
  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
 InheritedREMOVED : String = "removed"
[static] The Event.REMOVED constant defines the value of the type property of a removed event object.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] The Event.REMOVED_FROM_STAGE constant defines the value of the type property of a removedFromStage event object.
Event
 InheritedRENDER : String = "render"
[static] The Event.RENDER constant defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] The Event.RESIZE constant defines the value of the type property of a resize event object.
Event
  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
 InheritedSCROLL : String = "scroll"
[static] The Event.SCROLL constant defines the value of the type property of a scroll event object.
Event
  SEEKING : String = "seeking"
[static] The value of the VideoDisplay.state property for a seek occurring due to the VideoDisplay.playHeadTime property being set.
VideoEvent
 InheritedSELECT : String = "select"
[static] The Event.SELECT constant defines the value of the type property of a select event object.
Event
 InheritedSELECT_ALL : String = "selectAll"
[static] The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
Event
  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
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] The Event.TAB_ENABLED_CHANGE constant defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] The Event.TAB_INDEX_CHANGE constant defines the value of the type property of a tabIndexChange event object.
Event
 InheritedUNLOAD : String = "unload"
[static] The Event.UNLOAD constant defines the value of the type property of an unload event object.
Event
 InheritedAIR-only USER_IDLE : String = "userIdle"
[static] The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
Event
 InheritedAIR-only USER_PRESENT : String = "userPresent"
[static] The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
Event
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

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

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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
playheadTimeThe location of the playhead when the event occurs.
stateThe value of the VideoDisplay.state property when the event occurs.
stateResponsiveThe value of the VideoDisplay.stateResponsive property when the event occurs.
targetThe 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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
playheadTimeThe location of the playhead when the event occurs.
stateThe value of the VideoDisplay.state property when the event occurs.
stateResponsiveThe value of the VideoDisplay.stateResponsive property when the event occurs.
targetThe 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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
playheadTimeThe location of the playhead when the event occurs.
stateThe value of the VideoDisplay.state property when the event occurs.
stateResponsiveThe value of the VideoDisplay.stateResponsive property when the event occurs.
targetThe 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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
playheadTimeThe location of the playhead when the event occurs.
stateThe value of the VideoDisplay.state property when the event occurs.
stateResponsiveThe value of the VideoDisplay.stateResponsive property when the event occurs.
targetThe 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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
playheadTimeThe location of the playhead when the event occurs.
stateThe value of the VideoDisplay.state property when the event occurs.
stateResponsiveThe value of the VideoDisplay.stateResponsive property when the event occurs.
targetThe 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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
playheadTimeThe location of the playhead when the event occurs.
stateThe value of the VideoDisplay.state property when the event occurs.
stateResponsiveThe value of the VideoDisplay.stateResponsive property when the event occurs.
targetThe 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.