flash.events

# MediaEvent - AS3

Package | flash.events
Class | public class MediaEvent
Inheritance | MediaEvent Event Object

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2.5

CameraRoll and CameraUI classes dispatch MediaEvent objects when a media stream is available.

The CameraRoll class dispatches a `select`-type MediaEvent object when the user selects an image. The CameraUI class dispatches a `complete`-type MediaEvent object when an image or video captured from the device camera is returned.

Related API Elements

CameraRoll
CameraUI

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
|  | data : MediaPromise [read-only] The MediaPromise object for the available media file. | MediaEvent
|  | 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
--- | --- | ---
|  | MediaEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, data:MediaPromise = null) Creates an MediaEvent object that contains information about the available media file. | MediaEvent
|  | clone():Event [override] Creates a copy of an MediaEvent object and sets the value of each property to match that of the original. | MediaEvent
|  | 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 [override] Returns a string that contains all the properties of MediaEvent object. | MediaEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | COMPLETE : String = "complete" [static] A constant for the complete MediaEvent. | MediaEvent
|  | SELECT : String = "select" [static] A constant for the select MediaEvent. | MediaEvent

Property Detail

### data

property

`data:MediaPromise` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2.5

The MediaPromise object for the available media file.

Implementation
`public function get data():MediaPromise`
Constructor Detail

### MediaEvent

()
Constructor

`public function MediaEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, data:MediaPromise = null)`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2.5

Creates an MediaEvent object that contains information about the available media file. Event objects are passed as parameters to event listeners.

Parameters

| `type:String` — The type of the event.
| `bubbles:Boolean` (default = `false`)`` — Determines whether the Event object bubbles.
| `cancelable:Boolean` (default = `false`)`` — Determines whether the Event object can be canceled.
| `data:MediaPromise` (default = `null`)`` — The MediaPromise object corresponding to the selected image.

Method Detail

### clone

()
method

`override public function clone():Event`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2.5

Creates a copy of an MediaEvent object and sets the value of each property to match that of the original.

Returns

| `Event` — a new MediaEvent object with property values that match those of the original.

### toString

()
method

`override public function toString():String`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2.5

Returns a string that contains all the properties of MediaEvent object. The following format is used:

`[MediaEvent type=value bubbles=value cancelable=value data=value ]`

Returns

| `String` — a new MediaEvent object with property values that match those of the original.

Constant Detail

### COMPLETE

Constant

`public static const COMPLETE:String = "complete"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2.5

A constant for the `complete` MediaEvent.

Defines the value of the `type` property of a `MediaEvent` 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 object with an event listener.
`data` | The MediaPromise object of the available media instance.

### SELECT

Constant

`public static const SELECT:String = "select"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2.5

A constant for the `select` MediaEvent.

Defines the value of the `type` property of a `MediaEvent` 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 object with an event listener.
`data` | The MediaPromise object of the available media instance.

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