Class StreamModule

This class is for processing sound data from WebRTC.

Hierarchy (view full)

Constructors

Properties

analyser: Analyser
autopanner: Autopanner
bitcrusher: BitCrusher
chorus: Chorus
compressor: Compressor
constraints: MediaStreamConstraints = ...
context: AudioContext
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
output: boolean = true
overdrive: OverDrive
panner: Panner
paused: boolean = true
phaser: Phaser
pitchshifter: PitchShifter
preamp: Preamp
processor: AudioWorkletNode
recorder: Recorder
reverb: Reverb
ringmodulator: Ringmodulator
runningAnalyser: boolean = false
sources: MediaStreamAudioSourceNode[] | MediaStreamTrackAudioSourceNode[] = []
stereo: Stereo
stream: null | MediaStream = null
track: boolean = false
tremolo: Tremolo
vocalcanceler: VocalCanceler
wah: Wah
NUMBER_OF_INPUTS: 2 = 2
NUMBER_OF_OUTPUTS: 2 = 2

Accessors

Methods

  • This method gets available devices as array that contains instance of MediaDeviceInfo.

    Returns Promise<void | MediaDeviceInfo[]>

    Return value is Promise that has array contains instance of MediaDeviceInfo.

  • This method gets instance of MediaStream.

    Returns null | MediaStream

  • This method re-initials modules.

    Parameters

    • context: AudioContext

      This argument is in order to use Web Audio API.

    Returns void

  • This method opens devices or sets instance of MediaStream.

    Parameters

    • Optional params: {
          errorCallback?: ((error) => void);
          stream?: MediaStream;
          successCallback?: ((stream) => void);
      }
      • Optional errorCallback?: ((error) => void)
          • (error): void
          • Parameters

            • error: Error

            Returns void

      • Optional stream?: MediaStream
      • Optional successCallback?: ((stream) => void)
          • (stream): void
          • Parameters

            • stream: MediaStream

            Returns void

    Returns Promise<Error | MediaStream>

    Return value is Promise that getUserMedia returns.

  • This method sets up for using WebRTC.

    Parameters

    • Optional constraints: MediaStreamConstraints

      This argument is object based on MediaStreamConstraints dictionary.

    Returns StreamModule

    Return value is for method chain.

  • This method determines whether streaming is active.

    Returns boolean

    If streaming is active, this value is true. Otherwise, this value is false.