Interface NoiseModule

This subclass is for generating noise.

interface NoiseModule {
    analyser: Analyser;
    autopanner: Autopanner;
    bitcrusher: BitCrusher;
    chorus: Chorus;
    compressor: Compressor;
    context: AudioContext;
    delay: Delay;
    destination: AudioDestinationNode | MediaStreamAudioDestinationNode;
    envelopegenerator: EnvelopeGenerator;
    equalizer: Equalizer;
    filter: Filter;
    flanger: Flanger;
    fuzz: Fuzz;
    listener: Listener;
    mastervolume: GainNode;
    mixed: boolean;
    modules: Connectable[];
    noisegate: NoiseGate;
    noisesuppressor: NoiseSuppressor;
    overdrive: OverDrive;
    panner: Panner;
    phaser: Phaser;
    pitchshifter: PitchShifter;
    preamp: Preamp;
    processor: AudioWorkletNode;
    recorder: Recorder;
    reverb: Reverb;
    ringmodulator: Ringmodulator;
    runningAnalyser: boolean;
    stereo: Stereo;
    tremolo: Tremolo;
    vocalcanceler: VocalCanceler;
    wah: Wah;
    get INPUT(): GainNode | null;
    get OUTPUT(): GainNode;
    audioDestination(): NoiseModule;
    connect(source: AudioNode): void;
    demix(): NoiseModule;
    disconnect(): void;
    edit(modules: Connectable[]): Connectable[];
    init(context: AudioContext): void;
    install<ExtendedEffector extends Effector>(
        effector: new (context: AudioContext) => ExtendedEffector,
    ): ExtendedEffector;
    mix(): NoiseModule;
    module(moduleName: "analyser"): Analyser;
    module(moduleName: "recorder"): Recorder;
    module(moduleName: "autopanner"): Autopanner;
    module(moduleName: "bitcrusher"): BitCrusher;
    module(moduleName: "chorus"): Chorus;
    module(moduleName: "compressor"): Compressor;
    module(moduleName: "delay"): Delay;
    module(moduleName: "envelopegenerator"): EnvelopeGenerator;
    module(moduleName: "equalizer"): Equalizer;
    module(moduleName: "filter"): Filter;
    module(moduleName: "flanger"): Flanger;
    module(moduleName: "fuzz"): Fuzz;
    module(moduleName: "listener"): Listener;
    module(moduleName: "noisegate"): NoiseGate;
    module(moduleName: "noisesuppressor"): NoiseSuppressor;
    module(moduleName: "overdrive"): OverDrive;
    module(moduleName: "panner"): Panner;
    module(moduleName: "phaser"): Phaser;
    module(moduleName: "pitchshifter"): PitchShifter;
    module(moduleName: "preamp"): Preamp;
    module(moduleName: "reverb"): Reverb;
    module(moduleName: "ringmodulator"): Ringmodulator;
    module(moduleName: "stereo"): Stereo;
    module(moduleName: "tremolo"): Tremolo;
    module(moduleName: "vocalcanceler"): VocalCanceler;
    module(moduleName: "wah"): Wah;
    off(stopTime?: number): NoiseModule;
    on(startTime?: number): NoiseModule;
    param(params: "mastervolume"): number;
    param(params: "type"): NoiseType;
    param(params: NoiseModuleParams): NoiseModule;
    params(): Required<NoiseModuleParams>;
    ready(): NoiseModule;
    setSinkId(
        sinkId: string,
        successCallback?: () => void,
        errorCallback?: (error: Error) => void,
    ): NoiseModule;
    setup(): NoiseModule;
    start(): NoiseModule;
    stop(): NoiseModule;
    streamDestination(
        params?: {
            errorCallback?: (error: Error) => void;
            sinkId: string;
            successCallback?: () => void;
        },
    ): NoiseModule;
    suspend(): NoiseModule;
    toJSON(): string;
}

Hierarchy (View Summary)

SoundModule
- NoiseModule

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`destination

destination: AudioDestinationNode | MediaStreamAudioDestinationNode

`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

Accessors

INPUT

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

OUTPUT

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

Methods

audioDestination

audioDestination(): NoiseModule
This method switches destination over to AudioDestinationNode.

Returns NoiseModule
Return value is for method chain.
Inherited from SoundModule.audioDestination
- Defined in SoundModule/index.ts:316

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:254

demix

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

Returns NoiseModule
Return value is for method chain.
Inherited from SoundModule.demix
- Defined in SoundModule/index.ts:471

disconnect

disconnect(): void
Returns void
Overrides SoundModule.disconnect
- Defined in NoiseModule/index.ts:337

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:517

