SpeechInjector by Richard Simpson

contact : [email protected]

The easiest way to apply voice-commands in your IOS app.

Simple add words you want your program to react to and after that program or call functions you want to react on that specific word or set of words. You can make as much different sets as you want. I no time you have your app fully navigational with voice-commands!

Installation

pod 'SpeechInjector','~> 1.1.0'

Demo Application

Demo application can be downloaded here : https://github.com/revsimpson/SpeechInjector-Demo

How to use?

Here is some example code how to use it :

import UIKit

class ViewController: UIViewController {

var injector : SpeechInjector!  // Allways initiate here not in viedDidLoad or anywhere else!!!

override func viewDidLoad() {
    super.viewDidLoad()
    
    // Setting up connectors...which are a set of words (add as much as you like) which when are being said
    // will perform the action you specify in the closure. PS Also keep in mind people do not say the words
    // as they should so you should take grammer errors into account. During debugging you will see what word
    // is captured when you say something.
    
    let connector1 = SpeechConnector(words: "hello","hi","good morning","hellu") {
        // do some kind of action
        print("connector1 action done") 
    }
    
    let connector2 = SpeechConnector(words: "next","forward") {
        // do some kind of action for instance transtion to another screen
        // or do something in the UI. Always refer to self within the closure
        // but code complition will let you know ;-)
        
        print("connector2 action done") 
    }
    
    let connector3 .... etc etc etc

   // When you made all your voice-commands add them to the SpeechInjector
   // You always send 'self' along with the init of the injector
   
   injector = SpeechInjector(connectors: [connector1,connector2, etc etc], vc: self)
   
   // Now place the button in you viewcontroller
   injector.placeSpeechButton()
}

}

If the button is not place correctly in your app set the injector.placeSpeechButton() in viewDidAppear

Plist

Add the following privacy settings to your plist and tell the user why you need to use their microphone and speech recognition.

Privacy - Microphone Usage Description

Privacy - Speech Recognition Usage Description

Different init options for the SpeechInjector

You can set different options when you initiate a SpeechInjector

Basic :

SpeechInjector(connectors: [SpeechConnector], vc: UIViewController) <- Connectors and a vc is a must!

With options :

Valid

SpeechInjector(connectors: [connector1], vc: self, language: "nl-NL")

Valid

SpeechInjector(connectors: [connector1,connector2,connector3], vc: self, language: "en-US")

Valid

SpeechInjector(connectors: [connector1,connector2], vc: self)

Invalid

If you do not want to use a property do not set it to 'nil'. So you either use it or delete it from the init.

So this is wrong :

SpeechInjector(connectors: [connector1, connector2], vc: self, language: nil) <- WRONG !!

or

SpeechInjector(connectors: [connector1, connector2], vc: self, language: "") <- WRONG !!

If you do not use a property then just leave the whole thing out!

FOR LANGUAGECODES CHECK : https://gist.github.com/JamieMason/3748498

Default settings SpeechInjector

When you do not use a property default settings will be used:

language = "nl-NL" (use your own country code to capture words in your own language!)

Placing the speechbutton and its default settings

The basic placement of the button is when you have an instance of the SpeechInjector and you call

injector.placeSpeechButton()

A button is placed with default settings. You can change the image of the button and the button tintcolor and elevation settings etc etc. Just like the SpeechInjector init... just fill what you want to use and leave out which you do not want to use and for the rest of the parameters defaults settings will apply.

This is the default for the placeSpeechButton.

func placeSpeechButton(position : SpeechButtonLocation = .rightBottom, buttonColor: UIColor = UIColor(red:0.30, green:0.50, blue:0.70, alpha:1.0) , buttonRecordingColor :UIColor = UIColor(red:0.94, green:0.17, blue:0.18, alpha:1.0), buttonHeight:CGFloat = 60 , buttonWidth : CGFloat = 60, xOffset: CGFloat = 16, yOffset : CGFloat = 16, image : UIImage = UIImage(named: "speech")!, tintColor : UIColor = UIColor.white, elevationNormalState: CGFloat = 6.0, elevationHighlightedState : CGFloat = 12.0)

So you can call for example:

The values you did not fill in will get the default values. The standard image for the button is the microphone materialdesign button called speech so make sure you do not have also a picture in your project with the same name. Otherwise you can put any image in there you want. But again....do not fill paramaters with "nil" if you do not want to use them, because it will fail, just leave them out and it will work.

Extra offset after setting the position

When you have set the position in your placeSpeechButton ... you can still change the offset of that position.

Remember where we have set the button :

injector.placeSpeechButton(postion: right.bottom)

You can add offsets to that function like this :

injector.placeSpeechButton(postion: right.bottom, xOffset: 20, yOffset : 35)

Default offset is xOffset = 16 and yOffset =16)