StageVideoAvailabilityEvent

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

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10.2, AIR 3

This event fires when the state of the Stage.stageVideos property changes. This property can change when a user expands a video to full screen display from a wmode that does not support StageVideo (for example, wmode=normal, wmode=opaque, or wmode=transparent). Expanding to full screen can cause the Stage.stageVideos vector to become populated. Conversely, exiting full screen display can cause the Stage.stageVideos vector to become empty.

NOTE: This notification occurs only when the state of the Stage.stageVideos property changes. As a result, behavior may vary according to platform and browser. On Windows, for example, the stageVideoAvailability event is not dispatched when you go into full screen mode while wmode is set to direct. On some other platforms, however, the same behavior causes Flash Player to reallocate resources. In those cases, the Stage.stageVideos property state changes, and the event fires. You can detect changes to full screen mode by listening to the flash.events.FullScreenEvent event. This event is dispatched by the Stage object.

Learn more

Working with Video

Related API Elements

flash.events.StageVideoEvent
flash.media.StageVideoAvailability
flash.events.VideoEvent
flash.events.FullScreenEvent
flash.display.Stage.stageVideos
flash.events.FullScreenEvent
flash.media.Video
flash.net.NetStream

Public Properties

	Property		Defined By
		availability : String [read-only] Reports the current availability of stage video using a constant of the flash.media.StageVideoAvailability class.	StageVideoAvailabilityEvent
		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
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

	Method		Defined By
		StageVideoAvailabilityEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, availability:String = null) Constructor.	StageVideoAvailabilityEvent
		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
		driver : String	StageVideoAvailabilityEvent
		reason : String	StageVideoAvailabilityEvent
		STAGE_VIDEO_AVAILABILITY : String = "stageVideoAvailability" [static] Defines the value of the type property of a stageVideoAvailability event object.	StageVideoAvailabilityEvent

Property Detail

availability

property

availability:String [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10.2, AIR 3

Reports the current availability of stage video using a constant of the flash.media.StageVideoAvailability class.

Implementation
public function get availability():String

Constructor Detail