Node-icy 技术文档

本文档将为您提供详细的 Node-icy 项目安装指南、使用说明以及项目 API 使用文档。

1. 安装指南

要安装 Node-icy 模块，请使用 npm 命令：

npm install icy

2. 项目的使用说明

Node-icy 是一个 Node.js 模块，用于解析和/或注入 ICY 元数据。该模块提供了以下类：

• Reader 类：用于从 ICY 流（通常是 SHOUTcast 或 Icecast 广播）中检索原始音频数据和解析元数据。
• Writer 类：允许您将自定义元数据注入数据流中，然后可以被其他 ICY 客户端（如 VLC）显示。
• Client 类：基于 Node 的核心 http 模块构建，但这个版本支持返回 ICY HTTP 版本的服务器，并自动发送 "Icy-MetaData: 1" HTTP 头，以通知服务器我们需要元数据。最后，它在 "response" 事件中返回一个 Reader 实例，因此 "res" 对象也会发出 "metadata" 事件。

以下是一个基本示例，演示如何使用 HTTP Client 类连接到远程 ICY 流：

var icy = require('icy');
var lame = require('lame');
var Speaker = require('speaker');

// 已知的 ICY 流 URL
var url = 'http://firewall.pulsradio.com';

// 连接到远程流
icy.get(url, function (res) {
  // 输出 HTTP 响应头
  console.error(res.headers);

  // 输出任何发生的 "metadata" 事件
  res.on('metadata', function (metadata) {
    var parsed = icy.parse(metadata);
    console.error(parsed);
  });

  // 播放音乐（假设是 MP3 数据）
  // lame 解码并使用 Speaker 发送到扬声器
  res.pipe(new lame.Decoder())
     .pipe(new Speaker());
});

您还可以向请求添加自定义头：

var url = require('url');

// 已知的 ICY 流 URL
var opts = url.parse('http://yourstreamurl.tld/');

// 添加自定义头
opts.headers = { 'User-Agent': 'Your awesome useragent' };

// 连接到远程流
icy.get(opts, callback);

3. 项目 API 使用文档

以下是 Node-icy 模块提供的 API：

• Client()
• request()
• get()
• Reader()
• Writer()
  • .queue()
• parse()
• stringify()

Client()

Client 类是 http.ClientRequest 对象的子类。它添加了一个流预处理器来处理 ICY 响应。

request()

request() 方便函数。与 Node 核心的 http.request() 类似，但返回一个 icy.Client 实例。

get()

get() 方便函数。与 Node 核心的 http.get() 类似，但返回一个 icy.Client 实例，并调用 .end() 方法，且不写入请求体（最常见的场景）。

Reader()

ICY 流读取器。这是一个双工流，除了从输出数据中删除元数据本身外，还会发出 "metadata" 事件。

Writer()

Writer 类是一个双工流，接受原始音频/视频数据并原样传递。它还具有一个 queue() 函数，允许在下一个 "metaint" 间隔将元数据注入流中。

Writer#queue(metadata)

将一个元数据片段加入队列，以便在流中发送。metadata 可以是一个字符串，也可以是一个包含至少 "StreamTitle" 键的对象，其值为字符串。序列化的元数据有效载荷必须小于或等于 4080 字节。

parse()

解析包含 ICY 元数据的 Buffer（或字符串）为对象。

stringify()

将对象转换为 ICY 元数据字符串。

4. 项目安装方式

请参考上述安装指南，使用 npm 命令进行安装。

npm install icy