Class DistortionFilter

Filter for adding adding delaynode.

Memberof

filters

Hierarchy (View Summary)

PixiSound.Filter
- DistortionFilter

Index

Constructors

Properties

destination source

Accessors

Methods

connect destroy disconnect init

Constructors

constructor

new DistortionFilter(amount?: number): DistortionFilter
Parameters
- Optionalamount: number
  The amount of distoration from 0 to 1.
Returns DistortionFilter
Overrides Filter.constructor
- Defined in node_modules/@pixi/sound/lib/filters/DistortionFilter.d.ts:13

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

amount

get amount(): number
Returns number
- Defined in node_modules/@pixi/sound/lib/filters/DistortionFilter.d.ts:16
set amount(value: number): void
The amount of distortion to set.
Parameters
- value: number
Returns void
- Defined in node_modules/@pixi/sound/lib/filters/DistortionFilter.d.ts:15

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/DistortionFilter.d.ts:17

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