首页
/ say.js 技术文档

say.js 技术文档

2024-12-20 23:17:44作者:曹令琨Iris

本文档将为您提供 say.js 的安装指南、使用说明以及 API 使用文档,帮助您更好地理解和使用这个项目。

1. 安装指南

首先,您需要确保您的开发环境满足以下要求:

  • Mac OS X(自带 say 命令)
  • Linux 系统已安装 Festival
  • Windows 系统已安装 SAPI.SpVoice,并确保 Powershell 可在系统路径中访问

接着,使用以下命令通过 npm 安装 say.js:

npm install say

2. 项目使用说明

以下是如何使用 say.js 的基本示例:

自动选择平台

const say = require('say')

覆盖平台选择

const Say = require('say').Say
const say = new Say('darwin' || 'win32' || 'linux')

使用默认系统声音和速度

say.speak('Hello!')

停止当前正在播放的文本

say.stop()

复杂示例(使用 macOS 语音,速度较慢)

say.speak("What's up, dog?", 'Alex', 0.5)

播放完成后回调

say.speak("What's up, dog?", 'Good News', 1.0, (err) => {
  if (err) {
    return console.error(err)
  }

  console.log('文本已播放完成。')
})

导出音频到 WAV 文件

say.export("I'm sorry, Dave.", 'Cellos', 0.75, 'hal.wav', (err) => {
  if (err) {
    return console.error(err)
  }

  console.log('文本已保存至 hal.wav。')
})

3. 项目 API 使用文档

以下是 say.js 提供的方法:

speak 方法

  • 速度:1 = 100%,0.5 = 50%,2 = 200%,等
say.speak(text, voice || null, speed || null, callback || null)

export 方法

  • 仅限 macOS / Windows 系统
  • 速度:1 = 100%,0.5 = 50%,2 = 200%,等
say.export(text, voice || null, speed || null, filename, callback || null)

stop 方法

say.stop(callback || null)

getInstalledVoices 方法

say.getInstalledVoices(callback)

4. 项目安装方式

请参考上文“安装指南”部分。

以上就是 say.js 的技术文档,希望对您的使用有所帮助。如果您在使用过程中遇到任何问题,欢迎提出 issue 或 pull request。

登录后查看全文
热门项目推荐
相关项目推荐