BETA ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Hide Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes

Language Reference only
Filters: AIR 32.0 and earlier, Flash Player 32.0 and earlier, Flash Lite 4
None
Hide Filters
flash.events 

MediaEvent  - AS3

(Beta)
Packageflash.events
Classpublic class MediaEvent
InheritanceMediaEvent Inheritance Event Inheritance 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
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : 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
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined 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
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
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
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
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
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined 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:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
dataThe 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:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
dataThe MediaPromise object of the available media instance.




© 2015 Adobe Systems Incorporated. All rights reserved.
Wed Nov 21 2018, 06:34 AM -08:00
 
[an error occurred while processing this directive]

 

Legal Notices | Online Privacy Policy