KeenASR Unity is a beta release Unity plugin that encapsulates speech recognition functionality and provides simple-to-use C# interface via KeenASR class. Unity plugin currently supports only the iOS platform (we are planning to provide Android support in the plugin in early 2018).

Installing KeenASR Unity Plugin (tested in Unity 5.5.1)

  1. Download the latest archive file for the plugin.

  2. Unpack the archive in your Unity project root directory. You should end up with Assets/Plugins/KeenASR directory in your project.

  3. Make sure Unity is setup to build for iOS (editor version of the plugin provides only stubs)

  4. As of plugin version 0.3 all settings in XCode that are related to KeenASR SDK are performed automatically via Assets/Plugins/KeenASR/Editor/PostBuildProcess.cs script. Please review and edit settings for microphone usage description in this file. Current version of the plugin also contains librispeech-nnet2-en-us ASR Bundle, which will be automatically added to the XCode project via PostBuildProcess.cs script; if you decide not to keep the bundle directory in the Assets/Plugins/KeenASR folder, please make sure correct path to the directory is specified in PostBuildProcess.cs file.

  5. If you are using a custom ASR Bundle provided by Keen Research you can just modify the path in PostBuildProcess.cs to point to the corresponding directory

  6. If upgrading from previous plugin versions, we recommend you completely remove the old plugin (Assets/Plugins/KeenASR and Assets/Plugins/iOS directories) and then install the new version of the plugin. You will also need to make sure that SetLogLevel is called as class method; we recommend you set the log level before initializing the SDK.

Adding Speech Recognition Functionality to Your App **

Review Assets/Plugins/KeenASR/KeenASR.cs file, which provides high-level interface to the SDK. We highly recommend you review the documentation for the iOS framework to get familiar with the high-level concepts. Unity plugin provides access to most of the functionality available in the iOS framework.

See sample code for using the plugin from within Unity.