XSound - v4.2.0
    Preparing search index...

    Interface TimeOverview

    This private class visualizes audio wave overview in time domain.

    interface TimeOverview {
        canvas: HTMLCanvasElement | null;
        channel: ChannelNumber;
        context: CanvasRenderingContext2D | null;
        graphics: GraphicsApi;
        interval: number;
        isActive: boolean;
        sampleRate: number;
        styles: GraphicsStyles;
        svg: SVGSVGElement | null;
        activate(): TimeOverview;
        clear(): TimeOverview;
        create(
            mimeType?: string,
            params?: { callback: BlobCallback; quality?: number; type?: string },
        ): string | void;
        createFontString(): string;
        createSVGLinearGradient(linearGradientId: string): SVGDefsElement | null;
        deactivate(): TimeOverview;
        drag(callback?: DragCallbackFunction): TimeOverview;
        get(): HTMLCanvasElement | SVGSVGElement | null;
        param(params: "interval"): number;
        param(params: "styles"): GraphicsStyles;
        param(params: "currentTime"): CurrentTimeStyles;
        param(params: "sprite"): string;
        param(params: "plotInterval"): number;
        param(params: "textInterval"): number;
        param(params: "mode"): DragMode;
        param(params: TimeOverviewParams): TimeOverview;
        setup(element: HTMLCanvasElement | SVGSVGElement): TimeOverview;
        start(
            data: Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
            minDecibels?: number,
            maxDecibels?: number,
        ): TimeOverview;
        state(): boolean;
        update(time: number): TimeOverview;
        visualizeBySVG(
            data: Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
            _minDecibels?: number,
            _maxDecibels?: number,
        ): void;
        visualizeOnCanvas(
            data: Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
            _minDecibels?: number,
            _maxDecibels?: number,
        ): void;
        visualizeTimeDomainFloat32ArrayBySVG(
            data: Float32Array,
            innerWidth: number,
            innerHeight: number,
            middle: number,
            numberOfPlots: number,
            linearGradientId: string,
        ): SVGPathElement | SVGGElement | null;
        visualizeTimeDomainFloat32ArrayOnCanvas(
            context: CanvasRenderingContext2D,
            data: Float32Array,
            innerWidth: number,
            innerHeight: number,
            middle: number,
            numberOfPlots?: number,
        ): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    canvas channel context graphics interval isActive sampleRate styles svg

    Methods

    activate clear create createFontString createSVGLinearGradient deactivate drag get param setup start state update visualizeBySVG visualizeOnCanvas visualizeTimeDomainFloat32ArrayBySVG visualizeTimeDomainFloat32ArrayOnCanvas

    Properties

    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 audio wave. 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 audio wave if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for visualizing audio wave. 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 audio wave if getter. Otherwise, return value is for method chain.

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

      Parameters

      • params: "currentTime"

        This argument is string if getter. Otherwise, setter.

      Returns CurrentTimeStyles

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

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

      Parameters

      • params: "sprite"

        This argument is string if getter. Otherwise, setter.

      Returns string

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

    • This method gets or sets parameters for visualizing audio wave. 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 audio wave if getter. Otherwise, return value is for method chain.

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

      Parameters

      • params: "textInterval"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "mode"

        This argument is string if getter. Otherwise, setter.

      Returns DragMode

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

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

      Parameters

      Returns TimeOverview

      Return value is parameter for visualizing audio wave if getter. Otherwise, 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 TimeOverview

      Return value is for method chain.

    • This method visualizes audio wave overview to SVG.

      Parameters

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

        This argument is audio data for visualization.

      • Optional_minDecibels: number
      • Optional_maxDecibels: number

      Returns void

    • This method visualizes audio wave overview to Canvas.

      Parameters

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

        This argument is audio data for visualization.

      • Optional_minDecibels: number
      • Optional_maxDecibels: number

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

    Settings

    Member Visibility

    On This Page

    Properties
    Methods