Are We Playing Yet? 技术文档

1. 安装指南

在开始使用 Are We Playing Yet?（AWPY）项目之前，您需要安装 Node.js 和 npm。以下是在 macOS 系统上的安装步骤：

brew install node
curl http://npmjs.org/install.sh | sh

完成 Node.js 和 npm 的安装后，请进入项目根目录，运行以下命令来准备项目依赖：

npm install

2. 项目使用说明

运行 AWPY

准备完依赖后，运行以下命令启动 HTTP 服务器：

node server.js

启动服务器后，您应该能在浏览器中访问 http://localhost:3000。

编写测试

在 /public/tests 目录下创建一个新的文件，文件名应该以测试类型为前缀，并使用连字符分隔，例如：type-name.js。

例如，创建一个名为 event-seeking.js 的文件。

每个测试都应包含以下基本的 JSON 结构：

{
  "name": "", // 必填（与文件名相同）
  "description": "", // 必填（用于网站上的标题）
  "spec": "http://…", // 可选
  "longdesc": "lorem ipsum…", // 可选
  "reports": { // 可选
    "chrome": {
      "desc": "lorem ipsum…",
      "link": "http://…"
    }
  },
  "assert": function(finish) { // 必填
    var audio = this.audio;
  }
}

我们鼓励您尽可能地记录测试，包括链接到规范、精确描述测试内容以及包含已知的浏览器错误。

有效的 reports 值包括：

• firefox
• opera
• chrome
• safari
• ie
• firefoxMobile
• operaMobile
• android
• ieMobile
• safariMobile

终止测试

有三种方式可以终止一个测试：

• 通过（passing）
• 失败（failing）
• 超时失败（failing by timeout，加载 loadedmetadata 事件触发后 15 秒）

要使测试通过，需要调用：

finish(true);

要使测试失败，需要调用：

finish(false);

3. 项目 API 使用文档

本项目未提供详细的 API 文档。请参考项目源代码和测试示例来理解 API 的使用方法。

4. 项目安装方式

请参考上述“安装指南”部分进行项目安装。主要是通过 Node.js 和 npm 安装项目依赖，并启动 HTTP 服务器。