0.0.2 • Published 2 years ago

hci-asr v0.0.2

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
2 years ago

hci-asr

capacitor plugin for hci-asr

Install

npm install hci-asr
npx cap sync

API

checkPermissions()

checkPermissions() => Promise<PermissionStatus>

Returns: Promise<PermissionStatus>


requestPermissions()

requestPermissions() => Promise<PermissionStatus>

Returns: Promise<PermissionStatus>


sdkInit(...)

sdkInit(options: InitOptions) => Promise<PromiseResult>
ParamType
optionsInitOptions

Returns: Promise<PromiseResult>

Since: 0.0.1


createRecorder(...)

createRecorder(second: number) => Promise<PromiseResult>
ParamType
secondnumber

Returns: Promise<PromiseResult>


startRecord()

startRecord() => Promise<{ success: boolean; }>

Returns: Promise<{ success: boolean; }>


stopRecord(...)

stopRecord(cancel: boolean) => Promise<PromiseResult>
ParamType
cancelboolean

Returns: Promise<PromiseResult>


startRecognize(...)

startRecognize(language: RecognizeLanguage) => Promise<PromiseResult>
ParamType
languageRecognizeLanguage

Returns: Promise<PromiseResult>


cancelRecognize()

cancelRecognize() => Promise<PromiseResult>

Returns: Promise<PromiseResult>


Interfaces

PermissionStatus

PropType
access_network_statePermissionState
internetPermissionState
microphonePermissionState
storagePermissionState

PromiseResult

PropType
successboolean
messagestring
resultany

InitOptions

PropType
appKeystring
secretstring
sysUrlstring
capUrlstring

Type Aliases

PermissionState

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'

Enums

RecognizeLanguage

MembersValue
chinese'cn_16k_common'
shanghai'x-shanghai_16k_common'