SoundEffect

Pacchetto	mx.effects
Classe	public class SoundEffect
Ereditarietà	SoundEffect Effect EventDispatcher Object

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

The SoundEffect class plays an MP3 audio file. For example, you could play a sound when a user clicks a Button control. This effect lets you repeat the sound, select the source file, and control the volume and pan.

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.

Sintassi MXML expanded

Nascondi sintassi 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"
  />

Vedere gli esempi

Elementi API correlati

mx.effects.effectClasses.SoundEffectInstance
flash.media.Sound

Proprietà pubbliche

Nascondi proprietà pubbliche ereditate

Mostra proprietà pubbliche ereditate

	Proprietà		Definito da
		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 [sola lettura] The name of the effect class, such as "Fade".	Effect
		constructor : Object Un riferimento all'oggetto classe o alla funzione di costruzione per una determinata istanza di oggetto.	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 [sola lettura] This property is true if the MP3 has been loaded.	SoundEffect
		isPlaying : Boolean [sola lettura] 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 [sola lettura] 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

Proprietà protette

Nascondi proprietà protette ereditate

Mostra proprietà protette ereditate

	Proprietà		Definito da
		applyTransitionEndProperties : Boolean This flag controls whether the effect, when run in a transition, automatically applies the property values according to the end state, as opposed to leaving values as set by the effect itself.	Effect
		endValuesCaptured : Boolean = false A flag containing true if the end values of an effect have already been determined, or false if they should be acquired from the current properties of the effect targets when the effect runs.	Effect

Metodi pubblici

Nascondi metodi pubblici ereditati

Mostra metodi pubblici ereditati

	Metodo		Definito da
		SoundEffect(target:Object = null) Constructor.	SoundEffect
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registra un oggetto listener di eventi con un oggetto EventDispatcher, in modo che il listener riceva la notifica di un evento.	EventDispatcher
		captureEndValues():void Captures the current values of the relevant properties on the effect's targets and saves them as end values.	Effect
		captureMoreStartValues(targets:Array):void 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
		captureStartValues():void Captures the current values of the relevant properties on the effect's targets.	Effect
		createInstance(target:Object = null):IEffectInstance Creates a single effect instance and initializes it.	Effect
		createInstances(targets:Array = null):Array Takes an Array of target objects and invokes the createInstance() method on each target.	Effect
		deleteInstance(instance:IEffectInstance):void Removes event listeners from an instance and removes it from the list of instances.	Effect
		dispatchEvent(event:Event):Boolean Invia un evento nel flusso di eventi.	EventDispatcher
		end(effectInstance:IEffectInstance = null):void Interrupts an effect that is currently playing, and jumps immediately to the end of the effect.	Effect
		getAffectedProperties():Array Returns an Array of Strings, where each String is the name of a property changed by this effect.	Effect
		hasEventListener(type:String):Boolean Verifica se per l'oggetto EventDispatcher sono presenti listener registrati per un tipo specifico di evento.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indica se per un oggetto è definita una proprietà specifica.	Object
		isPrototypeOf(theClass:Object):Boolean Indica se un'istanza della classe Object si trova nella catena di prototipi dell'oggetto specificato come parametro.	Object
		load():void Loads the MP3 if the source property points to a URL.	SoundEffect
		pause():void Pauses the effect until you call the resume() method.	Effect
		play(targets:Array = null, playReversedFromEnd:Boolean = false):Array Begins playing the effect.	Effect
		propertyIsEnumerable(name:String):Boolean Indica se la proprietà specificata esiste ed è enumerabile.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Rimuove un listener dall'oggetto EventDispatcher.	EventDispatcher
		resume():void Resumes the effect after it has been paused by a call to the pause() method.	Effect
		reverse():void Plays the effect in reverse, if the effect is currently playing, starting from the current position of the effect.	Effect
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Imposta la disponibilità di una proprietà dinamica per le operazioni cicliche.	Object
		stop():void Stops the effect, leaving the effect targets in their current state.	Effect
		toLocaleString():String Restituisce la rappresentazione in formato stringa di questo oggetto, formattato in base alle convenzioni specifiche per le versioni localizzate.	Object
		toString():String Restituisce la rappresentazione in formato stringa dell'oggetto specificato.	Object
		valueOf():Object Restituisce il valore di base dell'oggetto specificato.	Object
		willTrigger(type:String):Boolean Verifica se un listener di eventi è registrato con questo oggetto EventDispatcher o qualsiasi suo antenato per il tipo di evento specificato.	EventDispatcher

Metodi protetti

Nascondi metodi protetti ereditati

Mostra metodi protetti ereditati

	Metodo		Definito da
		applyValueToTarget(target:Object, property:String, value:*, props:Object):void Used internally by the Effect infrastructure.	Effect
		effectEndHandler(event:EffectEvent):void Called when an effect instance has finished playing.	Effect
		effectStartHandler(event:EffectEvent):void This method is called when the effect instance starts playing.	Effect
		effectStopHandler(event:EffectEvent):void Called when an effect instance has stopped by a call to the stop() method.	Effect
		filterInstance(propChanges:Array, target:Object):Boolean Determines the logic for filtering out an effect instance.	Effect
		getValueFromTarget(target:Object, property:String):* Called by the captureStartValues() method to get the value of a property from the target.	Effect
		initInstance(instance:IEffectInstance):void Copies properties of the effect to the effect instance.	Effect

Eventi

Fate clic per visualizzare altre informazioni sugli eventi

Nascondi eventi ereditati

Mostra eventi ereditati

	Riepilogo	Definito da
