XSound - v4.2.0
    Preparing search index...

    Interface StreamModule

    This class is for processing sound data from WebRTC.

    interface StreamModule {
        analyser: Analyser;
        autopanner: Autopanner;
        bitcrusher: BitCrusher;
        chorus: Chorus;
        compressor: Compressor;
        context: AudioContext;
        delay: Delay;
        destination: AudioDestinationNode | MediaStreamAudioDestinationNode;
        envelopegenerator: EnvelopeGenerator;
        equalizer: Equalizer;
        filter: Filter;
        flanger: Flanger;
        fuzz: Fuzz;
        listener: Listener;
        mastervolume: GainNode;
        mixed: boolean;
        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;
        stereo: Stereo;
        tremolo: Tremolo;
        vocalcanceler: VocalCanceler;
        wah: Wah;
        get INPUT(): AudioWorkletNode;
        get OUTPUT(): GainNode;
        audioDestination(): StreamModule;
        clear(): StreamModule;
        clearAudioDevices(): StreamModule;
        clearVideoDevices(): StreamModule;
        connect(source: AudioNode): void;
        demix(): StreamModule;
        devices(): Promise<void | MediaDeviceInfo[]>;
        disconnect(): void;
        edit(modules: Connectable[]): Connectable[];
        get(
            index: number,
        ): MediaStreamTrackAudioSourceNode | MediaStreamAudioSourceNode;
        get(): MediaStreamAudioSourceNode[] | MediaStreamTrackAudioSourceNode[];
        getConstraints(): MediaStreamConstraints;
        getStream(): MediaStream | null;
        init(context: AudioContext): void;
        install<ExtendedEffector extends Effector>(
            effector: new (context: AudioContext) => ExtendedEffector,
        ): ExtendedEffector;
        mix(): StreamModule;
        module(moduleName: "analyser"): Analyser;
        module(moduleName: "recorder"): Recorder;
        module(moduleName: "autopanner"): Autopanner;
        module(moduleName: "bitcrusher"): BitCrusher;
        module(moduleName: "chorus"): Chorus;
        module(moduleName: "compressor"): Compressor;
        module(moduleName: "delay"): Delay;
        module(moduleName: "envelopegenerator"): EnvelopeGenerator;
        module(moduleName: "equalizer"): Equalizer;
        module(moduleName: "filter"): Filter;
        module(moduleName: "flanger"): Flanger;
        module(moduleName: "fuzz"): Fuzz;
        module(moduleName: "listener"): Listener;
        module(moduleName: "noisegate"): NoiseGate;
        module(moduleName: "noisesuppressor"): NoiseSuppressor;
        module(moduleName: "overdrive"): OverDrive;
        module(moduleName: "panner"): Panner;
        module(moduleName: "phaser"): Phaser;
        module(moduleName: "pitchshifter"): PitchShifter;
        module(moduleName: "preamp"): Preamp;
        module(moduleName: "reverb"): Reverb;
        module(moduleName: "ringmodulator"): Ringmodulator;
        module(moduleName: "stereo"): Stereo;
        module(moduleName: "tremolo"): Tremolo;
        module(moduleName: "vocalcanceler"): VocalCanceler;
        module(moduleName: "wah"): Wah;
        off(stopTime?: number): StreamModule;
        on(startTime?: number): StreamModule;
        param(params: "mastervolume"): number;
        param(params: "output"): boolean;
        param(params: "track"): boolean;
        param(params: StreamModuleParams): StreamModule;
        params(): Required<StreamModuleParams>;
        ready(
            params?: {
                errorCallback?: (error: Error) => void;
                stream?: MediaStream;
                successCallback?: (stream: MediaStream) => void;
            },
        ): Promise<Error | MediaStream>;
        setConstraints(constraints: MediaStreamConstraints): StreamModule;
        setInputDeviceId(deviceId: string): StreamModule;
        setSinkId(
            sinkId: string,
            successCallback?: () => void,
            errorCallback?: (error: Error) => void,
        ): StreamModule;
        setup(constraints?: MediaStreamConstraints): StreamModule;
        start(): StreamModule;
        stop(): StreamModule;
        streamDestination(
            params?: {
                errorCallback?: (error: Error) => void;
                sinkId: string;
                successCallback?: () => void;
            },
        ): StreamModule;
        streaming(): boolean;
        suspend(): StreamModule;
        toJSON(): string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    analyser autopanner bitcrusher chorus compressor context delay destination 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

    Accessors

    INPUT OUTPUT

    Methods

    audioDestination clear clearAudioDevices clearVideoDevices connect demix devices disconnect edit get getConstraints getStream init install mix module off on param params ready setConstraints setInputDeviceId setSinkId setup start stop streamDestination streaming suspend toJSON

    Properties

    analyser: Analyser
    autopanner: Autopanner
    bitcrusher: BitCrusher
    chorus: Chorus
    compressor: Compressor
    context: AudioContext
    delay: Delay
    destination: AudioDestinationNode | MediaStreamAudioDestinationNode
    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
    stereo: Stereo
    tremolo: Tremolo
    vocalcanceler: VocalCanceler
    wah: Wah

    Accessors

    Methods

    • This method connects AudioNodes.

      Parameters

      • source: AudioNode

        This argument is AudioNode as sound source.

      Returns void

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

      Returns MediaStreamConstraints

    • This method gets instance of MediaStream.

      Returns MediaStream | null

    • This method re-initials modules.

      Parameters

      • context: AudioContext

        This argument is in order to use Web Audio API.

      Returns void

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "analyser"

        This argument selects module.

      Returns Analyser

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "recorder"

        This argument selects module.

      Returns Recorder

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "autopanner"

        This argument selects module.

      Returns Autopanner

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "bitcrusher"

        This argument selects module.

      Returns BitCrusher

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "chorus"

        This argument selects module.

      Returns Chorus

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "compressor"

        This argument selects module.

      Returns Compressor

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "delay"

        This argument selects module.

      Returns Delay

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "envelopegenerator"

        This argument selects module.

      Returns EnvelopeGenerator

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "equalizer"

        This argument selects module.

      Returns Equalizer

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "filter"

        This argument selects module.

      Returns Filter

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "flanger"

        This argument selects module.

      Returns Flanger

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "fuzz"

        This argument selects module.

      Returns Fuzz

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "listener"

        This argument selects module.

      Returns Listener

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "noisegate"

        This argument selects module.

      Returns NoiseGate

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "noisesuppressor"

        This argument selects module.

      Returns NoiseSuppressor

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "overdrive"

        This argument selects module.

      Returns OverDrive

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "panner"

        This argument selects module.

      Returns Panner

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "phaser"

        This argument selects module.

      Returns Phaser

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "pitchshifter"

        This argument selects module.

      Returns PitchShifter

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "preamp"

        This argument selects module.

      Returns Preamp

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "reverb"

        This argument selects module.

      Returns Reverb

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "ringmodulator"

        This argument selects module.

      Returns Ringmodulator

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "stereo"

        This argument selects module.

      Returns Stereo

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "tremolo"

        This argument selects module.

      Returns Tremolo

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "vocalcanceler"

        This argument selects module.

      Returns VocalCanceler

    • This method gets instance of Module (Analyser, Recorder, Effector ... etc).

      Parameters

      • moduleName: "wah"

        This argument selects module.

      Returns Wah

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

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

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

    • This method gets or sets parameters for stream module. This method is overloaded for type interface and type check.

      Parameters

      Returns StreamModule

      Return value is parameter for stream module if getter. Otherwise, return value is for method chain.

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

    • This method changes MediaStreamConstraints.

      Parameters

      • constraints: MediaStreamConstraints

        This argument is object based on MediaStreamConstraints dictionary.

      Returns StreamModule

      Return value is for method chain.

    • This method enables to designate input device.

      Parameters

      • deviceId: string

        This argument is string as input device ID.

      Returns StreamModule

      Return value is for method chain.

    • This method enables to use multiple output devices.

      Parameters

      • sinkId: string

        This argument is string as output device ID.

      • OptionalsuccessCallback: () => void

        This argument is invoked on success.

      • OptionalerrorCallback: (error: Error) => void

        This argument is invoked on failure.

      Returns StreamModule

      Return value is for method chain.

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

    • This method switches destination over to MediaStreamAudioDestinationNode.

      Parameters

      • Optionalparams: {
            errorCallback?: (error: Error) => void;
            sinkId: string;
            successCallback?: () => void;
        }

      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.

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods