openui5-speech-recogniser

This repository contains the source code developed using UI5 tooling for the api which can be encorportaed to UI5 application to enable voice recognition.

Requirements

• NodeJS, version 8.0 or higher

• UI5 Command Line Interface

⚡️ Installation

Run below code in the root folder of your ui5 project (where package.json resides)

$ npm install openui5-speech-recogniser

In the package.json, at the end add below code.

"ui5": {
    "dependencies": [
	    "openui5-speech-recogniser"
	    ]
}

Run

$ ui5 serve

What is openui5-speech-recogniser?

openui5-speech-recogniser is a library which can be included into a project to enable voice recognition ability in the application. This API uses the Google Chrome’s voice recognition engine named ‘webkitSpeechRecognition’. This file can be placed anywhere in the webapp folder of the application. (recommended to be placed in util folder).

Usage

⚡️ Initialization

In the component.js of the application import the speech recognizer API like below

sap.ui.define("in/sijas/ui5/lib/speech-recognizer/SpeechRecognizer",function(SpeechRecognizer){

});

on the init method initialize the SpeechRecognizer using below code.

this.oSpeechRecognizer = new SpeechRecognizer(this,<true/false>);

In the above code, the first parameter to the API is the instance of the component and second is a boolean flag which enables application to listen to command “HELLO ASSISTANT” to start listening to user commands.

In any controller where user want to use the functionality of the Speech Recognizer, you need an instance of the previously created SpeechRecognizer. Use below code to get access to it.

var oComponent = this.getOwnerComponent();
this.oSpeechRecognizer = oComponent.oSpeechRecognizer;

Register the Mic Button

User can add a mic button in the UI, which while pressed will listen to commands. Use below code to register the mic.

this.oSpeechRecognizer.registerCallButton(this.byId("mic"));

Register Commands

Command Without parameter

It is possible to register a command which performs an action without taking any inputs from user. This can be performed by code below.

this.oSpeechRecognizer.registerCommandWithOutParam("<Command>", function(){

//callback function

}.bind(this));

The API will recognize the command and invokes call back function.

Command with Parameter

It is possible to register command which takes input from the user as voice and performs the action. This can be done using the code below.

this.oSpeechRecognizer.registerCommandWithParam("<command>", function(text) {

//callback function

}.bind(this));

In the above code, the texts spoken after the command is taken as parameter for the call back function.

Demo

Click here to see demo

References

• Webkit Speech Recognition API