WebSocket音频API使用指南

一、项目目录结构及介绍

WebSocket音频API是一个用于通过WebSocket传输麦克风声音的库。以下是该项目的基本目录结构及其简介：

ws-audio-api/
├── dist/                     # 编译后的生产环境代码，包括主文件ws-audio-api.min.js
├── example/                  # 示例文件夹，包含如何使用这个库的简单示例
│   ├── index.html            # 示例页面，展示如何在浏览器中集成和操作
├── server/                   # 服务器端脚本，用于启动WebSocket广播服务
│   └── server.js             # 主服务器逻辑
├── src/                      # 源代码文件夹
│   ├── WSAudioAPI.js         # 核心库代码
├── .gitignore                # Git忽略文件列表
├── LICENSE                   # 许可证文件，遵循MIT协议
├── README.md                 # 项目说明文档
├── bower.json                # Bower依赖管理文件（过时，但项目保留）
├── build.sh                  # 构建脚本，用于编译源码
├── package-lock.json         # NPM依赖锁定文件
├── package.json              # 包配置文件，定义了项目元数据和依赖

二、项目启动文件介绍

客户端启动

无需直接启动客户端文件，而是将其作为网页的一部分通过HTML <script> 标签引入。例如，在你的网页中添加以下代码来使用WebSocket音频API：

<script src="path/to/dist/ws-audio-api.min.js"></script>

之后，你可以通过JavaScript实例化WSAudioAPI.Streamer或WSAudioAPI.Player对象，并根据需要进行操作。

服务器端启动

服务器端运行需进入server目录，并执行以下命令安装依赖并启动WebSocket服务器：

cd server
npm install
node server.js

这将启动一个监听特定端口（默认是5000）的WebSocket服务器，等待来自客户端的连接。

三、项目的配置文件介绍

主要涉及的是客户端使用的配置选项，这些通常以参数形式传递给WSAudioAPI.Streamer和WSAudioAPI.Player构造函数。虽然没有单独的配置文件，但在初始化这两个类时可以通过对象字面量指定配置。例如：

var defaultConfig = {
    codec: {         // 编解码设置
        sampleRate: 24000,
        channels: 1,
        app: 2048,     // 不同的应用场景有不同的值
        frameDuration: 20,
        bufferSize: 4096
    },
    server: 'ws://' + window.location.hostname + ':5000'  // WebSocket服务器地址
};

开发者可以根据需要调整这些配置参数，确保编码器和解码器两边设置一致，以及服务器地址正确配置。

请注意，项目维护状态为不再更新，因此在实际应用中可能需要自行解决潜在的兼容性和稳定性问题。建议在实施前充分测试。