Class ReverbFilter

Filter for adding reverb. Refactored from https://github.com/web-audio-components/simple-reverb/

Memberof

filters

Hierarchy (View Summary)

PixiSound.Filter
- ReverbFilter

Index

Constructors

Properties

destination source

Accessors

decay reverse seconds

Methods

connect destroy disconnect init

Constructors

constructor

new ReverbFilter(
    seconds?: number,
    decay?: number,
    reverse?: boolean,
): ReverbFilter
Parameters
- Optionalseconds: number
  Seconds for reverb
- Optionaldecay: number
  The decay length
- Optionalreverse: boolean
  Reverse reverb
Returns ReverbFilter
Overrides Filter.constructor
- Defined in node_modules/@pixi/sound/lib/filters/ReverbFilter.d.ts:17

Properties

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.

Accessors

decay

get decay(): number
Decay value from 0 to 100

Returns number
Default
```
2
```
- Defined in node_modules/@pixi/sound/lib/filters/ReverbFilter.d.ts:36
set decay(decay: number): void
Parameters
- decay: number
Returns void
- Defined in node_modules/@pixi/sound/lib/filters/ReverbFilter.d.ts:37

reverse

get reverse(): boolean
Reverse value from 0 to 1

Returns boolean
Default
```
false
```
- Defined in node_modules/@pixi/sound/lib/filters/ReverbFilter.d.ts:42
set reverse(reverse: boolean): void
Parameters
- reverse: boolean
Returns void
- Defined in node_modules/@pixi/sound/lib/filters/ReverbFilter.d.ts:43

seconds

get seconds(): number
Length of reverb in seconds from 1 to 50

Returns number
Default
```
3
```
- Defined in node_modules/@pixi/sound/lib/filters/ReverbFilter.d.ts:30
set seconds(seconds: number): void
Parameters
- seconds: number
Returns void
- Defined in node_modules/@pixi/sound/lib/filters/ReverbFilter.d.ts:31

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
Inherited from Filter.destroy
- Defined in node_modules/@pixi/sound/lib/filters/Filter.d.ts:27

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

`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