Utterly Voice
Mode Settings
Mode settings files are found in the
config\modes
directory in the application directory.
Each mode has its own settings file.
To add a mode to your settings,
simply create a mode YAML file and put it in this directory.
You can name these files anything you like,
but use a file suffix of .yaml.
A mode has the following settings:
| Setting | Type | Description |
|---|---|---|
name |
String | The name of the mode. Choose a name that is easy to recognize, so you can easily use the "activate", "deactivate", and "open help" commands. |
alternates |
List Collection | An optional list of additional string phrases that will match this mode name when using the "activate", "deactivate", and "open help" commands. This is helpful when a recognizer consistently fails to recognize a mode name. |
description |
String | A description of the mode. This text will appear in the content when you say "open help". |
initiallyActive |
Boolean |
If true,
this mode will be automatically active when the application starts.
|
exclusive |
Boolean |
If true,
this mode is an exclusive mode.
|
biases |
List Collection | You can use this optional setting to control recognition bias for certain phrases while the mode is active. See Bias. |
commands |
List Collection | The list of commands that are available when the mode is active. See Commands below. |
Commands 
Every mode has a list of commands. Each command has the following settings:
| Setting | Type | Description |
|---|---|---|
name |
String | The spoken name for the command. |
description |
String | The command description. This text will appear in the content when you say "open help". |
biasFactor |
Number | This optional setting is used to control recognition bias for this command name. If not supplied, the default value is 1.2. See Bias. |
pseudoCommand |
Boolean |
This optional setting
controls whether the command is identified as a true command
when the commands-only interpreter state is active. If it is false (the default),
the commands-only state will treat this as a true command.If it is true,
the commands-only state will treat this as normal typing
and ignore the command.
|
alternates |
List Collection | A list of additional string phrases that will trigger this command. This is helpful when a recognizer consistently fails to recognize a command name. |
functions |
List Collection | This is a list of functions that should be called for this command. Functions define the actions that are taken for this command. See Functions. |
spaceLeft |
Boolean |
Set this field to true
if this command types text
that normally has a space on the left side of it.
For example,
this is true for most words
and false for ",".The default value of this field is false.Details: When the auto-spacing interpreter state is on, and this optional field is set to true,
Utterly Voice will insert a space character on the left
of any text typed by this command.This does not apply if the command is the first thing in the utterance. |
spaceRight |
Boolean |
Set this field to true
if this command types text
that normally has a space on the right side of it.
For example,
this is true for most words
and false for "$".The default value of this field is false.Details: This is similar to spaceLeft,
except it adds space on the right side of the command output.If there is another command immediately after this command in the utterance, the spaceLeft value of the other command
overrides this spaceRight value.If the auto-utterance-spacing interpreter state is on, and spaceRight is true,
and this is the last command in the utterance,
a space will be added after the content typed by the command.
Otherwise, no space is added after the last command.In addition, auto-spacing never inserts two space characters between consecutive command outputs. |