cordova-plugin-speech-recognition-feat-siri

This plugin provides access to Speech Recognition API(Apple SFSpeechRecognizer).

Build&Runtime Requirements

It is not available until after the deviceready event.

Installation

cordova plugin add cordova-plugin-speech-recognition-feat-siri

Usage

Methods

• SpeechRecognitionFeatSiri.recordButtonTapped

SpeechRecognitionFeatSiri.recordButtonTapped

The tap of the toggle button on the UI indicates the start and stop of the speech recognition.

SpeechRecognitionFeatSiri.recordButtonTapped([LimitationSeconds], [locale], onSuccess, onError)

• LimitationSeconds: Limitation seconds of Speech Recognition. (String)

• locale: The locale specified when executing speech recognition. (String)

  The locale that can be specified with this plugin (Only locale supported by Siri API (SFSpeechRecognizer) can be specified(as of April 2017).) "": defaults to the system locale set on the device.

• onSuccess: Call back when the API call to the voice recognition was successful. (Function)

• onError: Call back when the API call of speech recognition has failed. (Function)

Return Value

on Success(returnMessage) :

There are three ways to obtain the result of speech recognition.

1. Your application calls the plug-in method twice at the timing of start and end of speech recognition.

   1. The voice input between the first and the second call will be converted as into character type and will be returned to the caller.

   2. Therefore, at the time of the first method call, it is just waiting for voice input.
      Because the plug-in does not control the user interface, please implement the user interface of speech recognition state in the app side.

   3. At method call the second time, it returns of analyzing the result of speech recognition as a character type.

2. After the sound input by the microphone, when a certain period of time elapses with no voice, the speech recognition is automatically ended and the text is returned to the caller.

3. When the upper limit of the speech recognition time(LimitationSeconds) specified by the method is exceeded, the speech recognition is automatically ended and the text is returned to the caller

on Error(errorMessage) :

These error string is returned from the plug-in.

return value(type: string)	description
"commandArg(recognitionLimitSec)IsNotString"	Invalid argument. specify the character type in the argument "limitationSeconds".
"recognitionLimitSecTypeInvalid"	Invalid argument. specify the character type that can be interpreted as a numerical value to the argument "limitationSeconds".
"commandArg(locale)IsNotString"	Invalid argument. specify the character type in the argument "locale".
"commandArg(localeIdentifier)Invalid"	Invalid argument. The locale is not supported by the Siri API (SFSpeechRecognizer).
"timeOut"	Interrupted the speech recognition. Because it exceeds the upper limit(argument "limitationSeconds") of the specified time.
"pluginIsDisabled"	Plug-ins can not be used for any reason.

Example1

function doSpeechRecognition() {
    if(SpeechRecognitionFeatSiri) {
       SpeechRecognitionFeatSiri.recordButtonTapped(
           '15',  // ex. 15 seconds limitation for Speech
           'ja-JP', // ex. locale: japanese, Japan
           function(returnMessage){
               console.log(returnMessage); // onSuccess
           },
           function(errorMessage) {
               console.log(errorMessage); // onError
           }
       )
    }
};

Example2(use system locale.)

function doSpeechRecognition() {
    if(SpeechRecognitionFeatSiri) {
       SpeechRecognitionFeatSiri.recordButtonTapped(
           '15',  // ex. 15 seconds limitation for Speech
           '', // defaults to the system locale set on the device.
           function(returnMessage){
               console.log(returnMessage); // onSuccess
           },
           function(errorMessage) {
               console.log(errorMessage); // onError
           }
       )
    }
};

Supported Platforms

• iOS(version 10.0 or Higher)

About this plugin's user interface

This plugin does not provide a graphical user interface.
We are not planning to provide it in the future.
Because it is a plug-in of Apache Cordoba which is a hybrid application.
We believe that our plugin should not restrict the design of your application.
Please implement sophisticated GUI designed for application.

Development and verification environment

1. Xcode : 10.2.1(10E1001, swift compiler uses the latest version included in Xcode)

2. swift : 5.0

3. Node.js : v10.15.0

4. npm : 6.5.0

5. Apache Cordova : 9.0.0(cordova-lib@9.0.1)

6. cordova ios : 5.0.1

7. Devices used for verification : iPhone7 Plus, iPadPro 11inch

LICENSE

Copyright (c) 2016 Masakatsu Aoyama.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---

Includes Sample Code "SpeakToMe" License

Sample code project: SpeakToMe: Using Speech Recognition with AVAudioEngine Version: 1.0

Guides and Sample Code

IMPORTANT: This Apple software is supplied to you by Apple Inc. ("Apple") in consideration of your agreement to the following terms, and your use, installation, modification or redistribution of this Apple software constitutes acceptance of these terms. If you do not agree with these terms, please do not use, install, modify or redistribute this Apple software.

In consideration of your agreement to abide by the following terms, and subject to these terms, Apple grants you a personal, non-exclusive license, under Apple's copyrights in this original Apple software (the "Apple Software"), to use, reproduce, modify and redistribute the Apple Software, with or without modifications, in source and/or binary forms; provided that if you redistribute the Apple Software in its entirety and without modifications, you must retain this notice and the following text and disclaimers in all such redistributions of the Apple Software. Neither the name, trademarks, service marks or logos of Apple Inc. may be used to endorse or promote products derived from the Apple Software without specific prior written permission from Apple. Except as expressly stated in this notice, no other rights or licenses, express or implied, are granted by Apple herein, including but not limited to any patent rights that may be infringed by your derivative works or by other works in which the Apple Software may be incorporated.

The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.

IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Copyright (C) 2016 Apple Inc. All Rights Reserved.