| Pakiet | mx.effects |
| Klasa | public class SoundEffect |
| Dziedziczenie | SoundEffect  Effect EventDispatcher Object |
| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Flex 3 |
| Wersje środowiska wykonawczego: | 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.
Pokaż składnię MXML
Ukryj składnię MXMLThe <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"
/>
Powiązane elementy interfejsu API
| Właściwość | Zdefiniowane przez | ||
|---|---|---|---|
| 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 [tylko do odczytu]
The name of the effect class, such as "Fade". | Effect | |
| constructor : Object
Odwołanie do obiektu klasy lub funkcji konstruktora, dotyczące danej instancji obiektu. | 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 [tylko do odczytu]
This property is true if the MP3 has been loaded. | SoundEffect | ||
| isPlaying : Boolean [tylko do odczytu]
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 [tylko do odczytu]
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 | ||
| Metoda | Zdefiniowane przez | ||
|---|---|---|---|
SoundEffect(target:Object = null)
Constructor. | SoundEffect | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Rejestruje obiekt detektora zdarzeń w obiekcie EventDispatcher, dzięki czemu detektor będzie otrzymywał powiadomienia o zdarzeniu. | 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 | |
|
Wywołuje zdarzenie, tj. kieruje je do przepływu zdarzeń. | 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 | |
|
Sprawdza, czy obiekt EventDispatcher zawiera jakiekolwiek detektory zarejestrowane dla konkretnego typu zdarzeń. | EventDispatcher | |
|
Wskazuje, czy dla obiektu zdefiniowano określoną właściwość. | Object | |
|
Wskazuje, czy instancja klasy Object należy do łańcucha prototypów obiektu określonego jako parametr. | 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 | |
|
Wskazuje, czy określona właściwość istnieje i jest przeliczalna. | Object | |
|
Usuwa detektor z obiektu 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 | |
|
Ustawia dostępność właściwości dynamicznej używanej w pętlach. | Object | |
|
Stops the effect, leaving the effect targets in their current state. | Effect | |
|
Zwraca ciąg reprezentujący obiekt — sformatowany zgodnie z konwencjami właściwymi dla ustawień regionalnych. | Object | |
|
Zwraca ciąg reprezentujący określony obiekt. | Object | |
|
Zwraca pierwotną wartość dla określonego obiektu. | Object | |
|
Sprawdza, czy detektor zdarzeń określonego typu jest zarejestrowany w tym obiekcie EventDispatcher lub jego elementach macierzystych. | EventDispatcher | |
| Zdarzenie | Podsumowanie | Zdefiniowane przez | ||
|---|---|---|---|---|
| [zdarzenie broadcast] Wywoływane, gdy program Flash Player lub aplikacja środowiska wykonawczego AIR uzyskuje fokus w systemie operacyjnym i przechodzi w stan aktywny. | EventDispatcher | ||
| Dispatched when the sound file finishes loading. | SoundEffect | |||
| [zdarzenie broadcast] Wywoływane, gdy program Flash Player lub aplikacja AIR traci fokus w systemie operacyjnym i przechodzi w stan nieaktywny. | 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 | właściwość |
autoLoad:Boolean| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Flex 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
If true, load the MP3 file
when the source has been specified.
Wartością domyślną jest true.
Implementacja
public function get autoLoad():Boolean public function set autoLoad(value:Boolean):voidbufferTime | właściwość |
public var bufferTime:Number = 1000| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Flex 3 |
| Wersje środowiska wykonawczego: | 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.
Wartością domyślną jest 1000.
isLoading | właściwość |
loops | właściwość |
public var loops:int = 0| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Flex 3 |
| Wersje środowiska wykonawczego: | 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.
Wartością domyślną jest 0.
panEasingFunction | właściwość |
public var panEasingFunction:Function| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Flex 3 |
| Wersje środowiska wykonawczego: | 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 | właściwość |
public var panFrom:Number| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Flex 3 |
| Wersje środowiska wykonawczego: | 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.
Wartością domyślną jest 0.0.
panTo | właściwość |
public var panTo:Number| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Flex 3 |
| Wersje środowiska wykonawczego: | 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.
Wartością domyślną jest 0.0.
sound | właściwość |
source | właściwość |
source:Object| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Flex 3 |
| Wersje środowiska wykonawczego: | 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.
Implementacja
public function get source():Object public function set source(value:Object):voidstartTime | właściwość |
public var startTime:Number = 0| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Flex 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
The initial position in the MP3 file, in milliseconds, at which playback should start.
Wartością domyślną jest 0.
useDuration | właściwość |
public var useDuration:Boolean = true| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Flex 3 |
| Wersje środowiska wykonawczego: | 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.
Wartością domyślną jest true.
volumeEasingFunction | właściwość |
public var volumeEasingFunction:Function| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Flex 3 |
| Wersje środowiska wykonawczego: | 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 | właściwość |
public var volumeFrom:Number| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Flex 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
Initial volume of the Sound object. Value can range from 0.0 to 1.0.
Wartością domyślną jest 1.
volumeTo | właściwość |
public var volumeTo:Number| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Flex 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
Final volume of the Sound object. Value can range from 0.0 to 1.0.
Wartością domyślną jest 1.
SoundEffect | () | Konstruktor |
load | () | metoda |
public function load():void| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Flex 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
Loads the MP3 if the source property points to a URL.
complete | Zdarzenie |
flash.events.Eventwłaściwość Event.type =
flash.events.Event.COMPLETE| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Flex 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
Dispatched when the sound file finishes loading.
StałaEvent.COMPLETE definiuje wartość właściwości type obiektu zdarzenia complete.
To zdarzenie ma następujące właściwości:
| Właściwość | Wartość |
|---|---|
bubbles | false |
cancelable | false; nie ma domyślnego zachowania, które można byłoby anulować. |
currentTarget | Obiekt przetwarzający aktywnie obiekt Event za pomocą detektora zdarzeń. |
target | Obiekt sieciowy, którego ładowanie zostało ukończone. |
id3 | Zdarzenie |
flash.events.Eventwłaściwość Event.type =
flash.events.Event.ID3| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Flex 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
Dispatched when ID3 data is available for an MP3 sound file.
StałaEvent.ID3 definiuje wartość właściwości type obiektu zdarzenia id3.
To zdarzenie ma następujące właściwości:
| Właściwość | Wartość |
|---|---|
bubbles | false |
cancelable | false; nie ma domyślnego zachowania, które można byłoby anulować. |
currentTarget | Obiekt przetwarzający aktywnie obiekt Event za pomocą detektora zdarzeń. |
target | Obiekt Sound ładujący plik MP3, dla którego są obecnie dostępne dane ID3. Obiekt target nie zawsze jest obiektem na liście wyświetlania, która zarejestrowała detektor zdarzeń. Właściwość currentTarget umożliwia uzyskanie dostępu do obiektu na liście wyświetlania, który obecnie przetwarza zdarzenie. |
ioError | Zdarzenie |
flash.events.IOErrorEventwłaściwość IOErrorEvent.type =
flash.events.IOErrorEvent.IO_ERROR| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Flex 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
Dispatched when an error occurs during the loading of the sound file.
Definiuje wartość właściwościtype obiektu zdarzenia ioError.
To zdarzenie ma następujące właściwości:
| Właściwość | Wartość |
|---|---|
bubbles | false |
cancelable | false; nie ma domyślnego zachowania, które można byłoby anulować. |
currentTarget | Obiekt przetwarzający aktywnie obiekt Event za pomocą detektora zdarzeń. |
errorID | Numer referencyjny skojarzony z konkretnym błędem (tylko w środowisku AIR). |
target | Obiekt sieciowy, w którym wystąpił błąd wejścia/wyjścia. |
text | Tekst, który ma być wyświetlany w charakterze komunikatu o błędzie. |
progress | Zdarzenie |
flash.events.ProgressEventwłaściwość ProgressEvent.type =
flash.events.ProgressEvent.PROGRESS| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Flex 3 |
| Wersje środowiska wykonawczego: | 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.
type obiektu zdarzenia progress.
To zdarzenie ma następujące właściwości:
| Właściwość | Wartość |
|---|---|
bubbles | false |
bytesLoaded | Liczba elementów lub bajtów załadowanych w momencie, w którym detektor przetwarza zdarzenie. |
bytesTotal | Łączna liczba elementów lub bajtów, które zostaną ostatecznie załadowane w razie pomyślnego zakończenia operacji ładowania. |
cancelable | false; nie ma domyślnego zachowania, które można byłoby anulować. |
currentTarget | Obiekt przetwarzający aktywnie obiekt Event za pomocą detektora zdarzeń. |
target | Obiekt informujący o postępie. |
<?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, 12:06 PM Z