capacitor-microphone

plugin to use the microphone

Install

``bash
npm install capacitor-microphone
npx cap sync
`

API

* checkPermission()
* requestPermission()
* checkRequestPermission()
* startListening(...)
* stopListening()
* addListener('partialResult', ...)
* removeAllListeners()
* restartListening(...)
* Interfaces

$3

`typescript
checkPermission() => Promise
`

Returns: Promise<MicrophonePermissions>

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

$3

`typescript
requestPermission() => Promise
`

Returns: Promise<MicrophonePermissions>

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

$3

`typescript
checkRequestPermission() => Promise
`

Returns: Promise<MicrophonePermissions>

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

$3

`typescript
startListening(options?: StartListeningOptions | undefined) => Promise
`

| Param | Type |
| ------------- | ----------------------------------------------------------------------- |
| options | StartListeningOptions |

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

$3

`typescript
stopListening() => Promise
`

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

$3

`typescript
addListener(eventName: 'partialResult', listenerFunc: (data: SpeechResult) => void) => Promise
`

| Param | Type |
| ------------------ | ------------------------------------------------------------------------ |
| eventName | 'partialResult' |
| listenerFunc | (data: SpeechResult) => void |

Returns: Promise<PluginListenerHandle>

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

$3

`typescript
removeAllListeners() => Promise
`

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

$3

`typescript
restartListening(options?: StartListeningOptions | undefined) => Promise
`

| Param | Type |
| ------------- | ----------------------------------------------------------------------- |
| options | StartListeningOptions |

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

$3


#### MicrophonePermissions

| Prop | Type |
| ------------------ | -------------------- |
| details | string |
| granted | boolean |
| status | string |
| errorMessage | string |


#### StartListeningOptions

| Prop | Type |
| ---------- | ------------------- |
| lang | string |


#### PluginListenerHandle

| Prop | Type |
| ------------ | ----------------------------------------- |
| remove | () => Promise<void> |


#### SpeechResult

| Prop | Type |
| ------------- | -------------------- |
| text | string |
| isFinal` | boolean |