Class ProcessorModule

This subclass is for using AudioWorkletNode as sound source.

Hierarchy (View Summary)

SoundModule
- ProcessorModule

Constructors

constructor

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

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

INPUT

get INPUT(): null | GainNode
Returns null | GainNode
Overrides SoundModule.INPUT
- Defined in ProcessorModule/index.ts:354

OUTPUT

get OUTPUT(): GainNode
Returns GainNode
Overrides SoundModule.OUTPUT
- Defined in ProcessorModule/index.ts:365

Methods

connect

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

demix

demix(): ProcessorModule
Returns ProcessorModule
Overrides SoundModule.demix
- Defined in ProcessorModule/index.ts:348

disconnect

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

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

edit

edit(modules: Connectable[]): 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.
Inherited from SoundModule.edit
- Defined in SoundModule/index.ts:439

get

get(): AudioWorkletNode
This method gets instance of AudioWorkletNode.

Returns AudioWorkletNode
- Defined in ProcessorModule/index.ts:172

`Protected`init

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

install

install<ExtendedEffector extends Effector>(
effector: new (context: AudioContext) => ExtendedEffector,
): 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.
Returns ExtendedEffector
Return value is instance of customized effector (that extends Effector class).
Inherited from SoundModule.install
- Defined in SoundModule/index.ts:314

map

map(): AudioParamMap
This method gets map based on AudioParamMap.

Returns AudioParamMap
- Defined in ProcessorModule/index.ts:164

mix

mix(): ProcessorModule
Returns ProcessorModule
Overrides SoundModule.mix
- Defined in ProcessorModule/index.ts:342

module

module(moduleName: "analyser"): Analyser
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "analyser"
  This argument selects module.
Returns Analyser
- Defined in ProcessorModule/index.ts:181
module(moduleName: "recorder"): Recorder
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "recorder"
  This argument selects module.
Returns Recorder
- Defined in ProcessorModule/index.ts:182
module(moduleName: "autopanner"): Autopanner
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "autopanner"
  This argument selects module.
Returns Autopanner
- Defined in ProcessorModule/index.ts:183
module(moduleName: "bitcrusher"): BitCrusher
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "bitcrusher"
  This argument selects module.
Returns BitCrusher
- Defined in ProcessorModule/index.ts:184
module(moduleName: "chorus"): Chorus
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "chorus"
  This argument selects module.
Returns Chorus
- Defined in ProcessorModule/index.ts:185
module(moduleName: "compressor"): Compressor
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "compressor"
  This argument selects module.
Returns Compressor
- Defined in ProcessorModule/index.ts:186
module(moduleName: "delay"): Delay
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "delay"
  This argument selects module.
Returns Delay
- Defined in ProcessorModule/index.ts:187
module(moduleName: "envelopegenerator"): EnvelopeGenerator
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "envelopegenerator"
  This argument selects module.
Returns EnvelopeGenerator
- Defined in ProcessorModule/index.ts:188
module(moduleName: "equalizer"): Equalizer
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "equalizer"
  This argument selects module.
Returns Equalizer
- Defined in ProcessorModule/index.ts:189
module(moduleName: "filter"): Filter
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "filter"
  This argument selects module.
Returns Filter
- Defined in ProcessorModule/index.ts:190
module(moduleName: "flanger"): Flanger
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "flanger"
  This argument selects module.
Returns Flanger
- Defined in ProcessorModule/index.ts:191
module(moduleName: "fuzz"): Fuzz
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "fuzz"
  This argument selects module.
Returns Fuzz
- Defined in ProcessorModule/index.ts:192
module(moduleName: "listener"): Listener
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "listener"
  This argument selects module.
Returns Listener
- Defined in ProcessorModule/index.ts:193
module(moduleName: "noisegate"): NoiseGate
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "noisegate"
  This argument selects module.
Returns NoiseGate
- Defined in ProcessorModule/index.ts:194
module(moduleName: "noisesuppressor"): NoiseSuppressor
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "noisesuppressor"
  This argument selects module.
Returns NoiseSuppressor
- Defined in ProcessorModule/index.ts:195
module(moduleName: "overdrive"): OverDrive
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "overdrive"
  This argument selects module.
Returns OverDrive
- Defined in ProcessorModule/index.ts:196
module(moduleName: "panner"): Panner
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "panner"
  This argument selects module.
Returns Panner
- Defined in ProcessorModule/index.ts:197
module(moduleName: "phaser"): Phaser
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "phaser"
  This argument selects module.
Returns Phaser
- Defined in ProcessorModule/index.ts:198
module(moduleName: "pitchshifter"): PitchShifter
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "pitchshifter"
  This argument selects module.
