| 套件 | mx.effects |
| 類別 | public class SoundEffect |
| 繼承 | SoundEffect  Effect EventDispatcher Object |
| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
You specify the MP3 file using the source property.
If you have already embedded the MP3 file, using the Embed
keyword, you can pass the Class object of the MP3 file to the
source property.
Otherwise, specify the full URL to the MP3 file.
顯示 MXML 語法
隱藏 MXML 語法The <mx:SoundEffect> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<mx:SoundEffect
Properties
id="ID"
autoLoad="true|false"
bufferTime="1000"
loops="0"
panEasingFunction=""
panFrom="0"
source=""
startTime="0"
useDuration="true|false"
volumeEasingFunction="true|false"
volumeTo="1"
Events
complete="No default"
id3="No default"
ioError="No default"
progress="No default"
/>
相關 API 元素
| 屬性 | 定義自 | ||
|---|---|---|---|
| autoLoad : Boolean
If true, load the MP3 file
when the source has been specified. | SoundEffect | ||
| bufferTime : Number = 1000
The SoundEffect class uses an internal Sound object to control
the MP3 file. | SoundEffect | ||
 | className : String [唯讀]
The name of the effect class, such as "Fade". | Effect | |
| constructor : Object
類別物件的參照或是特定物件實體的建構函數。 | Object | |
| customFilter : mx.effects:EffectTargetFilter
Specifies a custom filter object, of type EffectTargetFilter,
used by the effect to determine the targets
on which to play the effect. | Effect | |
| duration : Number
Duration of the effect in milliseconds. | Effect | |
| effectTargetHost : mx.effects:IEffectTargetHost
A property that lets you access the target list-based control
of a data effect. | Effect | |
| filter : String
Specifies an algorithm for filtering targets for an effect. | Effect | |
| hideFocusRing : Boolean
Determines whether the effect should hide the focus ring
when starting the effect. | Effect | |
| instanceClass : Class
An object of type Class that specifies the effect
instance class class for this effect class. | Effect | |
| isLoading : Boolean [唯讀]
This property is true if the MP3 has been loaded. | SoundEffect | ||
| isPlaying : Boolean [唯讀]
A read-only flag which is true if any instances of the effect
are currently playing, and false if none are. | Effect | |
| loops : int = 0
The number of times to play the sound in a loop, where a value of
0 means play the effect once, a value of 1 means play the effect twice,
and so on. | SoundEffect | ||
| panEasingFunction : Function
The easing function for the pan effect. | SoundEffect | ||
| panFrom : Number
Initial pan of the Sound object. | SoundEffect | ||
| panTo : Number
Final pan of the Sound object. | SoundEffect | ||
| perElementOffset : Number
Additional delay, in milliseconds, for effect targets
after the first target of the effect. | Effect | |
| playheadTime : Number
Current time position of the effect. | Effect | |
| relevantProperties : Array
An Array of property names to use when performing filtering. | Effect | |
| relevantStyles : Array
An Array of style names to use when performing filtering. | Effect | |
| repeatCount : int = 1
Number of times to repeat the effect. | Effect | |
| repeatDelay : int = 0
Amount of time, in milliseconds, to wait before repeating the effect. | Effect | |
| sound : Sound [唯讀]
The Sound object that the MP3 file has been loaded into. | SoundEffect | ||
| source : Object
The URL or class of the MP3 file to play. | SoundEffect | ||
| startDelay : int = 0
Amount of time, in milliseconds, to wait before starting the effect. | Effect | |
| startTime : Number = 0
The initial position in the MP3 file, in milliseconds,
at which playback should start. | SoundEffect | ||
| suspendBackgroundProcessing : Boolean = false
If true, blocks all background processing
while the effect is playing. | Effect | |
| target : Object
The object to which this effect is applied. | Effect | |
| targets : Array
An Array of objects that are targets for the effect. | Effect | |
| triggerEvent : Event
The Event object passed to this Effect
by the EffectManager when an effect is triggered,
or null if the effect is not being
played by the EffectManager. | Effect | |
| useDuration : Boolean = true
If true, stop the effect
after the time specified by the duration
property has elapsed. | SoundEffect | ||
| volumeEasingFunction : Function
The easing function for the volume effect. | SoundEffect | ||
| volumeFrom : Number
Initial volume of the Sound object. | SoundEffect | ||
| volumeTo : Number
Final volume of the Sound object. | SoundEffect | ||
| 方法 | 定義自 | ||
|---|---|---|---|
SoundEffect(target:Object = null)
Constructor. | SoundEffect | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
會在 EventDispatcher 物件註冊事件偵聽程式，以便讓偵聽程式收到事件的通知。 | EventDispatcher | |
|
Captures the current values of the relevant properties
on the effect's targets and saves them as end values. | Effect | |
|
Captures the current values of the relevant properties
of an additional set of targets
Flex uses this function when a data change
effect is run.
| Effect | |
|
Captures the current values of the relevant properties
on the effect's targets. | Effect | |
|
Creates a single effect instance and initializes it. | Effect | |
|
Takes an Array of target objects and invokes the
createInstance() method on each target. | Effect | |
|
Removes event listeners from an instance
and removes it from the list of instances. | Effect | |
|
會將事件傳送到事件流程。 | EventDispatcher | |
|
Interrupts an effect that is currently playing,
and jumps immediately to the end of the effect. | Effect | |
|
Returns an Array of Strings, where each String is the name
of a property changed by this effect. | Effect | |
|
會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。 | EventDispatcher | |
|
指出物件是否有已定義的指定屬性。 | Object | |
|
指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。 | Object | |
Loads the MP3 if the source property points to a URL. | SoundEffect | ||
|
Pauses the effect until you call the resume() method. | Effect | |
|
Begins playing the effect. | Effect | |
|
指出指定的屬性是否存在，以及是否可列舉。 | Object | |
|
會從 EventDispatcher 物件移除偵聽程式。 | EventDispatcher | |
|
Resumes the effect after it has been paused
by a call to the pause() method. | Effect | |
|
Plays the effect in reverse, if the effect is currently playing,
starting from the current position of the effect. | Effect | |
|
為迴圈作業設定動態屬性的可用性。 | Object | |
|
Stops the effect, leaving the effect targets in their current state. | Effect | |
|
傳回代表此物件的字串，根據地區特定慣例進行格式化。 | Object | |
|
會傳回指定之物件的字串形式。 | Object | |
|
會傳回指定之物件的基本值。 | Object | |
|
檢查此 EventDispatcher 物件是否已註冊事件偵聽程式，或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。 | EventDispatcher | |
| 事件 | 摘要 | 定義自 | ||
|---|---|---|---|---|
| [廣播事件] 當 Flash Player 或 AIR 應用程式取得作業系統焦點並成為作用中時傳送。 | EventDispatcher | ||
| Dispatched when the sound file finishes loading. | SoundEffect | |||
| [廣播事件] 當 Flash Player 或 AIR 應用程式失去作業系統焦點並成為非作用中時傳送。 | EventDispatcher | ||
| Dispatched when one of the effect's instances finishes playing, either when the instance finishes playing or when the effect is interrupted by a call to the end() method. | Effect | ||
| Dispatched when the effect starts playing. | Effect | ||
| Dispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method. | Effect | ||
| Dispatched when ID3 data is available for an MP3 sound file. | SoundEffect | |||
| Dispatched when an error occurs during the loading of the sound file. | SoundEffect | |||
| Dispatched periodically as the sound file loads. | SoundEffect | |||
autoLoad | 屬性 |
bufferTime | 屬性 |
public var bufferTime:Number = 1000| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
The SoundEffect class uses an internal Sound object to control the MP3 file. This property specifies the minimum number of milliseconds worth of sound data to hold in the Sound object's buffer. The Sound object waits until it has at least this much data before beginning playback, and before resuming playback after a network stall.
預設值為 1000。
isLoading | 屬性 |
loops | 屬性 |
public var loops:int = 0| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
The number of times to play the sound in a loop, where a value of
0 means play the effect once, a value of 1 means play the effect twice,
and so on. If you repeat the MP3 file, it still uses the setting of the
useDuration property to determine the playback time.
The duration property takes precedence
over this property.
If the effect duration is not long enough to play the sound
at least once, the sound does not loop.
預設值為 0。
panEasingFunction | 屬性 |
public var panEasingFunction:Function| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
The easing function for the pan effect.
Use this function to interpolate between the values
of panFrom and panTo.
panFrom | 屬性 |
public var panFrom:Number| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Initial pan of the Sound object. The value can range from -1.0 to 1.0, where -1.0 uses only the left channel, 1.0 uses only the right channel, and 0.0 balances the sound evenly between the two channels.
預設值為 0.0。
panTo | 屬性 |
public var panTo:Number| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Final pan of the Sound object. The value can range from -1.0 to 1.0, where -1.0 uses only the left channel, 1.0 uses only the right channel, and 0.0 balances the sound evenly between the two channels.
預設值為 0.0。
sound | 屬性 |
source | 屬性 |
source:Object| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
The URL or class of the MP3 file to play.
If you have already embedded the MP3 file, using the Embed keyword,
you can pass the Class object of the MP3 file to the source property.
Otherwise, specify the full URL to the MP3 file.
實作
public function get source():Object public function set source(value:Object):voidstartTime | 屬性 |
public var startTime:Number = 0| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
The initial position in the MP3 file, in milliseconds, at which playback should start.
預設值為 0。
useDuration | 屬性 |
public var useDuration:Boolean = true| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
If true, stop the effect
after the time specified by the duration
property has elapsed.
If false, stop the effect
after the MP3 finishes playing or looping.
預設值為 true。
volumeEasingFunction | 屬性 |
public var volumeEasingFunction:Function| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
The easing function for the volume effect.
This function is used to interpolate between the values
of volumeFrom and volumeTo.
volumeFrom | 屬性 |
public var volumeFrom:Number| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Initial volume of the Sound object. Value can range from 0.0 to 1.0.
預設值為 1。
volumeTo | 屬性 |
public var volumeTo:Number| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Final volume of the Sound object. Value can range from 0.0 to 1.0.
預設值為 1。
SoundEffect | () | 建構函式 |
load | () | 方法 |
public function load():void| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Loads the MP3 if the source property points to a URL.
complete | 事件 |
flash.events.Event屬性 Event.type =
flash.events.Event.COMPLETE| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Dispatched when the sound file finishes loading.
Event.COMPLETE 常數會定義 complete 事件物件的 type 屬性值。
這個事件具有下列屬性：
| 屬性 | 值 |
|---|---|
bubbles | false |
cancelable | false；沒有要取消的預設行為指令。 |
currentTarget | 正主動使用事件偵聽程式處理 Event 物件的物件。 |
target | 已完成載入的網路物件。 |
id3 | 事件 |
flash.events.Event屬性 Event.type =
flash.events.Event.ID3| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Dispatched when ID3 data is available for an MP3 sound file.
Event.ID3 常數會定義 id3 事件物件的 type 屬性值。
這個事件具有下列屬性：
| 屬性 | 值 |
|---|---|
bubbles | false |
cancelable | false；沒有要取消的預設行為指令。 |
currentTarget | 正主動使用事件偵聽程式處理 Event 物件的物件。 |
target | 載入目前可使用 ID3 資料之 MP3 的 Sound 物件。 target 不會永遠都是顯示清單中註冊事件偵聽程式的物件。 請使用 currentTarget 屬性，存取目前正在處理該事件之顯示清單中的物件。 |
ioError | 事件 |
flash.events.IOErrorEvent屬性 IOErrorEvent.type =
flash.events.IOErrorEvent.IO_ERROR| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Dispatched when an error occurs during the loading of the sound file.
定義ioError 事件物件的 type 屬性值。
這個事件具有下列屬性：
| 屬性 | 值 |
|---|---|
bubbles | false |
cancelable | false；沒有要取消的預設行為指令。 |
currentTarget | 正主動使用事件偵聽程式處理 Event 物件的物件。 |
errorID | 與特定錯誤相關聯的參考號碼 (僅限 AIR)。 |
target | 遭遇輸入/輸出錯誤的網路物件。 |
text | 要顯示為錯誤訊息的文字。 |
progress | 事件 |
flash.events.ProgressEvent屬性 ProgressEvent.type =
flash.events.ProgressEvent.PROGRESS| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Dispatched periodically as the sound file loads.
Within the event object, you can access the number of bytes
currently loaded and the total number of bytes to load.
The event is not guaranteed to be dispatched, which means that
the complete event might be dispatched
without any progress events being dispatched.
progress 事件物件的 type 屬性值。
這個事件具有下列屬性：
| 屬性 | 值 |
|---|---|
bubbles | false |
bytesLoaded | 在偵聽程式處理事件時，載入的項目或位元組數目。 |
bytesTotal | 如果載入程序成功時，最終將載入的項目或位元組總數。 |
cancelable | false；沒有要取消的預設行為指令。 |
currentTarget | 正主動使用事件偵聽程式處理 Event 物件的物件。 |
target | 回報進度的物件。 |
<?xml version="1.0"?>
<!-- Simple example to demonstrate the SoundEffect effect. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark"
xmlns:mx="library://ns.adobe.com/flex/mx">
<fx:Declarations>
<mx:SoundEffect id="mySounds" source="@Embed(source='assets/jazz.mp3')"/>
</fx:Declarations>
<s:Panel title="Sound Effect Example" width="75%" height="75%" >
<s:VGroup left="20" right="20" top="20" bottom="20">
<s:Label width="100%" color="blue"
text="Click on the phone to hear the sound effect."/>
<mx:Image id="flex" source="@Embed(source='assets/Nokia_6630.png')"
mouseDownEffect="{mySounds}"/>
</s:VGroup>
</s:Panel>
</s:Application>
Tue Jun 12 2018, 03:47 PM Z