Class Filter

Effector's subclass for Filter.

Hierarchy

Effector
- Filter

Index

Constructors

Properties

attack context decay depth filter input isActive lfo maxFrequency output paused range rate release sustain

Accessors

Methods

activate connect deactivate param params start state stop toJSON

Constructors

constructor

new Filter(context): Filter
Parameters
- context: AudioContext
  
  This argument is in order to use Web Audio API.
Returns Filter
Overrides Effector.constructor
- Defined in SoundModule/Effectors/Filter.ts:35

Properties

`Private` attack

attack: number = 0.01

`Protected` context

context: AudioContext

`Private` decay

decay: number = 0.3

`Protected` depth

depth: GainNode

`Private` filter

filter: BiquadFilterNode

`Protected` input

input: GainNode

`Protected` isActive

isActive: boolean = true

`Protected` lfo

lfo: OscillatorNode

`Private` maxFrequency

maxFrequency: number

`Protected` output

output: GainNode

`Protected` paused

paused: boolean = true

`Private` range

range: number = 0.1

`Protected` rate

rate: AudioParam

`Private` release

release: number = 1.0

`Private` sustain

sustain: number = 1.0

Accessors

INPUT

get INPUT(): GainNode
Connector for input.

Returns GainNode
Inherited from Effector.INPUT
- Defined in SoundModule/Effectors/Effector.ts:146

OUTPUT

get OUTPUT(): GainNode
Connector for output.

Returns GainNode
Inherited from Effector.OUTPUT
- Defined in SoundModule/Effectors/Effector.ts:153

Methods

activate

activate(): Filter
Returns Filter
Overrides Effector.activate
- Defined in SoundModule/Effectors/Filter.ts:245

connect

connect(): GainNode
Returns GainNode
Overrides Effector.connect
- Defined in SoundModule/Effectors/Filter.ts:90

deactivate

deactivate(): Filter
Returns Filter
Overrides Effector.deactivate
- Defined in SoundModule/Effectors/Filter.ts:255

param

param(params): boolean
This method gets or sets parameters for filter effector. This method is overloaded for type interface and type check.
Parameters
- params: "state"
  
  This argument is string if getter. Otherwise, setter.
Returns boolean
Return value is parameter for filter effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Filter.ts:118
param(params): BiquadFilterType
Parameters
- params: "type"
Returns BiquadFilterType
- Defined in SoundModule/Effectors/Filter.ts:119
param(params): number
Parameters
- params: "frequency"
Returns number
- Defined in SoundModule/Effectors/Filter.ts:120
param(params): number
Parameters
- params: "Q"
Returns number
- Defined in SoundModule/Effectors/Filter.ts:121
param(params): number
Parameters
- params: "gain"
Returns number
- Defined in SoundModule/Effectors/Filter.ts:122
param(params): number
Parameters
- params: "range"
Returns number
- Defined in SoundModule/Effectors/Filter.ts:123
param(params): number
Parameters
- params: "attack"
Returns number
- Defined in SoundModule/Effectors/Filter.ts:124
param(params): number
Parameters
- params: "decay"
Returns number
- Defined in SoundModule/Effectors/Filter.ts:125
param(params): number
Parameters
- params: "sustain"
Returns number
- Defined in SoundModule/Effectors/Filter.ts:126
param(params): number
Parameters
- params: "release"
Returns number
- Defined in SoundModule/Effectors/Filter.ts:127
param(params): Filter
Parameters
- params: FilterParams
Returns Filter
- Defined in SoundModule/Effectors/Filter.ts:128

params

params(): Required<FilterParams>
Returns Required<FilterParams>
Overrides Effector.params
- Defined in SoundModule/Effectors/Filter.ts:229

start

start(startTime?): void
Parameters
- Optional startTime: number
Returns void
Overrides Effector.start
- Defined in SoundModule/Effectors/Filter.ts:53

state

state(): boolean
This method gets effector state. If returns true, effector is active.

Returns boolean
Inherited from Effector.state
- Defined in SoundModule/Effectors/Effector.ts:107

stop

stop(stopTime?): void
Parameters
- Optional stopTime: number
Returns void
Overrides Effector.stop
- Defined in SoundModule/Effectors/Filter.ts:73

toJSON

toJSON(): string
This method gets effector's parameters as JSON.

Returns string
Inherited from Effector.toJSON
- Defined in SoundModule/Effectors/Effector.ts:99

Generated using TypeDoc