# capacitor-plugin-tts

**Repository Path**: mengqingnan/capacitor-plugin-tts

## Basic Information

- **Project Name**: capacitor-plugin-tts
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-09-17
- **Last Updated**: 2022-03-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# @mqn/capacitor-plugin-tts

Capacitor的Android平台TTS插件

## Install

```bash
npm install @mqn/capacitor-plugin-tts
npx cap sync
```

## API

<docgen-index>

* [`init(...)`](#init)
* [`speak(...)`](#speak)
* [Interfaces](#interfaces)

</docgen-index>

<docgen-api>
<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->

### init(...)

```typescript
init(options: InitOptions) => Promise<void>
```

初始化

| Param         | Type                                                |
| ------------- | --------------------------------------------------- |
| **`options`** | <code><a href="#initoptions">InitOptions</a></code> |

--------------------


### speak(...)

```typescript
speak(options: SpeakOptions) => Promise<void>
```

合成语音

| Param         | Type                                                  |
| ------------- | ----------------------------------------------------- |
| **`options`** | <code><a href="#speakoptions">SpeakOptions</a></code> |

--------------------


### Interfaces


#### InitOptions

初始化选项

| Prop         | Type                | Description |
| ------------ | ------------------- | ----------- |
| **`Engine`** | <code>string</code> | 语音引擎包名      |


#### SpeakOptions

语音合成选项

| Prop            | Type                          | Description |
| --------------- | ----------------------------- | ----------- |
| **`Text`**      | <code>string</code>           | 语音文本        |
| **`Pitch`**     | <code>number</code>           | 音调          |
| **`Rate`**      | <code>number</code>           | 语音速率        |
| **`QueueMode`** | <code>'ADD' \| 'FLUSH'</code> | 队列模式        |

</docgen-api>