Class Ringmodulator

Effector's subclass for Ring Modulator.

Hierarchy (View Summary)

Effector
- Ringmodulator

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 Ringmodulator(context: AudioContext): Ringmodulator
Parameters
- context: AudioContext
  This argument is in order to use Web Audio API.
Returns Ringmodulator
Overrides Effector.constructor
- Defined in SoundModule/Effectors/Ringmodulator.ts:18

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

connect

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

deactivate

deactivate(): Ringmodulator
Returns Ringmodulator
Overrides Effector.deactivate
- Defined in SoundModule/Effectors/Ringmodulator.ts:145

param

param(params: "state"): boolean
This method gets or sets parameters for ring modulator 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 ring modulator effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Ringmodulator.ts:77
param(params: "depth"): number
This method gets or sets parameters for ring modulator 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 ring modulator effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Ringmodulator.ts:78
param(params: "rate"): number
This method gets or sets parameters for ring modulator 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 ring modulator effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Ringmodulator.ts:79
param(params: RingmodulatorParams): Ringmodulator
This method gets or sets parameters for ring modulator effector. This method is overloaded for type interface and type check.
Parameters
- params: RingmodulatorParams
  This argument is string if getter. Otherwise, setter.
Returns Ringmodulator
Return value is parameter for ring modulator effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Ringmodulator.ts:80

params

params(): Required<RingmodulatorParams>
Returns Required<RingmodulatorParams>
Overrides Effector.params
- Defined in SoundModule/Effectors/Ringmodulator.ts:130

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/Ringmodulator.ts:38

toJSON

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

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