Packageflash.media
Classpublic final class SoundMixer
InheritanceSoundMixer Inheritance Object

The SoundMixer class contains static properties and methods for global sound control in the SWF file. The SoundMixer class controls embedded streaming sounds in a SWF; it does not control dynamically created Sound objects (that is, Sound objects created in ActionScript).



Public Properties
 PropertyDefined by
  bufferTime : int
[static] The number of seconds to preload an embedded streaming sound into a buffer before it starts to stream.
SoundMixer
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  soundTransform : SoundTransform
[static] The SoundTransform object that controls global sound properties.
SoundMixer
Public Methods
 MethodDefined by
  
[static] Determines whether any sounds are not accessible due to security restrictions.
SoundMixer
  
computeSpectrum(outputArray:ByteArray, FFTMode:Boolean = false, stretchFactor:int = 0):void
[static] Takes a snapshot of the current sound wave and places it into the specified ByteArray object.
SoundMixer
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
  
[static] Stops all sounds currently playing.
SoundMixer
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property detail
bufferTimeproperty
bufferTime:int  [read-write]

The number of seconds to preload an embedded streaming sound into a buffer before it starts to stream. The data in a loaded sound, including its buffer time, cannot be accessed by a SWF file that is in a different domain unless you implement a cross-domain policy file. For more information about security and sound, see the Sound class description.

The SoundMixer.bufferTime property only affects the buffer time for embedded streaming sounds in a SWF and is independent of dynamically created Sound objects (that is, Sound objects created in ActionScript). The value of SoundMixer.bufferTime cannot override or set the default of the buffer time specified in the SoundLoaderContext object that is passed to the Sound.load() method.

Implementation
    public static function get bufferTime():int
    public function set bufferTime(value:int):void

See also

soundTransformproperty 
soundTransform:SoundTransform  [read-write]

The SoundTransform object that controls global sound properties. A SoundTransform object includes properties for setting volume, panning, left speaker assignment, and right speaker assignment. This SoundTransform object only affects sounds embedded within a SWF file. The SoundTransform object used in this property provides final sound settings that are applied to all sounds after any individual sound settings are applied.

Implementation
    public static function get soundTransform():SoundTransform
    public function set soundTransform(value:SoundTransform):void

See also

Method detail
areSoundsInaccessible()method
public static function areSoundsInaccessible():Boolean

Determines whether any sounds are not accessible due to security restrictions. For example, a sound loaded from a domain other than that of the SWF file is not accessible if the server for the sound has no cross-domain policy file that grants access to the domain of the SWF file. The sound can still be loaded and played, but low-level operations, such as getting ID3 metadata for the sound, cannot be performed on inaccessible sounds.

Returns
Boolean

See also

computeSpectrum()method 
public static function computeSpectrum(outputArray:ByteArray, FFTMode:Boolean = false, stretchFactor:int = 0):void

Takes a snapshot of the current sound wave and places it into the specified ByteArray object. The values are formatted as normalized floating-point values, in the range -1.0 to 1.0. The ByteArray object passed to the outputArray parameter is overwritten with the new values. The size of the ByteArray object created is fixed to 512 floating-point values, where the first 256 values represent the left channel, and the second 256 values represent the right channel.

Note: This method is subject to local file security restrictions and restrictions on cross-domain loading. If you are working with local SWF files or sounds loaded from a server in a different domain than the calling SWF, you might need to address sandbox restrictions through a cross-domain policy file. For more information, see the Sound class description. In addition, this method cannot be used to extract data from RTMP streams, even when it is called by SWF files that reside in the same domain as the RTMP server.

Parameters
outputArray:ByteArray — A ByteArray object that holds the values associated with the sound. If any sounds are not available due to security restrictions (areSoundsInaccessible == true), the outputArray object is left unchanged. If all sounds are stopped, the outputArray object is filled with zeros.
 
FFTMode:Boolean (default = false) — A Boolean value indicating whether a Fourier transformation is performed on the sound data first. Setting this parameter to true causes the method to return a frequency spectrum instead of the raw sound wave. In the frequency spectrum, low frequencies are represented on the left and high frequencies are on the right.
 
stretchFactor:int (default = 0) — The resolution of the sound samples. If you set the stretchFactor value to 0, data is sampled at 44.1 KHz; with a value of 1, data is sampled at 22.05 KHz; with a value of 2, data is sampled 11.025 KHz; and so on.

See also

stopAll()method 
public static function stopAll():void

Stops all sounds currently playing.

This method does not stop the playhead. Sounds set to stream will resume playing as the playhead moves over the frames in which they are located.

When using this property, consider the Flash Player security model:

For more information, see the following: