Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
SoundEffect

Package | mx.effects
Class | public class SoundEffect
Inheritance | SoundEffect Effect flash.events.EventDispatcher

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | 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 Syntax Show MXML Syntax
Hide 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"
      />

View the examples

See also

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

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | 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 [read-only] The name of the effect class, such as "Fade". | Effect
|  | customFilter : 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 : 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 [read-only] This property is true if the MP3 has been loaded. | SoundEffect
|  | isPlaying : Boolean [read-only] 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 [read-only] 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

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | 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

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | SoundEffect(target:Object = null) Constructor. | SoundEffect
|  | 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
|  | 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
|  | 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
|  | 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
|  | stop():void Stops the effect, leaving the effect targets in their current state. | Effect

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | 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

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | complete | Dispatched when the sound file finishes loading. | SoundEffect
|  | 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

Property Detail

autoLoad | property

`autoLoad:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

The default value is `true`.

Implementation
`public function get autoLoad():Boolean`
`public function set autoLoad(value:Boolean):void`

bufferTime | property |

`public var bufferTime:Number = 1000`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | 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.

The default value is `1000`.

isLoading | property |

`isLoading:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

This property is `true` if the MP3 has been loaded.

Implementation
`public function get isLoading():Boolean`

loops | property |

`public var loops:int = 0`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | 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.

The default value is `0`.

panEasingFunction | property |

`public var panEasingFunction:Function`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | 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 | property |

`public var panFrom:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | 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.

The default value is `0.0`.

panTo | property |

`public var panTo:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | 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.

The default value is `0.0`.

sound | property |

`sound:Sound` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

Implementation
`public function get sound():Sound`

source | property |

`source:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | 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.

Implementation
`public function get source():Object`
`public function set source(value:Object):void`

startTime | property |

`public var startTime:Number = 0`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

The default value is `0`.

useDuration | property |

`public var useDuration:Boolean = true`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | 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.

The default value is `true`.

volumeEasingFunction | property |

`public var volumeEasingFunction:Function`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | 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 | property |

`public var volumeFrom:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

The default value is `1`.

volumeTo | property |

`public var volumeTo:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

The default value is `1`.

Constructor Detail

SoundEffect | () | Constructor

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Parameters

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

Method Detail

load | () | method

`public function load():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

Event Detail

complete | Event

Event Object Type: `flash.events.Event`
Event.type property = `flash.events.Event.COMPLETE`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Dispatched when the sound file finishes loading.

id3 | Event |

Event Object Type: `flash.events.Event`
Event.type property = `flash.events.Event.ID3`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

ioError | Event |

Event Object Type: `flash.events.IOErrorEvent`
IOErrorEvent.type property = `flash.events.IOErrorEvent.IO_ERROR`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

progress | Event |

Event Object Type: `flash.events.ProgressEvent`
ProgressEvent.type property = `flash.events.ProgressEvent.PROGRESS`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | 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.

Examples
SoundEffectExample.mxml

    <?xml version="1.0"?>
    <!--

      Licensed to the Apache Software Foundation (ASF) under one or more
      contributor license agreements.  See the NOTICE file distributed with
      this work for additional information regarding copyright ownership.
      The ASF licenses this file to You under the Apache License, Version 2.0
      (the "License"); you may not use this file except in compliance with
      the License.  You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

    -->
    <!-- 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="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 image to hear the sound effect."/>

            <mx:Image id="flex" source="@Embed(source='assets/Product1.png')"
                mouseDownEffect="{mySounds}"/>

            </s:VGroup>
        </s:Panel>
    </s:Application>

Wed Nov 15 2017, 09:50 AM +01:00