Interface Filter

Effector's subclass for Filter.

interface Filter {
    context: AudioContext;
    depth: GainNode;
    input: GainNode;
    isActive: boolean;
    lfo: OscillatorNode;
    output: GainNode;
    paused: boolean;
    rate: AudioParam;
    get INPUT(): GainNode;
    get OUTPUT(): GainNode;
    activate(): Filter;
    connect(): GainNode;
    deactivate(): Filter;
    param(params: "state"): boolean;
    param(params: "type"): BiquadFilterType;
    param(params: "frequency"): number;
    param(params: "Q"): number;
    param(params: "gain"): number;
    param(params: "range"): number;
    param(params: "attack"): number;
    param(params: "decay"): number;
    param(params: "sustain"): number;
    param(params: "release"): number;
    param(params: FilterParams): Filter;
    params(): Required<FilterParams>;
    start(startTime?: number): void;
    state(): boolean;
    stop(stopTime?: number): void;
    toJSON(): string;
}

Hierarchy (View Summary)

Effector
- Filter

Index

Properties

`Protected`context

context: AudioContext

`Protected`depth

depth: GainNode

`Protected`input

input: GainNode

`Protected`isActive

isActive: boolean = true

`Protected`lfo

lfo: OscillatorNode

`Protected`output

output: GainNode

`Protected`paused

paused: boolean = true

`Protected`rate

rate: AudioParam

Accessors

INPUT

get INPUT(): GainNode
Connector for input.

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

OUTPUT

get OUTPUT(): GainNode
Connector for output.

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

Methods

activate

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

connect

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

deactivate

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

param

param(params: "state"): 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:123
param(params: "type"): BiquadFilterType
This method gets or sets parameters for filter effector. This method is overloaded for type interface and type check.
Parameters
- params: "type"
  This argument is string if getter. Otherwise, setter.
Returns BiquadFilterType
Return value is parameter for filter effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Filter.ts:124
param(params: "frequency"): number
This method gets or sets parameters for filter effector. This method is overloaded for type interface and type check.
Parameters
- params: "frequency"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for filter effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Filter.ts:125
param(params: "Q"): number
This method gets or sets parameters for filter effector. This method is overloaded for type interface and type check.
Parameters
- params: "Q"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for filter effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Filter.ts:126
param(params: "gain"): number
This method gets or sets parameters for filter effector. This method is overloaded for type interface and type check.
Parameters
- params: "gain"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for filter effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Filter.ts:127
param(params: "range"): number
This method gets or sets parameters for filter effector. This method is overloaded for type interface and type check.
Parameters
- params: "range"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for filter effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Filter.ts:128
param(params: "attack"): number
This method gets or sets parameters for filter effector. This method is overloaded for type interface and type check.
Parameters
- params: "attack"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for filter effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Filter.ts:129
param(params: "decay"): number
This method gets or sets parameters for filter effector. This method is overloaded for type interface and type check.
Parameters
- params: "decay"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for filter effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Filter.ts:130
param(params: "sustain"): number
This method gets or sets parameters for filter effector. This method is overloaded for type interface and type check.
Parameters
- params: "sustain"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for filter effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Filter.ts:131
param(params: "release"): number
This method gets or sets parameters for filter effector. This method is overloaded for type interface and type check.
Parameters
- params: "release"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for filter effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Filter.ts:132
param(params: FilterParams): Filter
This method gets or sets parameters for filter effector. This method is overloaded for type interface and type check.
Parameters
- params: FilterParams
  This argument is string if getter. Otherwise, setter.
Returns Filter
Return value is parameter for filter effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Filter.ts:133

params

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

start

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

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:101

stop

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

toJSON

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

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

Interface Filter

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

Protectedcontext

Protecteddepth

Protectedinput

ProtectedisActive

Protectedlfo

Protectedoutput

Protectedpaused

Protectedrate

Accessors

INPUT

Returns GainNode

OUTPUT

Returns GainNode

Methods

activate

Returns Filter

connect

Returns GainNode

deactivate

Returns Filter

param

Parameters

Returns boolean

Parameters

Returns BiquadFilterType

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns Filter

params

Returns Required<FilterParams>

start

Parameters

Returns void

state

Returns boolean

stop

Parameters

Returns void

toJSON

Returns string

Settings

On This Page

`Protected`context

`Protected`depth

`Protected`input

`Protected`isActive

`Protected`lfo

`Protected`output

`Protected`paused

`Protected`rate