StageVideoEvent

Package	flash.events
Class	public class StageVideoEvent
Inheritance	StageVideoEvent Event Object

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 2.5, Flash Player 10.2

A StageVideo object dispatches a StageVideoEvent object after the attachNetStream() method of the StageVideo object and the play() method of the attached NetStream object have both been called. Also, depending on the platform, any change in the playing status can result in dispatching the event. The one type of StageVideoEvent is StageVideoEvent.RENDER_STATE.

More examples

Using the StageVideoEvent.RENDER_STATE and VideoEvent.RENDER_STATE events

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
		colorSpace : String [read-only] The color space used by the video being displayed in the StageVideo object.	StageVideoEvent
		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] The status of the StageVideo object.	StageVideoEvent
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

	Method		Defined By
		StageVideoEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, status:String = null, colorSpace:String = null) Creates an Event object that contains information about StageVideo events.	StageVideoEvent
		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

	Constant		Defined By
		codecInfo : String	StageVideoEvent
		RENDER_STATE : String = "renderState" [static] The StageVideoEvent.RENDER_STATE constant defines the value of the type property of a renderState event object.	StageVideoEvent
		RENDER_STATUS_ACCELERATED : String = "accelerated" Deprecated since Flash Player 10.2, AIR 3: Please Use flash.media.VideoStatus.ACCELERATED [static] Indicates that hardware is decoding and displaying the video.	StageVideoEvent
		RENDER_STATUS_SOFTWARE : String = "software" Deprecated since Flash Player 10.2, AIR 3: Please Use flash.media.VideoStatus.SOFTWARE [static] Indicates that software is decoding and displaying the video.	StageVideoEvent
		RENDER_STATUS_UNAVAILABLE : String = "unavailable" Deprecated since Flash Player 10.2, AIR 3: Please Use flash.media.VideoStatus.UNAVAILABLE [static] Indicates that displaying the video using the StageVideo object is not possible.	StageVideoEvent

Property Detail

colorSpace

property

colorSpace:String [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 2.5, Flash Player 10.2

The color space used by the video being displayed in the StageVideo object.

Implementation
public function get colorSpace():String

Related API Elements

flash.media.StageVideo

status

property

status:String [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 2.5, Flash Player 10.2

The status of the StageVideo object.

Implementation
public function get status():String

Related API Elements

flash.events.StageVideoEvent.RENDER_STATUS_UNAVAILABLE
flash.events.StageVideoEvent.RENDER_STATUS_SOFTWARE
flash.events.StageVideoEvent.RENDER_STATUS_ACCELERATED

Constructor Detail

StageVideoEvent

()

Constructor

public function StageVideoEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, status:String = null, colorSpace:String = null)

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 2.5, Flash Player 10.2

Creates an Event object that contains information about StageVideo events. Event objects are passed as parameters to event listeners.

Parameters

	`type:String` — The type of the event. Event listeners can access this information through the inherited `type` property. The one type of StageVideoEvent is `StageVideoEvent.RENDER_STATE`.

	`bubbles:Boolean` (default = `false`) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited `bubbles` property.

	`cancelable:Boolean` (default = `false`) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited `cancelable` property.

	`status:String` (default = `null`) — Indicates the status of the target StageVideo object.

	`colorSpace:String` (default = `null`) — The color space used by the video being displayed.

Related API Elements

flash.media.StageVideo
flash.display.Stage.stageVideos
flash.events.StageVideoEvent.RENDER_STATE

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:

AIR 2.5, Flash Player 10.2

The StageVideoEvent.RENDER_STATE constant 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.
`colorSpace`	The available color spaces for displaying the video.
`currentTarget`	The object that is actively processing the StageVideoEvent object with an event listener.
`status`	Indicates whether the video is being rendered (decoded and displayed) by hardware or software, or not at all.
`target`	The StageVideo object that changed state.

Related API Elements

flash.events.StageVideoEvent.RENDER_STATE
flash.events.StageVideoEvent.RENDER_STATUS_UNAVAILABLE
flash.events.StageVideoEvent.RENDER_STATUS_SOFTWARE
flash.events.StageVideoEvent.RENDER_STATUS_ACCELERATED

RENDER_STATUS_ACCELERATED

Constant

public static const RENDER_STATUS_ACCELERATED:String = "accelerated"

Deprecated since Flash Player 10.2, AIR 3: Please Use flash.media.VideoStatus.ACCELERATED

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 2.5

Indicates that hardware is decoding and displaying the video.

This value is one of the possible values of the StageVideoEvent object status property.

Related API Elements

status

RENDER_STATUS_SOFTWARE

Constant

public static const RENDER_STATUS_SOFTWARE:String = "software"

Deprecated since Flash Player 10.2, AIR 3: Please Use flash.media.VideoStatus.SOFTWARE

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 2.5

Indicates that software is decoding and displaying the video.

This value is one of the possible values of the StageVideoEvent object status property.

For example, if the platform does not support hardware decoding and display of the audio or video codec of the video, the StageVideoEvent object has this status value.

Related API Elements

status

RENDER_STATUS_UNAVAILABLE

Constant

public static const RENDER_STATUS_UNAVAILABLE:String = "unavailable"

Deprecated since Flash Player 10.2, AIR 3: Please Use flash.media.VideoStatus.UNAVAILABLE

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 2.5

Indicates that displaying the video using the StageVideo object is not possible.

This value is one of the possible values of the StageVideoEvent object status property.

For example, consider a platform that does not support decoding and displaying the video's audio or video codec with either software or hardware. In this case, the StageVideoEvent object has this status value.

This status value also is used if no hardware decoders are available. This situation can occur in AIR for TV. For backward compatibility with its previous releases, AIR for TV allows you to use a Video object for hardware decoding and display. By using a Video object, you are using the underlying hardware decoder and therefore you have one less StageVideo object available for use. Note that using a StageVideo object for hardware video decoding and display is recommended.

Related API Elements

status

Legal Notices | Online Privacy Policy

StageVideoEvent - AS3

Classes x

colorSpace

status

StageVideoEvent

codecInfo

RENDER_STATE

RENDER_STATUS_ACCELERATED

RENDER_STATUS_SOFTWARE

RENDER_STATUS_UNAVAILABLE