更新记录

1.0.0（2025-11-19）

• 首发

平台兼容性

uni-app(4.71)

uni-app x(4.71)

UTS环境兼容性

sn-tts

功能描述

系统语音合成，支持android和ios

使用说明

导入模块

import * as TTS from '@/uni_modules/sn-tts';
const tts = TTS.useTTS();

检查TTS可用性

在使用TTS功能前，需要先检查设备是否支持TTS：

if (!tts.checkTTSAvailability()) {
    tts.installTTSData();
    // 提示用户未安装TTS引擎
}

初始化TTS

配置TTS参数：

tts.initTTS({
    language: 'zh-CN',  // 语言
    pitch: 1.0,         // 音调 (0.5-2.0)
    speechRate: 1.0,    // 语速 (0.1-10.0)
    volume: 0.8         // 音量 (0.0-1.0)
});

监听事件

监听TTS事件回调：

tts.onTtsEventListener((e) => {
    console.log('ttsEvent', e);
});

文本转语音

将文本转换为语音播放：

tts.speak('你好，我是中国人');

停止播放

停止当前正在播放的语音：

tts.stop();

示例

<template>
    <view>
        <button type="default" @click="speekTTS">tts合成</button>
        <button type="default" @click="stopTTS">停止</button>
    </view>
</template>

<script>
import * as TTS from '@/uni_modules/sn-tts';
const tts = TTS.useTTS();

export default {
    onLoad() {
        // 监听TTS事件
        tts.onTtsEventListener((e) => {
            console.log('ttsEvent', e);
        });

        // 检查TTS可用性
        if (!tts.checkTTSAvailability()) {
            tts.installTTSData();
            uni.showToast({
                icon: 'none',
                title: '未安装tts引擎'
            });
            return;
        }

        // 初始化TTS配置
        tts.initTTS({
            language: 'zh-CN',
            pitch: 1.0,
            speechRate: 1.0,
            volume: 0.8
        });
    },
    methods: {
        speekTTS() {
            tts.speak('你好，我是中国人');
        },
        stopTTS() {
            tts.stop();
        }
    }
};
</script>

注意事项

1. 在使用TTS功能前必须先调用checkTTSAvailability()检查TTS引擎是否可用
2. 如果TTS引擎不可用，可以通过installTTSData()方法尝试安装
3. initTTS()方法用于配置TTS参数，包括语言、音调、语速和音量
4. speak()方法用于播放文本语音
5. stop()方法用于停止当前播放
6. 通过onTtsEventListener()可以监听TTS相关事件