ReadMe/Help (sorry for some reason the images are appearing as links, somethign is up with the board editor?
This is the start screen, it's the small white box on the top left hand side. It has 3 buttons, press the SpeakEasy text and the main window opens and voice recognition starts. press the info logo and it opesn the settings screen. Press the X and it closes the application.
The main SpeakEasy screen.
The Buttons on the top:
Phrases - opens the vocabulary editor window, see below.
Settings - opens the configuration/settigns screen see below
Reset - reset the recogniser engine and clears all group locks or disabled groups
Pause - Stops the recogniter engine so that you can keep the window open without executing commands
Mute - Mutes the audio volume on the PC
Close - CLoses the current SepakEasy window
The panels in the screen help you when you talk tp the PC. The text in red on the top left is what it has heard so far, as you talk it will add more to this phrase until a command is recognised or it timeout.
The panel on the left in the middle is the command that it recognises. Each time SpeakEasy recognises a phrase it gives it a accuracy score, something like 75%. You can use the sliding bar below this text to set your default acceptance threshold, phrases that score above this threshold are executed and you'll see them in green text, scores below this level are in red text and are not executed. If you play with the threshold settings you'll find what works best when driving. You can change it for words that are harder to recognise and the set it back. Also if a phrase falls below the threshold and is not executed (in red text) then you can just click the text in red and the command will be executed even if below the threshold. The idea of the threshold is to stop false commands being executed because of background noise like engine revs or MP3 playback.
The panel on the bottom left is a help telling you the current status of commands or if you are talkign to loudly or slowly.
The panel on the reight is a list of commands than can be said for the phrase you spoken so far. It is kind of like an auto-complete to tell you what's available in the phrase vocabulary. It is also a quick way to learn/remember the phrases.
Finally if you set the Activation timeout to anything above 0, then the countdown clock will be shown in the bottom of the screen timing down to zero, once it hits zero the window will automatically close. Useful if you are driving and want to speak a few commands and then deactivate SpeakEasy recogniser. If there is a timer on the main window then you can click the counter at any time to pause the timer so timed automatic close is haulted, you can press it another time to toggle the timeout counter.
The phrase editor allow you to simple add/update/delete phrases from your *.ini vocab files. You can have as many *.ini files as you like as long as they are in one folder. Where that folder is can be set in the Settings screen. When you open the settigns screen the default.ini file is shown. I've created a few commands in it to illustrate what is possible. A voice command is made up of a group and a phrase. You can create new groups by typing text intot he puppdown list on the right hand panel in the group box and complete a new phrase and press the Add Phrase button(or you can select an existing group from the list).
The list on the top left list all the group/phrases in the current file. The "global" group is different to all the others, when you create commands in the global group you only speak the phrase not the group word, for eaxmple "group juke box" means that if the user says "juke box" then the command is executed. If the command is something like "playlist folder down" in the playlist grouping then the user has to say the whole command "playlist folder down" for it to be executed.
A Voice command is made up of 4 things:
Group - the first word to say (excludes global grouping)
Phrase - the remainder of the words to say
Help Text - text that will appear in the status panel in the main window if you click on the Help list panel when speaking words
Macro - A list of commmands to be executed by SpeakEasy
A Macro is one or more commands that look like RR:STOP or MM:ADDRESS. You add a command to a macro by selecting the application you want to talk to (deafult apps include: RR, MM, FP, FD, SE, you can add more apps by adding their details tot he settings window, more later). After selecting somethign like RR from the list, a help list appears ont he bottom left side of the window with a list of possible command (and some helpful description in square brackets). If you select the correct command it is added to the COMMAND text box, you then need to press the "Add Command" button to add it to the current Macro. You can use the "Remove Command" to delete any command from the Macro list.
Once you have entered the items below then press the "Add Phrase" button to add it to the current vocabulary file.
3. Help text (optional)
4. Macro list
You can remove a single phrase from the vocab file by pressing the "Delete Phrase" button, you can also delete a whole grouping of commands by pressing the "Delete Group" button.
Thre are also buttons to open other vocab files or create completely new ones.
The settings window allows you to customise SpeakEasy the way you want it.
Activation Phrase - WHen SpeakEasy starts (with the 3 buttons at the top left of the monitor) open opening is to activate the main window by saying a few words. Kind of like the "BORIS" phrase in NaviVoice. If you leqave this text blank in this screen then the is no voice activation, you'll need to press the SpeakEasy text button.
Vocabulary Folder - is where the *.ini vocab files are located. By default in the vocab folder under the install folder.
There are 3 sliders for setting defaults for:
Activation Timeout - the number of seconds the mian SpeakEasy window stays open listening for commands, if you set this to zero then there is no timeout you'll need to press close to close the main window.
Accuracy Threshold - The default threshold % for the mian window, I normally set this to about 5 or 10 % which stops false commands because of background noise. You can set this threshold from 0% to 50%. O% means that any command that is heard will be executed. The higher the threshold value the more precise you need to speak.
Transparency - THis allow you to make the mian speakEays window as transparent as you like. Will testing I'd keep this near 100%. Once you know you're vocabulary and don't need the main window buttons so much make the transparency higher to fade it into the colors behind.
Finally this screen ahs a listing of the applications it can talk to. Each Application has 5 items:
1. name - A prefix like RR or MM, you can decide the prefixes you want. These are the use in each command in the Macros like MM::Address
2. method - The way to talk to the plugin application, settings include
COM - sendMessage
TCP - Internet packet requests
OPEN - To start an application or open a file.
SELF - Is just used by SepakEasy for internal commands, like reset or disable groupings.
KEY - To simulate keyboard keystrokes liek CTRL-ALT-DEL or typing OSK letters
MM - To use MapMonkey specific interface
3. windowName - The name of the applciation you want to talk to. Like "Map Monkey [GPS]"
4. className - the underlying code name, use a spying programm to get the className, it is not 100% necessary but it is good to have. PM me if you want to know the windowName and className of any applications you want to use.
5. port - is use just when you use the TCP method you need to specify the port number of the application like 4413 for MapMonkey TCP interface if you use MM that way.