activate	[evento di trasmissione] Inviato quando Flash Player o l'applicazione AIR ottiene lo stato di attivazione del sistema operativo ed entra nello stato attivo.	EventDispatcher
complete	Dispatched when the sound file finishes loading.	SoundEffect
deactivate	[evento di trasmissione] Inviato quando Flash Player o l'applicazione AIR perde l'attivazione del sistema operativo e sta entrando nello stato inattivo.	EventDispatcher
effectEnd	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
effectStart	Dispatched when the effect starts playing.	Effect
effectStop	Dispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method.	Effect
id3	Dispatched when ID3 data is available for an MP3 sound file.	SoundEffect
ioError	Dispatched when an error occurs during the loading of the sound file.	SoundEffect
progress	Dispatched periodically as the sound file loads.	SoundEffect

Descrizione delle proprietà

autoLoad

proprietà

autoLoad:Boolean

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

If true, load the MP3 file when the source has been specified.

Il valore predefinito è true.

Implementazione
public function get autoLoad():Boolean
public function set autoLoad(value:Boolean):void

bufferTime

proprietà

public var bufferTime:Number = 1000

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni 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.

Il valore predefinito è 1000.

isLoading

proprietà

isLoading:Boolean [sola lettura]

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

This property is true if the MP3 has been loaded.

Implementazione
public function get isLoading():Boolean

loops

proprietà

public var loops:int = 0

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni 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.

Il valore predefinito è 0.

proprietà

public var volumeEasingFunction:Function

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni 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

proprietà

public var volumeFrom:Number

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Initial volume of the Sound object. Value can range from 0.0 to 1.0.

Il valore predefinito è 1.

volumeTo

proprietà

public var volumeTo:Number

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Final volume of the Sound object. Value can range from 0.0 to 1.0.

Il valore predefinito è 1.

Descrizione della funzione di costruzione

()

Funzione di costruzione

public function SoundEffect(target:Object = null)

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Constructor.

Parametri

target:Object (default = null) — The Object to animate with this effect.

Descrizione dei metodi

load

()

metodo

public function load():void

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Loads the MP3 if the source property points to a URL.

Descrizione degli eventi

complete

Evento

Tipo di oggetto evento: flash.events.Event
proprietà Event.type = flash.events.Event.COMPLETE

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Dispatched when the sound file finishes loading.

La costante Event.COMPLETE definisce il valore della proprietà type di un oggetto evento complete.

Questo evento ha le seguenti proprietà:

Proprietà	Valore
`bubbles`	`false`
`cancelable`	`false`; non è presente alcun comportamento predefinito da annullare.
`currentTarget`	L'oggetto che elabora attivamente l'oggetto Event con un listener di eventi.
`target`	L'oggetto di rete che ha completato il caricamento.

id3

Evento

Tipo di oggetto evento: flash.events.Event
proprietà Event.type = flash.events.Event.ID3

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Dispatched when ID3 data is available for an MP3 sound file.

La costante Event.ID3 definisce il valore della proprietà type di un oggetto evento id3.

Questo evento ha le seguenti proprietà:

Proprietà	Valore
`bubbles`	`false`
`cancelable`	`false`; non è presente alcun comportamento predefinito da annullare.
`currentTarget`	L'oggetto che elabora attivamente l'oggetto Event con un listener di eventi.
`target`	L'oggetto Sound che carica l'MP3 per cui sono ora disponibili dati ID3. Il `target` non è sempre l'oggetto nell'elenco di visualizzazione che ha registrato il listener di eventi. Utilizzate la proprietà `currentTarget` per accedere all'oggetto dell'elenco di visualizzazione che sta elaborando l'evento.

ioError

Evento

Tipo di oggetto evento: flash.events.IOErrorEvent
proprietà IOErrorEvent.type = flash.events.IOErrorEvent.IO_ERROR

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Dispatched when an error occurs during the loading of the sound file.

Definisce il valore della proprietà type di un oggetto evento ioError.

Questo evento ha le seguenti proprietà:

Proprietà	Valore
`bubbles`	`false`
`cancelable`	`false`; non è presente alcun comportamento predefinito da annullare.
`currentTarget`	L'oggetto che elabora attivamente l'oggetto Event con un listener di eventi.
`errorID`	Un numero di riferimento associato all'errore specifico (solo AIR).
`target`	L'oggetto di rete interessato dall'errore di input/output.
`text`	Testo da visualizzare come messaggio di errore.

progress

Evento

Tipo di oggetto evento: flash.events.ProgressEvent
proprietà ProgressEvent.type = flash.events.ProgressEvent.PROGRESS

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni 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.

Definisce il valore della proprietà type di un oggetto evento progress.

Questo evento ha le seguenti proprietà:

Proprietà	Valore
`bubbles`	`false`
`bytesLoaded`	Il numero di elementi o di byte caricati nel momento in cui il listener elabora l'evento.
`bytesTotal`	Il numero totale di elementi o byte che vengono caricati se il processo di caricamento viene completato correttamente.
`cancelable`	`false`; non è presente alcun comportamento predefinito da annullare.
`currentTarget`	L'oggetto che elabora attivamente l'oggetto Event con un listener di eventi.
`target`	L'oggetto che riporta l'avanzamento.

Esempi Come utilizzare questo esempio

SoundEffectExample.mxml

<?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>

Note legali | Informativa sulla privacy online

SoundEffect - AS3 Flex

Classi x

autoLoad

bufferTime

isLoading

loops

panEasingFunction

panFrom

panTo

sound

source

startTime

useDuration

volumeEasingFunction

volumeFrom

volumeTo

SoundEffect

load

complete

id3

ioError

progress