mx.effects.SoundEffect (Flex 3.2)

constructor : Object

对类对象或给定对象实例的构造函数的引用。

customFilter : EffectTargetFilter

指定一个 EffectTargetFilter 类型的自定义滤镜对象，效果将使用此对象来确定播放效果的目标。

duration : Number

效果的持续时间（以毫秒为单位）。

effectTargetHost : IEffectTargetHost

一个属性，您可以通过设置此属性访问数据效果基于列表的目标控件。

filter : String

指定用于过滤效果目标的算法。

hideFocusRing : Boolean

确定在开始播放效果时，效果是否应隐藏对焦环。

instanceClass : Class

一个 Class 类型的对象，用于指定此效果类的效果实例类。

isLoading : Boolean

[只读 (read-only)] 如果已加载 MP3，则此属性为 true。

SoundEffect

isPlaying : Boolean

[只读 (read-only)] 一个只读标志，如果当前正在播放效果的任一实例，则为 true；否则，则为 false。

loops : int = 0

循环模式下播放该声音的次数，其中值 0 表示此效果播放一次，值 1 表示此效果播放两次，依此类推。

SoundEffect

panEasingFunction : Function

均衡效果的缓动函数。

SoundEffect

panFrom : Number

Sound 对象的初始平移。

SoundEffect

panTo : Number

Sound 对象的最终平移。

SoundEffect

perElementOffset : Number

在效果的第一个目标之后，其它效果目标的附加延迟（以毫秒为单位）。

prototype : Object

[静态] 对类或函数对象的原型对象的引用。

relevantProperties : Array

一个属性名称 Array，执行过滤时将使用这些名称。

relevantStyles : Array

一个样式名称 Array，执行过滤时将使用这些名称。

repeatCount : int = 1

效果的重复次数。

repeatDelay : int = 0

重复播放效果前需要等待的时间（以毫秒为单位）。

sound : Sound

[只读 (read-only)] 已加载 MP3 文件的 Sound 对象。

SoundEffect

source : Object

要播放的 MP3 文件的 URL 或类。

SoundEffect

startDelay : int = 0

开始播放效果前需要等待的时间（以毫秒为单位）。

startTime : Number = 0

MP3 文件中的初始位置（以毫秒为单位），应在此位置开始回放。

SoundEffect

suspendBackgroundProcessing : Boolean = false

如果为 true，则在播放效果时阻止所有背景处理。

target : Object

要应用此效果的 UIComponent 对象。

targets : Array

一个 UIComponent 对象 Array，这些对象都是效果的目标。

triggerEvent : Event

如果触发了某个效果，则此项目是由 EffectManager 传递给此 Effect 的 Event 对象；如果 EffectManager 当前没有播放此效果，则为 null。

volumeEasingFunction : Function

useDuration : Boolean = true

如果为 true，则会在 duration 属性中指定的时间过后停止效果。

SoundEffect

音量效果的缓动函数。

SoundEffect

volumeFrom : Number

Sound 对象的初始音量。

SoundEffect

volumeTo : Number

Sound 对象的最终音量。

SoundEffect

	属性	定义方
		endValuesCaptured : Boolean = false 一个标志，如果已确定效果的结束值，则该标志中包含 true；如果需要在效果运行时从效果目标的当前属性捕获这些值，则其中包含 false。	Effect

属性

定义方

endValuesCaptured : Boolean = false

一个标志，如果已确定效果的结束值，则该标志中包含 true；如果需要在效果运行时从效果目标的当前属性捕获这些值，则其中包含 false。

	方法	定义方
		SoundEffect(target:Object = null) 构造函数。	SoundEffect
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。	EventDispatcher
		captureEndValues():void 捕获效果目标上相关属性的当前值，并将这些值另存为结束值。	Effect
		captureMoreStartValues(targets:Array):void 捕获另一组目标相关属性的当前值。在运行数据更改效果时，此函数由 Flex 使用。	Effect
		captureStartValues():void 捕获效果目标上相关属性的当前值。	Effect
		createInstance(target:Object = null):IEffectInstance 创建一个效果实例并对其进行初始化。	Effect
		createInstances(targets:Array = null):Array 获取一个目标对象 Array，并对每个目标调用 createInstance() 方法。	Effect
		deleteInstance(instance:IEffectInstance):void 删除实例中的事件侦听器，然后从实例列表中删除该实例。	Effect
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	EventDispatcher
		end(effectInstance:IEffectInstance = null):void 中断当前正在播放的效果，立即跳转到该效果的末尾。	Effect
		getAffectedProperties():Array 返回一个字符串 Array，其中每个 String 都是被此效果更改的属性名称。	Effect
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	EventDispatcher
		hasOwnProperty(name:String):Boolean 指示对象是否已经定义了指定的属性。	Object
		isPrototypeOf(theClass:Object):Boolean 指示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		load():void 如果 source 属性指向 URL，则加载 MP3。	SoundEffect
		pause():void 暂停效果，直到调用 resume() 方法。	Effect
		play(targets:Array = null, playReversedFromEnd:Boolean = false):Array 开始播放效果。	Effect
		propertyIsEnumerable(name:String):Boolean 指示指定的属性是否存在、是否可枚举。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	EventDispatcher
		resume():void 在效果由 pause() 方法暂停后继续播放效果。	Effect
		reverse():void 逆序播放效果；如果当前正在播放效果，则从该效果的当前位置开始逆序播放。	Effect
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		stop():void 停止播放效果，使效果目标保持当前状态。	Effect
		toString():String 返回指定对象的字符串表示形式。	Object
		valueOf():Object 返回指定对象的原始值。	Object
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何始祖为指定事件类型注册了事件侦听器。	EventDispatcher

