| Package | com.noteflight.standingwave2.filters |
| Class | public class BiquadFilter |
| Inheritance | BiquadFilter AbstractFilter Object |
frequency property, as a high-pass filter that attenuates frequencies lower
than the center, or as a band-pass filter that attenuates frequencies that lie
further from the center. In all three cases the resonance property controls
the abruptness of the rolloff as a function of frequency. The type property
determines which filter behavior is used.
| Property | Defined By | ||
|---|---|---|---|
![]() | descriptor : AudioDescriptor [read-only]
The AudioDescriptor describing the audio characteristics of this source. | AbstractFilter | |
![]() | frameCount : Number [read-only]
The number of sample frames in this source. | AbstractFilter | |
| frequency : Number
The center frequency of the filter in Hz. | BiquadFilter | ||
![]() | position : Number [read-only]
The position of the audio cursor in this source, as a frame index. | AbstractFilter | |
| resonance : Number
The resonance of the filter, which controls the degree of attenuation in its frequency response. | BiquadFilter | ||
![]() | source : IAudioSource
The underlying audio source for this filter. | AbstractFilter | |
| type : int
The type of the filter, which controls the shape of its frequency response. | BiquadFilter | ||
| Method | Defined By | ||
|---|---|---|---|
BiquadFilter(source:IAudioSource = null, type:int, frequency:Number = 1000, resonance:Number = 1)
Construct an instance of a BiquadFilter. | BiquadFilter | ||
[override] | BiquadFilter | ||
![]() |
Retrieve a number of sample frames from this source as a Sample object,
starting from the audio cursor position. | AbstractFilter | |
resetPosition():void [override] | BiquadFilter | ||
| Method | Defined By | ||
|---|---|---|---|
computeCoefficients():void
Called to force calculation of the derived coefficients. | BiquadFilter | ||
invalidateCoefficients():void
Called when a property change invalidates the derived coefficients for the filter. | BiquadFilter | ||
transformChannel(data:Vector.<Number>, channel:Number, start:Number, numFrames:Number):void [override] | BiquadFilter | ||
| Constant | Defined By | ||
|---|---|---|---|
| BAND_PASS_TYPE : int = 2 [static] Band-pass filter type (constant peak, attenuated skirt) | BiquadFilter | ||
| HIGH_PASS_TYPE : int = 1 [static] High-pass filter type | BiquadFilter | ||
| LOW_PASS_TYPE : int = 0 [static] Low-pass filter type | BiquadFilter | ||
| frequency | property |
frequency:NumberThe center frequency of the filter in Hz.
public function get frequency():Number public function set frequency(value:Number):void| resonance | property |
resonance:NumberThe resonance of the filter, which controls the degree of attenuation in its frequency response.
public function get resonance():Number public function set resonance(value:Number):void| type | property |
type:intThe type of the filter, which controls the shape of its frequency response.
public function get type():int public function set type(value:int):void| BiquadFilter | () | Constructor |
public function BiquadFilter(source:IAudioSource = null, type:int, frequency:Number = 1000, resonance:Number = 1)Construct an instance of a BiquadFilter. Parameters may be left as defaulted and/or changed later while the filter is in operation.
Parameterssource:IAudioSource (default = null) — the underlying audio source
| |
type:int (default = NaN) — the type of filter desired
| |
frequency:Number (default = 1000) — the center frequency of the filter
| |
resonance:Number (default = 1) — the resonance characteristic of the filter, also known as "Q"
|
| clone | () | method |
| computeCoefficients | () | method |
protected function computeCoefficients():voidCalled to force calculation of the derived coefficients.
| invalidateCoefficients | () | method |
protected function invalidateCoefficients():voidCalled when a property change invalidates the derived coefficients for the filter.
| resetPosition | () | method |
override public function resetPosition():void| transformChannel | () | method |
override protected function transformChannel(data:Vector.<Number>, channel:Number, start:Number, numFrames:Number):voidParameters
data:Vector.<Number> | |
channel:Number | |
start:Number | |
numFrames:Number |
| BAND_PASS_TYPE | Constant |
public static const BAND_PASS_TYPE:int = 2Band-pass filter type (constant peak, attenuated skirt)
| HIGH_PASS_TYPE | Constant |
public static const HIGH_PASS_TYPE:int = 1High-pass filter type
| LOW_PASS_TYPE | Constant |
public static const LOW_PASS_TYPE:int = 0Low-pass filter type