flash.events

# StageVideoAvailabilityEvent - AS3

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
Hide Inherited Public Properties
Show Inherited 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
Hide Inherited Public Methods
Show Inherited 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
Hide Inherited Public Constants
Show Inherited 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

### StageVideoAvailabilityEvent

()
Constructor

`public function StageVideoAvailabilityEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, availability: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: `StageVideoAvailabilityEvent.STAGE_VIDEO_AVAILABILITY`.
| `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.
| `availability:String` (default = `null`)`` — The current availability of stage video.

Constant Detail

### driver

Constant

`public const driver:String`

### reason

Constant

`public const reason:String`

### STAGE_VIDEO_AVAILABILITY

Constant

`public static const STAGE_VIDEO_AVAILABILITY:String = "stageVideoAvailability"`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10.2, AIR 3

Defines the value of the `type` property of a `stageVideoAvailability` event object.

This event has the following properties:

Property | Value
--- | ---
`availability` | The status reported by the event.
`bubbles` | `false`
`cancelable` | `false`; there is no default behavior to cancel.
`currentTarget` | The object that is actively processing the event.
`target` | The Stage object reporting on the availability of stage video.

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