Class ProcessorModule

This subclass is for using AudioWorkletNode as sound source.

Hierarchy (view full)

Constructors

Properties

analyser: Analyser
autopanner: Autopanner
bitcrusher: BitCrusher
chorus: Chorus
compressor: Compressor
context: AudioContext
delay: Delay
envelopegenerator: EnvelopeGenerator
equalizer: Equalizer
filter: Filter
flanger: Flanger
fuzz: Fuzz
listener: Listener
mastervolume: GainNode
mixed: boolean = false
moduleURL: string = ''
modules: Connectable[] = []
noisegate: NoiseGate
noisesuppressor: NoiseSuppressor
options: AudioWorkletNodeOptions = {}
overdrive: OverDrive
panner: Panner
phaser: Phaser
pitchshifter: PitchShifter
preamp: Preamp
processor: AudioWorkletNode
processorName: string = ''
recorder: Recorder
reverb: Reverb
ringmodulator: Ringmodulator
runningAnalyser: boolean = false
stereo: Stereo
tremolo: Tremolo
vocalcanceler: VocalCanceler
wah: Wah
NUMBER_OF_INPUTS: 2 = 2
NUMBER_OF_OUTPUTS: 2 = 2

Accessors

Methods

  • This method re-initials modules.

    Parameters

    • context: AudioContext

      This argument is in order to use Web Audio API.

    Returns void

  • This method sets event handler that is invoked on receiving message.

    Parameters

    • callback: ((event) => void)

      This argument is invoked on receiving message.

        • (event): void
        • Parameters

          • event: MessageEvent<any>

          Returns void

    Returns ProcessorModule

    Return value is for method chain.

  • This method sets event handler that is invoked on receiving message that cannot be deserialized.

    Parameters

    • callback: ((event) => void)

      This argument is invoked on receiving message that cannot be deserialized.

        • (event): void
        • Parameters

          • event: MessageEvent<any>

          Returns void

    Returns ProcessorModule

    Return value is for method chain.

  • 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.

    • Optional options: 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.

  • This method sets registered processor name and options for AudioWorkletNode constructor.

    Parameters

    • processorName: string

      This argument is name of AudioWorkletProcessor.

    • Optional options: AudioWorkletNodeOptions

      This argument is object based on AudioWorkletNodeOptions dictionary.

    Returns ProcessorModule

    Return value is for method chain.