Class AudioModule

This subclass is for playing single audio. This class enables to create audio player that has higher features than HTMLAudioElement. But, this class is disadvantage to play many one shot audios. In that case, developer should use OneshotModule.

Hierarchy (View Summary)

SoundModule
- AudioModule

Constructors

constructor

new AudioModule(context: AudioContext): AudioModule
Parameters
- context: AudioContext
  This argument is in order to use the interfaces of Web Audio API.
Returns AudioModule
Overrides SoundModule.constructor
- Defined in AudioModule/index.ts:67

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

OUTPUT

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

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(): AudioModule
Returns AudioModule
Overrides SoundModule.demix
- Defined in AudioModule/index.ts:731

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

end

end(): AudioModule
This method rewinds audio.

Returns AudioModule
Return value is for method chain.
- Defined in AudioModule/index.ts:404

fadeIn

fadeIn(time?: number): number | AudioModule
This method gets or sets fade-in time.
Parameters
- Optionaltime: number
  This argument is fade-in time. If this argument is omitted, this method is getter.
Returns number | AudioModule
Return value is fade-in time. Otherwise, return value is for method chain.
- Defined in AudioModule/index.ts:436

fadeOut

fadeOut(time?: number): number | AudioModule
This method gets or sets fade-out time.
Parameters
- Optionaltime: number
  This argument is fade-out time. If this argument is omitted, this method is getter.
Returns number | AudioModule
Return value is fade-out time. Otherwise, return value is for method chain.
- Defined in AudioModule/index.ts:459

get

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

Returns AudioBufferSourceNode
- Defined in AudioModule/index.ts:396

has

has(): boolean
This method determines whether instance of AudioBuffer exists.

Returns boolean
If instance of AudioBuffer already exists, this value is true. Otherwise, this value is false.
- Defined in AudioModule/index.ts:419

