Class Effector`Abstract`

This class is superclass for effector classes. Also, this class is used for implementing custom effector.

Implements

Index

Constructors

Properties

context depth input isActive lfo output paused rate

Accessors

Methods

activate connect deactivate params start state stop toJSON

Constructors

constructor

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

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
Implementation of Connectable.INPUT
- Defined in SoundModule/Effectors/Effector.ts:140

OUTPUT

get OUTPUT(): GainNode
Connector for output.

Returns GainNode
Implementation of Connectable.OUTPUT
- Defined in SoundModule/Effectors/Effector.ts:147

Methods

activate

activate(): Effector
This method activates effector.

Returns Effector
Return value is for method chain.
Implementation of Statable.activate
- Defined in SoundModule/Effectors/Effector.ts:109

`Abstract`connect

connect(): GainNode
This method connects AudioNodes for effector.

Returns GainNode
Return value is for connect method chain.
- Defined in SoundModule/Effectors/Effector.ts:82

deactivate

deactivate(): Effector
This method deactivates effector.

Returns Effector
Return value is for method chain.
Implementation of Statable.deactivate
- Defined in SoundModule/Effectors/Effector.ts:125

`Abstract`params

params(): void
This method gets effector's parameters as associative array.

Returns void
- Defined in SoundModule/Effectors/Effector.ts:87

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
- Defined in SoundModule/Effectors/Effector.ts:40

state

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

Returns boolean
Implementation of Statable.state
- Defined in SoundModule/Effectors/Effector.ts:101

stop

stop(stopTime?: number, releaseTime?: number): void
This method stops LFO, then creates instance of OscillatorNode again.
Parameters
- OptionalstopTime: number
  This argument is in order to schedule parameter.
- OptionalreleaseTime: number
  This argument is in order to schedule parameter when it is necessary to consider release time.
Returns void
- Defined in SoundModule/Effectors/Effector.ts:54

toJSON

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

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