AcquireSpeech

Overview

AcquireSpeech is the integrated speech recognition interface for the Toolkit.  AcquireSpeech provides real time monitoring, transcripts, and recording, as well as allowing for direct text input and playback of recorded speech samples. It has been designed with a focus on configurability and usability, allowing for different speech recognition systems and usage scenarios. AcquireSpeech is not a speech recognizer itself, but a tool that connects the sound input on your computer to the included speech recognition server.  By default, the Toolkit uses PocketSphinx, but AcquireSpeech is compatible with a number of ASR systems.

Quick facts:

• Location: /core/acquirespeech 
• Language: Java
• Distribution: Source

• Platform(s): Multi-platform

Users

AcquireSpeech is the key component for interacting with the Toolkit.  AcquireSpeech is designed for use with a microphone, but also supports text input of user speech and the use of prerecorded speech samples.

Launching AcquireSpeech

Acquirespeech launches by default when you press, 'Launch' under the 'Run It All' group in the Virtual Humans Launcher.

To launch AcquireSpeech manually, expand the Launcher options with the 'Advanced' button, then press 'Launch' next to 'Speech Recognition' in the 'Input/Output' tab. This will launch both the PocketSphinx Wrapper and AcquireSpeech.  There is a slight delay to allow PocketSphinx to load before AcquireSpeech connects to it.

Setting up a Microphone

AcquireSpeech is configured to automatically select your default audio input on start, and so will usually not require manual configuration. It can be configured by either a configuration file or the Settings Tab.

Speaking to a Character

The Recorder tab is the primary interface for AcquireSpeech. From here, you can start a session, monitor you microphone level, and trigger recording using the press to talk 'Speak' button.

To start an AcquireSpeech session, hit the green 'Start Session' button in the upper right, or Ctrl+r. Once the session is started, the large 'Speak' button in the top of the tab will brighten and become interactive.  When depressed, the 'Speak' button turns bright green.  

To say something to the Toolkit, simply press the 'Speak' button and hold it down while you speak. You should see the horizontal level meter fill in green as you speak, showing the input levels. If you see a lot of yellow or red, try turning down your microphone volume. When you're finished speaking, release the button. You will see what you've said, or the ASR's best guess, fill in the 'Text:' area below. You can also change the speaker with the drop down box, if necessary. The default is "user" throughout the Toolkit.

To lock the mouse to the 'Speak' button, such as during a presentation, press Ctrl+m.  This will also unlock the cursor when you are finished.  When the mouse is locked, the 'Speak' button darkens, to either dark gray or dark green.

To stop a session, such as when you've finished a Toolkit session, or wish to change Settings, hit the red, 'Stop Session' button.

Configuring AcquireSpeech

• General Settings include the time to record before, and after, the "Speak" button is pressed; default is .25 seconds.  This allows AcquireSpeech to capture the entire spoken utterance bracketed by silence or background noise without requiring any special action from the user.
• VHMSG Settings covers how AcquireSpeech interacts with other components. For most users, the Server and Scope will be filled in automatically with the values "localhost" and "DEFAULT_SCOPE", respectively. It is not recommended you change these values without referring to the expanded documentation.
• Microphone Settings are the bottom block, and cover the sound setup for AcquireSpeech. The Microphone check box at the top should be checked, indicating a microphone should be used. The sound input can be changed with the drop down box, but the default setting should work for most users.  If AcquireSpeech isn't hearing you, try a different input or microphone.  If no options are presented in the drop down, please ensure your microphone is connected and working properly in your OS's configuration tool.
• Show recognition results toggles display of the recognition feedback from Pocket Sphinx, or whichever recognition server is connected, underneath the 'Speak' button in the Recording Tab. 'Default speaker' is used to connect to NPCEditor, and supports multiple speakers. The speaker here should match the 'Agent Name' in the "Smartbody" account in 'People' > 'Accounts' of NPCEditor.
• Record Session and Record Utterances toggle recording of the user's speech. The session recording is of everything said into the microphone from when an AcquireSpeech session is started, while utterances are split recordings from when the 'Speak' button is depressed.

Message API

Receives

Output

AcquireSpeech sends out events transmitting recognition result and notifications about the state of recording

Known Issues

Provide a list of known issues and peculiarities. Allow the reader to give feedback, probably by giving a link to the /wiki/spaces/VHTK/pages/14583665 page.

FAQ

Probably just link to the appropriate section in the Main FAQ.