speech-to-text

A capacitor plugin for speech to text that can work in the background

Install

npm i @deldev/speech-to-text
npx cap sync

API

• startListening(...)
• stopListening()
• isAvailable()
• requestPermissions()
• checkPermissions()
• addListener('onResults', ...)
• removeAllListeners()
• addListener('onError', ...)
• addListener('onPermissionsResult', ...)
• removeAllListeners()
• Interfaces

startListening(...)

startListening(options?: { language?: string | undefined; } | undefined) => Promise<void>

| Param | Type | | ------------- | ----------------------------------- | | options | { language?: string; } |

stopListening()

stopListening() => Promise<void>

isAvailable()

isAvailable() => Promise<{ available: boolean; }>

Returns: Promise<{ available: boolean; }>

requestPermissions()

requestPermissions() => Promise<{ recordAudio: boolean; foregroundService: boolean; }>

Returns: Promise<{ recordAudio: boolean; foregroundService: boolean; }>

checkPermissions()

checkPermissions() => Promise<{ recordAudio: boolean; foregroundService: boolean; }>

Returns: Promise<{ recordAudio: boolean; foregroundService: boolean; }>

addListener('onResults', ...)

addListener(eventName: 'onResults', listenerFunc: (result: { transcript: string; }) => void) => Promise<PluginListenerHandle>

| Param | Type | | ------------------ | --------------------------------------------------------- | | eventName | 'onResults' | | listenerFunc | (result: { transcript: string; }) => void |

Returns: Promise<PluginListenerHandle>

removeAllListeners()

removeAllListeners() => Promise<void>

addListener('onError', ...)

addListener(eventName: 'onError', listenerFunc: (error: { message: string; }) => void) => Promise<PluginListenerHandle>

| Param | Type | | ------------------ | ----------------------------------------------------- | | eventName | 'onError' | | listenerFunc | (error: { message: string; }) => void |

Returns: Promise<PluginListenerHandle>

addListener('onPermissionsResult', ...)

addListener(eventName: 'onPermissionsResult', listenerFunc: (result: { recordAudio: boolean; foregroundService: boolean; }) => void) => Promise<PluginListenerHandle>

| Param | Type | | ------------------ | --------------------------------------------------------------------------------------- | | eventName | 'onPermissionsResult' | | listenerFunc | (result: { recordAudio: boolean; foregroundService: boolean; }) => void |

Returns: Promise<PluginListenerHandle>

removeAllListeners()

removeAllListeners() => Promise<void>

Interfaces

PluginListenerHandle

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