Class Delay

Effector's subclass for Delay.

Hierarchy (view full)

Effector
- Delay

Index

Constructors

Properties

context delay depth dry feedback input isActive lfo output paused rate tone wet MAX_DELAY_TIME

Accessors

Methods

activate connect deactivate param params start state stop toJSON

Constructors

constructor

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

Properties

`Protected` context

context: AudioContext

`Private` delay

delay: DelayNode

`Protected` depth

depth: GainNode

`Private` dry

dry: GainNode

`Private` feedback

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

`Private` tone

tone: BiquadFilterNode

`Private` wet

wet: GainNode

`Static` MAX_DELAY_TIME

MAX_DELAY_TIME: number = 5

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(): Delay
Returns Delay
Overrides Effector.activate
- Defined in SoundModule/Effectors/Delay.ts:200

connect

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

deactivate

deactivate(): Delay
Returns Delay
Overrides Effector.deactivate
- Defined in SoundModule/Effectors/Delay.ts:206

param

param(params): boolean
This method gets or sets parameters for delay 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 delay effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Delay.ts:96
param(params): number
Parameters
- params: "time"
Returns number
- Defined in SoundModule/Effectors/Delay.ts:97
param(params): number
Parameters
- params: "dry"
Returns number
- Defined in SoundModule/Effectors/Delay.ts:98
param(params): number
Parameters
- params: "wet"
Returns number
- Defined in SoundModule/Effectors/Delay.ts:99
param(params): number
Parameters
- params: "tone"
Returns number
- Defined in SoundModule/Effectors/Delay.ts:100
param(params): number
Parameters
- params: "feedback"
Returns number
- Defined in SoundModule/Effectors/Delay.ts:101
param(params): Delay
Parameters
- params: DelayParams
Returns Delay
- Defined in SoundModule/Effectors/Delay.ts:102

params

params(): Required<DelayParams>
Returns Required<DelayParams>
Overrides Effector.params
- Defined in SoundModule/Effectors/Delay.ts:188

start

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

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?, releaseTime?): void
This method stops LFO, then creates instance of OscillatorNode again.
Parameters
- Optional stopTime: number
  This argument is in order to schedule parameter.
- Optional releaseTime: number
  This argument is in order to schedule parameter when it is necessary to consider release time.
Returns void
Inherited from Effector.stop
- Defined in SoundModule/Effectors/Effector.ts:58

toJSON

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

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