annyang

环境要求

• 已安装 Node.js 与 npm（用于 npm install annyang）
• 使用支持 Web Speech API 的浏览器，如 Chrome、Edge
• 网页需通过浏览器访问，能在页面中执行 JavaScript

安装与启动步骤

1. 1安装 annyang

   在项目根目录执行 npm 安装命令，把 annyang 加入项目依赖。

   npm install annyang

   复制

2. 2ESM 方式引入

   推荐用 ESM 在脚本顶部引入默认导出的 annyang 对象。

   import annyang from 'annyang';

   复制

3. 3或按需命名引入

   也可只引入需要的函数：addCommands、start、isSpeechRecognitionSupported。

   import { addCommands, start, isSpeechRecognitionSupported } from 'annyang';

   复制

4. 4CommonJS 引入

   若项目使用 CommonJS，用 require 方式引入 annyang。

   const annyang = require('annyang');

   复制

5. 5判断浏览器支持

   调用 isSpeechRecognitionSupported()，仅在返回真时初始化，避免不支持时报错。

   if (annyang.isSpeechRecognitionSupported()) {
     // 在这里添加命令并启动
   }

   复制

6. 6定义语音命令

   用对象定义命令与回调，'search for *term' 中的 *term 会作为参数传给回调。

   const commands = {
     'hello': () => { alert('Hello world!'); },
     'search for *term': (term) => { console.log(`Searching for ${term}`); },
   };
   annyang.addCommands(commands);

   复制

7. 7启动语音监听

   调用 start() 开始监听麦克风，页面此时会请求麦克风权限。

   annyang.start();

   复制

如何确认成功

对麦克风说“hello”，页面弹出 Hello world! 提示，说明命令已识别并执行。

常见问题

注意事项

• annyang 无依赖、体积约 2KB，MIT 许可，可自由使用和修改。
• 命令通过 addCommands 批量注册，注册后再调用 start() 才会开始监听。
• 官网提供可直接体验的在线语音识别 Demo，便于先验证效果。