@audio/encode-mp3

中文文档
2.0.1发布于 2026/10/06MITTypeScriptES Module零依赖近 30 天下载 9208

Encode PCM audio samples to MP3 format via WASM

原始使用文档
文档目录5 节
  1. Gapless
  2. Options
  3. Streaming
  4. Streaming output
  5. License

@audio/encode-mp3

Encode PCM audio samples to MP3 format.
WASM (libmp3lame via wasm-media-encoders) — works in both node and browser.

npm install @audio/encode-mp3

import mp3 from '@audio/encode-mp3';

const encoder = await mp3({ sampleRate: 44100, channels: 1, bitrate: 128 });
const chunk = encoder.encode(channelData); // → Uint8Array (MP3 frames)
const tail = encoder.flush();              // → Uint8Array (remaining)
// concatenate chunk + tail, then write encoder.head() over the start

Gapless

The output opens with an Info (CBR) or Xing (VBR) frame carrying LAME's tag: the frame and byte counts, a seek TOC, and the encoder delay (576 samples) and padding that decoders trim (ffmpeg, mpg123, Apple's AudioToolbox, LAME's own), so a decoded file has the source's exact length and timing. The totals are known at the end: head() after flush() returns the finished frame (after the ID3 tag when one leads) to write over the start; the whole-file encode.mp3(...) of @audio/encode does it for you. Unpatched (a pipe), the placeholder still carries the delay, and with frames (the exact length upfront) the frame count and padding too.

Options

OptionDefaultDescription
sampleRate—Sample rate (required)
channels21 (mono) or 2 (stereo)
bitrate128CBR bitrate in kbps
quality—VBR quality 0–9 (0=best). If set, overrides bitrate.

Streaming

const encoder = await mp3({ sampleRate: 44100, channels: 1, bitrate: 192 });
const a = encoder.encode(chunk1); // → Uint8Array
const b = encoder.encode(chunk2); // → Uint8Array
const c = encoder.flush();        // → Uint8Array
// complete MP3 = concat(a, b, c), encoder.head() written over its start
encoder.free();

Streaming output

chapters: [{ time, title }] (seconds) become ID3v2 CTOC/CHAP frames (ID3v2 Chapter Frame Addendum), in writeMeta too. stream: true puts the tag (meta, chapters) ahead of the first frames; the last chapter's end is unknown until head() returns the finished tag after flush(), unless frames gives the exact length upfront.

License

MIT

ॐ

版本与发布记录

@audio/encode-mp3 共发布 12 个版本,首次发布于 2026/04/04;过去 12 个月发布了 12 个版本。

版本发布日期距今
2.0.1latest2026/10/061 个月前
2.0.02026/09/291 个月前
1.4.02026/09/261 个月前
1.3.02026/09/261 个月前
1.2.22026/07/113 个月前
1.2.12026/07/113 个月前

关于 @audio/encode-mp3 的常见问题

@audio/encode-mp3 是什么?

Encode PCM audio samples to MP3 format via WASM

如何安装 @audio/encode-mp3?

在项目目录运行 npm install @audio/encode-mp3,或使用 pnpm add / yarn add / bun add。

@audio/encode-mp3 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@audio/encode-mp3 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@audio/encode-mp3 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@audio/encode-mp3 可以商用吗?

@audio/encode-mp3 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@audio/encode-mp3 的下载量有多少?

根据 npm 官方下载统计,@audio/encode-mp3 在 2026/10/07 – 2026/11/05 这 30 天内被下载 9,208 次,日均约 307 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@audio/encode-mp3 还在维护吗?

最新版本 2.0.1 发布于 2026/10/06(1 个月前);至今共发布 12 个版本,其中过去 12 个月发布了 12 个;首次发布于 2026/04/04。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。