Type

AudioSampleCopyToOptions

Options used for copying audio sample data.

type AudioSampleCopyToOptions = {
	planeIndex: number;
	format?: AudioSampleFormat;
	frameOffset?: number;
	frameCount?: number;
};

Used by

planeIndex: number;

The index identifying the plane to copy from. This must be 0 if using a non-planar (interleaved) output format.

format?: AudioSampleFormat;

The output format for the destination data. Defaults to the AudioSample's format. See sample formats

frameOffset?: number;

An offset into the source plane data indicating which frame to begin copying from. Defaults to 0.

frameCount?: number;

The number of frames to copy. If not provided, the copy will include all frames in the plane beginning with frameOffset.