Packagemx.events
Classpublic class VideoEvent
InheritanceVideoEvent Inheritance Event Inheritance Object

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
 PropertyDefined by
 Inheritedbubbles : Boolean
Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
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
The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
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
The event target.
Event
 Inheritedtype : String
The type of event.
Event
Public Methods
 MethodDefined by
  
VideoEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, state:String = null, playheadTime:Number)
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 your custom Event class.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether preventDefault() 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 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] Defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] Defines the value of the type property of an added 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] Defines the value of the type property of a cancel event object.
Event
 InheritedCHANGE : String = "change"
[static] Defines the value of the type property of a change 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
  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] 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
 InheritedDEACTIVATE : String = "deactivate"
[static] 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
 InheritedENTER_FRAME : String = "enterFrame"
[static] 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
 InheritedID3 : String = "id3"
[static] Defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] 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
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] Defines the value of the type property of a mouseLeave event object.
Event
 InheritedOPEN : String = "open"
[static] Defines the value of the type property of an open 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] Defines the value of the type property of a removed event object.
Event
 InheritedRENDER : String = "render"
[static] Defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] 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] 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] Defines the value of the type property of a select event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] 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] Defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] Defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] Defines the value of the type property of a tabIndexChange event object.
Event
 InheritedUNLOAD : String = "unload"
[static] Defines the value of the type property of an unload event object.
Event
Property detail
playheadTimeproperty
public var playheadTime:Number

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

stateproperty 
public var state:String

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

See also

stateResponsiveproperty 
stateResponsive:Boolean  [read-only]

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)

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 — The location of the playhead when the event occurs.
Constant detail
BUFFERINGconstant
public static const BUFFERING:String = "buffering"

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.

CLOSEconstant 
public static const CLOSE:String = "close"

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.
COMPLETEconstant 
public static const COMPLETE:String = "complete"

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_ERRORconstant 
public static const CONNECTION_ERROR:String = "connectionError"

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.

DISCONNECTEDconstant 
public static const DISCONNECTED:String = "disconnected"

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_CMDconstant 
public static const EXEC_QUEUED_CMD:String = "execQueuedCmd"

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.

LOADINGconstant 
public static const LOADING:String = "loading"

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.

PAUSEDconstant 
public static const PAUSED:String = "paused"

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_UPDATEconstant 
public static const PLAYHEAD_UPDATE:String = "playheadUpdate"

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.
PLAYINGconstant 
public static const PLAYING:String = "playing"

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.

READYconstant 
public static const READY:String = "ready"

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.
RESIZINGconstant 
public static const RESIZING:String = "resizing"

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.

REWINDconstant 
public static const REWIND:String = "rewind"

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.
REWINDINGconstant 
public static const REWINDING:String = "rewinding"

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.

SEEKINGconstant 
public static const SEEKING:String = "seeking"

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_CHANGEconstant 
public static const STATE_CHANGE:String = "stateChange"

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.
STOPPEDconstant 
public static const STOPPED:String = "stopped"

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.





 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flex/2/langref/mx/events/VideoEvent.html