Class Filter

Represents a single sound element. Can be used to play, pause, etc. sound instances.

Memberof

filters

Hierarchy (View Summary)

Filter

Index

Constructors

Properties

destination source

Methods

connect destroy disconnect init

Constructors

constructor

new Filter(destination: AudioNode, source?: AudioNode): PixiSound.Filter
Parameters
- destination: AudioNode
  The audio node to use as the destination for the input AudioNode
- Optionalsource: AudioNode
  Optional output node, defaults to destination node. This is useful when creating filters which contains multiple AudioNode elements chained together.
Returns PixiSound.Filter
- Defined in node_modules/@pixi/sound/lib/filters/Filter.d.ts:16

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.

Methods

connect

connect(destination: AudioNode): void
Connect to the destination.
Parameters
- destination: AudioNode
  The destination node to connect the output to
Returns void
- 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
- 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
- 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
- Defined in node_modules/@pixi/sound/lib/filters/Filter.d.ts:18