# capacitor-plugin-nuance-speechkit

nuance-speechkit

## Install

```bash
npm install capacitor-plugin-nuance-speechkit
npx cap sync
```

## API

<docgen-index>

* [`echo(...)`](#echo)
* [`initSpeechKit(...)`](#initspeechkit)
* [`start(...)`](#start)
* [Interfaces](#interfaces)

</docgen-index>

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

### echo(...)

```typescript
echo(options: { value: string; }) => Promise<{ value: string; }>
```

| Param         | Type                            |
| ------------- | ------------------------------- |
| **`options`** | <code>{ value: string; }</code> |

**Returns:** <code>Promise&lt;{ value: string; }&gt;</code>

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


### initSpeechKit(...)

```typescript
initSpeechKit(options: InitSpeechKitOptions) => Promise<void>
```

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

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


### start(...)

```typescript
start(options: InputOptions) => Promise<{ text: string; }>
```

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

**Returns:** <code>Promise&lt;{ text: string; }&gt;</code>

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


### Interfaces


#### InitSpeechKitOptions

| Prop                    | Type                |
| ----------------------- | ------------------- |
| **`applicationName`**   | <code>string</code> |
| **`partnerGuid`**       | <code>string</code> |
| **`organizationToken`** | <code>string</code> |
| **`userName`**          | <code>string</code> |


#### InputOptions

| Prop       | Type                |
| ---------- | ------------------- |
| **`text`** | <code>string</code> |

</docgen-api>