ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flash.events 

VideoEvent  - AS3

Packageflash.events
Classpublic class VideoEvent
InheritanceVideoEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.2, AIR 3

This event class reports the current video rendering status. Use this event for the following purposes:

  • To find out when size of the Video display changes or is initialized. Use this event instead of polling for size changes. When you receive this event you can access Video.videoSize and Video.videoHeight to get the pixel dimensions of the video that is currently playing.
  • To find out whether the video is decoded by software or the GPU. If the status property returns "accelerated", you should switch to using the StageVideo class, if possible.

Learn more

Working with Video

Related API Elements

flash.events.StageVideoEvent
flash.events.StageVideoAvailabilityEvent
flash.display.Stage.stageVideos
flash.media.Video
flash.net.NetStream

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
  status : String
[read-only] Returns the rendering status of the VideoEvent object.
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, status:String = null)
Constructor.
VideoEvent
 Inherited
clone():Event
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
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
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
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  codecInfo : String
VideoEvent
  RENDER_STATE : String = "renderState"
[static] Defines the value of the type property of a renderState event object.
VideoEvent
  RENDER_STATUS_ACCELERATED : String = "accelerated"
[static] For internal use only.
VideoEvent
  RENDER_STATUS_SOFTWARE : String = "software"
[static] For internal use only.
VideoEvent
  RENDER_STATUS_UNAVAILABLE : String = "unavailable"
[static] For internal use only.
VideoEvent
Property Detail

status

property
status:String  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.2, AIR 3

Returns the rendering status of the VideoEvent object. Possible values include "unavailable", "software", and "accelerated".



Implementation
    public function get status():String
Constructor Detail

VideoEvent

()Constructor
public function VideoEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, status:String = null)

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.2, AIR 3

Constructor.

Parameters
type:String — The type of event. Possible values are: VideoEvent.RENDER_STATE.
 
bubbles:Boolean (default = false) — Indicates whether this Event object participates in the bubbling stage of the event flow.
 
cancelable:Boolean (default = false) — Indicates whether you can cancel the action that triggers this event.
 
status:String (default = null) — The rendering state of the video.
Constant Detail

codecInfo

Constant
public const codecInfo:String

RENDER_STATE

Constant 
public static const RENDER_STATE:String = "renderState"

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.2, AIR 3

Defines the value of the type property of a renderState event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event.
statusThe rendering status reported by the event.
targetThe Video object reporting rendering status.

RENDER_STATUS_ACCELERATED

Constant 
public static const RENDER_STATUS_ACCELERATED:String = "accelerated"

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.2, AIR 3

For internal use only. Use flash.media.VideoStatus.ACCELERATED instead.

RENDER_STATUS_SOFTWARE

Constant 
public static const RENDER_STATUS_SOFTWARE:String = "software"

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.2, AIR 3

For internal use only. Use flash.media.VideoStatus.SOFTWARE instead.

RENDER_STATUS_UNAVAILABLE

Constant 
public static const RENDER_STATUS_UNAVAILABLE:String = "unavailable"

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.2, AIR 3

For internal use only. Use flash.media.VideoStatus.UNAVAILABLE instead.




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy