Class EqualizerFilter

Filter for adding equalizer bands.

Memberof

filters

Hierarchy (View Summary)

PixiSound.Filter
- EqualizerFilter

Index

Constructors

constructor

new EqualizerFilter(
    f32?: number,
    f64?: number,
    f125?: number,
    f250?: number,
    f500?: number,
    f1k?: number,
    f2k?: number,
    f4k?: number,
    f8k?: number,
    f16k?: number,
): EqualizerFilter
Parameters
- Optionalf32: number
  Default gain for 32 Hz
- Optionalf64: number
  Default gain for 64 Hz
- Optionalf125: number
  Default gain for 125 Hz
- Optionalf250: number
  Default gain for 250 Hz
- Optionalf500: number
  Default gain for 500 Hz
- Optionalf1k: number
  Default gain for 1000 Hz
- Optionalf2k: number
  Default gain for 2000 Hz
- Optionalf4k: number
  Default gain for 4000 Hz
- Optionalf8k: number
  Default gain for 8000 Hz
- Optionalf16k: number
  Default gain for 16000 Hz
Returns EqualizerFilter
Overrides Filter.constructor
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:80

Properties

`Readonly`bands

bands: BiquadFilterNode[]

The list of bands

`Readonly`bandsMap

bandsMap: Record<number, BiquadFilterNode>

The map of bands to frequency

destination

destination: AudioNode

The node to connect for the filter to the previous filter.

source

source: AudioNode

The node to connect for the filter to the previous filter.

`Static` `Readonly`F125

F125: number

Band at 125 Hz

`Static` `Readonly`F16K

F16K: number

Band at 16000 Hz

`Static` `Readonly`F1K

F1K: number

Band at 1000 Hz

`Static` `Readonly`F250

F250: number

Band at 250 Hz

`Static` `Readonly`F2K

F2K: number

Band at 2000 Hz

`Static` `Readonly`F32

F32: number

Band at 32 Hz

`Static` `Readonly`F4K

F4K: number

Band at 4000 Hz

`Static` `Readonly`F500

F500: number

Band at 500 Hz

`Static` `Readonly`F64

F64: number

Band at 64 Hz

`Static` `Readonly`F8K

F8K: number

Band at 8000 Hz

Accessors

f125

get f125(): number
Returns number
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:109
set f125(value: number): void
Gain at 125 Hz frequencey.
Parameters
- value: number
Returns void
Default
```
0
```
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:108

f16k

get f16k(): number
Returns number
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:151
set f16k(value: number): void
Gain at 16 KHz frequencey.
Parameters
- value: number
Returns void
Default
```
0
```
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:150

f1k

get f1k(): number
Returns number
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:127
set f1k(value: number): void
Gain at 1 KHz frequencey.
Parameters
- value: number
Returns void
Default
```
0
```
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:126

f250

get f250(): number
Returns number
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:115
set f250(value: number): void
Gain at 250 Hz frequencey.
Parameters
- value: number
Returns void
Default
```
0
```
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:114

f2k

get f2k(): number
Returns number
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:133
set f2k(value: number): void
Gain at 2 KHz frequencey.
Parameters
- value: number
Returns void
Default
```
0
```
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:132

f32

get f32(): number
Returns number
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:97
set f32(value: number): void
Gain at 32 Hz frequencey.
Parameters
- value: number
Returns void
Default
```
0
```
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:96

f4k

get f4k(): number
Returns number
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:139
set f4k(value: number): void
Gain at 4 KHz frequencey.
Parameters
- value: number
Returns void
Default
```
0
```
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:138

f500

get f500(): number
Returns number
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:121
set f500(value: number): void
Gain at 500 Hz frequencey.
Parameters
- value: number
Returns void
Default
```
0
```
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:120

f64

get f64(): number
Returns number
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:103
set f64(value: number): void
Gain at 64 Hz frequencey.
Parameters
- value: number
Returns void
Default
```
0
```
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:102

f8k

get f8k(): number
Returns number
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:145
set f8k(value: number): void
Gain at 8 KHz frequencey.
Parameters
- value: number
Returns void
Default
```
0
```
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:144

Methods

connect

connect(destination: AudioNode): void
Connect to the destination.
Parameters
- destination: AudioNode
  The destination node to connect the output to
Returns void
Inherited from Filter.connect
- Defined in node_modules/@pixi/sound/lib/filters/Filter.d.ts:23

destroy

destroy(): void
Destroy the filter and don't use after this.

Returns void
Overrides Filter.destroy
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:154

disconnect

disconnect(): void
Completely disconnect filter from destination and source nodes.

Returns void
Inherited from Filter.disconnect
- Defined in node_modules/@pixi/sound/lib/filters/Filter.d.ts:25

getGain

getGain(frequency: number): number
Get gain amount on a specific frequency.
Parameters
- frequency: number
Returns number
The amount of gain set.
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:91

`Protected`init

init(destination: AudioNode, source?: AudioNode): void
Reinitialize
Parameters
- destination: AudioNode
- Optionalsource: AudioNode
Returns void
Inherited from Filter.init
- Defined in node_modules/@pixi/sound/lib/filters/Filter.d.ts:18

reset

reset(): void
Reset all frequency bands to have gain of 0

Returns void
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:153

setGain

setGain(frequency: number, gain?: number): void
Set gain on a specific frequency.
Parameters
- frequency: number
  The frequency, see EqualizerFilter.F* for bands
- Optionalgain: number
  Recommended -40 to 40.
Returns void
- Defined in node_modules/@pixi/sound/lib/filters/EqualizerFilter.d.ts:86

Class EqualizerFilter

Memberof

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns EqualizerFilter

Properties

Readonlybands

ReadonlybandsMap

destination

source

Static ReadonlyF125

Static ReadonlyF16K

Static ReadonlyF1K

Static ReadonlyF250

Static ReadonlyF2K

Static ReadonlyF32

Static ReadonlyF4K

Static ReadonlyF500

Static ReadonlyF64

Static ReadonlyF8K

Accessors

f125

Returns number

Parameters

Returns void

Default

f16k

Returns number

Parameters

Returns void

Default

f1k

Returns number

Parameters

Returns void

Default

f250

Returns number

Parameters

Returns void

Default

f2k

Returns number

Parameters

Returns void

Default

f32

Returns number

Parameters

Returns void

Default

f4k

Returns number

Parameters

Returns void

Default

f500

Returns number

Parameters

Returns void

Default

f64

Returns number

Parameters

Returns void

Default

f8k

Returns number

Parameters

Returns void

Default

Methods

connect

`Readonly`bands

`Readonly`bandsMap

`Static` `Readonly`F125

`Static` `Readonly`F16K

`Static` `Readonly`F1K

`Static` `Readonly`F250

`Static` `Readonly`F2K

`Static` `Readonly`F32

`Static` `Readonly`F4K

`Static` `Readonly`F500

`Static` `Readonly`F64

`Static` `Readonly`F8K

`Protected`init