flash.events

# ThrottleType - AS3

Package | flash.events
Class | public final class ThrottleType
Inheritance | ThrottleType Object

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 11, AIR 3.2

The ThrottleType class provides values for the playback `state` property of the flash.event.ThrottleEvent class.

The platforms that support throttling and pausing are currently the following: Flash Player Desktop Mac and Windows, AIR Mobile, and Flash Player Android. The following platforms do not dispatch the ThrottleEvent automatically because they do not yet support pausing or throttling: AIR for TV devices, AIR for desktop, and Flash Player Linux Desktop.

Related API Elements

flash.events.ThrottleEvent

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | 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
|  | 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
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants

| Constant | Defined By
--- | --- | ---
|  | PAUSE : String = "pause" [static] This constant is used for the status property in the ThrottleEvent class. | ThrottleType
|  | RESUME : String = "resume" [static] This constant is used for the status property in the ThrottleEvent class. | ThrottleType
|  | THROTTLE : String = "throttle" [static] This constant is used for the state property in the ThrottleEvent class. | ThrottleType

Constant Detail

### PAUSE

Constant

`public static const PAUSE:String = "pause"`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 11, AIR 3.2

This constant is used for the `status` property in the ThrottleEvent class. Use the syntax `ThrottleType.PAUSE`.

Related API Elements

flash.events.ThrottleEvent

### RESUME

Constant

`public static const RESUME:String = "resume"`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 11, AIR 3.2

This constant is used for the `status` property in the ThrottleEvent class. Use the syntax `ThrottleType.RESUME`.

Related API Elements

flash.events.ThrottleEvent

### THROTTLE

Constant

`public static const THROTTLE:String = "throttle"`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 11, AIR 3.2

This constant is used for the `state` property in the ThrottleEvent class. Use the syntax `ThrottleType.THROTTLE`.

Related API Elements

flash.events.ThrottleEvent

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