`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

mix

mix(): AudioModule
Returns AudioModule
Overrides SoundModule.mix
- Defined in AudioModule/index.ts:725

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 AudioModule/index.ts:572
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 AudioModule/index.ts:573
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 AudioModule/index.ts:574
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 AudioModule/index.ts:575
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 AudioModule/index.ts:576
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 AudioModule/index.ts:577
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 AudioModule/index.ts:578
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 AudioModule/index.ts:579
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 AudioModule/index.ts:580
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 AudioModule/index.ts:581
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 AudioModule/index.ts:582
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 AudioModule/index.ts:583
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 AudioModule/index.ts:584
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 AudioModule/index.ts:585
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 AudioModule/index.ts:586
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 AudioModule/index.ts:587
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 AudioModule/index.ts:588
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 AudioModule/index.ts:589
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 AudioModule/index.ts:590
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 AudioModule/index.ts:591
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 AudioModule/index.ts:592
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 AudioModule/index.ts:593
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 AudioModule/index.ts:594
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 AudioModule/index.ts:595
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 AudioModule/index.ts:596
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 AudioModule/index.ts:597

off

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

on

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

param

param(params: "mastervolume"): number
This method gets or sets parameters for audio 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 audio module if getter. Otherwise, return value is for method chain.
- Defined in AudioModule/index.ts:275
param(params: "playbackRate"): number
This method gets or sets parameters for audio module. This method is overloaded for type interface and type check.
Parameters
- params: "playbackRate"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for audio module if getter. Otherwise, return value is for method chain.
- Defined in AudioModule/index.ts:276
param(params: "detune"): number
This method gets or sets parameters for audio module. This method is overloaded for type interface and type check.
Parameters
- params: "detune"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for audio module if getter. Otherwise, return value is for method chain.
- Defined in AudioModule/index.ts:277
param(params: "loop"): boolean
This method gets or sets parameters for audio module. This method is overloaded for type interface and type check.
Parameters
- params: "loop"
  This argument is string if getter. Otherwise, setter.
Returns boolean
Return value is parameter for audio module if getter. Otherwise, return value is for method chain.
- Defined in AudioModule/index.ts:278
param(params: "currentTime"): number
This method gets or sets parameters for audio module. This method is overloaded for type interface and type check.
Parameters
- params: "currentTime"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for audio module if getter. Otherwise, return value is for method chain.
- Defined in AudioModule/index.ts:279
param(params: "duration"): number
This method gets or sets parameters for audio module. This method is overloaded for type interface and type check.
Parameters
- params: "duration"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for audio module if getter. Otherwise, return value is for method chain.
- Defined in AudioModule/index.ts:280
param(params: "sampleRate"): number
This method gets or sets parameters for audio module. This method is overloaded for type interface and type check.
Parameters
- params: "sampleRate"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for audio module if getter. Otherwise, return value is for method chain.
- Defined in AudioModule/index.ts:281
param(params: "numberOfChannels"): number
This method gets or sets parameters for audio module. This method is overloaded for type interface and type check.
Parameters
- params: "numberOfChannels"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for audio module if getter. Otherwise, return value is for method chain.
- Defined in AudioModule/index.ts:282
param(params: "numberOfChannels"): number
This method gets or sets parameters for audio module. This method is overloaded for type interface and type check.
Parameters
- params: "numberOfChannels"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for audio module if getter. Otherwise, return value is for method chain.
- Defined in AudioModule/index.ts:283
param(params: AudioModuleParams): AudioModule
This method gets or sets parameters for audio module. This method is overloaded for type interface and type check.
Parameters
- params: AudioModuleParams
  This argument is string if getter. Otherwise, setter.
Returns AudioModule
Return value is parameter for audio module if getter. Otherwise, return value is for method chain.
- Defined in AudioModule/index.ts:284

params

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

Returns Required<AudioModuleParams>
Overrides SoundModule.params
- Defined in AudioModule/index.ts:741

paused

paused(): boolean
This method determines whether audio is paused.

Returns boolean
If audio is paused, this value is true. Otherwise, this value is false.
- Defined in AudioModule/index.ts:427

ready

ready(buffer: ArrayBuffer | AudioBuffer): AudioModule
This method decodes instance of ArrayBuffer to ArrayBuffer or sets instanceof AudioBuffer.
Parameters
- buffer: ArrayBuffer | AudioBuffer
  This argument is instance of ArrayBuffer or AudioBuffer. If this is ArrayBuffer, this method executes decode.
Returns AudioModule
Return value is for method chain.
- Defined in AudioModule/index.ts:120

setup

setup(
    callbacks?: {
        decodeCallback(buffer: AudioBuffer): void;
        endedCallback(source: AudioBufferSourceNode, currentTime: number): void;
        errorCallback(error: Error): void;
        updateCallback(source: AudioBufferSourceNode, currentTime: number): void;
    },
): AudioModule
This method sets up envelope generator for fade-in and fade-out.
Parameters
- Optionalcallbacks: {
      decodeCallback(buffer: AudioBuffer): void;
      endedCallback(source: AudioBufferSourceNode, currentTime: number): void;
      errorCallback(error: Error): void;
      updateCallback(source: AudioBufferSourceNode, currentTime: number): void;
  }
Returns AudioModule
Return value is for method chain.
- Defined in AudioModule/index.ts:79

slice

slice(startTime?: number, endTime?: number): null | AudioBuffer
This method slices instance of AudioBuffer.
Parameters
- OptionalstartTime: number
  This argument is start time [sec] on AudioBuffer.
- OptionalendTime: number
  This argument is end time [sec] on AudioBuffer.
Returns null | AudioBuffer
Return value is sliced AudioBuffer.
- Defined in AudioModule/index.ts:483

sprite

sprite(
sprites: { [spriteName: string]: [number, number] },
): null | AudioBufferSprite
This method sprites audio.
Parameters
- sprites: { [spriteName: string]: [number, number] }
  This argument is associative array that contains sprite times.
Returns null | AudioBufferSprite
Return value is associative array that contains sprited AudioBuffer.
- Defined in AudioModule/index.ts:549

start

start(startTime?: number, endTime?: number): AudioModule
This method starts audio from designated time.
Parameters
- OptionalstartTime: number
  This argument is time that audio is started at. The default value is 0.
- OptionalendTime: number
  This argument is time that audio is ended at. The default value is audio duration.
Returns AudioModule
This is returned for method chain.
- Defined in AudioModule/index.ts:149

stop

stop(): AudioModule
This method stops audio.

Returns AudioModule
Return value is for method chain.
- Defined in AudioModule/index.ts:248

suspend

suspend(): AudioModule
Returns AudioModule
Overrides SoundModule.suspend
- Defined in AudioModule/index.ts:719

toJSON

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

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

Class AudioModule

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AudioModule

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 AudioWorkletNode

OUTPUT

Returns GainNode

Methods

connect

Parameters

Returns void

demix

Returns AudioModule

disconnect

Returns void

edit

Parameters

Returns Connectable[]

end

Returns AudioModule

fadeIn

Parameters

Returns number | AudioModule

fadeOut

Parameters

Returns number | AudioModule

get

Returns AudioBufferSourceNode

has

Returns boolean

Protectedinit

Parameters

Returns void

install

Type Parameters

Parameters

`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