Class StreamModule

This class is for processing sound data from WebRTC.

Hierarchy (View Summary)

SoundModule
- StreamModule

Constructors

constructor

new StreamModule(context: AudioContext): StreamModule
Parameters
- context: AudioContext
  This argument is in order to use Web Audio API.
Returns StreamModule
Overrides SoundModule.constructor
- Defined in StreamModule/index.ts:63

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 StreamModule/index.ts:542

OUTPUT

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

Methods

clear

clear(): StreamModule
This method stops microphone and camera by stopping instances of MediaStreamTrack.

Returns StreamModule
Return value is for method chain.
- Defined in StreamModule/index.ts:280

clearAudioDevices

clearAudioDevices(): StreamModule
This method stops microphone by stopping instances of MediaStreamTrack.

Returns StreamModule
Return value is for method chain.
- Defined in StreamModule/index.ts:295

clearVideoDevices

clearVideoDevices(): StreamModule
This method stops camera by stopping instances of MediaStreamTrack.

Returns StreamModule
Return value is for method chain.
- Defined in StreamModule/index.ts:316

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

devices

devices(): Promise<void | MediaDeviceInfo[]>
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.
- Defined in StreamModule/index.ts:339

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

get

get(index: number): MediaStreamTrackAudioSourceNode | MediaStreamAudioSourceNode
This method gets instance of MediaStreamAudioSourceNode or MediaStreamTrackAudioSourceNode or that array contains these. This method is overloaded for type interface and type check.
Parameters
- index: number
  This argument selects instance of MediaStreamAudioSourceNode or MediaStreamTrackAudioSourceNode.
Returns MediaStreamTrackAudioSourceNode | MediaStreamAudioSourceNode
- Defined in StreamModule/index.ts:258
get(): MediaStreamAudioSourceNode[] | MediaStreamTrackAudioSourceNode[]
This method gets instance of MediaStreamAudioSourceNode or MediaStreamTrackAudioSourceNode or that array contains these. This method is overloaded for type interface and type check.

Returns MediaStreamAudioSourceNode[] | MediaStreamTrackAudioSourceNode[]
- Defined in StreamModule/index.ts:259

getStream

getStream(): null | MediaStream
This method gets instance of MediaStream.

Returns null | MediaStream
- Defined in StreamModule/index.ts:272

`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(): StreamModule
Returns StreamModule
Overrides SoundModule.mix
- Defined in StreamModule/index.ts:513

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 StreamModule/index.ts:360
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 StreamModule/index.ts:361
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 StreamModule/index.ts:362
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 StreamModule/index.ts:363
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 StreamModule/index.ts:364
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 StreamModule/index.ts:365
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 StreamModule/index.ts:366
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 StreamModule/index.ts:367
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 StreamModule/index.ts:368
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 StreamModule/index.ts:369
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 StreamModule/index.ts:370
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 StreamModule/index.ts:371
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 StreamModule/index.ts:372
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 StreamModule/index.ts:373
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 StreamModule/index.ts:374
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 StreamModule/index.ts:375
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 StreamModule/index.ts:376
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 StreamModule/index.ts:377
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 StreamModule/index.ts:378
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 StreamModule/index.ts:379
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 StreamModule/index.ts:380
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 StreamModule/index.ts:381
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 StreamModule/index.ts:382
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 StreamModule/index.ts:383
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 StreamModule/index.ts:384
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 StreamModule/index.ts:385

off

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

on

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

param

param(params: "mastervolume"): number
This method gets or sets parameters for stream 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 stream module if getter. Otherwise, return value is for method chain.
- Defined in StreamModule/index.ts:200
param(params: "output"): boolean
This method gets or sets parameters for stream module. This method is overloaded for type interface and type check.
Parameters
- params: "output"
  This argument is string if getter. Otherwise, setter.
Returns boolean
Return value is parameter for stream module if getter. Otherwise, return value is for method chain.
- Defined in StreamModule/index.ts:201
param(params: "track"): boolean
This method gets or sets parameters for stream module. This method is overloaded for type interface and type check.
Parameters
- params: "track"
  This argument is string if getter. Otherwise, setter.
Returns boolean
Return value is parameter for stream module if getter. Otherwise, return value is for method chain.
- Defined in StreamModule/index.ts:202
param(params: StreamModuleParams): StreamModule
This method gets or sets parameters for stream module. This method is overloaded for type interface and type check.
Parameters
- params: StreamModuleParams
  This argument is string if getter. Otherwise, setter.
Returns StreamModule
Return value is parameter for stream module if getter. Otherwise, return value is for method chain.
- Defined in StreamModule/index.ts:203

params

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

Returns Required<StreamModuleParams>
Overrides SoundModule.params
- Defined in StreamModule/index.ts:529

ready

ready(
    params?: {
        errorCallback?: (error: Error) => void;
        stream?: MediaStream;
        successCallback?: (stream: MediaStream) => void;
    },
): Promise<Error | MediaStream>
This method opens devices or sets instance of MediaStream.
Parameters
- Optionalparams: {
      errorCallback?: (error: Error) => void;
      stream?: MediaStream;
      successCallback?: (stream: MediaStream) => void;
  }
Returns Promise<Error | MediaStream>
Return value is Promise that getUserMedia returns.
- Defined in StreamModule/index.ts:89

setup

setup(constraints?: MediaStreamConstraints): StreamModule
This method sets up for using WebRTC.
Parameters
- Optionalconstraints: MediaStreamConstraints
  This argument is object based on MediaStreamConstraints dictionary.
Returns StreamModule
Return value is for method chain.
- Defined in StreamModule/index.ts:74

start

start(): StreamModule
This method starts streaming.

Returns StreamModule
Return value is for method chain.
- Defined in StreamModule/index.ts:132

stop

stop(): StreamModule
This method stops streaming.

Returns StreamModule
Return value is for method chain.
- Defined in StreamModule/index.ts:180

streaming

streaming(): boolean
This method determines whether streaming is active.

Returns boolean
If streaming is active, this value is true. Otherwise, this value is false.
- Defined in StreamModule/index.ts:351

suspend

suspend(): StreamModule
Returns StreamModule
Overrides SoundModule.suspend
- Defined in StreamModule/index.ts:507

toJSON

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

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

Class StreamModule

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns StreamModule

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

clear

Returns StreamModule

clearAudioDevices

Returns StreamModule

clearVideoDevices

Returns StreamModule

connect

Parameters

Returns void

demix

Returns StreamModule

devices

Returns Promise<void | MediaDeviceInfo[]>

disconnect

Returns void

edit

Parameters

Returns Connectable[]

get

Parameters

Returns MediaStreamTrackAudioSourceNode | MediaStreamAudioSourceNode

Returns MediaStreamAudioSourceNode[] | MediaStreamTrackAudioSourceNode[]

getStream

Returns null | MediaStream

Protectedinit

Parameters

Returns void

install

`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