Interface MixerModule

This class is for mixing sound sources (instance of SoundModule subclass).

interface MixerModule {
    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(): AudioWorkletNode;
    get OUTPUT(): GainNode;
    audioDestination(): MixerModule;
    connect(source: AudioNode): void;
    demix(): MixerModule;
    disconnect(): void;
    edit(modules: Connectable[]): Connectable[];
    get(): SoundModule[];
    init(context: AudioContext): void;
    install<ExtendedEffector extends Effector>(
        effector: new (context: AudioContext) => ExtendedEffector,
    ): ExtendedEffector;
    mix(): MixerModule;
    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): MixerModule;
    on(startTime?: number): MixerModule;
    param(params: "mastervolume"): number;
    param(params: SoundModuleParams): MixerModule;
    params(): Required<SoundModuleParams>;
    ready(): MixerModule;
    setSinkId(
        sinkId: string,
        successCallback?: () => void,
        errorCallback?: (error: Error) => void,
    ): MixerModule;
    setup(): MixerModule;
    start(sources: SoundModule[], gains?: number[]): MixerModule;
    stop(): MixerModule;
    streamDestination(
        params?: {
            errorCallback?: (error: Error) => void;
            sinkId: string;
            successCallback?: () => void;
        },
    ): MixerModule;
    suspend(): MixerModule;
    toJSON(): string;
}

Hierarchy (View Summary)

SoundModule
- MixerModule

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(): AudioWorkletNode
Returns AudioWorkletNode
Overrides SoundModule.INPUT
- Defined in MixerModule/index.ts:327

OUTPUT

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

Methods

audioDestination

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

Returns MixerModule
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(): MixerModule
This method is invoked on demixing.

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

disconnect

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

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

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

get

get(): SoundModule[]
This method gets array that contains instance of SoundModule subclass.

Returns SoundModule[]
- Defined in MixerModule/index.ts:183

`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(): MixerModule
This method is invoked on mixing.

Returns MixerModule
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 MixerModule/index.ts:192
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 MixerModule/index.ts:193
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 MixerModule/index.ts:194
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 MixerModule/index.ts:195
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 MixerModule/index.ts:196
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 MixerModule/index.ts:197
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 MixerModule/index.ts:198
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 MixerModule/index.ts:199
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 MixerModule/index.ts:200
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 MixerModule/index.ts:201
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 MixerModule/index.ts:202
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 MixerModule/index.ts:203
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 MixerModule/index.ts:204
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 MixerModule/index.ts:205
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 MixerModule/index.ts:206
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 MixerModule/index.ts:207
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 MixerModule/index.ts:208
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 MixerModule/index.ts:209
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 MixerModule/index.ts:210
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 MixerModule/index.ts:211
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 MixerModule/index.ts:212
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 MixerModule/index.ts:213
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 MixerModule/index.ts:214
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 MixerModule/index.ts:215
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 MixerModule/index.ts:216
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 MixerModule/index.ts:217

off

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

on

on(startTime?: number): MixerModule
This method starts effectors.
Parameters
- OptionalstartTime: number
  This argument is used for scheduling parameter.
Returns MixerModule
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 mixer module. This method is overloaded for type interface and type check.
Parameters
- params: "mastervolume"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for mixer module if getter. Otherwise, return value is for method chain.
- Defined in MixerModule/index.ts:153
param(params: SoundModuleParams): MixerModule
This method gets or sets parameters for mixer module. This method is overloaded for type interface and type check.
Parameters
- params: SoundModuleParams
  This argument is string if getter. Otherwise, setter.
Returns MixerModule
Return value is parameter for mixer module if getter. Otherwise, return value is for method chain.
- Defined in MixerModule/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:482

ready

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

Returns MixerModule
- Defined in MixerModule/index.ts:61

setSinkId

setSinkId(
    sinkId: string,
    successCallback?: () => void,
    errorCallback?: (error: Error) => void,
): MixerModule
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 MixerModule
Return value is for method chain.
Inherited from SoundModule.setSinkId
- Defined in SoundModule/index.ts:354

setup

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

Returns MixerModule
- Defined in MixerModule/index.ts:53

start

start(sources: SoundModule[], gains?: number[]): MixerModule
This method mixes sound sources (instance of SoundModule subclass).
Parameters
- sources: SoundModule[]
  This argument is array that contains sound sources.
- Optionalgains: number[]
  This argument is array for each sound source volume.
Returns MixerModule
Return value is for method chain.
- Defined in MixerModule/index.ts:72

stop

stop(): MixerModule
This method demixes sound sources (instance of SoundModule subclass).

Returns MixerModule
Return value is for method chain.
- Defined in MixerModule/index.ts:123

streamDestination

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

suspend

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

Returns MixerModule
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 MixerModule

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 AudioWorkletNode

OUTPUT

Returns GainNode

Methods

audioDestination

Returns MixerModule

connect

Parameters

Returns void

demix

Returns MixerModule

disconnect

Returns void

edit

Parameters

Returns Connectable[]

get

Returns SoundModule[]

Protectedinit

Parameters

Returns void

install

Type Parameters

Parameters

Returns ExtendedEffector

mix

Returns MixerModule

module

Parameters

Returns Analyser

Parameters

Returns Recorder

Parameters

Returns Autopanner

Parameters

Returns BitCrusher

Parameters

Returns Chorus

`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