XSound - v4.2.6
    Preparing search index...

    Interface Spectrogram

    This private class visualizes spectrogram.

    interface Spectrogram {
        analyser: AnalyserNode | null;
        canvas: HTMLCanvasElement | null;
        channel: ChannelNumber;
        context: CanvasRenderingContext2D | null;
        graphics: GraphicsApi;
        interval: number;
        isActive: boolean;
        sampleRate: number;
        styles: GraphicsStyles;
        svg: SVGSVGElement | null;
        activate(): Spectrogram;
        clear(): Spectrogram;
        connect(source: AudioNode | SoundModule): Spectrogram | undefined;
        create(
            mimeType?: string,
            params?: { callback: BlobCallback; quality?: number; type?: string },
        ): string | void;
        createFontString(): string;
        createSVGLinearGradient(linearGradientId: string): SVGDefsElement | null;
        deactivate(): Spectrogram;
        get(): HTMLCanvasElement | SVGSVGElement | null;
        param(params: "interval"): number;
        param(params: "styles"): GraphicsStyles;
        param(params: "type"): DataType;
        param(params: "size"): number;
        param(params: "scale"): SpectrumScale;
        param(params: "duration"): number;
        param(params: "plotInterval"): number;
        param(params: "linearFrequencyTextInterval"): number;
        param(params: "timeTextInterval"): number;
        param(params: "logarithmicFrequencies"): number[];
        param(params: "minFrequency"): number;
        param(params: "maxFrequency"): number;
        param(params: SpectrogramParams): Spectrogram;
        renderCanvas(
            data: Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
        ): void;
        renderSVG(
            data: Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
        ): void;
        renderTimeDomainFloat32ArrayCanvas(
            context: CanvasRenderingContext2D,
            data: Float32Array,
            innerWidth: number,
            innerHeight: number,
            middle: number,
            numberOfPlots?: number,
        ): void;
        renderTimeDomainFloat32ArraySVG(
            data: Float32Array,
            innerWidth: number,
            innerHeight: number,
            middle: number,
            numberOfPlots: number,
            linearGradientId: string,
        ): SVGPathElement | SVGGElement | null;
        setColorFromNumberFunction(
            func: ((data: number) => string) | null,
        ): Spectrogram;
        setup(element: HTMLCanvasElement | SVGSVGElement): Spectrogram;
        start(
            data: Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
            minDecibels?: number,
            maxDecibels?: number,
        ): Spectrogram;
        state(): boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    analyser canvas channel context graphics interval isActive sampleRate styles svg

    Methods

    activate clear connect create createFontString createSVGLinearGradient deactivate get param renderCanvas renderSVG renderTimeDomainFloat32ArrayCanvas renderTimeDomainFloat32ArraySVG setColorFromNumberFunction setup start state

    Properties

    analyser: AnalyserNode | null = null
    canvas: HTMLCanvasElement | null = null
    channel: ChannelNumber
    context: CanvasRenderingContext2D | null = null
    graphics: GraphicsApi = ''
    interval: number = 1000
    isActive: boolean = false
    sampleRate: number
    styles: GraphicsStyles = ...
    svg: SVGSVGElement | null = null

    Methods

    • This method creates visualized graphics as string (Data URL or Blob or SVG).

      Parameters

      • OptionalmimeType: string

        This argument is string that indicates image format. The default value is image/octet-stream.

      • Optionalparams: { callback: BlobCallback; quality?: number; type?: string }

      Returns string | void

    • This method creates elements for SVG linear gradient.

      Parameters

      • linearGradientId: string

        This argument is id attribute for SVGLinearGradientElement.

      Returns SVGDefsElement | null

      This value is as instance of SVGDefsElement.

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

      Parameters

      • params: "interval"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "styles"

        This argument is string if getter. Otherwise, setter.

      Returns GraphicsStyles

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

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

      Parameters

      • params: "type"

        This argument is string if getter. Otherwise, setter.

      Returns DataType

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

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

      Parameters

      • params: "size"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "scale"

        This argument is string if getter. Otherwise, setter.

      Returns SpectrumScale

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

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

      Parameters

      • params: "duration"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "plotInterval"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "linearFrequencyTextInterval"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "timeTextInterval"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "logarithmicFrequencies"

        This argument is string if getter. Otherwise, setter.

      Returns number[]

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

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

      Parameters

      • params: "minFrequency"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "maxFrequency"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      Returns Spectrogram

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

    • This method visualizes spectrogram to Canvas.

      Parameters

      • data: Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

        This argument is frequency domain data for spectrogram.

      Returns void

    • This method visualizes spectrogram to SVG.

      Parameters

      • data: Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

        This argument is frequency domain data for spectrogram.

      Returns void

    • This method visualizes time domain data (Float32Array) to Canvas.

      Parameters

      • context: CanvasRenderingContext2D

        This argument is instance of CanvasRenderingContext2D.

      • data: Float32Array

        This argument is time domain data.

      • innerWidth: number

        This argument is width of visualization area.

      • innerHeight: number

        This argument is height of visualization area.

      • middle: number

        This argument is middle of visualization area.

      • OptionalnumberOfPlots: number

        This argument is interval for visualization.

      Returns void

    • This method visualizes time domain data (Float32Array) to SVG.

      Parameters

      • data: Float32Array

        This argument is time domain data.

      • innerWidth: number

        This argument is width of visualization area.

      • innerHeight: number

        This argument is height of visualization area.

      • middle: number

        This argument is middle of visualization area.

      • numberOfPlots: number

        This argument is interval for visualization.

      • linearGradientId: string

        This argument is id attribute for SVGLinearGradientElement.

      Returns SVGPathElement | SVGGElement | null

      This value is instance of SVGPathElement or SVGGElement.

    • This method sets function that converts number to color string.

      Parameters

      • func: ((data: number) => string) | null

        This argument is function that converts number to color string;

      Returns Spectrogram

      Return value is for method chain.

    • This method visualizes sound wave to Canvas or SVG. This method conceals difference of API for visualization.

      Parameters

      • data: Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

        This argument is sound data for visualization.

      • OptionalminDecibels: number

        This argument is parameter for spectrum. The default value is -100 dB.

      • OptionalmaxDecibels: number

        This argument is parameter for spectrum. The default value is -30 dB.

      Returns Spectrogram

      Return value is for method chain.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods