SoundEffect

Paket	mx.effects
Klasse	public class SoundEffect
Vererbung	SoundEffect Effect EventDispatcher Object

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Die SoundEffect-Klasse gibt MP3-Audiodateien wieder. Beispielsweise kann Sound wiedergegeben werden, wenn der Benutzer auf ein Button-Steuerelement klickt. Bei diesem Effekt können Sie den Sound wiederholen, die Quelldatei auswählen und die Lautstärke und Richtungseinstellung steuern.

Sie geben die MP3-Datei mit der source-Eigenschaft an. Wenn Sie die MP3-Datei bereits eingebettet haben, können Sie mit dem Embed-Schlüsselwort das Class-Objekt der MP3-Datei an die source-Eigenschaft übergeben. Geben Sie andernfalls die vollständige URL der MP3-Datei an.

MXML-Syntax expanded

MXML-Syntax ausblenden

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

Beispiele anzeigen

Verwandte API-Elemente

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

Öffentliche Eigenschaften

Vererbte öffentliche Eigenschaften ausblenden

Vererbte öffentliche Eigenschaften anzeigen

	Eigenschaft		Definiert von
		autoLoad : Boolean Bei „true“ laden Sie die MP3-Datei, wenn die „Source“ angegeben wurde.	SoundEffect
		bufferTime : Number = 1000 Die SoundEffect-Klasse verwendet ein internes Sound-Objekt zum Steuern der MP3-Datei.	SoundEffect
		className : String [schreibgeschützt] Name der Effektklasse wie „Fade“.	Effect
		constructor : Object Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.	Object
		customFilter : mx.effects:EffectTargetFilter Gibt ein benutzerdefiniertes Filterobjekt des Typs EffectTargetFilter an, das zur Ermittlung der Ziele dient, bei denen der Effekt wiedergegeben wird.	Effect
		duration : Number Dauer des Effekts in Millisekunden.	Effect
		effectTargetHost : mx.effects:IEffectTargetHost Eine Eigenschaft, die Ihnen den Zugriff auf listenbasierte Zielsteuerelemente eines Dateneffekts ermöglicht.	Effect
		filter : String Gibt einen Algorithmus zum Filtern der Ziele für einen Effekt an.	Effect
		hideFocusRing : Boolean Bestimmt, ob der Effekt den Fokusring beim Start ausblenden soll.	Effect
		instanceClass : Class Ein Objekt der type-Klasse, das die Effektinstanzklasse für diese Effektklasse angibt.	Effect
		isLoading : Boolean [schreibgeschützt] Diese Eigenschaft hat den Wert „true“, wenn die MP3 geladen wurde.	SoundEffect
		isPlaying : Boolean [schreibgeschützt] Ein Flag für den Schreibschutz, das auf „true“ gesetzt ist, wenn Instanzen des Effekts aktuell wiedergegeben werden, und andernfalls auf „false“.	Effect
		loops : int = 0 Anzahl der Wiedergaben in einer Sound-Schleife. Beim Wert 0 wird der Effekt ein einziges Mal wiedergegeben, beim Wert 1 zwei Male usw.	SoundEffect
		panEasingFunction : Function Die Beschleunigungsfunktion für den Richtungseffekt.	SoundEffect
		panFrom : Number Richtungseinstellung des Sound-Objekts am Anfang.	SoundEffect
		panTo : Number Richtungseinstellung des Sound-Objekts am Ende.	SoundEffect
		perElementOffset : Number Zusätzliche Verzögerung (in Millisekunden) für Effektziele nach dem ersten Ziel des Effekts.	Effect
		playheadTime : Number Aktuelle Zeitposition des Effekts.	Effect
		relevantProperties : Array Ein Array von Eigenschaftsnamen zur Verwendung beim Filtern.	Effect
		relevantStyles : Array Ein Array von Stilnamen zur Verwendung beim Filtern.	Effect
		repeatCount : int = 1 Ein Wert, der angibt, wie oft der Effekt wiederholt werden soll.	Effect
		repeatDelay : int = 0 Wartezeit in Millisekunden vor der Wiederholung des Effekts.	Effect
		sound : Sound [schreibgeschützt] Das Sound-Objekt, in das die MP3-Datei geladen wurde.	SoundEffect
		source : Object Die URL oder Klasse der MP3-Datei, die wiedergegeben werden soll.	SoundEffect
		startDelay : int = 0 Wartezeit in Millisekunden vor dem Starten des Effekts.	Effect
		startTime : Number = 0 Die Anfangsposition in der MP3-Datei in Millisekunden, an der die Wiedergabe beginnen soll.	SoundEffect
		suspendBackgroundProcessing : Boolean = false Bei „true“ erfolgt keine Hintergrundverarbeitung, während der Effekt wiedergegeben wird.	Effect
		target : Object Das Objekt, auf das dieser Effekt angewendet wird.	Effect
		targets : Array Ein Array von Objekten, die als Ziele des Effekts verwendet werden können.	Effect
		triggerEvent : Event Der EffectManager übergibt diesem Effekt das Ereignisobjekt, wenn ein Effekt ausgelöst wird, oder null, wenn der Effekt nicht vom EffectManager wiedergegeben wird.	Effect
		useDuration : Boolean = true Bei „true“ wird der Effekt nach der durch die duration-Eigenschaft angegebenen Zeit beendet.	SoundEffect
		volumeEasingFunction : Function Die Beschleunigungsfunktion für den Lautstärkeeffekt.	SoundEffect
		volumeFrom : Number Lautstärke des Sound-Objekts am Anfang.	SoundEffect
		volumeTo : Number Lautstärke des Sound-Objekts am Ende.	SoundEffect

