Class BitCrusher

Effector's subclass for BitCrusher.

Hierarchy (view full)

Effector
- BitCrusher

Index

Constructors

Properties

bits bitsGain bitsInput context depth input inputLevel inputShaper isActive lfo output outputLevel outputShaper paused rate shaper

Accessors

Methods

activate connect deactivate param params start state stop toJSON

Constructors

constructor

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

Properties

`Private` bits

bits: number = 0

`Private` bitsGain

bitsGain: GainNode

`Private` bitsInput

bitsInput: ConstantSourceNode

`Protected` context

context: AudioContext

`Protected` depth

depth: GainNode

`Protected` input

input: GainNode

`Private` inputLevel

inputLevel: GainNode

`Private` inputShaper

inputShaper: WaveShaperNode

`Protected` isActive

isActive: boolean = true

`Protected` lfo

lfo: OscillatorNode

`Protected` output

output: GainNode

`Private` outputLevel

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

connect

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

deactivate

deactivate(): BitCrusher
Returns BitCrusher
Overrides Effector.deactivate
- Defined in SoundModule/Effectors/BitCrusher.ts:227

param

param(params): boolean
This method gets or sets parameters for bit crusher 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 bit crusher effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/BitCrusher.ts:156
param(params): number
Parameters
- params: "bits"
Returns number
- Defined in SoundModule/Effectors/BitCrusher.ts:157
param(params): OverSampleType
Parameters
- params: "oversample"
Returns OverSampleType
- Defined in SoundModule/Effectors/BitCrusher.ts:158
param(params): BitCrusher
Parameters
- params: BitCrusherParams
Returns BitCrusher
- Defined in SoundModule/Effectors/BitCrusher.ts:159

params

params(): Required<BitCrusherParams>
Returns Required<BitCrusherParams>
Overrides Effector.params
- Defined in SoundModule/Effectors/BitCrusher.ts:212

start

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

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/BitCrusher.ts:89

toJSON

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

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