Class Tremolo

Effector's subclass for Tremolo.

Hierarchy (View Summary)

Effector
- Tremolo

Index

Constructors

Properties

context depth input isActive lfo output paused rate

Accessors

Methods

activate connect deactivate param params start state stop toJSON

Constructors

constructor

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

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

connect

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

deactivate

deactivate(): Tremolo
Returns Tremolo
Overrides Effector.deactivate
- Defined in SoundModule/Effectors/Tremolo.ts:160

param

param(params: "type"): OscillatorType
This method gets or sets parameters for tremolo effector. This method is overloaded for type interface and type check.
Parameters
- params: "type"
  This argument is string if getter. Otherwise, setter.
Returns OscillatorType
Return value is parameter for tremolo effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Tremolo.ts:79
param(params: "depth"): number
This method gets or sets parameters for tremolo 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 tremolo effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Tremolo.ts:80
param(params: "rate"): number
This method gets or sets parameters for tremolo 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 tremolo effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Tremolo.ts:81
param(params: TremoloParams): Tremolo
This method gets or sets parameters for tremolo effector. This method is overloaded for type interface and type check.
Parameters
- params: TremoloParams
  This argument is string if getter. Otherwise, setter.
Returns Tremolo
Return value is parameter for tremolo effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Tremolo.ts:82

params

params(): Required<TremoloParams>
Returns Required<TremoloParams>
Overrides Effector.params
- Defined in SoundModule/Effectors/Tremolo.ts:144

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/Tremolo.ts:40

toJSON

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

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