AudioData
The AudioData interface of the WebCodecs API represents an audio sample.
Methods
allocationSize()
allocationSize(options): number;
The allocationSize() method of the AudioData interface returns the size in bytes required to hold the current sample as filtered by options passed into the method.
Parameters
| Parameter | Type |
|---|---|
options | AudioDataCopyToOptions |
Returns
number
clone()
clone(): AudioData;
The clone() method of the AudioData interface creates a new AudioData object with reference to the same media resource as the original.
Returns
AudioData
close()
close(): void;
The close() method of the AudioData interface clears all states and releases the reference to the media resource.
Returns
void
copyTo()
copyTo(destination, options): void;
The copyTo() method of the AudioData interface copies a plane of an AudioData object to a destination buffer.
Parameters
| Parameter | Type |
|---|---|
destination | AllowSharedBufferSource |
options | AudioDataCopyToOptions |
Returns
void
Properties
duration
readonly duration: number;
The duration read-only property of the AudioData interface returns the duration in microseconds of this AudioData object.
format
readonly format: AudioSampleFormat | null;
The format read-only property of the AudioData interface returns the sample format of the AudioData object.
numberOfChannels
readonly numberOfChannels: number;
The numberOfChannels read-only property of the AudioData interface returns the number of channels in the AudioData object.
numberOfFrames
readonly numberOfFrames: number;
The numberOfFrames read-only property of the AudioData interface returns the number of frames in the AudioData object.
sampleRate
readonly sampleRate: number;
The sampleRate read-only property of the AudioData interface returns the sample rate in Hz.
timestamp
readonly timestamp: number;
The timestamp read-only property of the AudioData interface returns the timestamp of this AudioData object.