Class OverDrive

Effector's subclass for OverDrive.

Hierarchy

Effector
- OverDrive

Index

Constructors

Properties

context depth drive driveInput input inputGain inputShaper isActive level lfo output outputGain outputShaper paused rate shaper

Accessors

Methods

activate connect deactivate param params start state stop toJSON

Constructors

constructor

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

Properties

`Protected` context

context: AudioContext

`Protected` depth

depth: GainNode

`Private` drive

drive: number = 0

`Private` driveInput

driveInput: ConstantSourceNode

`Protected` input

input: GainNode

`Private` inputGain

inputGain: GainNode

`Private` inputShaper

inputShaper: WaveShaperNode

`Protected` isActive

isActive: boolean = true

`Private` level

level: GainNode

`Protected` lfo

lfo: OscillatorNode

`Protected` output

output: GainNode

`Private` outputGain

outputGain: GainNode

`Private` outputShaper

outputShaper: WaveShaperNode

`Protected` paused

paused: boolean = true

`Protected` rate

rate: AudioParam

`Private` shaper

shaper: WaveShaperNode

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

connect

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

deactivate

deactivate(): OverDrive
Returns OverDrive
Overrides Effector.deactivate
- Defined in SoundModule/Effectors/OverDrive.ts:219

param

param(params): boolean
This method gets or sets parameters for overdrive 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 overdrive effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/OverDrive.ts:156
param(params): number
Parameters
- params: "drive"
Returns number
- Defined in SoundModule/Effectors/OverDrive.ts:157
param(params): number
Parameters
- params: "level"
Returns number
- Defined in SoundModule/Effectors/OverDrive.ts:158
param(params): OverDrive
Parameters
- params: OverDriveParams
Returns OverDrive
- Defined in SoundModule/Effectors/OverDrive.ts:159

params

params(): Required<OverDriveParams>
Returns Required<OverDriveParams>
Overrides Effector.params
- Defined in SoundModule/Effectors/OverDrive.ts:204

start

start(_startTime?): void
Parameters
- Optional _startTime: number
Returns void
Overrides Effector.start
- Defined in SoundModule/Effectors/OverDrive.ts:80

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/OverDrive.ts:91

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