ContextQMD
Back to Content

AudioBuffer: copyToChannel() method

files/en-us/web/api/audiobuffer/copytochannel/index.md

latest1.5 KB
Original Source

{{ APIRef("Web Audio API") }}

The copyToChannel() method of the {{ domxref("AudioBuffer") }} interface copies the samples to the specified channel of the AudioBuffer, from the source array.

Syntax

js-nolint
copyToChannel(source, channelNumber)
copyToChannel(source, channelNumber, startInChannel)

Parameters

  • source
    • : A {{jsxref("Float32Array")}} that the channel data will be copied from.
  • channelNumber
    • : The channel number of the current {{domxref("AudioBuffer")}} to copy the channel data to. If channelNumber is greater than or equal to {{domxref("AudioBuffer.numberOfChannels")}}, an INDEX_SIZE_ERR will be thrown.
  • startInChannel {{optional_inline}}
    • : An optional offset to copy the data to. If startInChannel is greater than {{domxref("AudioBuffer.length")}}, an INDEX_SIZE_ERR will be thrown.

Return value

None ({{jsxref("undefined")}}).

Examples

js
const myArrayBuffer = audioCtx.createBuffer(2, frameCount, audioCtx.sampleRate);
const anotherArray = new Float32Array();
// Copy channel data from second channel of myArrayBuffer.
myArrayBuffer.copyFromChannel(anotherArray, 1, 0);
// Copy data from anotherArray to first channel of myArrayBuffer. Both channels have the same data now.
myArrayBuffer.copyToChannel(anotherArray, 0, 0);

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also