The AudioData interface of the WebCodecs API represents an audio sample.

MDN Reference

interface AudioData {
    duration: number;
    format: AudioSampleFormat | null;
    numberOfChannels: number;
    numberOfFrames: number;
    sampleRate: number;
    timestamp: number;
    allocationSize(options: AudioDataCopyToOptions): number;
    clone(): AudioData;
    close(): void;
    copyTo(
        destination: AllowSharedBufferSource,
        options: AudioDataCopyToOptions,
    ): void;
}
Index

Properties

duration: number

The duration read-only property of the AudioData interface returns the duration in microseconds of this AudioData object.

MDN Reference

format: AudioSampleFormat | null

The format read-only property of the AudioData interface returns the sample format of the AudioData object.

MDN Reference

numberOfChannels: number

The numberOfChannels read-only property of the AudioData interface returns the number of channels in the AudioData object.

MDN Reference

numberOfFrames: number

The numberOfFrames read-only property of the AudioData interface returns the number of frames in the AudioData object.

MDN Reference

sampleRate: number

The sampleRate read-only property of the AudioData interface returns the sample rate in Hz.

MDN Reference

timestamp: number

The timestamp read-only property of the AudioData interface returns the timestamp of this AudioData object.

MDN Reference

Methods

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

    MDN Reference

    Parameters

    Returns number

  • The clone() method of the AudioData interface creates a new AudioData object with reference to the same media resource as the original.

    MDN Reference

    Returns AudioData

  • The close() method of the AudioData interface clears all states and releases the reference to the media resource.

    MDN Reference

    Returns void