Class Marshall

Effector's subclass for Preamplifier (Marshall).

Hierarchy (View Summary)

Effector
- Marshall

Index

Constructors

constructor

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

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

connect

connect(): GainNode
Returns GainNode
Overrides Effector.connect
- Defined in SoundModule/Effectors/Preamps/Marshall.ts:472

deactivate

deactivate(): Marshall
Returns Marshall
Overrides Effector.deactivate
- Defined in SoundModule/Effectors/Preamps/Marshall.ts:629

param

param(params: "state"): 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/Preamps/Marshall.ts:501
param(params: "level"): number
This method gets or sets parameters for preamp effector. This method is overloaded for type interface and type check.
Parameters
- params: "level"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for preamp effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Preamps/Marshall.ts:502
param(params: "samples"): number
This method gets or sets parameters for preamp effector. This method is overloaded for type interface and type check.
Parameters
- params: "samples"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for preamp effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Preamps/Marshall.ts:503
param(params: "pre"): undefined | MarshallPreEqualizerParams
This method gets or sets parameters for preamp effector. This method is overloaded for type interface and type check.
Parameters
- params: "pre"
  This argument is string if getter. Otherwise, setter.
Returns undefined | MarshallPreEqualizerParams
Return value is parameter for preamp effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Preamps/Marshall.ts:504
param(params: "post"): undefined | MarshallPostEqualizerParams
This method gets or sets parameters for preamp effector. This method is overloaded for type interface and type check.
Parameters
- params: "post"
  This argument is string if getter. Otherwise, setter.
Returns undefined | MarshallPostEqualizerParams
Return value is parameter for preamp effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Preamps/Marshall.ts:505
param(params: "cabinet"): CabinetParams
This method gets or sets parameters for preamp effector. This method is overloaded for type interface and type check.
Parameters
- params: "cabinet"
  This argument is string if getter. Otherwise, setter.
Returns CabinetParams
Return value is parameter for preamp effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Preamps/Marshall.ts:506
param(params: MarshallParams): Marshall
This method gets or sets parameters for preamp effector. This method is overloaded for type interface and type check.
Parameters
- params: MarshallParams
  This argument is string if getter. Otherwise, setter.
Returns Marshall
Return value is parameter for preamp effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Preamps/Marshall.ts:507

params

params(): Required<MarshallParams>
Returns Required<MarshallParams>
Overrides Effector.params
- Defined in SoundModule/Effectors/Preamps/Marshall.ts:611

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
This method stops LFO, then creates instance of OscillatorNode again.
Parameters
- OptionalstopTime: number
  This argument is in order to schedule parameter.
- OptionalreleaseTime: 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:54

toJSON

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

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

Class Marshall

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Marshall

Properties

Protectedcontext

Protecteddepth

Protectedinput

ProtectedisActive

Protectedlfo

Protectedoutput

Protectedpaused

Protectedrate

Accessors

INPUT

Returns GainNode

OUTPUT

Returns GainNode

Methods

activate

Returns Marshall

connect

Returns GainNode

deactivate

Returns Marshall

param

Parameters

Returns boolean

Parameters

Returns number

Parameters

Returns number

Parameters

Returns undefined | MarshallPreEqualizerParams

Parameters

Returns undefined | MarshallPostEqualizerParams

Parameters

Returns CabinetParams

Parameters

Returns Marshall

params

Returns Required<MarshallParams>

start

Parameters

Returns void

state

Returns boolean

stop

Parameters

Returns void

toJSON

Returns string

Settings

On This Page

`Protected`context

`Protected`depth

`Protected`input

`Protected`isActive

`Protected`lfo

`Protected`output

`Protected`paused

`Protected`rate