| Package | com.sonoport |
| Class | public class Extender |
| Inheritance | Extender  com.sonoport.BaseSound |
| Implements | IExtender |
In a typical case, you'd create an Extender object, load an external mp3 file, and call play().
var extender:Extender = new Extender;
extender.audioFile = "OceanSurf.mp3";
extender.play();
| Property | Defined By | ||
|---|---|---|---|
| audioFile : Object
The ambient sound recording to use as raw material. | Extender | ||
| eventLen : Number Event period (s). | Extender | ||
| filterFreq : Number Filter frequency (Hz). | Extender | ||
| filterQ : Number Filter Q (i.e. | Extender | ||
| filterType : int Filter type. | Extender | ||
| pitchShift : Number Pitch Shift (octaves). | Extender | ||
| reverse : Boolean Reverse. | Extender | ||
| xfadeDur : Number Cross-fade duration (fraction of max possible for given Event length). | Extender | ||
| Method | Defined By | ||
|---|---|---|---|
Extender()
Constructor
| Extender | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when Extender has finished loading the file specified by audioFile. | Extender | |||
| Dispatched if Extender is unable to load the file specified by audioFile. | Extender | |||
| Constant | Defined By | ||
|---|---|---|---|
| FILTER_TYPE_BANDPASS : uint = 3 [static] Use band-pass filter. | Extender | ||
| FILTER_TYPE_HIGHPASS : uint = 2 [static] Use high-pass filter. | Extender | ||
| FILTER_TYPE_LOWPASS : uint = 1 [static] Use low-pass filter. | Extender | ||
| FILTER_TYPE_NONE : uint = 0 [static] No filtering. | Extender | ||
| audioFile | property |
audioFile:ObjectThe ambient sound recording to use as raw material. The audio file must be 16-bit 44.1 kHz stereo, wav or mp3.
The recording can be wav or mp3 (44.1 kHz, 16-bit, stereo only), and can be embedded within your swf/swc, stored as external files, or specified as a FileReference. Typical syntax is as follows.
Embedded mp3 files
[Embed(source="OceanSurf.mp3")]
private var OCEANSURF:Class;
var extender:Extender = new Extender;
extender.audioFile = OCEANSURF;
Embedded wav file
[Embed(source="OceanSurf.wav", mimeType="application/octet-stream")]
private var OCEANSURF:Class;
extender.audioFile = OCEANSURF;
mp3 in separate file
extender.setParam( Extender.AUDIO_FILE, "OceanSurf.mp3" );
wav in separate file
extender.audioFile = "OceanSurf.wav";
public function get audioFile():Object public function set audioFile(value:Object):void| eventLen | property |
eventLen:NumberEvent period (s). Default is 2. Range is [0.1, 10].
public function get eventLen():Number public function set eventLen(value:Number):void| filterFreq | property |
filterFreq:NumberFilter frequency (Hz). Default is 1000. Range is [10, 11025].
public function get filterFreq():Number public function set filterFreq(value:Number):void| filterQ | property |
filterQ:NumberFilter Q (i.e. selectivity). Default is 1. Range is [0.01, 10].
public function get filterQ():Number public function set filterQ(value:Number):void| filterType | property |
filterType:intFilter type. 0=none, 1=lopass, 2=highpass, 3=bandpass. Default is 0. Range is [0, 3].
public function get filterType():int public function set filterType(value:int):void| pitchShift | property |
pitchShift:NumberPitch Shift (octaves). Default is 0. Range is [-2, 2].
public function get pitchShift():Number public function set pitchShift(value:Number):void| reverse | property |
reverse:BooleanReverse. Default is false.
public function get reverse():Boolean public function set reverse(value:Boolean):void| xfadeDur | property |
xfadeDur:NumberCross-fade duration (fraction of max possible for given Event length). Default is 0.5. Range is [0, 1].
public function get xfadeDur():Number public function set xfadeDur(value:Number):void| Extender | () | Constructor |
public function Extender()Constructor
| complete | Event |
flash.events.Eventflash.events.Event.COMPLETEDispatched when Extender has finished loading the file specified by audioFile.
| error | Event |
flash.events.ErrorEventflash.events.ErrorEvent.ERRORDispatched if Extender is unable to load the file specified by audioFile.
| FILTER_TYPE_BANDPASS | Constant |
public static const FILTER_TYPE_BANDPASS:uint = 3Use band-pass filter. For use when setting filterType parameter.
| FILTER_TYPE_HIGHPASS | Constant |
public static const FILTER_TYPE_HIGHPASS:uint = 2Use high-pass filter. For use when setting filterType parameter.
| FILTER_TYPE_LOWPASS | Constant |
public static const FILTER_TYPE_LOWPASS:uint = 1Use low-pass filter. For use when setting filterType parameter.
| FILTER_TYPE_NONE | Constant |
public static const FILTER_TYPE_NONE:uint = 0No filtering. For use when setting filterType property.