Returns PitchShifter
- Defined in ProcessorModule/index.ts:199
module(moduleName: "preamp"): Preamp
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "preamp"
  This argument selects module.
Returns Preamp
- Defined in ProcessorModule/index.ts:200
module(moduleName: "reverb"): Reverb
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "reverb"
  This argument selects module.
Returns Reverb
- Defined in ProcessorModule/index.ts:201
module(moduleName: "ringmodulator"): Ringmodulator
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "ringmodulator"
  This argument selects module.
Returns Ringmodulator
- Defined in ProcessorModule/index.ts:202
module(moduleName: "stereo"): Stereo
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "stereo"
  This argument selects module.
Returns Stereo
- Defined in ProcessorModule/index.ts:203
module(moduleName: "tremolo"): Tremolo
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "tremolo"
  This argument selects module.
Returns Tremolo
- Defined in ProcessorModule/index.ts:204
module(moduleName: "vocalcanceler"): VocalCanceler
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "vocalcanceler"
  This argument selects module.
Returns VocalCanceler
- Defined in ProcessorModule/index.ts:205
module(moduleName: "wah"): Wah
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "wah"
  This argument selects module.
Returns Wah
- Defined in ProcessorModule/index.ts:206

off

off(stopTime?: number): ProcessorModule
Parameters
- OptionalstopTime: number
Returns ProcessorModule
Overrides SoundModule.off
- Defined in ProcessorModule/index.ts:322

on

on(startTime?: number): ProcessorModule
Parameters
- OptionalstartTime: number
Returns ProcessorModule
Overrides SoundModule.on
- Defined in ProcessorModule/index.ts:316

onMessage

onMessage(callback: (event: MessageEvent) => void): ProcessorModule
This method sets event handler that is invoked on receiving message.
Parameters
- callback: (event: MessageEvent) => void
  This argument is invoked on receiving message.
Returns ProcessorModule
Return value is for method chain.
- Defined in ProcessorModule/index.ts:143

onMessageError

onMessageError(callback: (event: MessageEvent) => void): ProcessorModule
This method sets event handler that is invoked on receiving message that cannot be deserialized.
Parameters
- callback: (event: MessageEvent) => void
  This argument is invoked on receiving message that cannot be deserialized.
Returns ProcessorModule
Return value is for method chain.
- Defined in ProcessorModule/index.ts:154

params

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

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

postMessage

postMessage(data: unknown): ProcessorModule
This method sends message from MessagePort that AudioWorkletNode has.
Parameters
- data: unknown
  This argument is sent as any data.
Returns ProcessorModule
Return value is for method chain.
- Defined in ProcessorModule/index.ts:132

ready

ready(moduleURL: string, options?: WorkletOptions): Promise<void>
This method adds module for AudioWorklet and creates instance of AudioWorkletNode.
Parameters
- moduleURL: string
  This argument is string that contains URL of file (.js) with module to add.
- Optionaloptions: WorkletOptions
  This argument is one of 'omit', 'same-origin', 'include'. The default value is 'same-origin'.
Returns Promise<void>
Return value is Promise that addModule returns.
- Defined in ProcessorModule/index.ts:67

setup

setup(processorName: string, options?: AudioWorkletNodeOptions): ProcessorModule
This method sets registered processor name and options for AudioWorkletNode constructor.
Parameters
- processorName: string
  This argument is name of AudioWorkletProcessor.
- Optionaloptions: AudioWorkletNodeOptions
  This argument is object based on AudioWorkletNodeOptions dictionary.
Returns ProcessorModule
Return value is for method chain.
- Defined in ProcessorModule/index.ts:54

start

start(): ProcessorModule
This method starts sound by connecting to AudioDestinationNode.

Returns ProcessorModule
Return value is for method chain.
- Defined in ProcessorModule/index.ts:80

stop

stop(): ProcessorModule
This method stops sound by disconnecting to AudioDestinationNode.

Returns ProcessorModule
Return value is for method chain.
- Defined in ProcessorModule/index.ts:118

suspend

suspend(): ProcessorModule
Returns ProcessorModule
Overrides SoundModule.suspend
- Defined in ProcessorModule/index.ts:328

toJSON

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

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

Class ProcessorModule

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ProcessorModule

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

INPUT

Returns null | GainNode

OUTPUT

Returns GainNode

Methods

connect

Parameters

Returns void

demix

Returns ProcessorModule

disconnect

Returns void

edit

Parameters

Returns Connectable[]

get

Returns AudioWorkletNode

Protectedinit

Parameters

Returns void

install

Type Parameters

Parameters

Returns ExtendedEffector

map

Returns AudioParamMap

mix

Returns ProcessorModule

module

Parameters

Returns Analyser

Parameters

Returns Recorder

`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

`Protected`init