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 full)

Constructors

constructor

Properties

analyser autopanner bitcrusher chorus compressor context delay envelopegenerator equalizer filter flanger fuzz listener mastervolume mixed modules noisegate noisesuppressor overdrive panner phaser pitchshifter preamp processor recorder reverb ringmodulator runningAnalyser stereo tremolo vocalcanceler wah NUMBER_OF_INPUTS NUMBER_OF_OUTPUTS

Accessors

INPUT OUTPUT

Methods

connect demix disconnect edit end fadeIn fadeOut get has init install mix module off on param params paused ready setup slice sprite start stop suspend toJSON

Constructors

constructor

Properties

Protectedanalyser

analyser: Analyser

Protectedautopanner

autopanner: Autopanner

Protectedbitcrusher

bitcrusher: BitCrusher

Protectedchorus

chorus: Chorus

Protectedcompressor

compressor: Compressor

Protectedcontext

context: AudioContext

Protecteddelay

delay: Delay

Protectedenvelopegenerator

envelopegenerator: EnvelopeGenerator

Protectedequalizer

equalizer: Equalizer

Protectedfilter

filter: Filter

Protectedflanger

flanger: Flanger

Protectedfuzz

fuzz: Fuzz

Protectedlistener

listener: Listener

Protectedmastervolume

mastervolume: GainNode

Protectedmixed

mixed: boolean = false

Protectedmodules

modules: Connectable[] = []

Protectednoisegate

noisegate: NoiseGate

Protectednoisesuppressor

noisesuppressor: NoiseSuppressor

Protectedoverdrive

overdrive: OverDrive

Protectedpanner

panner: Panner

Protectedphaser

phaser: Phaser

Protectedpitchshifter

pitchshifter: PitchShifter

Protectedpreamp

preamp: Preamp

Protectedprocessor

processor: AudioWorkletNode

Protectedrecorder

recorder: Recorder

Protectedreverb

reverb: Reverb

Protectedringmodulator

ringmodulator: Ringmodulator

ProtectedrunningAnalyser

runningAnalyser: boolean = false

Protectedstereo

stereo: Stereo

Protectedtremolo

tremolo: Tremolo

Protectedvocalcanceler

vocalcanceler: VocalCanceler

Protectedwah

wah: Wah

Static ReadonlyNUMBER_OF_INPUTS

NUMBER_OF_INPUTS = 2

Static ReadonlyNUMBER_OF_OUTPUTS

NUMBER_OF_OUTPUTS = 2

Accessors

INPUT

OUTPUT

Methods

connect

demix

disconnect

edit

end

fadeIn

  • fadeIn(time?): 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.

fadeOut

  • fadeOut(time?): 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.

get

  • get(): AudioBufferSourceNode

  • This method gets instance of AudioBufferSourceNode.

    Returns AudioBufferSourceNode

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.

Protectedinit

  • init(context): void

  • This method re-initials modules.

    Parameters

    • context: AudioContext

      This argument is in order to use Web Audio API.

    Returns void

install

mix

module

off

on

param

params

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.

ready

  • ready(buffer): 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.

setup

  • setup(callbacks?): 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;
      }
      • decodeCallback?:function
      • endedCallback?:function
        • endedCallback(source, currentTime): void

        • Parameters

          • source: AudioBufferSourceNode
          • currentTime: number

          Returns void

      • errorCallback?:function
      • updateCallback?:function
        • updateCallback(source, currentTime): void

        • Parameters

          • source: AudioBufferSourceNode
          • currentTime: number

          Returns void

    Returns AudioModule

    Return value is for method chain.

slice

  • slice(startTime?, endTime?): 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.

sprite

  • sprite(sprites): null | AudioBufferSprite

  • This method sprites audio.

    Parameters

    • sprites: {
          [spriteName: string]: [number, number];
      }

      This argument is associative array that contains sprite times.

      • [spriteName: string]: [number, number]

    Returns null | AudioBufferSprite

    Return value is associative array that contains sprited AudioBuffer.

start

  • start(startTime?, endTime?): 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.

stop

suspend

toJSON

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods