Referenshandbok för ActionScript® 3.0 i Adobe® Flash®-plattformen
Hem  |  Dölj paket och klasslista |  Paket  |  Klasser  |  Nyheter  |  Index  |  Bilagor  |  Varför på engelska?
Filter: Hämtar data från servern ...
Hämtar data från servern ...
mx.effects 

SoundEffect  - AS3 Flex

Paketmx.effects
Klasspublic class SoundEffect
ArvSoundEffect Inheritance Effect Inheritance EventDispatcher Inheritance Object

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: 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.

MXML-syntaxexpandedDölj MXML-syntax

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

Visa exemplen

Relaterade API-element



Publika egenskaper
 EgenskapDefinieras med
  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
 InheritedclassName : String
[skrivskyddad] The name of the effect class, such as "Fade".
Effect
 Inheritedconstructor : Object
En referens till klassobjektet eller konstruktorfunktionen för en given objektinstans.
Object
 InheritedcustomFilter : 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
 Inheritedduration : Number
Duration of the effect in milliseconds.
Effect
 InheritedeffectTargetHost : mx.effects:IEffectTargetHost
A property that lets you access the target list-based control of a data effect.
Effect
 Inheritedfilter : String
Specifies an algorithm for filtering targets for an effect.
Effect
 InheritedhideFocusRing : Boolean
Determines whether the effect should hide the focus ring when starting the effect.
Effect
 InheritedinstanceClass : Class
An object of type Class that specifies the effect instance class class for this effect class.
Effect
  isLoading : Boolean
[skrivskyddad] This property is true if the MP3 has been loaded.
SoundEffect
 InheritedisPlaying : Boolean
[skrivskyddad] 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
 InheritedperElementOffset : Number
Additional delay, in milliseconds, for effect targets after the first target of the effect.
Effect
 InheritedplayheadTime : Number
Current time position of the effect.
Effect
 InheritedrelevantProperties : Array
An Array of property names to use when performing filtering.
Effect
 InheritedrelevantStyles : Array
An Array of style names to use when performing filtering.
Effect
 InheritedrepeatCount : int = 1
Number of times to repeat the effect.
Effect
 InheritedrepeatDelay : int = 0
Amount of time, in milliseconds, to wait before repeating the effect.
Effect
  sound : Sound
[skrivskyddad] 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
 InheritedstartDelay : 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
 InheritedsuspendBackgroundProcessing : Boolean = false
If true, blocks all background processing while the effect is playing.
Effect
 Inheritedtarget : Object
The object to which this effect is applied.
Effect
 Inheritedtargets : Array
An Array of objects that are targets for the effect.
Effect
 InheritedtriggerEvent : 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
Skyddade egenskaper
 EgenskapDefinieras med
 InheritedapplyTransitionEndProperties : 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
 InheritedendValuesCaptured : 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
Publika metoder
 MetodDefinieras med
  
SoundEffect(target:Object = null)
Constructor.
SoundEffect
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registrerar ett händelseavlyssnarobjekt för ett EventDispatcher-objekt så att avlyssnaren får meddelanden om händelser.
EventDispatcher
 Inherited
Captures the current values of the relevant properties on the effect's targets and saves them as end values.
Effect
 Inherited
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
 Inherited
Captures the current values of the relevant properties on the effect's targets.
Effect
 Inherited
Creates a single effect instance and initializes it.
Effect
 Inherited
createInstances(targets:Array = null):Array
Takes an Array of target objects and invokes the createInstance() method on each target.
Effect
 Inherited
Removes event listeners from an instance and removes it from the list of instances.
Effect
 Inherited
Skickar en händelse till händelseflödet.
EventDispatcher
 Inherited
end(effectInstance:IEffectInstance = null):void
Interrupts an effect that is currently playing, and jumps immediately to the end of the effect.
Effect
 Inherited
Returns an Array of Strings, where each String is the name of a property changed by this effect.
Effect
 Inherited
Kontrollerar om EventDispatcher-objektet har några avlyssnare registrerade för en viss typ av händelse.
EventDispatcher
 Inherited
Anger om det finns en egenskap angiven för ett objekt.
Object
 Inherited
