AudioData: copyTo() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Note: This feature is available in Dedicated Web Workers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The copyTo() method of the AudioData interface copies a plane of an AudioData object to a destination buffer.

copyTo(destination, options)

An ArrayBuffer, a TypedArray, or a DataView to copy the plane to.

An object containing the following:

planeIndex: The index of the plane to copy from.
frameOffset Optional: An integer giving an offset into the plane data indicating which plane to begin copying from. Defaults to 0.
frameCount Optional: An integer giving the number of frames to copy. If omitted then all frames in the plane will be copied, beginning with the frame specified in frameOffset.

Undefined.

Thrown if the AudioData object has been transferred.

Thrown if one of the following conditions is met:

The length of the sample is longer than the destination length.
The format of the AudioData object describes a planar format, but options.planeIndex is outside of the number of planes available.
The format of the AudioData object describes an interleaved format, but options.planeIndex is greater than 0.

The following example copies the plane at index 1 to a destination buffer.

AudioData.copyTo(AudioBuffer, { planeIndex: 1 });

Specification
WebCodecs # dom-audiodata-copyto

BCD tables only load in the browser