arcodange/mediabunny
1
0
Fork 0
mirror of https://github.com/arcodange-org/mediabunny.git synced 2026-09-27 02:43:48 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add xingHeader option to Mp3OutputFormat

Browse Source
This commit is contained in:
Vanilagy
2025-08-10 16:04:18 +02:00
parent 230f02fffc
commit 5608f519a7
3 changed files with 23 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/guide/output-formats.md
+7 -1
View File
@@ -206,11 +206,17 @@ const output = new Output({
The following options are available:
```ts
type Mp3OutputFormatOptions = {
xingHeader?: boolean;
onXingFrame?: (data: Uint8Array, position: number) => unknown;
};
```
- `xingHeader`\
Controls whether the Xing header, which contains additional metadata as well as an index, is written to the start of the MP3 file. Defaults to `true`.
::: info
When set to `false`, this option ensures [append-only writing](#append-only-writing).
:::
- `onXingFrame`\
Will be called once the Xing metadata frame is finalized, which happens at the end of the writing process.
Will be called once the Xing metadata frame is finalized, which happens at the end of the writing process. This callback only fires if `xingHeader` isn't set to `false`.
::: info
Most browsers don't support encoding MP3. Use the official [`@mediabunny/mp3-encoder`](./extensions/mp3-encoder) package to polyfill an encoder.