| Pacote | mx.effects |
| Classe | public class SoundEffect |
| Herança | SoundEffect  Effect EventDispatcher Object |
| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | 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.
Mostrar sintaxe MXML
Ocultar sintaxe 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"
/>
Elementos da API relacionados
| Propriedade | Definido por | ||
|---|---|---|---|
| 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 [somente leitura]
The name of the effect class, such as "Fade". | Effect | |
| constructor : Object
Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto. | 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 [somente leitura]
This property is true if the MP3 has been loaded. | SoundEffect | ||
| isPlaying : Boolean [somente leitura]
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 [somente leitura]
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 | ||
| Método | Definido por | ||
|---|---|---|---|
SoundEffect(target:Object = null)
Constructor. | SoundEffect | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registra um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento. | 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 | |
|
Envia um evento para o fluxo de eventos. | 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 | |
|
Verifica se o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento. | EventDispatcher | |
|
Indica se um objeto tem uma propriedade especificada definida. | Object | |
|
Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro. | 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 | |
|
Indica se a propriedade especificada existe e é enumerável. | Object | |
|
Remove um ouvinte do objeto 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 | |
|
Define a disponibilidade de uma propriedade dinâmica para operações de repetição. | Object | |
|
Stops the effect, leaving the effect targets in their current state. | Effect | |
|
Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade. | Object | |
|
Retorna a representação de string do objeto especificado. | Object | |
|
Retorna o valor primitivo do objeto especificado. | Object | |
|
Verifica se um ouvinte de evento está registrado nesse objeto EventDispatcher ou em qualquer um de seus ancestrais para o tipo de evento especificado. | EventDispatcher | |
| Evento | Resumo | Definido por | ||
|---|---|---|---|---|
| [transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR ganha o foco do sistema operacional e está se tornando inativo. | EventDispatcher | ||
| Dispatched when the sound file finishes loading. | SoundEffect | |||
| [transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR perde o foco do sistema operacional e está se tornando inativo. | 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 | propriedade |
autoLoad:Boolean| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
If true, load the MP3 file
when the source has been specified.
O valor padrão é true.
Implementação
public function get autoLoad():Boolean public function set autoLoad(value:Boolean):voidbufferTime | propriedade |
public var bufferTime:Number = 1000| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | 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.
O valor padrão é 1000.
isLoading | propriedade |
loops | propriedade |
public var loops:int = 0| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | 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.
O valor padrão é 0.
panEasingFunction | propriedade |
public var panEasingFunction:Function| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | 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 | propriedade |
public var panFrom:Number| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | 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.
O valor padrão é 0.0.
panTo | propriedade |
public var panTo:Number| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | 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.
O valor padrão é 0.0.
sound | propriedade |
source | propriedade |
source:Object| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | 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.
Implementação
public function get source():Object public function set source(value:Object):voidstartTime | propriedade |
public var startTime:Number = 0| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
The initial position in the MP3 file, in milliseconds, at which playback should start.
O valor padrão é 0.
useDuration | propriedade |
public var useDuration:Boolean = true| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | 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.
O valor padrão é true.
volumeEasingFunction | propriedade |
public var volumeEasingFunction:Function| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | 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 | propriedade |
public var volumeFrom:Number| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Initial volume of the Sound object. Value can range from 0.0 to 1.0.
O valor padrão é 1.
volumeTo | propriedade |
public var volumeTo:Number| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Final volume of the Sound object. Value can range from 0.0 to 1.0.
O valor padrão é 1.
SoundEffect | () | Construtor |
load | () | método |
public function load():void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Loads the MP3 if the source property points to a URL.
complete | Evento |
flash.events.Eventpropriedade Event.type =
flash.events.Event.COMPLETE| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Dispatched when the sound file finishes loading.
A constanteEvent.COMPLETE define o valor da propriedade type de um objeto de evento complete.
Esse evento tem as seguintes propriedades:
| Propriedade | Valor |
|---|---|
bubbles | false |
cancelable | false; não há comportamento padrão a ser cancelado. |
currentTarget | O objeto que está processando ativamente o objeto Event com um ouvinte de evento. |
target | O objeto de rede que concluiu o carregamento. |
id3 | Evento |
flash.events.Eventpropriedade Event.type =
flash.events.Event.ID3| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Dispatched when ID3 data is available for an MP3 sound file.
A constanteEvent.ID3 define o valor da propriedade type de um objeto de evento id3.
Esse evento tem as seguintes propriedades:
| Propriedade | Valor |
|---|---|
bubbles | false |
cancelable | false; não há comportamento padrão a ser cancelado. |
currentTarget | O objeto que está processando ativamente o objeto Event com um ouvinte de evento. |
target | O objeto Sound que carrega o MP3 para o qual dados ID3 estão agora disponíveis. target não é sempre o objeto na lista de exibição que registrou o ouvinte de evento. Use a propriedade currentTarget para acessar o objeto na lista de exibição que está processando o evento no momento. |
ioError | Evento |
flash.events.IOErrorEventpropriedade IOErrorEvent.type =
flash.events.IOErrorEvent.IO_ERROR| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Dispatched when an error occurs during the loading of the sound file.
Define o valor da propriedadetype de um objeto de evento ioError.
Esse evento tem as seguintes propriedades:
| Propriedade | Valor |
|---|---|
bubbles | false |
cancelable | false; não há comportamento padrão a ser cancelado. |
currentTarget | O objeto que está processando ativamente o objeto Event com um ouvinte de evento. |
errorID | Um número de referência associado ao erro específico (somente AIR). |
target | O objeto de rede que está recebendo o erro de entrada/saída. |
text | Texto a ser exibido como uma mensagem de erro. |
progress | Evento |
flash.events.ProgressEventpropriedade ProgressEvent.type =
flash.events.ProgressEvent.PROGRESS| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | 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 de um objeto de evento progress.
Esse evento tem as seguintes propriedades:
| Propriedade | Valor |
|---|---|
bubbles | false |
bytesLoaded | O número de itens ou bytes carregados no momento em que o ouvinte processa o evento. |
bytesTotal | O número total de itens ou bytes que serão carregados no final se o processo de carregamento tiver êxito. |
cancelable | false; não há comportamento padrão a ser cancelado. |
currentTarget | O objeto que está processando ativamente o objeto Event com um ouvinte de evento. |
target | O objeto que está informando o andamento. |
<?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>
Wed Jun 13 2018, 11:10 AM Z