renderToBuffer

Renders a sound definition using an OfflineAudioContext. Useful for pre-rendering sounds, generating previews, or exporting audio.

import { renderToBuffer } from "@web-kits/audio";

const buffer = await renderToBuffer(definition, {
  duration: 1,
  sampleRate: 44100,
});

Signature

function renderToBuffer(
  definition: SoundDefinition,
  options: OfflineRenderOptions
): Promise<AudioBuffer>;

OfflineRenderOptions

PropertyTypeDefaultDescription
durationnumber-Duration in seconds
sampleRatenumber44100Output sample rate
numberOfChannelsnumber2Number of audio channels