Class Cabinet

Effector's subclass for Cabinet.

Hierarchy

Effector
- Cabinet

Index

Constructors

Properties

context depth input isActive lfo lowpass notch output paused rate

Accessors

Methods

activate connect deactivate param params start state stop toJSON

Constructors

constructor

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

Properties

`Protected` context

context: AudioContext

`Protected` depth

depth: GainNode

`Protected` input

input: GainNode

`Protected` isActive

isActive: boolean = true

`Protected` lfo

lfo: OscillatorNode

`Private` lowpass

lowpass: BiquadFilterNode

`Private` notch

notch: BiquadFilterNode

`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(): Effector
This method activates effector.

Returns Effector
Return value is for method chain.
Inherited from Effector.activate
- Defined in SoundModule/Effectors/Effector.ts:115

connect

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

deactivate

deactivate(): Effector
This method deactivates effector.

Returns Effector
Return value is for method chain.
Inherited from Effector.deactivate
- Defined in SoundModule/Effectors/Effector.ts:131

param

param(params): boolean
This method gets or sets parameters for cabinet. 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 cabinet if getter.
- Defined in SoundModule/Effectors/Preamp.ts:444
param(params): void
Parameters
- params: CabinetParams
Returns void
- Defined in SoundModule/Effectors/Preamp.ts:445

params

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

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

Generated using TypeDoc