`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:547

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:380

mix

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

Returns NoiseModule
Return value is for method chain.
Inherited from SoundModule.mix
- Defined in SoundModule/index.ts:460

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 NoiseModule/index.ts:202
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 NoiseModule/index.ts:203
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 NoiseModule/index.ts:204
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 NoiseModule/index.ts:205
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 NoiseModule/index.ts:206
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 NoiseModule/index.ts:207
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 NoiseModule/index.ts:208
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 NoiseModule/index.ts:209
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 NoiseModule/index.ts:210
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 NoiseModule/index.ts:211
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 NoiseModule/index.ts:212
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 NoiseModule/index.ts:213
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 NoiseModule/index.ts:214
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 NoiseModule/index.ts:215
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 NoiseModule/index.ts:216
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 NoiseModule/index.ts:217
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 NoiseModule/index.ts:218
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 NoiseModule/index.ts:219
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 NoiseModule/index.ts:220
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 NoiseModule/index.ts:221
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 NoiseModule/index.ts:222
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 NoiseModule/index.ts:223
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 NoiseModule/index.ts:224
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 NoiseModule/index.ts:225
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 NoiseModule/index.ts:226
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 NoiseModule/index.ts:227

off

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

on

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

param

param(params: "mastervolume"): number
This method gets or sets parameters for noise module.
Parameters
- params: "mastervolume"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for noise module if getter. Otherwise, return value is for method chain.
- Defined in NoiseModule/index.ts:152
param(params: "type"): NoiseType
This method gets or sets parameters for noise module.
Parameters
- params: "type"
  This argument is string if getter. Otherwise, setter.
Returns NoiseType
Return value is parameter for noise module if getter. Otherwise, return value is for method chain.
- Defined in NoiseModule/index.ts:153
param(params: NoiseModuleParams): NoiseModule
This method gets or sets parameters for noise module.
Parameters
- params: NoiseModuleParams
  This argument is string if getter. Otherwise, setter.
Returns NoiseModule
Return value is parameter for noise module if getter. Otherwise, return value is for method chain.
- Defined in NoiseModule/index.ts:154

params

params(): Required<NoiseModuleParams>
This method gets noise module parameters as associative array.

Returns Required<NoiseModuleParams>
Overrides SoundModule.params
- Defined in NoiseModule/index.ts:350

ready

ready(): NoiseModule
This method defines noop for the same API.

Returns NoiseModule
- Defined in NoiseModule/index.ts:82

setSinkId

setSinkId(
    sinkId: string,
    successCallback?: () => void,
    errorCallback?: (error: Error) => void,
): NoiseModule
This method enables to use multiple output devices.
Parameters
- sinkId: string
  This argument is string as output device ID.
- OptionalsuccessCallback: () => void
  This argument is invoked on success.
- OptionalerrorCallback: (error: Error) => void
  This argument is invoked on failure.
Returns NoiseModule
Return value is for method chain.
Inherited from SoundModule.setSinkId
- Defined in SoundModule/index.ts:354

setup

setup(): NoiseModule
This method defines noop for the same API.

Returns NoiseModule
- Defined in NoiseModule/index.ts:74

start

start(): NoiseModule
This method starts noise.

Returns NoiseModule
Return value is for method chain.
- Defined in NoiseModule/index.ts:91

stop

stop(): NoiseModule
This method stops noise.

Returns NoiseModule
Return value is for method chain.
- Defined in NoiseModule/index.ts:131

streamDestination

streamDestination(
    params?: {
        errorCallback?: (error: Error) => void;
        sinkId: string;
        successCallback?: () => void;
    },
): NoiseModule
This method switches destination over to MediaStreamAudioDestinationNode.
Parameters
- Optionalparams: {
      errorCallback?: (error: Error) => void;
      sinkId: string;
      successCallback?: () => void;
  }
Returns NoiseModule
Return value is for method chain.
Inherited from SoundModule.streamDestination
- Defined in SoundModule/index.ts:330

suspend

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

Returns NoiseModule
Return value is for method chain.
Inherited from SoundModule.suspend
- Defined in SoundModule/index.ts:440

toJSON

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

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

Interface NoiseModule

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

Protectedanalyser

Protectedautopanner

Protectedbitcrusher

Protectedchorus

Protectedcompressor

Protectedcontext

Protecteddelay

Protecteddestination

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

Accessors

INPUT

Returns GainNode | null

OUTPUT

Returns GainNode

Methods

audioDestination

Returns NoiseModule

connect

Parameters

Returns void

demix

Returns NoiseModule

disconnect

Returns void

edit

Parameters

Returns Connectable[]

Protectedinit

Parameters

Returns void

install

Type Parameters

Parameters

Returns ExtendedEffector

mix

Returns NoiseModule

module

Parameters

Returns Analyser

Parameters

Returns Recorder

Parameters

Returns Autopanner

Parameters

Returns BitCrusher

Parameters

Returns Chorus

Parameters

Returns Compressor

`Protected`analyser

`Protected`autopanner

`Protected`bitcrusher

`Protected`chorus

`Protected`compressor

`Protected`context

`Protected`delay

`Protected`destination

`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

`Protected`init