@morphood/capacitor-plugin-azure-keyword

capacitor-plugin-azure-keyword

This project hosts the samples for the Microsoft Cognitive Services Speech SDK.

Install

npm install @morphood/capacitor-plugin-azure-keyword
npx cap sync

API

• initialize(...)
• recognizeKeywordFromMic()
• stopRecognizeKeyword()
• recognizeSpeech()
• stopRecognizeSpeech()
• recognizeIntent(...)
• stopIntentRecognize()
• synthesisToSpeaker(...)
• addListener('keywordResult', ...)
• addListener('speechResult', ...)
• addListener('speechIntentResult', ...)
• Interfaces

initialize(...)

initialize(options?: InitOptions | undefined) => Promise<void>

Param	Type
options	InitOptions

---

recognizeKeywordFromMic()

recognizeKeywordFromMic() => Promise<RecognizeResult>

Returns: Promise<RecognizeResult>

---

stopRecognizeKeyword()

stopRecognizeKeyword() => Promise<RecognizeResult>

Returns: Promise<RecognizeResult>

---

recognizeSpeech()

recognizeSpeech() => Promise<RecognizeResult>

Returns: Promise<RecognizeResult>

---

stopRecognizeSpeech()

stopRecognizeSpeech() => Promise<RecognizeResult>

Returns: Promise<RecognizeResult>

---

recognizeIntent(...)

recognizeIntent(options: RecoIntentOption) => Promise<RecognizeResult>

Param	Type
options	RecoIntentOption

Returns: Promise<RecognizeResult>

---

stopIntentRecognize()

stopIntentRecognize() => Promise<RecognizeResult>

Returns: Promise<RecognizeResult>

---

synthesisToSpeaker(...)

synthesisToSpeaker(options: { text: string; }) => Promise<SynthesizingResult>

Param	Type
options	{ text: string; }

Returns: Promise<SynthesizingResult>

---

addListener('keywordResult', ...)

addListener(eventName: 'keywordResult', listenerFunc: (data: KeywordResult) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Provides keyword result.

Param	Type
eventName	'keywordResult'
listenerFunc	(data: KeywordResult) => void

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 0.0.1

---

addListener('speechResult', ...)

addListener(eventName: 'speechResult', listenerFunc: (data: SpeechResult) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Provides Speechl result.

Param	Type
eventName	'speechResult'
listenerFunc	(data: SpeechResult) => void

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 0.0.1

---

addListener('speechIntentResult', ...)

addListener(eventName: 'speechIntentResult', listenerFunc: (data: SpeechIntentResult) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Provides Speechl result.

Param	Type
eventName	'speechIntentResult'
listenerFunc	(data: SpeechIntentResult) => void

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 0.0.1

---

Interfaces

InitOptions

Prop	Type
speechKey	string
speechRegion	string

RecognizeResult

Prop	Type
isRecognizing	boolean
recognizeString	string

RecoIntentOption

Prop	Type
appId	string

SynthesizingResult

Prop	Type
synthesizing	boolean

PluginListenerHandle

Prop	Type
remove	() => Promise<void>

KeywordResult

Prop	Type
reason	number
keyword	string

SpeechResult

Prop	Type
isFinal	boolean
text	string

SpeechIntentResult

Prop	Type
isFinal	boolean
text	string
intent	string
entities	SpeechEntity[]

SpeechEntity

Prop	Type
entity	string
type	string
startIndex	number
endIndex	number
score	number

Android Build Command

Add the following to android/build.gradle

// Top-level build file where you can add configuration options common to all sub-projects/modules.

buildscript {

  repositories {
      google()
      jcenter()
      mavenCentral()
  }
  dependencies {
      classpath 'com.android.tools.build:gradle:7.2.1'
      classpath 'com.google.gms:google-services:4.3.10'

      // NOTE: Do not place your application dependencies here; they belong
      // in the individual module build.gradle files
  }
}

apply from: "variables.gradle"

allprojects {
  repositories {
      google()
      jcenter()
      mavenCentral()

      maven {
        url 'https://csspeechstorage.blob.core.windows.net/maven/'
      }
  }
}

task clean(type: Delete) {
  delete rootProject.buildDir
}

ext {
rgcfaIncludeGoogle = true
}