Geschützte Eigenschaften

Vererbte geschützte Eigenschaften ausblenden

Vererbte geschützte Eigenschaften anzeigen

	Eigenschaft		Definiert von
		applyTransitionEndProperties : Boolean Dieses Flag steuert, ob der Effekt, wenn er in einem Übergang ausgeführt wird, automatisch die Eigenschaftswerte des Endstatus anwendet, statt die durch den Effekt eingestellten Werte beizubehalten.	Effect
		endValuesCaptured : Boolean = false Wenn dieses Flag auf „true“ gesetzt ist, wurden die Werte eines Effekts bereits bestimmt. Bei „false“ werden die Werte beim Ausführen des Effekts aus den aktuellen Eigenschaften der Effektziele übernommen.	Effect

Öffentliche Methoden

Vererbte öffentliche Methoden ausblenden

Vererbte öffentliche Methoden anzeigen

	Methode		Definiert von
		SoundEffect(target:Object = null) Konstruktor.	SoundEffect
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registriert ein Ereignis-Listener-Objekt bei einem EventDispatcher-Objekt, sodass der Listener über ein Ereignis benachrichtigt wird.	EventDispatcher
		captureEndValues():void Erfasst die aktuellen Werte der relevanten Eigenschaften der Ziele des Effekts und speichert sie als Endwerte.	Effect
		captureMoreStartValues(targets:Array):void Erfasst die aktuellen Werte der relevanten Eigenschaften eines zusätzlichen Zielsatzes. Flex verwendet diese Funktion, wenn ein Datenänderungseffekt ausgeführt wird.	Effect
		captureStartValues():void Erfasst die aktuellen Werte der relevanten Eigenschaften der Ziele des Effekts.	Effect
		createInstance(target:Object = null):IEffectInstance Erstellt eine einzelne Effektinstanz und initialisiert sie.	Effect
		createInstances(targets:Array = null):Array Verwendet ein Array von Zielobjekten und ruft die createInstance()-Methode auf jedem Ziel auf.	Effect
		deleteInstance(instance:IEffectInstance):void Entfernt Ereignis-Listener von einer Instanz und entfernt sie aus der Liste der Instanzen.	Effect
		dispatchEvent(event:Event):Boolean Sendet ein Ereignis in den Ereignisablauf.	EventDispatcher
		end(effectInstance:IEffectInstance = null):void Unterbricht einen aktuell wiedergegebenen Effekt und springt sofort zum Ende des Effekts.	Effect
		getAffectedProperties():Array Gibt ein Array von Strings zurück, wobei jeder String dem Namen einer Eigenschaft entspricht, die von diesem Effekt geändert wird.	Effect
		hasEventListener(type:String):Boolean Überprüft, ob das EventDispatcher-Objekt Listener für einen bestimmten Ereignistyp registriert hat.	EventDispatcher
		hasOwnProperty(name:String):Boolean Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.	Object
		isPrototypeOf(theClass:Object):Boolean Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.	Object
		load():void Lädt die MP3, wenn die Source-Eigenschaft auf eine URL verweist.	SoundEffect
		pause():void Hält den Effekt an, bis die resume()-Methode aufgerufen wird.	Effect
		play(targets:Array = null, playReversedFromEnd:Boolean = false):Array Startet die Wiedergabe des Effekts.	Effect
		propertyIsEnumerable(name:String):Boolean Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Entfernt einen Listener aus dem EventDispatcher-Objekt.	EventDispatcher
		resume():void Setzt den Effekt fort, nachdem er durch Aufrufen der pause()-Methode vorübergehend unterbrochen wurde.	Effect
		reverse():void Gibt den aktuell wiedergegebenen Effekt rückwärts wieder und beginnt dabei an der aktuellen Position des Effekts.	Effect
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.	Object
		stop():void Hält den Effekt an und behält den aktuellen Status der Effektziele bei.	Effect
		toLocaleString():String Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.	Object
		toString():String Gibt das angegebene Objekt als String zurück.	Object
		valueOf():Object Gibt den Grundwert des angegebenen Objekts zurück.	Object
		willTrigger(type:String):Boolean Überprüft, ob bei diesem EventDispatcher-Objekt oder bei einem seiner Vorgänger ein Ereignis-Listener für einen bestimmten Ereignistyp registriert ist.	EventDispatcher

Geschützte Methoden

Vererbte geschützte Methoden ausblenden

Vererbte geschützte Methoden anzeigen

	Methode		Definiert von
		applyValueToTarget(target:Object, property:String, value:*, props:Object):void Wird intern von der Effektinfrastruktur verwendet.	Effect
		effectEndHandler(event:EffectEvent):void Wird aufgerufen, wenn die Wiedergabe einer Effektinstanz abgeschlossen ist.	Effect
		effectStartHandler(event:EffectEvent):void Diese Methode wird aufgerufen, wenn die Wiedergabe der Effektinstanz beginnt.	Effect
		effectStopHandler(event:EffectEvent):void Wird aufgerufen, wenn eine Effektinstanz durch einen Aufruf der stop()-Methode angehalten wurde.	Effect
		filterInstance(propChanges:Array, target:Object):Boolean Bestimmt die Logik zum Filtern einer Effektinstanz.	Effect
		getValueFromTarget(target:Object, property:String):* Wird von der captureStartValues()-Methode aufgerufen, um den Wert einer Eigenschaft des Ziels abzurufen.	Effect
		initInstance(instance:IEffectInstance):void Kopiert Eigenschaften des Effekts in die Effektinstanz.	Effect

Ereignisse

Klicken Sie, um weitere Informationen zu Ereignissen zu erhalten.

Vererbte Ereignisse ausblenden

Vererbte Ereignisse anzeigen

	Übersicht	Definiert von
