ThrottleEvent

包	flash.events
类	public class ThrottleEvent
继承	ThrottleEvent Event Object

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 11, AIR 3.2

当 Flash Player 节流、暂停或恢复播放内容时调度 ThrottleEvent。只有一种类型的 ThrottleEvent 事件：ThrottleEvent.THROTTLE。

此事件为广播事件，这意味着将由所有具有注册了此事件的侦听器的 EventDispatcher 对象调度此事件。有关广播事件的详细信息，请参阅 DisplayObject 类。

注意：此事件既不具有“捕获阶段”也不具有“冒泡阶段”，这意味着必须直接将事件侦听器添加到任何潜在的目标，而无论目标是否位于显示列表中。

Flash Player 可将内容节流到较低的帧速率（意味着帧速率减小到通常介于 2 至 8 fps 之间的值）。当隐藏或最小化内容的选项卡时可节流内容。在移动设备上，当背景灯熄灭或进入屏幕保护程序模式时，可节流内容。在节流内容之前，使用 ThrottleEvent.state=ThrottleType.THROTTLE 调度一个 ThrottleEvent。ThrottleEvent.targetFrameRate 属性包含新目标帧速率的值。

内容可在事件侦听器中运行代码从而为节流做好准备。借此可提醒外部内容，被节流的内容将更少有响应。例如，可能会取消活动的 FileReference.upload() 或 FileReference.download() 方法。或者，如果内容通过 LocalConnection 与另一个 SWF 进行通信，则借此可通知 SWF 期望更少的响应性。请注意，在进入节流之前，被节流的内容可能无法完成异步操作。当事件侦听器返回时，内容进入节流状态。

Flash Player 可能会暂停内容。例如，当无音频或正在播放视频时，每次移动设备上的内容滚动到屏幕以外，都可能会暂停内容。在暂停内容之前，将使用 ThrottleEvent.state=ThrottleType.PAUSE 和 ThrottleEvent.targetFrameRate=0 调度一个 ThrottleEvent。类似于当内容收到 ThrottleType.THROTTLE 事件时，内容可能会在事件侦听器中运行代码以为暂停做好准备。当事件侦听器返回时，内容进入暂停状态。暂停时，内容不会对用户交互作出响应，如鼠标单击或键盘输入。但是，仍能收到 ActionScript 网络事件。

当 Flash Player 从节流或暂停状态恢复内容时，使用 ThrottleEvent.state=ThrottleType.RESUME 调度一个 ThrottleEvent。ThrottleEvent.targetFrameRate 描述帧速率，通常等于 Stage.frameRate。当舞台的任何部分变为可见或者当用户请求恢复内容时，可能会恢复内容。

目前以下平台支持节流和暂停：Flash Player Desktop Mac 和 Windows、AIR Mobile 以及 Flash Player Android。以下平台不会自动调度 ThrottleEvent，因为它们尚不支持暂停或节流：AIR for TV 设备、用于台式机的 AIR 以及 Flash Player Linux Desktop。

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		bubbles : Boolean [只读] 表示事件是否为冒泡事件。	Event
		cancelable : Boolean [只读] 表示是否可以阻止与事件相关联的行为。	Event
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		currentTarget : Object [只读] 当前正在使用某个事件侦听器处理 Event 对象的对象。	Event
		eventPhase : uint [只读] 事件流中的当前阶段。	Event
		state : String [只读] 描述播放器正在进入的状态：ThrottleType.THROTTLE、ThrottleType.PAUSE 或 ThrottleType.RESUME。	ThrottleEvent
		target : Object [只读] 事件目标。	Event
		targetFrameRate : Number [只读] 在调度了 ThrottleEvent 之后 Flash Player 或 AIR 将使用的目标帧速率。	ThrottleEvent
		type : String [只读] 事件的类型。	Event

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		ThrottleEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, state:String = null, targetFrameRate:Number = 0) 创建一个 Event 对象，其中包含有关 ThrottleEvent 的信息。	ThrottleEvent
		clone():Event [覆盖] 创建 ThrottleEvent 对象的副本，并将每个属性的值设置为与原始属性值相匹配。	ThrottleEvent
		formatToString(className:String, ... arguments):String 用于在自定义 ActionScript 3.0 Event 类中实现 toString() 方法的实用程序函数。	Event
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		isDefaultPrevented():Boolean 检查是否已对事件调用 preventDefault() 方法。	Event
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		preventDefault():void 如果可以取消事件的默认行为，则取消该行为。	Event
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		stopImmediatePropagation():void 防止对事件流中当前节点中和所有后续节点中的事件侦听器进行处理。	Event
		stopPropagation():void 防止对事件流中当前节点的后续节点中的所有事件侦听器进行处理。	Event
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String [覆盖] 返回一个字符串，其中包含 ThrottleEvent 对象的所有属性。	ThrottleEvent
		valueOf():Object 返回指定对象的原始值。	Object

