XSound - v4.2.0
    Preparing search index...

    Interface SoundModuleAbstract

    This class is superclass that is the top in this library. This class is extended as subclass (OscillatorModule, OneshotModule, NoiseModule, AudioModule, MediaModule, StreamModule, ProcessorModule, MixerModule ...etc).

    interface SoundModule {
        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(): GainNode | AudioWorkletNode | null;
        get OUTPUT(): GainNode;
        audioDestination(): SoundModule;
        connect(source: AudioNode): void;
        demix(): SoundModule;
        disconnect(): void;
        edit(modules: Connectable[]): Connectable[];
        init(context: AudioContext): void;
        install<ExtendedEffector extends Effector>(
            effector: new (context: AudioContext) => ExtendedEffector,
        ): ExtendedEffector;
        mix(): SoundModule;
        off(stopTime?: number): SoundModule;
        on(startTime?: number): SoundModule;
        params(): Required<SoundModuleParams>;
        setSinkId(
            sinkId: string,
            successCallback?: () => void,
            errorCallback?: (error: Error) => void,
        ): SoundModule;
        streamDestination(
            params?: {
                errorCallback?: (error: Error) => void;
                sinkId: string;
                successCallback?: () => void;
            },
        ): SoundModule;
        suspend(): SoundModule;
        toJSON(): string;
    }

    Hierarchy (View Summary)

    Implements

    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 connect demix disconnect edit init install mix off on params setSinkId streamDestination 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

    • get INPUT(): GainNode | AudioWorkletNode | null

      Connector for input.

      Returns GainNode | AudioWorkletNode | null

    • get OUTPUT(): GainNode

      Connector for output.

      Returns GainNode

    Methods

    • This method connects AudioNodes.

      Parameters

      • source: AudioNode

        This argument is AudioNode as sound source.

      Returns void

    • This method disconnects instance of AudioWorkletNode as sound source.

      Returns void

    • This method re-initials modules.

      Parameters

      • context: AudioContext

        This argument is in order to use Web Audio API.

      Returns void

    • This method stops effectors.

      Parameters

      • OptionalstopTime: number

        This argument is used for scheduling parameter.

      Returns SoundModule

      Return value is for method chain.

    • This method starts effectors.

      Parameters

      • OptionalstartTime: number

        This argument is used for scheduling parameter.

      Returns SoundModule

      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 SoundModule

      Return value is for method chain.

    • This method switches destination over to MediaStreamAudioDestinationNode.

      Parameters

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

      Returns SoundModule

      Return value is for method chain.

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods