AudioData: copyTo() method

Available in workers

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

Syntax

copyTo(destination, options)

Parameters

• destination
  • : An ArrayBuffer, a TypedArray, or a DataView to copy the plane to.
• options
  • : An object containing the following:
    • planeIndex
      • : The index of the plane to copy from.
    • frameOffset Optional
      • : An integer giving the offset of the first frame to copy within the plane. Defaults to 0.
    • frameCount Optional
      • : An integer giving the number of frames to copy. If omitted, all frames from frameOffset to the end of the plane are copied.
    • format Optional
      • : A string indicating the audio format that the source samples should be converted to when copied to the destination. This can be any of the values: "u8", "s16", "s32", "f32", "u8-planar", "s16-planar", "s32-planar", and "f32-planar" (see format for more information). Note that "f32-planar" must be supported. If omitted, the samples are copied in the AudioData’s own format.

Return value

Undefined.

Exceptions

• InvalidStateError DOMException
  • : Thrown if the AudioData object has been transferred.
• RangeError
  • : 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.
• NotSupportedError DOMException
  • : Thrown if the specified format to convert the data to is not supported.

Examples

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

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

Specifications

Browser compatibility