Class OneshotModule

This subclass is for playing one-shot audio

Hierarchy

Constructors

Properties

analyser: Analyser
autopanner: Autopanner
bitcrusher: BitCrusher
buffers: AudioBuffer[] = []
chorus: Chorus
compressor: Compressor
context: AudioContext
delay: Delay
duration: number = 0
envelopegenerator: EnvelopeGenerator
equalizer: Equalizer
filter: Filter
flanger: Flanger
fuzz: Fuzz
listener: Listener
loadError: boolean = false
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
resources: string[] | AudioBuffer[] = []
reverb: Reverb
ringmodulator: Ringmodulator
runningAnalyser: boolean = false
settings: OneshotSettings = []
sources: AudioBufferSourceNode[] = []
startTime: number = 0
states: boolean[] = []
stereo: Stereo
transpose: number = 0
tremolo: Tremolo
vocalcanceler: VocalCanceler
volumes: GainNode[] = []
wah: Wah
NUMBER_OF_INPUTS: 2 = 2
NUMBER_OF_OUTPUTS: 2 = 2

Accessors

Methods

  • This method connects AudioNodes.

    Parameters

    • source: AudioNode

      This argument is AudioNode as sound source.

    Returns void

  • This method gets instance of AudioBuffer or array that contains the all of AudioBuffers. This method is overloaded for type interface and type check.

    Parameters

    • index: number

      This argument selects instance of AudioBuffer.

    Returns AudioBuffer

  • Returns AudioBuffer[]

  • This method re-initials modules.

    Parameters

    • context: AudioContext

      This argument is in order to use Web Audio API.

    Returns void

  • This method installs customized effector.

    Parameters

    • effectorName: string

      This argument selects effector.

    • effector: Effector

      This argument is subclass that extends Effector class.

    Returns Effector

    Return value is instance of customized effector.

  • This method gets ArrayBuffer and creates instance of AudioBuffer.

    Parameters

    • params: {
          index: number;
          timeout?: number;
          url: string;
          errorCallback?(event, textStatus) => void;
          progressCallback?(event) => void;
          successCallback?(event, buffers) => void;
      }
      • index: number
      • Optional timeout?: number
      • url: string
      • errorCallback?:function
      • progressCallback?:function
      • successCallback?:function
        • Parameters

          • event: ProgressEvent<EventTarget>
          • buffers: AudioBuffer[]

          Returns void

    Returns void

  • This method gets or sets parameters for one-shot 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 one-shot module if getter. Otherwise, return value is for method chain.

  • Parameters

    • params: "transpose"

    Returns number

  • Parameters

    Returns OneshotModule

  • This method schedules playing audio.

    Parameters

    • Optional startTime: number

      This argument is start time. The default value is 0.

    • Optional duration: number

      This argument is duration. The default value is 0.

    Returns OneshotModule

    Return value is for method chain.

  • This method resets settings.

    Parameters

    • index: number

      This argument selects target setting.

    • paramName: keyof OneshotSetting

      This argument is one-shot parameter name.

    • param: number | boolean

      This argument is one-shot parameter value.

    Returns OneshotModule

    Return value is for method chain.

  • This method creates instances of AudioBuffer by Ajax.

    Parameters

    • params: {
          resources: string[] | AudioBuffer[];
          settings: OneshotSettings;
          timeout?: number;
          errorCallback?(event, textStatus) => void;
          progressCallback?(event) => void;
          successCallback?(event, buffers) => void;
      }
      • resources: string[] | AudioBuffer[]
      • settings: OneshotSettings
      • Optional timeout?: number
      • errorCallback?:function
      • progressCallback?:function
        • Parameters

          • event: ProgressEvent<EventTarget>

          Returns void

      • successCallback?:function
        • Parameters

          • event: ProgressEvent<EventTarget>
          • buffers: AudioBuffer[]

          Returns void

    Returns OneshotModule

Generated using TypeDoc