Class SoundModule`Abstract`

This class is superclass that is the top in this library. This class is extended as subclass (OscillatorModule, OneshotModule, NoiseModule, AudioModule, MediaModule, StreamModule, ProcessorModule, MixerModule ...etc).

Hierarchy (view full)

SoundModule

Implements

Connectable

Constructors

constructor

new SoundModule(context): SoundModule
Parameters
- context: AudioContext
  This argument is in order to use Web Audio API.
Returns SoundModule
- Defined in SoundModule/index.ts:191

Properties

`Protected`analyser

analyser: Analyser

`Protected`autopanner

autopanner: Autopanner

`Protected`bitcrusher

bitcrusher: BitCrusher

`Protected`chorus

chorus: Chorus

`Protected`compressor

compressor: Compressor

`Protected`context

context: AudioContext

`Protected`delay

delay: Delay

`Protected`envelopegenerator

envelopegenerator: EnvelopeGenerator

`Protected`equalizer

equalizer: Equalizer

`Protected`filter

filter: Filter

`Protected`flanger

flanger: Flanger

`Protected`fuzz

fuzz: Fuzz

`Protected`listener

listener: Listener

`Protected`mastervolume

mastervolume: GainNode

`Protected`mixed

mixed: boolean = false

`Protected`modules

modules: Connectable[] = []

`Protected`noisegate

noisegate: NoiseGate

`Protected`noisesuppressor

noisesuppressor: NoiseSuppressor

`Protected`overdrive

overdrive: OverDrive

`Protected`panner

panner: Panner

`Protected`phaser

phaser: Phaser

`Protected`pitchshifter

pitchshifter: PitchShifter

`Protected`preamp

preamp: Preamp

`Protected`processor

processor: AudioWorkletNode

`Protected`recorder

recorder: Recorder

`Protected`reverb

reverb: Reverb

`Protected`ringmodulator

ringmodulator: Ringmodulator

`Protected`runningAnalyser

runningAnalyser: boolean = false

`Protected`stereo

stereo: Stereo

`Protected`tremolo

tremolo: Tremolo

`Protected`vocalcanceler

vocalcanceler: VocalCanceler

`Protected`wah

wah: Wah

`Static` `Readonly`NUMBER_OF_INPUTS

NUMBER_OF_INPUTS = 2

`Static` `Readonly`NUMBER_OF_OUTPUTS

NUMBER_OF_OUTPUTS = 2

Accessors

`Abstract`INPUT

get INPUT(): null | GainNode | AudioWorkletNode
Connector for input.

Returns null | GainNode | AudioWorkletNode
Implementation of Connectable.INPUT
- Defined in SoundModule/index.ts:458

`Abstract`OUTPUT

get OUTPUT(): GainNode
Connector for output.

Returns GainNode
Implementation of Connectable.OUTPUT
- Defined in SoundModule/index.ts:463

Methods

connect

connect(source): void
This method connects AudioNodes.
Parameters
- source: AudioNode
  This argument is AudioNode as sound source.
Returns void
- Defined in SoundModule/index.ts:251

demix

demix(): SoundModule
This method is invoked on demixing.

Returns SoundModule
Return value is for method chain.
- Defined in SoundModule/index.ts:395

disconnect

disconnect(): void
This method disconnects instance of AudioWorkletNode as sound source.

Returns void
- Defined in SoundModule/index.ts:305

edit

edit(modules): Connectable[]
This method edits module to use and module connection order.
Parameters
- modules: Connectable[]
  This argument is edited modules.
Returns Connectable[]
Return value is previous modules.
- Defined in SoundModule/index.ts:439

`Protected`init

init(context): void
This method re-initials modules.
Parameters
- context: AudioContext
  This argument is in order to use Web Audio API.
Returns void
- Defined in SoundModule/index.ts:469

install

