Node-AirTunes 技术文档

1. 安装指南

首先，确保你已经安装了Node.js环境。接下来，通过以下命令安装node-airtunes：

npm install airtunes

2. 项目的使用说明

node-airtunes是一个基于Node.js实现的AirTunes v2协议。它支持将音频同步输出到任意数量的AirTunes接收器（如Apple的AirPort Express或AirFoil Speakers）。

构建项目

使用以下命令构建项目：

node-gyp configure build

播放音频

airtunes是一个可写流，接受16位，小端序，立体声PCM数据。

var airtunes = require('airtunes');
myPCMStream.pipe(airtunes);

内部有一个循环缓冲区，允许从网络源进行流式传输。流将以正确的速度输出音频，并根据需要暂停/恢复。airtunes会发出'buffer'事件，帮助你监控缓冲区：

• 'buffering'：在缓冲区填充数据时播放静音。
• 'playing'：实际声音正在被发送到设备。
• 'end'：输入流关闭了缓冲区。尝试写入更多数据将引发异常。

在end事件后，应该在2秒后使用airtunes.stopAll()关闭所有设备（AirTunes设备通常有2秒的延迟）。如果你想要将多个连续的流传输到airtunes，只需向stream.pipe传递{end: false}。

AirTunes 设备

你可以在任何时间添加设备：所有设备之间的声音将被同步。第二个参数是可选的：

var device = airtunes.add(host, {
  port: 5000,
  volume: 100,
  password: 'mypassword'
});

• host和port是Zeroconf报告的AirTunes设备的位置。默认端口是5000。
• volume是初始音量，必须在0到100之间。默认音量是50。
• AirTunes允许使用password保护设备，这是可选的。Bonjour会指示设备是否需要密码。

AirTunes设备会发出'status'事件：

• 'ready'：设备已连接并准备好播放。
• 'stopped'：设备已停止并被从池中移除。

它们还会发出'error'事件。错误发生后，设备将不再发出任何事件。

• 'timeout'：设备在'config.rtsp_timeout'内未回复。
• 'connection_refused'：设备拒绝给定端口的连接。
• 'busy'：另一个应用程序已经在向此设备传输。
• 'disconnected'：设备关闭了连接。这通常发生在用户请求时。
• 'need_password'：设备需要密码，但没有提供。
• 'bad_password'：设备拒绝了给定的密码。
• 'udp_ports'：无法绑定UDP端口（这些是AirPort v2所需的）。
• 'rtsp_socket'：其他未处理的RTSP错误。

你可以使用以下命令停止设备：

device.stop(function() {
  // 设备已停止
});

也可以停止所有设备：

airtunes.stopAll(function() {
  // 所有设备已停止
});

音量

音量必须在0到100之间。

device.setVolume(volume);

3. 项目API使用文档

以下是一些基本的API使用示例：

• 添加设备：

var device = airtunes.add(host, [options]);

• 停止设备：

device.stop([callback]);

• 停止所有设备：

airtunes.stopAll([callback]);

• 设置音量：

device.setVolume(volume);

更多API详细信息，请参考项目官方文档。

4. 项目安装方式

项目安装方式已在“安装指南”部分说明，简要概括如下：

确保安装了Node.js环境，然后通过以下命令安装node-airtunes：

npm install airtunes