@mingto/microsoft-tts

微软 Azure 文本转语音（TTS）服务工具库，流式处理，支持多种音色和语言。

特性

• 🎙️ 流式处理：支持流式文本合成与播放
• 🌍 多语言支持：支持多种语言和音色
• 🔧 灵活配置：支持自定义语音参数
• 📱 浏览器端支持：专为浏览器环境优化
• 🔇 静音控制：支持静音/取消静音操作

安装

pnpm add @mingto/microsoft-tts

快速开始

import microsoftTts from '@mingto/microsoft-tts'

// 配置全局参数
microsoftTts.config({
  // Azure语音服务订阅密钥
  subscriptionKey: 'your-subscriptionKey',
  // Azure语音服务区域（如"southeastasia"）
  region: 'your-region',
})

// 创建应用实例
const ttsInstance = microsoftTts.create({
  voice_type: 'zh-CN-XiaoxiaoNeural',
})

// 订阅事件
ttsInstance.on('audioFirstStart', () => {
  console.log('音频首次播放')
})

ttsInstance.on('appError', (error) => {
  console.error('应用错误', error)
})

ttsInstance.on('appFinish', () => {
  console.log('应用已销毁')
})

// 开始转换
ttsInstance.start()

// 发送文本
ttsInstance.send('你好呀。')

// 结束转换（通知发送文本已经结束，但是不会销毁应用，剩余的文本将会继续播放）
ttsInstance.end()

// 销毁应用（停止播放）
// ttsInstance.finish()

// 调整音量
// ttsInstance.mute()     // 静音
// ttsInstance.unmute()   // 恢复音量

API

全局配置

microsoftTts.config(options)

配置全局参数，支持以下参数：

| 参数 | 类型 | 必填 | 说明 | |------|------|------|------| | subscriptionKey | string | 否 | Azure 语音服务订阅密钥 | | region | string | 否 | Azure 语音服务区域（如"southeastasia"） |

创建应用实例

microsoftTts.create(options?)

创建 TTS 应用实例。

| 参数 | 类型 | 必填 | 默认值 | 说明 | |------|------|------|--------|------| | voice_type | string | ❌ | 'zh-CN-XiaoxiaoNeural' | 语音名称/音色 | | region | string | ❌ | 'eastasia' | Azure 语音服务区域 | | volume | number | ❌ | 100 | 音量，范围 0.0-100.0 | | outputFormat | SpeechSynthesisOutputFormat | ❌ | - | 音频输出格式 | | language | string | ❌ | 'zh-CN' | 语言区域 |

实例方法

ttsInstance.start()

激活应用，准备接收文本进行语音播放。

ttsInstance.start()

ttsInstance.send(text)

发送文本进行语音合成。

ttsInstance.send('你好呀。')

ttsInstance.end()

通知应用发送文本已经结束，但是不会销毁应用，剩余的文本将会继续播放。

ttsInstance.end()

ttsInstance.finish()

应用播放结束，应用将会被销毁，剩余的文本将会停止播放。

ttsInstance.finish()

ttsInstance.mute()

静音当前音频输出。

ttsInstance.mute()

ttsInstance.unmute()

取消静音，恢复音频输出。

ttsInstance.unmute()

ttsInstance.on(eventName, callback)

订阅应用事件，获取播放开始、错误、结束等通知。

ttsInstance.on('audioFirstStart', () => {
  console.log('音频首次播放')
})

应用事件

| 事件名 | 触发时机 | 说明 | |--------|----------|------| | audioFirstStart | 音频首次播放时触发 | 首次播放提示 | | appError | 应用发生错误时触发 | 携带错误信息 | | appFinish | 调用 finish() 或流程结束时触发 | 应用结束事件 |

事件示例

ttsInstance.on('audioFirstStart', () => {
  console.log('音频首次播放')
})

ttsInstance.on('appError', (error) => {
  console.error('应用错误', error)
})

ttsInstance.on('appFinish', () => {
  console.log('应用已销毁')
})

流式文本处理示例

import microsoftTts from '@mingto/microsoft-tts'

microsoftTts.config()

const ttsInstance = microsoftTts.create({
  voice_type: 'zh-CN-XiaoxiaoNeural'
})

ttsInstance
  .on('appFinish', () => console.log('appFinish'))
  .on('audioFirstStart', () => console.log('audioFirstStart'))

const arrText = ['你要抱', '抱我吗？', '我好', '喜欢你呀！']
let index = 0
ttsInstance.start()

const timer = setInterval(() => {
  ttsInstance.send(arrText[index])
  index += 1
  if (index === arrText.length) {
    ttsInstance.end()
    clearInterval(timer)
  }
}, 100)

推荐音色

中文常用音色

• zh-CN-XiaoxiaoNeural - 晓晓（女声）
• zh-CN-YunxiNeural - 云希（男声）
• zh-CN-YunyangNeural - 云扬（男声）
• zh-HK-HiuMaanNeural - 香港粤语女声
• zh-TW-HsiaoChenNeural - 台湾女声

许可证

MIT