Class Chorus

Effector's subclass for Chorus.

Hierarchy

Effector
- Chorus

Index

Constructors

Properties

context delay depth depthRate feedback input isActive lfo mix output paused rate tone

Accessors

Methods

activate connect deactivate param params start state stop toJSON

Constructors

constructor

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

Properties

`Protected` context

context: AudioContext

`Private` delay

delay: DelayNode

`Protected` depth

depth: GainNode

`Private` depthRate

depthRate: number = 0

`Private` feedback

feedback: GainNode

`Protected` input

input: GainNode

`Protected` isActive

isActive: boolean = true

`Protected` lfo

lfo: OscillatorNode

`Private` mix

mix: GainNode

`Protected` output

output: GainNode

`Protected` paused

paused: boolean = true

`Protected` rate

rate: AudioParam

`Private` tone

tone: BiquadFilterNode

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

connect

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

deactivate

deactivate(): Chorus
Returns Chorus
Overrides Effector.deactivate
- Defined in SoundModule/Effectors/Chorus.ts:208

param

param(params): boolean
This method gets or sets parameters for chorus 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 chorus effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Chorus.ts:104
param(params): number
Parameters
- params: "time"
Returns number
- Defined in SoundModule/Effectors/Chorus.ts:105
param(params): number
Parameters
- params: "depth"
Returns number
- Defined in SoundModule/Effectors/Chorus.ts:106
param(params): number
Parameters
- params: "rate"
Returns number
- Defined in SoundModule/Effectors/Chorus.ts:107
param(params): number
Parameters
- params: "mix"
Returns number
- Defined in SoundModule/Effectors/Chorus.ts:108
param(params): number
Parameters
- params: "tone"
Returns number
- Defined in SoundModule/Effectors/Chorus.ts:109
param(params): number
Parameters
- params: "feedback"
Returns number
- Defined in SoundModule/Effectors/Chorus.ts:110
param(params): Chorus
Parameters
- params: ChorusParams
Returns Chorus
- Defined in SoundModule/Effectors/Chorus.ts:111

params

params(): Required<ChorusParams>
Returns Required<ChorusParams>
Overrides Effector.params
- Defined in SoundModule/Effectors/Chorus.ts:189

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
Parameters
- Optional stopTime: number
- Optional releaseTime: number
Returns void
Overrides Effector.stop
- Defined in SoundModule/Effectors/Chorus.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

Generated using TypeDoc