On this page

Waveform

Container class for waveform audio data and metadata.

Constructor

new Waveform(optionsopt)

Parameters:

Name Type Attributes Description

options

object

<optional>

waveform data options

Properties

Name	Type	Attributes	Default	Description
`url`	string	<optional>	""	Streaming URL, blob URL, or object URL for the audio.
`sampleRate`	number	<optional>	-1	Sample rate in Hz; -1 if unknown.
`duration`	number	<optional>	-1	Duration in seconds; -1 if unknown.
`peaks`	Array.<number> \| null	<optional>	null	Pre-computed amplitude peaks for waveform rendering.
`filename`	string	<optional>	""	Original filename of the audio source.
`file`	File \| null	<optional>	null	Original File reference for direct upload (large files only).
`hasAudioMp3`	boolean	<optional>	false	Whether a converted audio.mp3 copy exists on the server.

Properties

Name	Type	Description
`url`	string	Streaming URL, blob URL, or object URL for the audio.
`sampleRate`	number	Sample rate of the audio in Hz; -1 if unknown.
`duration`	number	Duration of the audio in seconds; -1 if unknown.
`peaks`	Array.<number> \| null	Pre-computed amplitude peaks for fast waveform rendering.
`filename`	string	Original filename of the audio source.
`file`	File \| null	Original File reference for large audio (chunked path); null for small files or server audio.

Source: project.js, line 344

Classes

Waveform

Methods

clone(deepopt) → {Waveform}

Parameters:

Name	Type	Attributes	Default	Description
`deep`	boolean	<optional>	false	If true, peaks arrays are cloned; otherwise copied by reference.

Source: project.js, line 377

Returns:

Type:: Waveform