activate	[broadcast event] Wird ausgelöst, wenn Flash Player oder eine AIR-Anwendung den Betriebssystemfokus erhält und aktiv wird.	EventDispatcher
complete	Wird ausgelöst, wenn das Laden der Sounddatei abgeschlossen ist.	SoundEffect
deactivate	[broadcast event] Wird ausgelöst, wenn Flash Player- oder die AIR-Anwendung den Fokus verliert und inaktiv wird.	EventDispatcher
effectEnd	Wird ausgelöst, wenn die Wiedergabe einer der Effektinstanzen beendet wurde, da die Instanz das Ende erreicht hatte oder da der Effekt durch den Aufruf der end()-Methode unterbrochen wurde.	Effect
effectStart	Wird ausgelöst, wenn die Wiedergabe eines Effekts gestartet wird.	Effect
effectStop	Wird ausgelöst, wenn der Effekt angehalten wurde. Dies geschieht nur, wenn der Effekt durch Aufrufen der stop()-Methode unterbrochen wird.	Effect
id3	Wird ausgelöst, wenn für eine MP3-Sounddatei ID3-Daten zur Verfügung stehen.	SoundEffect
ioError	Wird ausgelöst, wenn ein Fehler während des Ladens der Sounddatei auftritt.	SoundEffect
progress	Wird regelmäßig beim Laden der Sounddatei ausgelöst.	SoundEffect

Eigenschaftendetails

autoLoad

Eigenschaft

autoLoad:Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Bei true wird die MP3-Datei geladen, wenn die Source angegeben wurde.

Der Standardwert ist true.

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

bufferTime

Eigenschaft

public var bufferTime:Number = 1000

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Die SoundEffect-Klasse verwendt ein internes Sound-Objekt zum Steuern der MP3-Datei. Diese Eigenschaft gibt an, wie viele Millisekunden Sounddaten im Puffer des Sound-Objekts mindestens enthalten sein müssen. Beim Starten und Fortsetzen der Wiedergabe nach einem Netzwerkabsturz wartet das Sound-Objekt mit der Wiedergabe, bis es mindestens so viele Daten erhalten hat.

Der Standardwert ist 1000.

isLoading

Eigenschaft

