From 1b1dd24959044b51f536270450e70b45fb1a0068 Mon Sep 17 00:00:00 2001 From: Vanilagy <1696106+Vanilagy@users.noreply.github.com> Date: Mon, 22 Sep 2025 22:06:09 +0200 Subject: [PATCH] Add missing docs --- docs/guide/output-formats.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/guide/output-formats.md b/docs/guide/output-formats.md index 03d358b..98e61d3 100644 --- a/docs/guide/output-formats.md +++ b/docs/guide/output-formats.md @@ -247,11 +247,16 @@ The following options are available: ```ts type WavOutputFormatOptions = { large?: boolean; + metadataFormat?: 'info' | 'id3'; onHeader?: (data: Uint8Array, position: number) => unknown; }; ``` - `large`\ When enabled, an RF64 file be written, allowing for file sizes to exceed 4 GiB, which is otherwise not possible for regular WAVE files. +- `metadataFormat`\ + The metadata format to use for writing metadata tags. + - `'info'` (default): Writes metadata into a RIFF INFO LIST chunk, the default way to contain metadata tags within WAVE. Only allows for a limited subset of tags to be written. + - `'id3'`: Writes metadata into an ID3 chunk. Non-default, but used by many taggers in practice. Allows for a much larger and richer set of tags to be written. - `onHeader`\ Will be called once the file header is written. The header consists of the RIFF header, the format chunk, and the start of the data chunk (with a placeholder size of 0).