Class Preamp

Effector's subclass for Preamplifier.

Hierarchy (view full)

Effector
- Preamp

Index

Constructors

Properties

cabinet context depth input isActive level lfo numberOfSamples output paused postEQ preEQ rate

Accessors

Methods

activate connect deactivate param params start state stop toJSON createCurve

Constructors

constructor

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

Properties

`Private` cabinet

cabinet: Cabinet

`Protected` context

context: AudioContext

`Protected` depth

depth: GainNode

`Protected` input

input: GainNode

`Protected` isActive

isActive: boolean = true

`Private` level

level: number = 0

`Protected` lfo

lfo: OscillatorNode

`Private` numberOfSamples

numberOfSamples: number = 1024

`Protected` output

output: GainNode

`Protected` paused

paused: boolean = true

`Private` postEQ

postEQ: PostEqualizer

`Private` preEQ

preEQ: PreEqualizer

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

connect

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

deactivate

deactivate(): Preamp
Returns Preamp
Overrides Effector.deactivate
- Defined in SoundModule/Effectors/Preamp.ts:751

param

param(params): boolean
This method gets or sets parameters for preamp 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 preamp effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Preamp.ts:636
param(params): number
Parameters
- params: "level"
Returns number
- Defined in SoundModule/Effectors/Preamp.ts:637
param(params): number
Parameters
- params: "samples"
Returns number
- Defined in SoundModule/Effectors/Preamp.ts:638
param(params): PreEqualizerParams
Parameters
- params: "pre"
Returns PreEqualizerParams
- Defined in SoundModule/Effectors/Preamp.ts:639
param(params): PostEqualizerParams
Parameters
- params: "post"
Returns PostEqualizerParams
- Defined in SoundModule/Effectors/Preamp.ts:640
param(params): CabinetParams
Parameters
- params: "cabinet"
Returns CabinetParams
- Defined in SoundModule/Effectors/Preamp.ts:641
param(params): Preamp
Parameters
- params: PreampParams
Returns Preamp
- Defined in SoundModule/Effectors/Preamp.ts:642

params

params(): Required<PreampParams>
Returns Required<PreampParams>
Overrides Effector.params
- Defined in SoundModule/Effectors/Preamp.ts:733

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

`Static` createCurve

createCurve(level, numberOfSamples): null | Float32Array
This class (static) method creates instance of Float32Array for WaveShaperNode.
Parameters
- level: number
  This argument is preamp effect level.
- numberOfSamples: number
  This argument is curve size.
Returns null | Float32Array
Return value is WaveShaperNode's 'curve'.
- Defined in SoundModule/Effectors/Preamp.ts:558