Packagecom.noteflight.standingwave2.filters
Classpublic class EchoFilter
InheritanceEchoFilter Inheritance AbstractFilter Inheritance Object

An EchoFilter implements a simple recirculating delay line in which the input is blended with a time-delayed copy of itself.


Public Properties
 PropertyDefined By
  decay : Number
The fraction of the delayed signal which is fed back into the delay line.
EchoFilter
 Inheriteddescriptor : AudioDescriptor
[read-only] The AudioDescriptor describing the audio characteristics of this source.
AbstractFilter
 InheritedframeCount : Number
[read-only] The number of sample frames in this source.
AbstractFilter
  period : Number
The time period of the echo in seconds.
EchoFilter
 Inheritedposition : Number
[read-only] The position of the audio cursor in this source, as a frame index.
AbstractFilter
 Inheritedsource : IAudioSource
The underlying audio source for this filter.
AbstractFilter
  wet : Number
The fraction of the output which is represented by the delayed signal.
EchoFilter
Protected Properties
 PropertyDefined By
 Inherited_source : IAudioSource
The underlying source that acts as input to this filter.
AbstractFilter
Public Methods
 MethodDefined By
  
EchoFilter(source:IAudioSource = null, period:Number = 0, wet:Number = 0.5, decay:Number = 0.5)
Create a new EchoFilter.
EchoFilter
  
clone():IAudioSource
[override]
EchoFilter
 Inherited
getSample(numFrames:Number):Sample
Retrieve a number of sample frames from this source as a Sample object, starting from the audio cursor position.
AbstractFilter
  
resetPosition():void
[override] Resets the audio cursor to the beginning of the source, and causes any cursor-dependent state in the source to be initialized.
EchoFilter
Protected Methods
 MethodDefined By
  
initializeState():void
EchoFilter
  
transformChannel(data:Vector.<Number>, channel:Number, start:Number, numFrames:Number):void
[override]
EchoFilter
Property Detail
decayproperty
decay:Number

The fraction of the delayed signal which is fed back into the delay line.


Implementation
    public function get decay():Number
    public function set decay(value:Number):void
periodproperty 
period:Number

The time period of the echo in seconds.


Implementation
    public function get period():Number
    public function set period(value:Number):void
wetproperty 
wet:Number

The fraction of the output which is represented by the delayed signal.


Implementation
    public function get wet():Number
    public function set wet(value:Number):void
Constructor Detail
EchoFilter()Constructor
public function EchoFilter(source:IAudioSource = null, period:Number = 0, wet:Number = 0.5, decay:Number = 0.5)

Create a new EchoFilter. Parameters may be changed while the filter is operating.

Parameters
source:IAudioSource (default = null) — the underlying IAudioSource
 
period:Number (default = 0) — the time period of the echo
 
wet:Number (default = 0.5) — the fraction of the output which is represented by the delayed signal
 
decay:Number (default = 0.5) — the fraction of the delayed signal which is fed back into the delay line
Method Detail
clone()method
override public function clone():IAudioSource

Returns
IAudioSource
initializeState()method 
protected function initializeState():void

resetPosition()method 
override public function resetPosition():void

Resets the audio cursor to the beginning of the source, and causes any cursor-dependent state in the source to be initialized.

transformChannel()method 
override protected function transformChannel(data:Vector.<Number>, channel:Number, start:Number, numFrames:Number):void

Parameters

data:Vector.<Number>
 
channel:Number
 
start:Number
 
numFrames:Number




Copyright 2011-2012 AI Speech Ltd

Tue Mar 26 2013, 01:05 PM +08:00