install<ExtendedEffector>(effector): ExtendedEffector
This method installs customized effector.
Type Parameters
- ExtendedEffector extends Effector
Parameters
- effector: (new (context: AudioContext) => ExtendedEffector)
  This argument is subclass that extends Effector class.
  - - new (context): ExtendedEffector
    - Parameters
      context: AudioContext
      Returns ExtendedEffector
Returns ExtendedEffector
Return value is instance of customized effector (that extends Effector class).
- Defined in SoundModule/index.ts:314

mix

mix(): SoundModule
This method is invoked on mixing.

Returns SoundModule
Return value is for method chain.
- Defined in SoundModule/index.ts:386

off

off(stopTime?): SoundModule
This method stops effectors.
Parameters
- OptionalstopTime: number
  This argument is used for scheduling parameter.
Returns SoundModule
Return value is for method chain.
- Defined in SoundModule/index.ts:350

on

on(startTime?): SoundModule
This method starts effectors.
Parameters
- OptionalstartTime: number
  This argument is used for scheduling parameter.
Returns SoundModule
Return value is for method chain.
- Defined in SoundModule/index.ts:327

params

params(): Required<SoundModuleParams>
This method gets effector's parameters as associative array.

Returns Required<SoundModuleParams>
- Defined in SoundModule/index.ts:404

suspend

suspend(): SoundModule
This method stops analyser, recorder and onaudioprocess event.

Returns SoundModule
Return value is for method chain.
- Defined in SoundModule/index.ts:372

toJSON

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

Returns string
- Defined in SoundModule/index.ts:451

Class SoundModuleAbstract

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SoundModule

Properties

Protectedanalyser

Protectedautopanner

Protectedbitcrusher

Protectedchorus

Protectedcompressor

Protectedcontext

Protecteddelay

Protectedenvelopegenerator

Protectedequalizer

Protectedfilter

Protectedflanger

Protectedfuzz

Protectedlistener

Protectedmastervolume

Protectedmixed

Protectedmodules

Protectednoisegate

Protectednoisesuppressor

Protectedoverdrive

Protectedpanner

Protectedphaser

Protectedpitchshifter

Protectedpreamp

Protectedprocessor

Protectedrecorder

Protectedreverb

Protectedringmodulator

ProtectedrunningAnalyser

Protectedstereo

Protectedtremolo

Protectedvocalcanceler

Protectedwah

Static ReadonlyNUMBER_OF_INPUTS

Static ReadonlyNUMBER_OF_OUTPUTS

Accessors

AbstractINPUT

Returns null | GainNode | AudioWorkletNode

AbstractOUTPUT

Returns GainNode

Methods

connect

Parameters

Returns void

demix

Returns SoundModule

disconnect

Returns void

edit

Parameters

Returns Connectable[]

Protectedinit

Parameters

Returns void

install

Type Parameters

Parameters

Parameters

Returns ExtendedEffector

Returns ExtendedEffector

mix

Returns SoundModule

off

Parameters

Returns SoundModule

on

Parameters

Returns SoundModule

Class SoundModule`Abstract`

`Protected`analyser

`Protected`autopanner

`Protected`bitcrusher

`Protected`chorus

`Protected`compressor

`Protected`context

`Protected`delay

`Protected`envelopegenerator

`Protected`equalizer

`Protected`filter

`Protected`flanger

`Protected`fuzz

`Protected`listener

`Protected`mastervolume

`Protected`mixed

`Protected`modules

`Protected`noisegate

`Protected`noisesuppressor

`Protected`overdrive

`Protected`panner

`Protected`phaser

`Protected`pitchshifter

`Protected`preamp

`Protected`processor

`Protected`recorder

`Protected`reverb

`Protected`ringmodulator

`Protected`runningAnalyser

`Protected`stereo

`Protected`tremolo

`Protected`vocalcanceler

`Protected`wah

`Static` `Readonly`NUMBER_OF_INPUTS

`Static` `Readonly`NUMBER_OF_OUTPUTS

`Abstract`INPUT

`Abstract`OUTPUT

`Protected`init