isLoading:Boolean [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Diese Eigenschaft hat den Wert true, wenn die MP3 geladen wurde.

Implementierung
public function get isLoading():Boolean

loops

Eigenschaft

public var loops:int = 0

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Anzahl der Wiedergaben in einer Sound-Schleife. Beim Wert 0 wird der Effekt ein einziges Mal wiedergegeben, beim Wert 1 zwei Male usw. Soll die MP3-Datei wiederholt werden, dann wird die Wiedergabezeit durch die useDuration-Eigenschaft bestimmt.

Die duration-Eigenschaft hat Vorrang vor dieser Eigenschaft. Wenn die Effektdauer nicht lang genug ist, um den Sound mindestens ein Mal ganz wiederzugeben, durchläuft der Sound keine Schleife.

Der Standardwert ist 0.

Eigenschaft

public var volumeEasingFunction:Function

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Die Beschleunigungsfunktion für den Lautstärkeeffekt. Mit dieser Funktion können Sie zwischen den Werten von volumeFrom und volumeTo interpolieren.

volumeFrom

Eigenschaft

public var volumeFrom:Number

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Lautstärke des Sound-Objekts am Anfang. Die Werte können zwischen 0,0 und 1,0 liegen.

Der Standardwert ist 1.

volumeTo

Eigenschaft

public var volumeTo:Number

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Lautstärke des Sound-Objekts am Ende. Die Werte können zwischen 0,0 und 1,0 liegen.

Der Standardwert ist 1.

Konstruktordetails

()

Konstruktor

public function SoundEffect(target:Object = null)

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Konstruktor.

Parameter

target:Object (default = null) — Das Objekt, das mit diesem Effekt animiert wird.

Methodendetails

load

()

Methode

public function load():void

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Lädt die MP3, wenn die Source-Eigenschaft auf eine URL verweist.

Ereignisdetails

complete

Ereignis

Ereignisobjekttyp: flash.events.Event
Eigenschaft Event.type = flash.events.Event.COMPLETE

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Wird ausgelöst, wenn das Laden der Sounddatei abgeschlossen ist.

Die Event.COMPLETE-Konstante definiert den Wert der type-Eigenschaft eines complete-Ereignisobjekts.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Eigenschaft	Wert
`bubbles`	`false`
`cancelable`	`false`. Es gibt kein Standardverhalten, das abgebrochen werden kann.
`currentTarget`	Das Objekt, welches das Ereignisobjekt aktiv mit einem Ereignis-Listener verarbeitet.
`target`	Das Netzwerkobjekt, dessen Ladevorgang beendet ist.

id3

Ereignis

Ereignisobjekttyp: flash.events.Event
Eigenschaft Event.type = flash.events.Event.ID3

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Wird ausgelöst, wenn für eine MP3-Sounddatei ID3-Daten zur Verfügung stehen.

Die Event.ID3-Konstante definiert den Wert der type-Eigenschaft eines id3-Ereignisobjekts.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Eigenschaft	Wert
`bubbles`	`false`
`cancelable`	`false`. Es gibt kein Standardverhalten, das abgebrochen werden kann.
`currentTarget`	Das Objekt, welches das Ereignisobjekt aktiv mit einem Ereignis-Listener verarbeitet.
`target`	Das Sound-Objekt, über das die MP3-Datei geladen wird, für die nun ID3-Daten verfügbar sind. Das unter `target` angegebene Ziel ist nicht immer das Objekt in der Anzeigeliste, in der der Ereignis-Listener registriert wurde. Mit der Eigenschaft `currentTarget` können Sie auf das Objekt in der Anzeigeliste zugreifen, das das Ereignis derzeit verarbeitet.

ioError

Ereignis

Ereignisobjekttyp: flash.events.IOErrorEvent
Eigenschaft IOErrorEvent.type = flash.events.IOErrorEvent.IO_ERROR

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Wird ausgelöst, wenn ein Fehler während des Ladens der Sounddatei auftritt.

Definiert den Wert der Eigenschaft type eines ioError-Ereignisobjekts.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Eigenschaft	Wert
`bubbles`	`false`
`cancelable`	`false`. Es gibt kein Standardverhalten, das abgebrochen werden kann.
`currentTarget`	Das Objekt, welches das Ereignisobjekt aktiv mit einem Ereignis-Listener verarbeitet.
`errorID`	Die Referenznummer des spezifischen Fehlers (nur AIR).
`target`	Das Netzwerkobjekt, bei dem der Eingabe/Ausgabe-Fehler auftritt.
`text`	Der als Fehlermeldung anzuzeigende Text.

progress

Ereignis

Ereignisobjekttyp: flash.events.ProgressEvent
Eigenschaft ProgressEvent.type = flash.events.ProgressEvent.PROGRESS

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Wird regelmäßig beim Laden der Sounddatei ausgelöst.

Innerhalb des Ereignisobjekts können Sie auf die Anzahl der aktuell geladenen Bytes und die insgesamt zu ladende Anzahl von Bytes zugreifen. Das Ereignis wird nicht immer ausgelöst. In manchen Fällen tritt das complete-Ereignis ohne progress-Ereignisse auf.

Definiert den Wert der Eigenschaft type eines progress-Ereignisobjekts.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Eigenschaft	Wert
`bubbles`	`false`
`bytesLoaded`	Die Anzahl der geladenen Elemente oder Byte zu dem Zeitpunkt, zu dem der Listener das Ereignis verarbeitet.
`bytesTotal`	Die Gesamtanzahl der Elemente oder Byte, die bei einem erfolgreichen Ladevorgang schließlich geladen werden.
`cancelable`	`false`. Es gibt kein Standardverhalten, das abgebrochen werden kann.
`currentTarget`	Das Objekt, welches das Ereignisobjekt aktiv mit einem Ereignis-Listener verarbeitet.
`target`	Das Objekt, dessen Fortschritt protokolliert wird.

Beispiele Verwendung dieses Beispiels

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>

Rechtliche Hinweise | Onlinedatenschutzerklärung

SoundEffect - AS3 Flex

Klassen x

autoLoad

bufferTime

isLoading

loops

panEasingFunction

panFrom

panTo

sound

source

startTime

useDuration

volumeEasingFunction

volumeFrom

volumeTo

SoundEffect

load

complete

id3

ioError

progress