flash.events

# VideoEvent - AS3

Package | flash.events
Class | public class VideoEvent
Inheritance | VideoEvent Event 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
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
|  | status : String [read-only] Returns the rendering status of the VideoEvent object. | 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, status:String = null) 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
--- | --- | ---
|  | 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:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `false`; there is no default behavior to cancel.
`currentTarget` | The object that is actively processing the event.
`status` | The rendering status reported by the event.
`target` | The 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.

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