Class Flanger

Effector's subclass for Flanger.

Hierarchy (View Summary)

Effector
- Flanger

Index

Constructors

constructor

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

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

OUTPUT

get OUTPUT(): GainNode
Connector for output.

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

Methods

activate

activate(): Flanger
Returns Flanger
Overrides Effector.activate
- Defined in SoundModule/Effectors/Flanger.ts:264

connect

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

deactivate

deactivate(): Flanger
Returns Flanger
Overrides Effector.deactivate
- Defined in SoundModule/Effectors/Flanger.ts:270

param

param(params: "state"): boolean
This method gets or sets parameters for flanger 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 flanger effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Flanger.ts:115
param(params: "time"): number
This method gets or sets parameters for flanger effector. This method is overloaded for type interface and type check.
Parameters
- params: "time"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for flanger effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Flanger.ts:116
param(params: "depth"): number
This method gets or sets parameters for flanger effector. This method is overloaded for type interface and type check.
Parameters
- params: "depth"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for flanger effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Flanger.ts:117
param(params: "rate"): number
This method gets or sets parameters for flanger effector. This method is overloaded for type interface and type check.
Parameters
- params: "rate"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for flanger effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Flanger.ts:118
param(params: "mix"): number
This method gets or sets parameters for flanger effector. This method is overloaded for type interface and type check.
Parameters
- params: "mix"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for flanger effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Flanger.ts:119
param(params: "dry"): number
This method gets or sets parameters for flanger effector. This method is overloaded for type interface and type check.
Parameters
- params: "dry"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for flanger effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Flanger.ts:120
param(params: "wet"): number
This method gets or sets parameters for flanger effector. This method is overloaded for type interface and type check.
Parameters
- params: "wet"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for flanger effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Flanger.ts:121
param(params: "tone"): number
This method gets or sets parameters for flanger effector. This method is overloaded for type interface and type check.
Parameters
- params: "tone"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for flanger effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Flanger.ts:122
param(params: "feedback"): number
This method gets or sets parameters for flanger effector. This method is overloaded for type interface and type check.
Parameters
- params: "feedback"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for flanger effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Flanger.ts:123
param(params: FlangerParams): Flanger
This method gets or sets parameters for flanger effector. This method is overloaded for type interface and type check.
Parameters
- params: FlangerParams
  This argument is string if getter. Otherwise, setter.
Returns Flanger
Return value is parameter for flanger effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Flanger.ts:124

params

params(): Required<FlangerParams>
Returns Required<FlangerParams>
Overrides Effector.params
- Defined in SoundModule/Effectors/Flanger.ts:249

start

start(startTime?: number): void
This method starts LFO. Namely, this method starts effector.
Parameters
- OptionalstartTime: number
  This argument is in order to schedule parameter.
Returns void
Inherited from Effector.start
- Defined in SoundModule/Effectors/Effector.ts:40

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, releaseTime?: number): void
Parameters
- OptionalstopTime: number
- OptionalreleaseTime: number
Returns void
Overrides Effector.stop
- Defined in SoundModule/Effectors/Flanger.ts:61

toJSON

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

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

Class Flanger

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Flanger

Properties

Protectedcontext

Protecteddepth

Protectedinput

ProtectedisActive

Protectedlfo

Protectedoutput

Protectedpaused

Protectedrate

Accessors

INPUT

Returns GainNode

OUTPUT

Returns GainNode

Methods

activate

Returns Flanger

connect

Returns GainNode

deactivate

Returns Flanger

param

Parameters

Returns boolean

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 Flanger

params

Returns Required<FlangerParams>

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