Class Ringmodulator

Effector's subclass for Ring Modulator.

Hierarchy (view full)

Effector
- Ringmodulator

Index

Constructors

Properties

amplitude context depth input isActive lfo output paused rate

Accessors

Methods

activate connect deactivate param params start state stop toJSON

Constructors

constructor

new Ringmodulator(context): 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:20

Properties

`Private` amplitude

amplitude: GainNode

`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:146

OUTPUT

get OUTPUT(): GainNode
Connector for output.

Returns GainNode
Inherited from Effector.OUTPUT
- Defined in SoundModule/Effectors/Effector.ts:153

Methods

activate

activate(): Ringmodulator
Returns Ringmodulator
Overrides Effector.activate
- Defined in SoundModule/Effectors/Ringmodulator.ts:141

connect

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

deactivate

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

param

param(params): 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:79
param(params): number
Parameters
- params: "depth"
Returns number
- Defined in SoundModule/Effectors/Ringmodulator.ts:80
param(params): number
Parameters
- params: "rate"
Returns number
- Defined in SoundModule/Effectors/Ringmodulator.ts:81
param(params): Ringmodulator
Parameters
- params: RingmodulatorParams
Returns Ringmodulator
- Defined in SoundModule/Effectors/Ringmodulator.ts:82

params

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

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

Generated using TypeDoc