公共常量

隐藏继承的公共常量

显示继承的公共常量

	常量		由以下参数定义
		THROTTLE : String = "throttle" [静态] 定义 ThrottleEvent 事件对象的 type 属性值。	ThrottleEvent

属性详细信息

state

属性

state:String [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 11, AIR 3.2

描述播放器正在进入的状态：ThrottleType.THROTTLE、ThrottleType.PAUSE 或 ThrottleType.RESUME。

实现
public function get state():String

相关 API 元素

flash.events.ThrottleType

targetFrameRate

属性

targetFrameRate:Number [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 11, AIR 3.2

在调度了 ThrottleEvent 之后 Flash Player 或 AIR 将使用的目标帧速率。

例如，如果内容处于暂停状态，targetFrameRate 为 0。如果内容处于节流状态，则 targetFrameRate 通常介于 2 至 8 之间，具体取决于运行内容的是什么平台、是否正在播放音频以及其他因素。如果在节流或暂停之后内容返回到预期帧速率，则 targetFrameRate 将等于 Stage.frameRate。

实现
public function get targetFrameRate():Number

相关 API 元素

flash.display.Stage

构造函数详细信息

()

构造函数

public function ThrottleEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, state:String = null, targetFrameRate:Number = 0)

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 11, AIR 3.2

创建一个 Event 对象，其中包含有关 ThrottleEvent 的信息。将 Event 对象作为参数传递给事件侦听器。

参数

	`type:String` — 事件的类型。事件侦听器可以通过继承的 `type` 属性访问此信息。只有一种类型的 ThrottleEvent 事件：`ThrottleEvent.THROTTLE`。

	`bubbles:Boolean` (default = `false`) — 确定 Event 对象是否参与事件流的冒泡阶段。事件侦听器可以通过继承的 `bubbles` 属性访问此信息。

	`cancelable:Boolean` (default = `false`) — 确定是否可以取消 Event 对象。事件侦听器可以通过继承的 `cancelable` 属性访问此信息。

	`state:String` (default = `null`) — `ThrottleType.THROTTLE`、`ThrottleType.PAUSE` 或 `ThrottleType.RESUME`。

	`targetFrameRate:Number` (default = `0`) — 描述在调度了 ThrottleEvent 之后 Flash Player 或 AIR 将使用的目标帧速率。例如，如果内容处于暂停状态，`targetFrameRate` 为 0。如果内容处于节流状态，则 `targetFrameRate` 通常介于 2 至 8 之间，具体取决于运行内容的是什么平台、是否正在播放音频以及其他因素。如果在暂停或节流之后内容返回到预期帧速率，则 `targetFrameRate` 等于·`Stage.frameRate`。

相关 API 元素

flash.display.Stage

方法详细信息

clone

()

方法

override public function clone():Event

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 11, AIR 3.2

创建 ThrottleEvent 对象的副本，并将每个属性的值设置为与原始属性值相匹配。

Event — 其属性值与原始属性值匹配的新 ThrottleEvent 对象。

toString

()

方法

override public function toString():String

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 11, AIR 3.2

返回一个字符串，其中包含 ThrottleEvent 对象的所有属性。字符串的格式如下：

[ThrottleEvent type=value bubbles=value cancelable=value state=value targetFrameRate=value]

String — 一个字符串，其中包含 ThrottleEvent 对象的所有属性。

常量详细信息

THROTTLE

常量

public static const THROTTLE:String = "throttle"

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 11, AIR 3.2

定义 ThrottleEvent 事件对象的 type 属性值。

此事件具有以下属性：

属性	值
`bubbles`	`false`
`cancelable`	`false`；没有要取消的默认行为。
`currentTarget`	当前正在使用某个事件侦听器处理 Event 对象的对象。
`target`	具有注册了 throttle 事件侦听器的任何 DisplayObject 实例。
`state`	ThrottleType.THROTTLE、ThrottleType.PAUSE 或 ThrottleType.RESUME。
`targetFrameRate`	描述在调度了 ThrottleEvent 之后 Flash Player 或 AIR 将使用的目标帧速率。例如，如果内容处于暂停状态，则 targetFrameRate 将为 0。如果内容处于节流状态，则 targetFrameRate 通常介于 2 至 8 之间，具体取决于运行内容的平台、是否正在播放音频以及其他因素。如果在暂停或节流之后内容返回到预期帧速率，则 targetFrameRate 等于 Stage.frameRate。

相关 API 元素

flash.display.Stage

法律声明 | 在线隐私策略

ThrottleEvent - AS3

类 x

state

targetFrameRate

ThrottleEvent

clone

toString

THROTTLE