方法

定义方

SoundEffect(target:Object = null)

构造函数。

SoundEffect

addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。

captureEndValues():void

捕获效果目标上相关属性的当前值，并将这些值另存为结束值。

captureMoreStartValues(targets:Array):void

捕获另一组目标相关属性的当前值。在运行数据更改效果时，此函数由 Flex 使用。

captureStartValues():void

捕获效果目标上相关属性的当前值。

createInstance(target:Object = null):IEffectInstance

创建一个效果实例并对其进行初始化。

createInstances(targets:Array = null):Array

获取一个目标对象 Array，并对每个目标调用 createInstance() 方法。

deleteInstance(instance:IEffectInstance):void

删除实例中的事件侦听器，然后从实例列表中删除该实例。

dispatchEvent(event:Event):Boolean

将事件调度到事件流中。

end(effectInstance:IEffectInstance = null):void

中断当前正在播放的效果，立即跳转到该效果的末尾。

getAffectedProperties():Array

返回一个字符串 Array，其中每个 String 都是被此效果更改的属性名称。

hasEventListener(type:String):Boolean

检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。

hasOwnProperty(name:String):Boolean

指示对象是否已经定义了指定的属性。

isPrototypeOf(theClass:Object):Boolean

指示 Object 类的实例是否在指定为参数的对象的原型链中。

load():void

如果 source 属性指向 URL，则加载 MP3。

SoundEffect

pause():void

暂停效果，直到调用 resume() 方法。

play(targets:Array = null, playReversedFromEnd:Boolean = false):Array

开始播放效果。

propertyIsEnumerable(name:String):Boolean

指示指定的属性是否存在、是否可枚举。

removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

从 EventDispatcher 对象中删除侦听器。

resume():void

在效果由 pause() 方法暂停后继续播放效果。

reverse():void

逆序播放效果；如果当前正在播放效果，则从该效果的当前位置开始逆序播放。

setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void

设置循环操作动态属性的可用性。

stop():void

停止播放效果，使效果目标保持当前状态。

返回指定对象的字符串表示形式。

返回指定对象的原始值。

willTrigger(type:String):Boolean

检查是否用此 EventDispatcher 对象或其任何始祖为指定事件类型注册了事件侦听器。

	方法	定义方
		applyValueToTarget(target:Object, property:String, value:*, props:Object):void 供 Effect 基础结构内部使用。	Effect
		effectEndHandler(event:EffectEvent):void 当效果实例完成播放时调用。	Effect
		effectStartHandler(event:EffectEvent):void 当效果实例开始播放时调用此方法。	Effect
		filterInstance(propChanges:Array, target:Object):Boolean 确定筛选效果实例所用的逻辑。	Effect
		getValueFromTarget(target:Object, property:String):* 由 captureStartValues() 方法调用，用来从目标获得某个属性的值。	Effect
		initInstance(instance:IEffectInstance):void 将效果的属性复制到效果实例。	Effect

方法

定义方

applyValueToTarget(target:Object, property:String, value:*, props:Object):void

供 Effect 基础结构内部使用。

effectEndHandler(event:EffectEvent):void

当效果实例完成播放时调用。

effectStartHandler(event:EffectEvent):void

当效果实例开始播放时调用此方法。

filterInstance(propChanges:Array, target:Object):Boolean

确定筛选效果实例所用的逻辑。

getValueFromTarget(target:Object, property:String):*

由 captureStartValues() 方法调用，用来从目标获得某个属性的值。

initInstance(instance:IEffectInstance):void

将效果的属性复制到效果实例。

摘要	定义方
activate	[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。	EventDispatcher
complete	当声音文件完成加载时调度。	SoundEffect
deactivate	[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。	EventDispatcher
effectEnd	当效果完成播放时（既可以是效果实际完成播放时，也可以是通过调用 end() 方法中断效果时）调度。	Effect
effectStart	当效果开始播放时调度。	Effect
id3	当 ID3 数据可用于 MP3 声音文件时调度。	SoundEffect
ioError	在加载声音文件期间发生错误时调度。	SoundEffect
progress	加载声音文件时定期调度。	SoundEffect

事件

摘要

定义方

activate

[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。

complete

当声音文件完成加载时调度。

SoundEffect

deactivate

[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。