Interface OscillatorModule

This class manages instances of Oscillator for creating sound.

interface OscillatorModule {
    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(): OscillatorModule;
    connect(source: AudioNode): void;
    demix(): OscillatorModule;
    disconnect(): void;
    edit(modules: Connectable[]): Connectable[];
    get(index: number): Oscillator;
    get(): Oscillator[];
    init(context: AudioContext): void;
    install<ExtendedEffector extends Effector>(
        effector: new (context: AudioContext) => ExtendedEffector,
    ): ExtendedEffector;
    length(): number;
    mix(): OscillatorModule;
    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;
    module(moduleName: "glide"): Glide;
    off(stopTime?: number): OscillatorModule;
    on(startTime?: number): OscillatorModule;
    param(params: "mastervolume"): number;
    param(params: OscillatorModuleParams): OscillatorModule;
    params(): Required<OscillatorModuleParams>;
    ready(startTime?: number, duration?: number): OscillatorModule;
    setSinkId(
        sinkId: string,
        successCallback?: () => void,
        errorCallback?: (error: Error) => void,
    ): OscillatorModule;
    setup(states: boolean[]): OscillatorModule;
    start(frequencies: number[]): OscillatorModule;
    stop(): OscillatorModule;
    streamDestination(
        params?: {
            errorCallback?: (error: Error) => void;
            sinkId: string;
            successCallback?: () => void;
        },
    ): OscillatorModule;
    suspend(): OscillatorModule;
    toJSON(): string;
}

Hierarchy (View Summary)

SoundModule
- OscillatorModule

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 OscillatorModule/index.ts:398

OUTPUT

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

Methods

audioDestination

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

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

Returns OscillatorModule
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(index: number): Oscillator
This method gets instance of Oscillator or array that contains the all of Oscillators. This method is overloaded for type interface and type check.
Parameters
- index: number
  This argument selects instance of Oscillator.
Returns Oscillator
- Defined in OscillatorModule/index.ts:216
get(): Oscillator[]
This method gets instance of Oscillator or array that contains the all of Oscillators. This method is overloaded for type interface and type check.

Returns Oscillator[]
- Defined in OscillatorModule/index.ts:217

`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

length

length(): number
This method returns the number of Oscillators.

Returns number
- Defined in OscillatorModule/index.ts:230

mix

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

Returns OscillatorModule
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 OscillatorModule/index.ts:239
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 OscillatorModule/index.ts:240
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 OscillatorModule/index.ts:241
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 OscillatorModule/index.ts:242
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 OscillatorModule/index.ts:243
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 OscillatorModule/index.ts:244
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 OscillatorModule/index.ts:245
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 OscillatorModule/index.ts:246
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 OscillatorModule/index.ts:247
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 OscillatorModule/index.ts:248
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 OscillatorModule/index.ts:249
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 OscillatorModule/index.ts:250
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 OscillatorModule/index.ts:251
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 OscillatorModule/index.ts:252
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 OscillatorModule/index.ts:253
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 OscillatorModule/index.ts:254
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 OscillatorModule/index.ts:255
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 OscillatorModule/index.ts:256
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 OscillatorModule/index.ts:257
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 OscillatorModule/index.ts:258
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 OscillatorModule/index.ts:259
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 OscillatorModule/index.ts:260
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 OscillatorModule/index.ts:261
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 OscillatorModule/index.ts:262
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 OscillatorModule/index.ts:263
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 OscillatorModule/index.ts:264
module(moduleName: "glide"): Glide
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "glide"
  This argument selects module.
Returns Glide
- Defined in OscillatorModule/index.ts:265

off

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

on

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

params

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

Returns Required<OscillatorModuleParams>
Overrides SoundModule.params
- Defined in OscillatorModule/index.ts:383

ready

ready(startTime?: number, duration?: number): OscillatorModule
This method schedules the time of start and stop.
Parameters
- OptionalstartTime: number
  This argument is start time. The default value is currentTime in instance of AudioContext
- Optionalduration: number
  This argument is duration. The default value is 0.
Returns OscillatorModule
Return value is for method chain.
- Defined in OscillatorModule/index.ts:97

setSinkId

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

setup

setup(states: boolean[]): OscillatorModule
This method creates instances of Oscillator.
Parameters
- states: boolean[]
  This argument is array that contains initial state in instance of Oscillator.
Returns OscillatorModule
Return value is for method chain.
- Defined in OscillatorModule/index.ts:79

start

start(frequencies: number[]): OscillatorModule
This method starts some sounds that are active at the same time.
Parameters
- frequencies: number[]
  This argument each oscillator frequency. The default value is 0 Hz.
Returns OscillatorModule
Return value is for method chain.
- Defined in OscillatorModule/index.ts:111

stop

stop(): OscillatorModule
This method stops active sounds.

Returns OscillatorModule
Return value is for method chain.
- Defined in OscillatorModule/index.ts:165

streamDestination

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

suspend

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

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

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 OscillatorModule

connect

Parameters

Returns void

demix

Returns OscillatorModule

disconnect

Returns void

edit

Parameters

Returns Connectable[]

get

Parameters

Returns Oscillator

Returns Oscillator[]

Protectedinit

Parameters

Returns void

install

Type Parameters

Parameters

Returns ExtendedEffector

length

Returns number

mix

Returns OscillatorModule

module

Parameters

Returns Analyser

Parameters

Returns Recorder

Parameters

Returns Autopanner

`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