AudioData.copyTo()
The copyTo()
method of the AudioData
interface copies a plane of an AudioData
object to a destination buffer.
Syntax
AudioData.copyTo(destination, options)
Parameters
destination
-
The
buffer
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 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
.
Return Value
Undefined.
Exceptions
InvalidStateError
DOMException
-
Thrown if the
AudioData
object has been transferred. RangeError
DOMException
-
Thrown if the length of the sample is longer than the destination length.
RangeError
DOMException
-
Thrown if the format of the
AudioData
object describes a planar format, butoptions.planeIndex
is outside of the number of planes available. RangeError
DOMException
-
Thrown if the format of the
AudioData
object describes an interleaved format, butoptions.planeIndex
is greater than0
.
Examples
The following example copies the plane at index 1
to a destination buffer.
AudioData.copyTo(AudioBuffer, {planeIndex: 1});
Specifications
Specification |
---|
WebCodecs # dom-audiodata-copyto |
Browser compatibility
BCD tables only load in the browser