XSound - v4.2.0
    Preparing search index...

    Interface Analyser

    This private class manages 3 private classes (TimeOverview, Time, FFT) for visualizing sound wave.

    interface Analyser {
        get INPUT(): GainNode;
        get OUTPUT(): GainNode;
        domain(domain: "timeoverview", channelNumber: ChannelNumber): TimeOverview;
        domain(domain: "time", channelNumber?: ChannelNumber): Time;
        domain(domain: "fft", channelNumber?: ChannelNumber): FFT;
        domain(domain: "spectrogram", channelNumber?: ChannelNumber): Spectrogram;
        get(channelNumber?: ChannelNumber): AnalyserNode | null;
        param(params: "fftSize"): number;
        param(params: "frequencyBinCount"): number;
        param(params: "minDecibels"): number;
        param(params: "maxDecibels"): number;
        param(params: "smoothingTimeConstant"): number;
        param(params: AnalyserParams): Analyser;
        start(
            domain: Domain,
            channelNumber?: ChannelNumber,
            buffer?: AudioBuffer,
        ): Analyser;
        stop(domain: Domain, channelNumber?: ChannelNumber): Analyser;
    }

    Implements

    Index

    Accessors

    INPUT OUTPUT

    Methods

    domain get param start stop

    Accessors

    Methods

    • This method selects domain for visualization. This method is overloaded for type interface and type check.

      Parameters

      • domain: "timeoverview"

        This argument is one of 'timeoverview', 'time', 'fft', spectrogram.

      • channelNumber: ChannelNumber

        This argument is channel number (Left: 0, Right: 1 ...).

      Returns TimeOverview

      Return value is instance of selected Visualizer class.

    • This method selects domain for visualization. This method is overloaded for type interface and type check.

      Parameters

      • domain: "time"

        This argument is one of 'timeoverview', 'time', 'fft', spectrogram.

      • OptionalchannelNumber: ChannelNumber

        This argument is channel number (Left: 0, Right: 1 ...).

      Returns Time

      Return value is instance of selected Visualizer class.

    • This method selects domain for visualization. This method is overloaded for type interface and type check.

      Parameters

      • domain: "fft"

        This argument is one of 'timeoverview', 'time', 'fft', spectrogram.

      • OptionalchannelNumber: ChannelNumber

        This argument is channel number (Left: 0, Right: 1 ...).

      Returns FFT

      Return value is instance of selected Visualizer class.

    • This method selects domain for visualization. This method is overloaded for type interface and type check.

      Parameters

      • domain: "spectrogram"

        This argument is one of 'timeoverview', 'time', 'fft', spectrogram.

      • OptionalchannelNumber: ChannelNumber

        This argument is channel number (Left: 0, Right: 1 ...).

      Returns Spectrogram

      Return value is instance of selected Visualizer class.

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

      Parameters

      • params: "fftSize"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "frequencyBinCount"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "minDecibels"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "maxDecibels"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "smoothingTimeConstant"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: AnalyserParams

        This argument is string if getter. Otherwise, setter.

      Returns Analyser

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

    • This method visualizes sound wave.

      Parameters

      • domain: Domain

        This argument is one of 'timeoverview', 'time', 'fft', 'spectrogram'.

      • OptionalchannelNumber: ChannelNumber

        This argument is channel number (Left: 0, Right: 1 ...).

      • Optionalbuffer: AudioBuffer

        This argument is instance of AudioBuffer (If domain is 'timeoverview', this argument is required).

      Returns Analyser

      Return value is for method chain.

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods