flash.events

# ActivityEvent - AS3

Package | flash.events
Class | public class ActivityEvent
Inheritance | ActivityEvent Event Object
Subclasses | FullScreenEvent

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9

A Camera or Microphone object dispatches an ActivityEvent object whenever a camera or microphone reports that it has become active or inactive. There is only one type of activity event: `ActivityEvent.ACTIVITY`.

View the examples

Related API Elements

ActivityEvent.ACTIVITY

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | activating : Boolean Indicates whether the device is activating (true) or deactivating (false). | ActivityEvent
|  | 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
--- | --- | ---
|  | ActivityEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, activating:Boolean = false) Creates an event object that contains information about activity events. | ActivityEvent
|  | clone():Event [override] Creates a copy of an ActivityEvent object and sets the value of each property to match that of the original. | ActivityEvent
|  | 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 the ActivityEvent object. | ActivityEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | ACTIVITY : String = "activity" [static] The ActivityEvent.ACTIVITY constant defines the value of the type property of an activity event object. | ActivityEvent

Property Detail

### activating

property

`activating:Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9

Indicates whether the device is activating (`true`) or deactivating (`false`).

Implementation
`public function get activating():Boolean`
`public function set activating(value:Boolean):void`
Constructor Detail

### ActivityEvent

()
Constructor

`public function ActivityEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, activating:Boolean = false)`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9

Creates an event object that contains information about activity 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. There is only one type of activity event: `ActivityEvent.ACTIVITY`.
| `bubbles:Boolean` (default = `false`)`` — Determines whether the Event object participates in the bubbling phase 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.
| `activating:Boolean` (default = `false`)`` — Indicates whether the device is activating (`true`) or deactivating (`false`). Event listeners can access this information through the `activating` property.

Related API Elements

ActivityEvent.ACTIVITY
Method Detail

### clone

()
method

`override public function clone():Event`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9

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

Returns

| `Event` — A new ActivityEvent 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 1.0, Flash Player 9

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

`[ActivityEvent type=value bubbles=value cancelable=value activating=value]`

Returns

| `String` — A string that contains all the properties of the ActivityEvent object.

Constant Detail

### ACTIVITY

Constant

`public static const ACTIVITY:String = "activity"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9

The `ActivityEvent.ACTIVITY` constant defines the value of the `type` property of an `activity` event object.

This event has the following properties:

Property | Value
--- | ---
`activating` | `true` if the device is activating or `false` if it is deactivating.
`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.
`target` | The object beginning or ending a session, such as a Camera or Microphone object.

Related API Elements

flash.media.Camera.activity
flash.media.Microphone.activity
Examples How to use this example
ActivityEventExample.as
The following example demonstrates the use of the ActivityEvent class by attaching an event listener method named `activityHandler()` to the microphone and generating text information every time the microphone generates an `activity` event.
Copy

    package {
        import flash.display.Sprite;
        import flash.events.ActivityEvent;
        import flash.media.Microphone;

        public class ActivityEventExample extends Sprite {
            public function ActivityEventExample() {
                var mic:Microphone = Microphone.getMicrophone();
                mic.addEventListener(ActivityEvent.ACTIVITY, activityHandler);
            }

            private function activityHandler(event:ActivityEvent):void {
                trace("event: " + event);
                trace("event.activating: " + event.activating);
            }
        }
    }

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