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

Properties

analyser: Analyser
autopanner: Autopanner
bitcrusher: BitCrusher
buffer: null | AudioBuffer = null
chorus: Chorus
compressor: Compressor
context: AudioContext
currentTime: number = 0
delay: Delay
envelopegenerator: EnvelopeGenerator
equalizer: Equalizer
filter: Filter
flanger: Flanger
fuzz: Fuzz
listener: Listener
mastervolume: GainNode
mixed: boolean = false
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 = false
source: AudioBufferSourceNode
stereo: Stereo
stopped: boolean = true
tremolo: Tremolo
vocalcanceler: VocalCanceler
wah: Wah
NUMBER_OF_INPUTS: 2 = 2
NUMBER_OF_OUTPUTS: 2 = 2

Accessors

Methods

  • Parameters

    • source: AudioBufferSourceNode
    • currentTime: number

    Returns void

  • This method gets or sets fade-in time.

    Parameters

    • Optional time: 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.

  • This method gets or sets fade-out time.

    Parameters

    • Optional time: 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.

  • This method gets instance of AudioBufferSourceNode.

    Returns AudioBufferSourceNode

  • 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.

  • This method re-initials modules.

    Parameters

    • context: AudioContext

      This argument is in order to use Web Audio API.

    Returns void

  • This method determines whether audio is paused.

    Returns boolean

    If audio is paused, this value is true. Otherwise, this value is false.

  • 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.

  • This method sets up envelope generator for fade-in and fade-out.

    Parameters

    • Optional callbacks: {
          decodeCallback?(buffer): void;
          endedCallback?(source, currentTime): void;
          errorCallback?(error): void;
          updateCallback?(source, currentTime): void;
      }
      • decodeCallback?:function
      • endedCallback?:function
        • Parameters

          • source: AudioBufferSourceNode
          • currentTime: number

          Returns void

      • errorCallback?:function
      • updateCallback?:function
        • Parameters

          • source: AudioBufferSourceNode
          • currentTime: number

          Returns void

    Returns AudioModule

    Return value is for method chain.

  • This method slices instance of AudioBuffer.

    Parameters

    • Optional startTime: number

      This argument is start time [sec] on AudioBuffer.

    • Optional endTime: number

      This argument is end time [sec] on AudioBuffer.

    Returns null | AudioBuffer

    Return value is sliced AudioBuffer.

  • 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.

  • This method starts audio from designated time.

    Parameters

    • Optional startTime: number

      This argument is time that audio is started at. The default value is 0.

    • Optional endTime: number

      This argument is time that audio is ended at. The default value is audio duration.

    Returns AudioModule

    This is returned for method chain.

  • Parameters

    • source: AudioBufferSourceNode
    • currentTime: number

    Returns void

Generated using TypeDoc