Anger om en instans av klassen Object finns i prototypkedjan för objektet som anges som parameter.
Object
  
Loads the MP3 if the source property points to a URL.
SoundEffect
 Inherited
Pauses the effect until you call the resume() method.
Effect
 Inherited
play(targets:Array = null, playReversedFromEnd:Boolean = false):Array
Begins playing the effect.
Effect
 Inherited
Anger om den angivna egenskapen finns och är uppräkningsbar.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Tar bort en avlyssnare från EventDispatcher-objektet.
EventDispatcher
 Inherited
Resumes the effect after it has been paused by a call to the pause() method.
Effect
 Inherited
Plays the effect in reverse, if the effect is currently playing, starting from the current position of the effect.
Effect
 Inherited
Anger tillgänglighet för en dynamisk egenskap för slingåtgärder.
Object
 Inherited
Stops the effect, leaving the effect targets in their current state.
Effect
 Inherited
Returnerar det här objektets strängrepresentation, formaterad i enlighet med språkspecifika konventioner.
Object
 Inherited
Returnerar det angivna objektets strängbeteckning.
Object
 Inherited
Returnerar det angivna objektets primitiva värde.
Object
 Inherited
Kontrollerar om en händelseavlyssnare är registrerad för det här EventDispatcher-objektet eller något av dess överordnade objekt för den angivna händelsetypen.
EventDispatcher
Skyddade metoder
 MetodDefinieras med
 Inherited
applyValueToTarget(target:Object, property:String, value:*, props:Object):void
Used internally by the Effect infrastructure.
Effect
 Inherited
Called when an effect instance has finished playing.
Effect
 Inherited
This method is called when the effect instance starts playing.
Effect
 Inherited
Called when an effect instance has stopped by a call to the stop() method.
Effect
 Inherited
filterInstance(propChanges:Array, target:Object):Boolean
Determines the logic for filtering out an effect instance.
Effect
 Inherited
getValueFromTarget(target:Object, property:String):*
Called by the captureStartValues() method to get the value of a property from the target.
Effect
 Inherited
Copies properties of the effect to the effect instance.
Effect
Händelser
 Händelse Sammanfattning Definieras med
 Inherited[utsändningshändelse] Skickas när Flash Player eller AIR får operativsystemfokus och blir aktivt.EventDispatcher
  Dispatched when the sound file finishes loading.SoundEffect
 Inherited[utsändningshändelse] Skickas när Flash Player eller AIR förlorar operativsystemfokus och blir inaktivt.EventDispatcher
 InheritedDispatched 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
 InheritedDispatched when the effect starts playing.Effect
 InheritedDispatched 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
Egenskapsdetaljer

autoLoad

egenskap
autoLoad:Boolean

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: Flash Player 9, AIR 1.1

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

Standardvärdet är true.



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

bufferTime

egenskap 
public var bufferTime:Number = 1000

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: 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.

Standardvärdet är 1000.

isLoading

egenskap 
isLoading:Boolean  [skrivskyddad]

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: Flash Player 9, AIR 1.1

This property is true if the MP3 has been loaded.



Implementering
    public function get isLoading():Boolean

loops

egenskap 
public var loops:int = 0

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: 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.

Standardvärdet är 0.

panEasingFunction

egenskap 
public var panEasingFunction:Function

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: 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

egenskap 
public var panFrom:Number

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: 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.

Standardvärdet är 0.0.

panTo

egenskap 
public var panTo:Number

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: 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.

Standardvärdet är 0.0.

sound

egenskap 
sound:Sound  [skrivskyddad]

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: Flash Player 9, AIR 1.1

The Sound object that the MP3 file has been loaded into.



Implementering
    public function get sound():Sound

source

egenskap 
source:Object

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: 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.



Implementering
    public function get source():Object
    public function set source(value:Object):void

startTime

egenskap 
public var startTime:Number = 0

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: Flash Player 9, AIR 1.1

The initial position in the MP3 file, in milliseconds, at which playback should start.

Standardvärdet är 0.

useDuration

egenskap 
public var useDuration:Boolean = true

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: 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.

Standardvärdet är true.

volumeEasingFunction

egenskap 
public var volumeEasingFunction:Function

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: 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

egenskap 
public var volumeFrom:Number

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: Flash Player 9, AIR 1.1

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

Standardvärdet är 1.

volumeTo

egenskap 
public var volumeTo:Number

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: Flash Player 9, AIR 1.1

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

Standardvärdet är 1.

Konstruktordetaljer

SoundEffect

()Konstruktor
public function SoundEffect(target:Object = null)

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: Flash Player 9, AIR 1.1

Constructor.

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

load

()metod
public function load():void

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: Flash Player 9, AIR 1.1

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

Händelsedetaljer

complete

Händelse
Typ av händelseobjekt: flash.events.Event
egenskap Event.type = flash.events.Event.COMPLETE

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: Flash Player 9, AIR 1.1

Dispatched when the sound file finishes loading.

Event.COMPLETE-konstanten definierar värdet på type-egenskapen i ett complete-händelseobjekt.

Den här händelsen har följande egenskaper:

EgenskapVärde
bubblesfalse
cancelablefalse; det finns inget standardbeteende att avbryta.
currentTargetDet objekt som aktivt behandlar Event-objektet med en händelseavlyssnare.
targetDet nätverksobjekt som har lästs in.

id3

Händelse  
Typ av händelseobjekt: flash.events.Event
egenskap Event.type = flash.events.Event.ID3

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: Flash Player 9, AIR 1.1

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

Event.ID3-konstanten definierar värdet på type-egenskapen i ett id3-händelseobjekt.

Den här händelsen har följande egenskaper:

EgenskapVärde
bubblesfalse
cancelablefalse; det finns inget standardbeteende att avbryta.
currentTargetDet objekt som aktivt behandlar Event-objektet med en händelseavlyssnare.
targetSound-objektet som läser in den MP3 som ID3-data nu är tillgänglig för. target är inte alltid det objekt i visningslistan som har registrerat händelseavlyssnaren. Använd egenskapen currentTarget om du vill komma åt det objekt i visningslistan som bearbetar händelsen.

ioError

Händelse  
Typ av händelseobjekt: flash.events.IOErrorEvent
egenskap IOErrorEvent.type = flash.events.IOErrorEvent.IO_ERROR

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: Flash Player 9, AIR 1.1

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

Definierar värdet för ett ioError-händelseobjekts type-egenskap.

Den här händelsen har följande egenskaper:

EgenskapVärde
bubblesfalse
cancelablefalse; det finns inget standardbeteende att avbryta.
currentTargetDet objekt som aktivt behandlar Event-objektet med en händelseavlyssnare.
errorIDEtt referensnummer som associeras med det specifika felet (enbart AIR).
targetObjektet är med om ett in-/utdatafel.
textText som visas som felmeddelande.

progress

Händelse  
Typ av händelseobjekt: flash.events.ProgressEvent
egenskap ProgressEvent.type = flash.events.ProgressEvent.PROGRESS

Språkversion: ActionScript 3.0
Produktversion: Flex 3
Körningsmiljöversioner: 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.

Definierar värdet för ett progress-händelseobjekts type-egenskap.

Den här händelsen har följande egenskaper:

EgenskapVärde
bubblesfalse
bytesLoadedAntalet objekt eller byte som har lästs in när avlyssnaren bearbetar händelsen.
bytesTotalDet totala antalet objekt eller byte som kommer att ha lästs in om inläsningen lyckas.
cancelablefalse; det finns inget standardbeteende att avbryta.
currentTargetDet objekt som aktivt behandlar Event-objektet med en händelseavlyssnare.
targetObjektet rapporterar förlopp.
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>




[ X ]Varför på engelska?
Innehåll i Referenshandbok för ActionScript 3.0 i Adobe Flash-plattformen är på engelska

Det är inte alla delar av Referenshandbok för ActionScript 3.0 i Adobe Flash-plattformen som översätts till alla språk. Om ett språkelement inte översätts visas det på engelska. Klassen ga.controls.HelpBox översätts till exempel inte till något språk. I den svenska versionen av referenshandboken visas därför klassen ga.controls.HelpBox på engelska.