web api instance method
AudioBuffer: copyFromChannel() method
The
copyFromChannel() method of the
AudioBuffer interface copies the audio sample data from the specified
channel of the AudioBuffer to a specified
Float32Array.
Syntax
copyFromChannel(destination, channelNumber, startInChannel)
Parameters
destination- : A
Float32Arrayto copy the channel’s samples to.
- : A
channelNumber- : The channel number of the current
AudioBufferto copy the channel data from.
- : The channel number of the current
startInChannelOptional- : An optional offset into the source channel’s buffer from which to begin copying samples. If not specified, a value of 0 (the beginning of the buffer) is assumed by default.
Return value
None (undefined).
Exceptions
indexSizeError- : One of the input parameters has a value that is outside the accepted range:
- The value of
channelNumberspecifies a channel number which doesn’t exist (that is, it’s greater than or equal to the value ofnumberOfChannelson the channel). - The value of
startInChannelis outside the current range of samples that already exist in the source buffer; that is, it’s greater than its currentlength.
- The value of
- : One of the input parameters has a value that is outside the accepted range:
Examples
This example creates a new audio buffer, then copies the samples from another channel into it.
const myArrayBuffer = audioCtx.createBuffer(2, frameCount, audioCtx.sampleRate);
const anotherArray = new Float32Array(length);
myArrayBuffer.copyFromChannel(anotherArray, 1, 0);
Specifications
SpecificationsStandards references are available on the canonical MDN page.
Browser compatibility
Browser compatibilityCompatibility data is available on the canonical MDN page.