@audiowave/core

中文文档
0.3.1发布于 2025/10/31MITTypeScriptESM + CJS零依赖近 30 天下载 78.4万

音频Wave的核心音频处理设施和接口

中文使用文档
文档目录14 节
  1. 特征
  2. 安装
  3. 使用量
  4. 多格式支持的音频处理
  5. 无国籍音频处理
  6. 直接缓冲转换
  7. 自定义音频数据提供者
  8. 工具函数
  9. API 参考
  10. 类型
  11. 类
  12. 职能
  13. 常数
  14. 许可证

@ audiowave/ 核心

音频Wave的核心音频处理设施和类型.

特征

  • 单步处理: 可视化数据转换的直接缓冲
  • 多格式支持: 8, 16, 24, 32位有多频道支持的音频
  • 类型安全: 综合类型脚本类型定义
  • 平台不可知论: 使用任何音频数据源(Electron、Node.js、Web)的工作
  • 无依赖: 重量轻而无外部依赖性
  • 业绩优化: 处理步骤比传统办法少67%

安装

npm install @audiowave/core

使用量

多格式支持的音频处理

import { AudioProcessor } from '@audiowave/core';

// Create configuration with audio format specification
const processor = new AudioProcessor({
  bufferSize: 1024,
  skipInitialFrames: 2,        // Skip first 2 frames to avoid initialization noise
  inputBitsPerSample: 16,      // 8, 16, 24, or 32-bit audio
  inputChannels: 2,            // Stereo input (will be mixed to mono for visualization)
});

// Process Buffer data (from Electron, Node.js audio capture)
const audioPacket = processor.process(audioBuffer);
if (audioPacket) {
  // timeDomainData is ready for visualization (Uint8Array)
  console.log('Processed audio data:', audioPacket.timeDomainData);
}

// Process Float32Array data (from Web Audio API)
const webAudioPacket = processor.process(float32AudioData);

// Reset when starting new stream
processor.reset();

无国籍音频处理

import { process } from '@audiowave/core';

// For simple processing without skip frames
const config = {
  bufferSize: 1024,
  inputBitsPerSample: 32,  // Specify input format
  inputChannels: 1,        // Mono input
};

const audioPacket = process(rawAudioData, config);

直接缓冲转换

import { convertBufferToWaveData } from '@audiowave/core';

// Convert audio buffer directly to visualization data
const waveData = convertBufferToWaveData(
  audioBuffer,    // Buffer from audio source
  16,            // 16-bit audio
  2,             // Stereo
  1024           // Target visualization size
);

// waveData is Uint8Array ready for visualization
console.log('Wave data:', waveData); // [128, 145, 112, ...]

自定义音频数据提供者

import type { AudioDataProvider } from '@audiowave/core';

const myProvider: AudioDataProvider = {
  setupStream: async (config) => {
    // Your setup logic
  },
  onData: (callback) => {
    // Your data subscription logic
    return () => { /* cleanup */ };
  },
  onError: (callback) => {
    // Optional error handling
    return () => { /* cleanup */ };
  }
};

工具函数

import { 
  isPowerOfTwo, 
  getNearestPowerOfTwo, 
  isValidAudioBuffer,
  validateAudioConfig 
} from '@audiowave/core';

// Check if buffer size is optimal for FFT
console.log(isPowerOfTwo(1024)); // true

// Get nearest power of 2
console.log(getNearestPowerOfTwo(1000)); // 1024

// Validate buffer format
console.log(isValidAudioBuffer(buffer)); // true/false

// Validate configuration
console.log(validateAudioConfig(config)); // true/false

API 参考

类型

  • AudioConfig - 音频处理配置
  • AudioDataProvider - 音频数据源接口
  • AudioDataPacket - 处理的音频数据
  • AudioDataInput - 原始音频数据输入类型
  • AudioDeviceInfo - 音频设备信息

类

  • AudioProcessor - 带有跳过帧支持的状态音频处理器
    • process(rawData) - 用跳过框处理音频
    • reset() - 重置帧计数器
    • updateConfig(config) - 更新配置

职能

  • process() - 无国籍音频处理
  • convertBufferToWaveData() - 直接缓冲可视化数据转换
  • validateAudioConfig() - 配置验证

常数

  • DEFAULT_AUDIO_CONFIG - 默认配置值
  • COMMON_BUFFER_SIZES - 常见的缓冲大小阵列
  • AUDIO_CONSTANTS - 音频处理常数

许可证

麻省理工学院

版本与发布记录

@audiowave/core 共发布 3 个版本,首次发布于 2025/08/01;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.3.1latest2025/10/311 年前
0.3.02025/08/021.3 年前
0.2.02025/08/011.3 年前

关于 @audiowave/core 的常见问题

@audiowave/core 是什么?

音频Wave的核心音频处理设施和接口

如何安装 @audiowave/core?

在项目目录运行 npm install @audiowave/core,或使用 pnpm add / yarn add / bun add。

@audiowave/core 支持 TypeScript 吗?

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

@audiowave/core 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@audiowave/core 可以商用吗?

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

@audiowave/core 的下载量有多少?

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

@audiowave/core 还在维护吗?

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