Actions

A reference for core actions available in the VoxCommando logical command builder (LCB).

Other actions will also be available depending on which plugins you have enabled. A plugin must be enabled before its actions can be used.

• General information about Plugins
• For a complete list of plugins that come with VoxCommando and their associated actions, see: Plugin List

Standard Version 2 VoxCommando Actions:

Below is a list of all actions that are available in version 2 by default. For default version 1 actions see: Actions_V1.

Note that we will try to regularly update this page as actions are deprecated or added in subsequent versions, but as a caution this list is deemed correct and complete for version 2.2.2.2

EventGhost

Send

EventGhost.Send
Generates an event in EventGhost. Any command payloads will be sent along with the event.

Example you could write your parameter as
Light.{1}.On

If you do not wish to send all payloads automatically then use EventGhost.SendNP

• Parameters: 1+

1. Event : Event string to send to EventGhost [string]
2. Payload : Optional payload [string]
3. Payload : Optional payload [string]
4. Payload : Optional payload [string]
5. Payload : Optional payload [string]

SendNP

EventGhost.SendNP
Same as EventGhost.Send but will NOT automatically append payloads.

• Parameters: 1+

1. Event : Event string to send to EventGhost [string]
2. Payload : Optional payload [string]
3. Payload : Optional payload [string]
4. Payload : Optional payload [string]
5. Payload : Optional payload [string]

SendHex

EventGhost.SendHex
sends a sequence of hex pairs via UDP

for example: 0A FF E2

• Parameters: 1

1. Sequence : example: 0A FF E2 [string]

SetIP

EventGhost.SetIP
Set the IP of the computer to send EG commands to.

Enable broadcast to all computers on the LAN by using 255.255.255.255

• Parameters: 1

1. IP : Target IP address [string]

SetPort

EventGhost.SetPort
Set the port to broadcast EG commands on.
Default port is: 33333

• Parameters: 1

1. Port : UDP port [integer]

File

File
Actions for writing, copying, moving, deleting files.

Append

File.Append
Writes <Text> to the file at <Path>.
If the file exists, then <Text> will be appended to the end of the file without creating a new line.

• Parameters: 2

1. Path : The file to append text to [string]
2. Text : The text to append [string]

AppendLine

File.AppendLine
Writes <Text> to the file at <Path>. If the file exists, then <Text> will be appended to the end of the file, followed by a new line.

• Parameters: 2

1. Path : The file to append text to [string]
2. Text : The text to append [string]

Copy

File.Copy
Copies the file at <SourcePath> to <DestinationPath>.
WARNING: If a file exists at <DestinationPath> it will be overwritten without prompting the user.

• Parameters: 2

1. SourcePath : File to copy [string]
2. DestinationPath : File path to copy the file to [string]

Delete

File.Delete
Deletes the file at <Path> without prompting the user.

• Parameters: 1

1. Path : The file to delete [string]

GetDirectories

File.GetDirectories
Scans the directory at <Path> and returns the names of all sub-directories matching <Filter> (if any are found).

If <Recursive> is True then all subdirectories will be recursively scanned.
**USE WITH CAUTION**

Results are returned as Matches: {Match.1} etc.

• Parameters: 1-3

1. Path : Path of directory to scan [string]
2. Filter : e.g. F* to get all subdirectories that start with F [string]
3. Recursive : Recursively scan through all subfolders (default = false) [boolean]

GetFiles

File.GetFiles
Scans the directory at <Path> and returns the filenames of all files matching <Filter> (if any are found).

Results are returned as Matches: {Match.1} etc.
Filter is usually *.* or *.wav or *.jpg or similar.

If <Recursive> is True then all subdirectories will be recursively scanned.
**USE WITH CAUTION**

• Parameters: 1-3

1. Path : Path of directory to scan [string]
2. Filter : *.* or *.mp3 etc. [string]
3. Recursive : Recursively scan through all subfolders (default = false) [boolean]

GetRandFile

File.GetRandFile
Scans the directory at <Path> and returns the filename of a single random file matching <Filter> if any are found.
Filter is usually *.* or *.wav or *.jpg or similar.

• Parameters: 2

1. Path : Folder to scan [string]
2. Filter : eg: *.* [string]

MakeDir

File.MakeDir
Creates a new Windows file directory (folder) at the specified <Path>

• Parameters: 1

1. Path : Path of directory to create [string]

Move

File.Move
Moves the file at <SourcePath> to <DestinationPath>.

• Parameters: 2

1. SourcePath : File to move [string]
2. DestinationPath : File path to move the file to [string]

Read

File.Read
Reads the contents of a text file. If the second optional parameter is included it will return the line specified. The first line in the file is line 0.

• Parameters: 1-2

1. Path : path to file [string]
2. Line : 0 based line number to read [integer]

Write

File.Write
Writes <Text> to the file at <Path>.
If the file exists, it will be overwritten.

• Parameters: 2

1. Path : The file to write to [string]
2. Text : The text to write to the file [string]

WriteLine

File.WriteLine
Writes <Text> to the file at <Path>. Followed by a new line.
If the file exists, it will be overwritten.

• Parameters: 2

1. Path : The file to write to [string]
2. Text : The text to write to the file [string]

Gmail

Actions to access information about unread emails via your gmail atom feed. You must set your username and password in the VC options under the email tab.

"2 step verification" must be DISABLED in your gmail account in order to use these actions. https://support.google.com/accounts/answer/1064203?hl=en

GetAllSummaries

Gmail.GetAllSummaries
Like GetAllTitles, but also returns a summary for each email.

"2 step verification" must be DISABLED in your gmail account in order to use these actions. https://support.google.com/accounts/answer/1064203?hl=en

GetAllTitles

Gmail.GetAllTitles
Returns a list of all unread emails in {LastResult}. For each email, it returns the sender and the subject line of the email.

"2 step verification" must be DISABLED in your gmail account in order to use these actions. https://support.google.com/accounts/answer/1064203?hl=en

GetCount

Gmail.GetCount
Returns the number of new (unread) messages.

"2 step verification" must be DISABLED in your gmail account in order to use these actions. https://support.google.com/accounts/answer/1064203?hl=en

GetCustom

Gmail.GetCustom
Gets all messages and returns them using a custom <Format>. <Format> can be any text but the following special strings will be replaced with the pertinent information. (note values in <> must be UPPERCASE and include the < > symbols. <#> <FROM> <TITLE> <SUMMARY>

These are self explanatory, but <#> is the index value of the message in the current list. 1 is the newest message.

Example <Format> parameter:
<#>: DER <FROM>, Titel: <TITLE>{CR}<SUMMARY>

• Parameters: 1

1. Format : Any text with special values in <> [string]

GetFeed

Gmail.GetFeed
Returns the unaltered XML atom feed.

"2 step verification" must be DISABLED in your gmail account in order to use these actions. https://support.google.com/accounts/answer/1064203?hl=en

Group

Actions relating to groups and grammars.

Disable

Group.Disable
Turns a command group off by specifying its name.

• Parameters: 1

1. Groupname : Name of the group to disable [string]

DisableRegEx

Group.DisableRegEx
Disable all groups whose names match the regular expression <Pattern>.

• Parameters: 1

1. Pattern : Groups matching this pattern will be disabled [string]

Enable

Group.Enable
Turns a command group on by specifying its name.
If <Duration> is specified then the group will automatically be disabled after the duration of time has elapsed.

• Parameters: 1-2

1. Groupname : Name of the group to enable [string]
2. Duration : Duration that group will remain enabled [string]

EnableRegEx

Group.EnableRegEx
Disable all groups whose names match the regular expression <Pattern>.
If <Duration> is specified then all matching groups will automatically be disabled after the duration of time has elapsed.

• Parameters: 1-2

1. Pattern : Groups matching this pattern will be enabled [string]
2. Duration : Duration that groups will remain enabled [']

GetEnabled

Group.GetEnabled
Returns "True" if the group <GroupName> is currently enabled.
Otherwise returns false.

• Parameters: 1

1. GroupName : Name of group [string]

Purge

Group.Purge
Purge all group caches

Rebuild

Group.Rebuild
Purges the cache for the group with <GroupName> and forces a rebuild and reload of the group. (Does not reload the group xml from voicecommands.xml)

• Parameters: 1

1. GroupName : Name of group to rebuild [string]

RefreshAll

Group.RefreshAll
Reloads all macros and checks to see if any groups need to be rebuilt and reloaded. To force a full update, first use the Group.Purge action.

RestoreStates

Group.RestoreStates
Returns groups to the state they were in when Group.SaveStatesAs was called with the same <StateName>.

• Parameters: 1

1. StateName : Restore group states that were previously saved under this name [string]

SaveStatesAs

Group.SaveStatesAs
Saves the current state (enabled / disabled) for all groups under this <StateName>.
Group states can later be restored using this same <StateName>.

• Parameters: 1

1. StateName : Save group state under this name. [string]

SoloRegEx

Group.SoloRegEx
Groups matching the regular expression <Pattern> will be enabled, all other groups will be disabled.

• Parameters: 1

1. Pattern : Groups matching this pattern will be enabled, all other groups will be disabled [string]

Help

Various actions to show your command phrases. Each action will generate an html-based help file.

Different actions will show different subsets of your command tree.

ShowAll

Help.ShowAll
Generates an html-based help file listing your voice commands, and opens it in your default web browser.

Shows all commands in all groups.

If <OpenBrowser> is set to false, then the html file will only be generated, but not opened.

• Parameters: 0-1

1. OpenBrowser : Default=True [boolean]

ShowByName*

Help.ShowByName*
Generates an html-based help file listing your voice commands, and opens it in your default web browser.

Shows all commands in groups whose GroupNames contain <substring>.

If <OpenBrowser> is set to false, then the html file will only be generated, but not opened.

• Parameters: 1-2

1. Substring : Show help for groups containing this substring will be shown [string]
2. OpenBrowser : Default=True [boolean]

ShowEnabled

Help.ShowEnabled
Generates an html-based help file listing your voice commands, and opens it in your default web browser.

Shows all commands in groups that are set to 'Enabled' in the Command Tree Editor.

If <OpenBrowser> is set to false, then the html file will only be generated, but not opened.

• Parameters: 0-1

1. OpenBrowser : Default=True [boolean]

InputKeys

Powerful keyboard emulation actions. Allows for more precise keyboard combinations than SendKeys.

In some cases the DxInput plugin may work (for example in some games) when InputKeys and SendKeys fail.

KeysDown

InputKeys.KeysDown
Presses one or more virtual keys down and does not release them.
example: {CONTROL+SHIFT}

Keys can be released later in the macro using InputKeys.KeysUp

• Parameters: 1

1. Keys : Keys to press down [string]

KeysUp

InputKeys.KeysUp
Releases one or more virtual keys that were previously pressed using InputKeys.KeysDown

You must specify which keys to release.

• Parameters: 1

1. Keys : Keys to release [string]

Send

InputKeys.Send
Presses and then releases a key combination as though it were typed on the keyboard.
Use the parameter helper tool for help with the correct format (i.e., the icon with 3 stacked building blocks).
Example: {ALT}({TAB})

• Parameters: 1

1. Keys : key combo to send [string]

TextEntry

InputKeys.TextEntry
Types a string. Overrides case, and allows use of brackets '( )' and '{ }'

Faster than using send if you wish to type without special keys or combinations.

Example parameter: Hello There! Dude(s). How are you?

• Parameters: 1

1. Text : The text to type [string]

Kinect

Actions to access information about unread emails via your gmail atom feed. You must set your username and password in the VC options under the email tab.

GetBeamAngle

Kinect.GetBeamAngle
Returns the current beam angle formed by the microphone.

SetTilt

Kinect.SetTilt

• Parameters: 1

1. TiltAngle : Positive values point up and negative values point down. [integer]

UseDeviceID

Kinect.UseDeviceID
Used to specify which Kinect to listen to when more than one Kinect device is connected to the computer.

• Parameters: 1

1. ID : [string]

Launch

Launch
Open the program at <Path> using optional command line parameters. Command line parameters will automatically be surrounded with quotes. If you don't want quotes use Launch.RawParam
Path can be absolute or relative to the folder that VoxCommando.exe is running in.

• Parameters: 1-2

1. Path : <path> [string]
2. Command line params : <command line params> [string]

Capture

Launch.Capture
Launch a process and attempt to read the commandline output it generates.
Open the program at <Path>. Command line parameters will not be surrounded with quotes.

*When using CMD.exe (shell commands) for the process it is often necessary to place /C at the beginning of the parameters field. See: http://ss64.com/nt/cmd.html

• Parameters: 1-4

1. Path : Process to launch [string]
2. Parameters : Command Line parameters [string]
3. Hidden : Hide the command window [boolean]
4. Codepage : Override the output character encoding. Default = 850 [integer]

CMD

Launch.CMD
Run the specified <CmdLine> command from the windows command line processor.

Some examples for <CmdLine> parameter:
Explorer.exe shell:PicturesLibrary
Explorer.exe shell:Favorites
Explorer.exe Shell:::{36eef7db-88ad-4e81-ad49-0e313f0c35f8} //windows updates

• Parameters: 1

1. CmdLine : Command line string to execute [string]

Hidden

Launch.Hidden
Same as Launch.RawParam but the window of the application will be hidden.

Useful for running batch files or command line utilities that perform a function and then close automatically, without seeing a window pop up.

• Parameters: 1-2

1. Path : Path to application [string]
2. Parameters : Command line parameters [string]

OpenBat

Launch.OpenBat
Runs the batch file found at <Path>.

• Parameters: 1

1. Path : Path to batch file [string]

OpenFile

Launch.OpenFile
Attempts to open the file at <Path> using the default program for that file type as defined in Windows. Results will vary depending on your system setup.

• Parameters: 1

1. Path : Path to file [string]

OpenURL

Launch.OpenURL
Attempts to open the website with the address <URL> using the default web browser.

• Parameters: 1

1. URL : the web URL to open [string]

RawParam

Launch.RawParam
Open the program at <Path>. Command line parameters will not be surrounded with quotes.

• Parameters: 1-2

1. Path : Path to application [string]
2. Parameters : Command line parameters [string]

LoopDelay

Action(s) that can be used to adjust the time between executions of the currently looping command.

Multiply

LoopDelay.Multiply
Changes the delay time of a currently looping command, such as "scroll right".

Using a parameter of 2 would cause the command to loop twice as slow.
Using a parameter of 0.5 would cause the command to loop twice as fast.

• Parameters: 1

1. Decimal number : Multiply time between loops by this number [string]

Map

Actions to control, store, and retrieve key-value pairs from the map tables.

Can be used to map long strings to friendly names (e.g. IR codes to button names).
Can be used to store data that will not be lost when the program closes and restarts.

CreateTable

Map.CreateTable
Creates a new MapTable with name <MapTable>. If the table already exists, no change is made.

• Parameters: 1

1. MapTable : Name of MapTable to create [string]

DropTable

Map.DropTable
Drops (deletes) <MapTable>, if it exists.

• Parameters: 1

1. MapTable : Name of MapTable to Drop (delete) [string]

ExportPayloadXML

Map.ExportPayloadXML
When using <Filter> do not include the word "where"

• Parameters: 2-5

1. Filename : Path of xml file to create [string]
2. Mapname : Name of maptable to export [string]
3. Key>>Value : default = false (map KEY to PHRASE) [boolean]
4. SubsetMatch : default = false [boolean]
5. Filter : SQL Where filter [string]

Get

Map.Get
Returns a value for the given <Map> and <Key>.

• Parameters: 2

1. MapTable : (Table) [string]
2. Key : Find value for this key [string]

GetKey

Map.GetKey
Returns the key for the given <Map> and <Value>.

• Parameters: 2

1. MapTable : (Table) [string]
2. Value : Find key for this value [string]

Query

Map.Query
Example of a <Query> to delete a key from a map table:

delete from test where fromKey="key5"

• Parameters: 1

1. Query : SQL query string [string]

Set

Map.Set
Stores a value for the given <MapTable>, <Key>, and <Value>.
If <Key> does not already exist in the given <MapTable> it will be created and the value set.
If <Key> already exists and <Overwrite> is True, the Key will be updated with a new value.
If <Key> already exists and <Overwrite> is False, no change will be made.

• Parameters: 3-4

1. MapTable : Name of MapTable to edit [string]
2. Key : Name of Key in MapTable [string]
3. Value : (Data to store in Key for this MapTable [string]
4. Overwrite : Overwrite existing map keys (default= true) [boolean]

Mouse

Manipulate the Windows mouse cursor (position and buttons) using emulation.

GetXY

Mouse.GetXY
Returns the current position of the mouse pointer in the form posX,posY
Position is measured in pixels relative to the top left corner of the leftmost screen.

For example if the mouse is at the top right the result returned might be:
1080,0

LeftButtonDown

Mouse.LeftButtonDown
Emulate left mouse button down, (not a full click) useful if you want to drag items.

LeftButtonUp

Mouse.LeftButtonUp
Emulate left mouse button up. Use after Mouse.LeftButtonDown to release the button.

LeftClick

Mouse.LeftClick
Emulate mouse left button click and release

MiddleClick

Mouse.MiddleClick
Emulate mouse middle button click and release

MoveAbsolute

Mouse.MoveAbsolute
Positions the mouse cursor at position <X>, <Y> in screen coordinates.
Distance of the move is relative to the top left corner of the leftmost screen.

• Parameters: 1

1. X,Y : pair of integers [string]

MoveRelative

Mouse.MoveRelative
Moves the mouse cursor horizontally by <x>, and vertically by <y>
Distance of the move is relative to the previous position of the mouse cursor.

• Parameters: 1

1. X,Y : pair of integers [integer]

RightButtonDown

Mouse.RightButtonDown
emulate right mouse button down, (not a full click) should be followed by Mouse.RightButtonUp

RightButtonUp

Mouse.RightButtonUp
emulate right mouse button up. Use after Mouse.RightButtonDown to release the button.

RightClick

Mouse.RightClick
emulate mouse right click and release

OSD

Actions for providing on-screen feedback to the user.

AddText

OSD.AddText
Same as OSD.ShowText, but adds <Text> to what was previously displayed starting on a new line.
Does not erase the old text.
If the overlay is hidden it will be shown again.

• Parameters: 1

1. Text : Text to add to the OSD popup [string]

HideOverlay

OSD.HideOverlay
Makes the status overlay invisible. (coloured floating microphone icon)

PositionOverlay

OSD.PositionOverlay
Moves the status overlay to the screen coordinates <X>,<Y>

Example, to move the overlay to the top right of a 1920 x1080 display you could use something like this

OSD.PositionOverlay 1880,20

• Parameters: 1

1. X,Y : Location on screen. 0,0 is top left corner [integer]

SetColors

OSD.SetColors
Example hex codes:
White: FFFFFF Black: 000000 Red: FF0000

• Parameters: 1-2

1. ForeColor : RGB Hex code for OSD font color [string]
2. BackColor : RGB Hex code for OSD background color [string]

SetFontSize

OSD.SetFontSize
Set the point size for the OSD font

• Parameters: 1

1. PointSize : Point size for OSD font [integer]

SetOverlayFade

OSD.SetOverlayFade
Overrides the default parameters for the dimming of the status overlay icon.

• Parameters: 3

1. FadeDelay : milliseconds to remain at full opacity [integer]
2. DimmedOpacity : Opacity when dimmed (0-100) [integer]
3. FullOpacity : Opacity when not dimmed (0-100) [integer]

ShowOverlay

OSD.ShowOverlay
Makes the status overlay (coloured floating microphone icon) visible.

ShowText

OSD.ShowText
Displays the text <Message> on screen.
If <Duration> is specified the <Message> will remain on screen for <Duration> milliseconds.
If <Position> is positive, the <Message> text box will have its bottom <Position> pixels from the bottom of the screen.
If <Position> is negative, the <Message> text box will have its top <Position> pixels from the top of the screen.

• Parameters: 1-3

1. Message : Text message to display [string]
2. Duration : Time to show message in milliseconds [integer]
3. Position : Offset from bottom of screen (negative values will offset from top) [integer]

PayloadXML

Actions to manipulate xml files that contain "value/phrase" payloads.

AddPair

PayloadXML.AddPair
Adds a new payload to the xml file <filename>

• Parameters: 3-4

1. Path : Path to payload xml file [string]
2. Value : Payload Value to add [string]
3. Phrase : Payload Phrase [string]
4. UseSubsetMatching : Will payload allow subset matching? (user can say partial phrase) [boolean]

Clear

PayloadXML.Clear
Removes all payloads from the xml file at <Path>
Does not delete the file, so you can add new payloads to it later.

• Parameters: 1

1. Path : Path to file that will be modified [string]

GetPhrase

PayloadXML.GetPhrase
Returns the first phrase found from the payloadXML file at <Path> for the item with a value of <Value>
<Return> determins what will be returned:
Full: The complete phrases as stored in the file. (this is the default)
First: The phrase preceding the first comma
Random: One of the phrases as separated by commas

• Parameters: 2-3

1. Path : Path of the payloadXML file to read [string]
2. Value : Value to search for [string]
3. Return : Full (default), First, Random [string]

GetRandomP

PayloadXML.GetRandomP
Returns a number <N> of random phrases from the payloadXML file at <Path>.
Phrases are returned as as matches {Match.1} to {Match.N}.

Default for N is: 1

• Parameters: 1-2

1. Path : Path to payload xml file to read [string]
2. N : # of phrases to retrieve (default = 1) [integer]

GetValue

PayloadXML.GetValue
Returns the first value found from the payloadXML file at <Path> for the item with a phrase of <Phrase>
If <ByComma> is true, <Phrase> will be compared to alternate phrases between commas. If false the whole string must match.
Search is NOT case sensitive.

• Parameters: 2-3

1. Path : Path of the payloadXML file to read [string]
2. Phrase : Phrase to search for [string]
3. ByComma : Default: False = match entire phrase string [boolean]

NewFile

PayloadXML.NewFile
Creates a new empty payloadXML file at <Path>

• Parameters: 1

1. Path : [string]

RegExTool

The RegExTool is a tool window that can help the user to create and test regular expression patterns for use in Results.RegEx and similar actions.

Open

RegExTool.Open
Opens the RegExTool window and optionally updates the source with {LastResult}

• Parameters: 1

1. UpdateLastResult : Update the source with {LastResult} [boolean]

Results

Perform operations using {LastResult}.

MatchConcat

Results.MatchConcat
Concatenates all matches (separated by <Delimiter>) into a single string that is stored in {LastResult}. Each available match will be used up to a maximum of <MaxMatches>, or all if <MaxMatches> is omitted.

• Parameters: 1-2

1. Delimiter : String to place between matches. You can use {CR} [string]
2. MaxMatches : Ignore matches after the first <MaxMatches> [integer]

MatchToEvent

Results.MatchToEvent
One event will be generated for each match that was stored. (i.e. {Match.1}..{Match.n} up to <MaxEvents>. If <MaxEvents> is not specified then all matches will be used.
The event will have the name <EventName>

Each event {i} will also carry payloads, where {i} indicates the match number.
{1} will be {Match.{i}}
{2} will be {Match.{i}.1}
{3} will be {Match.{i}.2} (if there are submatches)
etc.

• Parameters: 1-2

1. EventName : the Name of the event to Generate [string]
2. MaxEvents : The maximum number of events to generate [integer]

MatchToMap

Results.MatchToMap
After using Results.Regex you may use this action to store all matches in a map table.
By default the first capture of each match will be stored as the "value" and the second capture will be stored as the "phrase". If <PhraseFirst> is True then these will be reversed.
If each match has only one capture then this will be stored as both the key and the value.

• Parameters: 1-3

1. MapName : Name of map to add items to [string]
2. PhraseFirst : Save Match.x.1 as phrase (Default=False) [boolean]
3. Overwrite : Overwrite existing map keys (default= true) [boolean]

MatchToXML

Results.MatchToXML
After using Results.Regex you may use this action to export all matches to a payloadXML: <File>.
By default the first capture of each match will be stored as the "value" and the second capture will be stored as the "phrase". If <PhraseFirst> is True then these will be reversed.
If a match has only one capture then this will be stored as both the value and the phrase.

• Parameters: 1-3

1. File : Path to save payloadXML file to [string]
2. PhraseFirst : Save Match.X.1 as phrase (Default=False) [boolean]
3. SubsetMatching : Enable subset matching for each item in the payloadXML (Default=False) [boolean]

RegEx

Results.RegEx

Performs regular expression matching against the {LastResult} from a previous action, and stores multiple matches in {Match.1} {Match.2} etc.
If the pattern contans multiple captures (sets of brackets) they will be concatenated (and joined using <Delimiter>) in each match.

For example, if {LastResult} contains this line:

Artist: Beck

then the regex pattern might be:

Artist:\s(.*?)

which would return the string Beck as a match.

A good regex reference:
http://www.mikesdotnetting.com/Article/46/CSharp-Regular-Expressions-Cheat-Sheet

• Parameters: 1-3

1. Pattern : Regular expression pattern to match against [string]
2. Delimiter : Multiple captures will be joined using this string during concatenation [string]
3. Input String : Optional text to match against instead of {LastResult} [string]

RegExReplace

Results.RegExReplace
Performs a replace on {LastResult} using RegEx patterns.
Strings captured in the <FindPattern> using brackets, can be used in <ReplaceWith> using $1, $2 etc.

• Parameters: 2-3

1. FindPattern : RegEx pattern describing what to capture and remove [string]
2. ReplaceWith : Text to replace what was removed (see notes) [string]
3. InputString : Optional input text to use instead of {LastResult} [string]

RegExSingle

Results.RegExSingle
Works the same as Results.RegEx but treats the results as one long string so that you can match across multiple lines.

• Parameters: 1-3

1. Pattern : Regular expression pattern to match against [string]
2. Delimiter : Multiple captures will be joined using this string during concatenation [string]
3. Input String : Optional text to match against instead of {LastResult} [string]

Replace

Results.Replace
Performs a replace on {lastresult}

any occurences of <old string> will be replaced with <new string>

the result after replacement is placed back into {lastresult}

• Parameters: 2-3

1. OldString : Text to remove [string]
2. NewString : Text to replace OldString with [string]
3. InputString : Optional input text to use instead of {LastResult} [string]

SetLastResult

Results.SetLastResult
Set the value of {LastResult} to <newValue> so that you can perform other actions on the new custom string.

• Parameters: 1

1. NewValue : set {LastResult} to this value [string]

SetVar

Results.SetVar
Sets the user variable <VarName> to <Value>
You can access the variable in other actions by using {var.variablename}

* If <Value> is omitted then the value of {LastResult} will be used as the <Value>

• Parameters: 1-2

1. VarName : The name of the variable to store data in [string]
2. Value : The new value to store in the variable [string]

StoreLast

Results.StoreLast

• Deprecated. Please use: Results.SetVar
  
  Stores {LastResult} in a user variable of name: <variablename>
  
  You can access the variable in other actions by using {var.variablename}

• Parameters: 1

1. Variablename : <variablename> [string]

Scrape

Scrape
Equivalent to an HTTP "get" request. Returns the raw text contents of the file found at the address: <URL> and stores it in {LastResult}. <URL> can point to any kind of text file (html, xml rss) and can be a web address or a local file.

If the file is hosted on a server that requires authentication you can provide <username> and <password> credentials as optional parameters. Some sites require you to actually log in so that session variables can be maintained. In this case you can try using RoboBrowser.

Some content is not contained in the original file and is normally only created after the page loads and a web client asks for linked resources or executes javascript. Again, this requires the use of RoboBrowser which is an actual browser capable of doing these things.

• Parameters: 1-3

1. URL : http://... url to scrape [string]
2. Username : If authentication is required [string]
3. Password : If authentication is required [string]

Get

Scrape.Get
An alternative to regular Scrape action. With more control of parameters.

• Parameters: 3-8

1. URL : http://... url to scrape [string]
2. Content-type : [string]
3. User-agent : [string]
4. Username : [string]
5. Password : [string]
6. Header : eg: Key: "Value" [string]
7. Header : eg: Key: "Value" [string]
8. Header : eg: Key: "Value" [string]
9. Header : eg: Key: "Value" [string]
10. Header : Add as many headers params as you want. [string]

Post

Scrape.Post
Similar to Scrape, but performs an HTTP "POST" request instead of an HTTP "GET" request.
See http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request_methods.

• Parameters: 6+

1. URL : URL [string]
2. DataString : data to post [string]
3. Username : [string]
4. Password : [string]
5. ContentType : examples: application/json OR text/xml; charset="utf-8" [string]
6. Header : eg: Key: "Value" [string]
7. Header : eg: SOAPAction: "urn:Belkin:service:basicevent:1#SetBinaryState" [string]
8. Header : [string]

Put

Scrape.Put
Similar to Scrape, but performs an HTTP "PUT" request instead of an HTTP "GET" request.
See http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request_methods.

• Parameters: 2-8

1. URL : URL [string]
2. DataString : data to put to server [string]
3. Username : [string]
4. Password : [string]
5. ContentType : default: application/json [string]
6. Header : eg: Key: "Value" [string]
7. Header : eg: SOAPAction: "urn:Belkin:service:basicevent:1#SetBinaryState" [string]
8. Header : [string]

Simple

Scrape.Simple
Test action. Performs an HTTP-Get similar to the regular Scrape action.

If the regular scrape action fails for some reason you can try this as an alternative.

• Parameters: 1

1. URL : http://... url to scrape [string]

UserAgent

Scrape.UserAgent
Same as scrape, but instead of sending username and password you can send a string for <UserAgent> in the request.

• Parameters: 2

1. URL : http://... url to scrape [string]
2. UserAgent : add this useragen to the request header [string]

XML

Scrape.XML
Will scrape the website or feed at <URL> and return the inner text for nodes <NodeName>
Each node found will be stored in {Match.#} — the first node in {Match.1}, the second in {Match.2} etc.

• Parameters: 2-3

1. URL : URL or Feed to scape [string]
2. NodeName : Name of Nodes to return [string]
3. MaxNodes : Maximum number of matches to return [integer]

SendKeys

SendKeys
Sends <Keys> (a keyboard combination) to the keyboard (using emulation). Does not work with all programs. For more information about how to format the <Keys> parameter see:
http://msdn.microsoft.com/en-us/library/8c6yea83(v=vs.85).aspx

Example: to press Control-Shift-End use
^+{END}

* Note: For more power and control use InputKeys or the DxInput plugin.

• Parameters: 1

1. Keys : Keys to Send [string]

SMTP

Send email using an SMTP server. Configure your server in Options.

Send

SMTP.Send
Example parameter string:
test@gmail.com && Dinner at Joe's && Let's meet at Joe's diner tonight at 6 pm. We should still have time to eat before the movie.

If HTML is set to true, email will be sent as HTML, which allows markup in the Message. Defaults to false.

• Parameters: 3-5

1. To : recipient's address [string]
2. Subject : the subject of the email [string]
3. Message : the body (text) of the email [string]
4. Attachment : path/filename [string]
5. HTML : send text as HTML [boolean]

SendAsync

SMTP.SendAsync
This is the same as SMTP.Send, but does not wait to see if the email was sent before proceeding to the next action.

If you need to verify that the message was sent correctly then you should use SMTP.Send

• Parameters: 3-5

1. To : recipient's address [string]
2. Subject : the subject of the email [string]
3. Message : the body (text) of the email [string]
4. Attachment : path/filename [string]
5. HTML : send text as HTML [boolean]

Sound

Actions to play sound files and adjust system volume.

AdjustVol

Sound.AdjustVol
Adjust the volume by <value>. Use a negative number to decrease volume.

• Parameters: 1

1. Adjust by : Use a negative number to decrease volume [integer]

GetStreamInfo

Sound.GetStreamInfo
Returns information about the currently playing audio stream.

GetDefaultIn

Sound.GetDefaultIn
Returns the name of the current default audio input device.

GetDefaultOut

Sound.GetDefaultOut
Returns the name of the current default audio output device.

GetVol

Sound.GetVol
Returns the current system master volume

ListInputs

Sound.ListInputs
Returns a list of all the active audio input devices.

ListOutputs

Sound.ListOutputs
Returns a list of all the active audio output devices.

MicMute

Sound.MicMute
Attempts to mute the default microphone input.

Results may vary depending on the microphone.

MicSetVol

Sound.MicSetVol
Sets the default system input device volume to a value from 0 to 100.

Results may vary depending on the microphone.

• Parameters: 1

1. Volume : 0-100 [integer]

MicUnmute

Sound.MicUnmute
Attempts to unmute the default microphone input.

Mute

Sound.Mute
Mute the system volume.

PartialMute

Sound.PartialMute
Reduces volume to a % of the current system volume.
Has no effect if PartialMute is already in effect.

• Parameters: 1

1. 1-100 : <1-100> [string]

PartialUnMute

Sound.PartialUnMute
Restores the system master volume to the level it was at before calling PartialMute.

PlayStream

Sound.PlayStream
Plays the audio file found at <Path>. Accepts a file path or an URL so can be used to play an internet radio stream. Example:
http://scfire-a32.websys.aol.com:80/radio_paradise_mp3_128kbps

Audio can then be stopped using Sound.StopStream

Supported formats include .wav and .mp3 files or streams. Other formats may not play.

• Parameters: 1

1. Path : [string]

PlayWav

Sound.PlayWav
Plays the .wav file found at <Path>
If <Wait> is true, the execution of the command will be suspended until the wav file has finished playing.

• Parameters: 1-2

1. Path : file path to .wav file [string]
2. Wait : Wait for wav to finish before going to next action. Default = False [boolean]

SetDefaultIn

Sound.SetDefaultIn
Sets the default input device to the first device found with a name that contains the string <InputName>.

Not case sensitive.

• Parameters: 1

1. InputName : Name of input device (partial) [string]

SetDefaultOut

Sound.SetDefaultOut
Sets the default input device to the first device found with a name that contains the string <OutputName>

Not case sensitive.

• Parameters: 1

1. OutputName : Name of output device (partial) [string]

SetStreamVol

Sound.SetStreamVol
Set the volume for the currently playing stream

• Parameters: 1

1. Volume : 0-100 [integer]

SetVol

Sound.SetVol
Sets the current system master volume to a value from 1 to 100.

• Parameters: 1

1. Volume : 1-100 [integer]

StopStream

Sound.StopStream
Stop playback of the current audio stream (if any is playing).

ToggleMute

Sound.ToggleMute
Toggles system mute on / off.

UnMute

Sound.UnMute
Unmute the system volume.

System

Various Windows system actions to access the system clipboard, control sleep, hibernation, shutdown, and monitor power settings.

GetClipboardText

System.GetClipboardText
Copies the contents of the system clipboard text to {LastResult}.

GetVar

System.GetVar
Retrieve various system related variables.

Variables you can get values for:
MachineName, OSVersion, SystemDirectory, UserName, EnvironmentVar, AllEnvironmentVars,

* When using EnvironmentVar a second parameter is used to specify which environment variable to get. (e.g. PATH)

• Parameters: 1-2

1. VarName : See description for list of valid variable names [string]
2. ExtraVar : Used with EnvironmentVar [string]

Hibernate

System.Hibernate
Hibernates the system (if hibernation support is enabled in OS settings).

LockWorkstation

System.LockWorkstation
Locks the work station, requiring the user to log back in before using Windows.

Monitor

Control monitor power settings.

Off

System.Monitor.Off
Puts the computer monitor(s) to sleep.

On

System.Monitor.On
Wakes the computer monitor(s).

Standby

System.Monitor.Standby
Doesn't seem to do anything on most systems!

Use System.Monitor.Off instead.

SetClipboardText

System.SetClipboardText
Copies the text {LastResult} to the system clipboard.

• Parameters: 1

1. String : <string> [string]

ShutDown

System.ShutDown
Attempts to log off and shut down your system.

*** USE WITH CAUTION !

Sleep

System.Sleep
Puts the computer system into sleep (standby) mode.

Tools

Misc. helper actions

Decode

Actions to decode encoded strings.

HTML

Tools.Decode.HTML
Decodes (unescapes) HTML and XML strings of the form & to the correct text characters.

Example:
Converts: <foo> It's "quotable & memorable" </foo>
into: <foo> It's "quotable & memorable" </foo>

• Parameters: 0-1

1. InputString : Input string to use instead of {LastResult} [string]

URI

Tools.Decode.URI
Decodes (unescapes) URI encoded strings.

Example: converts %26 to a single space character.

• Parameters: 0-1

1. InputString : Input string to use instead of {LastResult} [string]

Encode

Actions to encode strings.

Base64

Tools.Encode.Base64
Converts {LastResult} or <PlainText> into a base 64 string.

• Parameters: 0-1

1. PlainText : Text to encode (UTF8) [string]

Data

Tools.Encode.Data
Similar to, but more aggressive than Tools.Encode.Uri.

Converts {LastResult} or <PlainText> into a URI encoded string.

Escapes more symbols like + and @

• Parameters: 0-1

1. PlainText : Input string to use instead of {LastResult} [string]

URI

Tools.Encode.URI
Converts {LastResult} or <PlainText> into a URI encoded string.

Examples:
où est-il allé? >> o%C3%B9%20est-il%20all%C3%A9?
видеть >>  %D0%B2%D0%B8%D0%B4%D0%B5%D1%82%D1%8C

• Parameters: 0-1

1. PlainText : Input string to use instead of {LastResult} [string]

GcCompress

Tools.GcCompress
Compresses an iTach IR code and allows you to change the repeat and connector (output port) number.

• Parameters: 4

1. IR Code : Original Uncompressed IR code [string]
2. Repeat : Times to repeat code when sending. Default =1 [integer]
3. Connector : Number of output port to send IR on (1-3) [integer]
4. Module : Always 1 think! [integer]

GcTrim

Tools.GcTrim
Trim a GlobalCache IR code. Detect and remove repeated IR sequences.

• Parameters: 3

1. IR Code : Original "untrimmed" learned IR code [string]
2. MaxValue : Longest gap before a new line is assumed [integer]
3. Lines : Number of lines to keep [integer]

WeekdayToOffset

Tools.WeekdayToOffset
Useful for actions that expect the day to be expressed as an integer relative to today, i.e. Today is 0 and tomorrow is 1.
e.g. If today is Wednesday you can convert Thursday to +1, or Monday to -2.

If <FutureOnly> is True then -2 will be adjusted to +5 (5 days in the future instead of 2 days in the past. Results returned will be in the range of 0 to +7.
If <FutureOnly> is False (default) then the value returned will be in the range of -3 to +3.

Use VC.SetCulture to change the names of the days of the week to another language.

• Parameters: 1-2

1. Day of Week : Example: Saturday or Thursday [integer]
2. FutureOnly : Default: False [boolean]

VcAdvanced

Not for your average user.

Use with caution.

Can cause major problems if used incorrectly.

You have been warned!

Backup

VcAdvanced.Backup
Backups up critical files from your VC folder in a zip file.
Only files with the following extensions will be stored:
.xml .xsp .css .wav .db3 .py .txt

Your <Path> parameter should include the .zip file extension.

The <Path> parameter must be a valid file path to an existing folder.

Example (relative path):
myTestBackup.zip --- will be saved in VoxCommando folder

Example (full path):
D:\backups\VcBackup001.zip

• Parameters: 1

1. <Path> : File path to save backup in [string]

ClearLog

VcAdvanced.ClearLog
Erases all text that is currently in the log file.

EnableLog

VcAdvanced.EnableLog
Set <Enabled> to true to enable the log.

Set <Enabled> to false to disable the log.

• Parameters: 1

1. Enabled : True or False [boolean]

GetOption

VcAdvanced.GetOption
Attempts to return the current value of *almost* any core option variable.

The value returned is the current value and may be different from the default value defined in the Options.xml file.

<OptionName> is case sensitive and must exactly match the Option name as it appears in the Options.xml file

• Parameters: 1

1. OptionName : Case sensitive! [']

Hide

VcAdvanced.Hide
Hide the main VC window (minimize to notification area).

Log

VcAdvanced.Log
Adds a user entry to the history panel (with optional tooltip) and to the log (if logging is enabled).

• Parameters: 1-2

1. LogText : Basic log info [string]
2. ToolTip : Extra info / history tooltip [string]

Notify

VcAdvanced.Notify
Displays a balloon tooltip. Windows 10 will display this as a "notification".

In Windows 10 setting <Icon> to 0 means use the VoxCommando icon.

The default (and minimum) duration for the notification is 5 seconds. You can increase this in Windows settings.

• Parameters: 2-4

1. Title : Notification heading [string]
2. Message : Notification text [string]
3. Icon : 0-3 (0=none, 1=info, 2=alert, 3=error) [integer]
4. Duration : milliseconds (experimental) [integer]

OpenPluginWindow

VcAdvanced.OpenPluginWindow

• Parameters: 1

1. Plugin : Name of plugin to open [string]

SaveRecoWav

VcAdvanced.SaveRecoWav
Saves the last audio stream that was recognized to the <Path> specified.
Creates or overwrites an existing wav.
Returns the full path to the wav file.
Will fail if the wav file is open and return an error.

• Parameters: 1

1. Path : Path to a wav file where audio will be saved. [string]

SetOption

VcAdvanced.SetOption
Allows you set *almost* any core VoxCommando option variable (not plugin settings).

The value is set temporarily and will return to default values the next time options are loaded from file.

<OptionName> is case sensitive and must exactly match the Option name as it appears in the Options.xml file

You must set the <NewValue> to one that can be converted to the correct option type (String, Boolean, Integer etc.)

• Parameters: 2

1. OptionName : Case sensitive! [string]
2. NewValue : Format must match option type [string]

Show

VcAdvanced.Show
Show the main VC window: Restore from notification area, ensure not minimized, and gain focus.

VoxCommando

Basic actions to control VoxCommando.

ConfirmNo

VC.ConfirmNo
Discards (without executing) the command that is currently waiting for confirmation (if any).

ConfirmYes

VC.ConfirmYes
Executes the command that is currently waiting for confirmation (if any).

DisableGroup

VC.DisableGroup
Deprecated. Please use Group.Disable

Turns a command group off by specifying its name.

• Parameters: 1

1. Groupname : Name of the group to disable [string]

DisableGroup*

VC.DisableGroup*
Deprecated. Please use Group.DisableRegEx

Same as EnableGroup but disables all groups whose name contains <substring>.

• Parameters: 1

1. Substring : Groups containing this substring will be disabled [string]

EnableGroup

VC.EnableGroup
Deprecated. Please use Group.Enable

Turns a command group on by specifying its name.

• Parameters: 1

1. Groupname : Name of the group to enable [string]

EnableGroup*

VC.EnableGroup*
Deprecated. Please use Group.EnableRegEx

Same as EnableGroup but enables all groups whose name contains <substring>.

• Parameters: 1

1. Substring : Groups containing this substring will be enabled [string]

GetOption

VC.GetOption
Returns the current setting for select VoxCommando options. This will be the current active value and not necessarily the same as the values saved in options.xml

Current options available:
RequiredConfidence, IdleTimeout, Prefix

• Parameters: 1

1. Option : The option to read [string]

GetProfile

VC.GetProfile
Returns the name of the current speech recognition engine profile being used by Windows (and VoxCommando unless you are using the SP version).

LoadOptions

VC.LoadOptions
Reloads all options from the "options.xml" file.

Off

VC.Off
Puts VoxCommando into (Off / Red) mode. The program will not listen for any spoken commands, but will still respond to user interaction via the mouse and keyboard and can still receive actions or events through the network.

On

VC.On
Puts VoxCommando into (Listen / On / Green) mode.

OnSingle

VC.OnSingle
Puts VoxCommando into (Listen / On / Green) mode and enables "single command mode":
After the next recognized command VC will return to Standby mode and generate the event VC.Single.End, which can be used to restore volume after muting to listen to your command.

Pause

VC.Pause
Pauses execution of the macro. Parameter is in milliseconds. (1000 = 1 second).

Warning: This will freeze VoxCommando. You should only use this for short pauses.

For longer delays it is recommended to use VC.SetEventTimer

If you must use a long VC.Pause then you can add ++ to the beginning of your command's name. This command will run in its own thread and will not block the rest of the program during long pauses. Be careful using this method as it may lead to unexpected results when multiple commands are running simultaneously.

• Parameters: 1

1. Time : time to pause in ms [integer]

RestartFull

VC.RestartFull
Actually closes the program and restarts it. If you have changed your display language in options, this will refresh the display with the new language.

RestartQuick

VC.RestartQuick
Attempts to restart VoxCommando while doing the minimum amount of "rebuilding". If the cache has been cleared by doing a genXML then this will actually result in a full rebuild, and may take just as long as VC.RestartFull.

SetCulture

VC.SetCulture

• • EXPERIMENTAL **
    Allows you to override the current culture so that certain actions (such as Date/Time) will use this culture setting instead.
    Examples for <Culture> paramer: en-US de-DE pt-BR ja-JP
    See http://sharpertutorials.com/list-of-culture-codes/

• Parameters: 1

1. Culture : aa-AA [string]

SetEventTimer

VC.SetEventTimer
Creates a timer that triggers the event <EventName> after a period of time.

Events can be assigned to any command(s) in order to trigger them (see: http://voxcommando.com/mediawiki/index.php?title=Events).

The parameter <Delay/Time> can use a number of different formats:
- A time of day such as 3:45 or 16:30 or 4:00 PM or 8:00 AM
- A delay. Default is seconds, but you can also specify hours, minutes or seconds:
Example: 1h 10m 30s

• Parameters: 2+

1. Delay/Time : * see notes for formats [string]
2. EventName : event to fire [string]
3. Payload : payload will be attached to the event [string]
4. Payload : payload will be attached to the event [string]
5. Payload : payload will be attached to the event [string]

SetOption

VC.SetOption
Temporarily overrides VoxCommando options. These will not be saved and will return to previous values on restart. Only certain options can be set. Currently just:
RequiredConfidence, IdleTimeout, Prefix

For a full list see: http://voxcommando.com/mediawiki/index.php?title=VC.SetOption

• Parameters: 2

1. Option : The Option to set [string]
2. NewSetting : The new value for the option [string]

SetProfile

VC.SetProfile
Changes the recognition engine to use a new speech profile:
<ProfileName> must be one of you speech profiles as defined is Windows Speech Control panel (Control Panel\All Control Panel Items\Speech Recognition).
Case sensitive.

• Parameters: 1

1. ProfileName : name of speech profile to switch to [string]

SetSpeechInput

VC.SetSpeechInput
Changes the audio input used for speech recognition to a new device.
Note that it does not change the default audio input for windows in general, only for speech recognition.
<Input> Should be the name or part of the name for an input device. If Input is omitted, the speech input will be set to the default windows input device.

• Parameters: 0-1

1. Input : blank = use default audio input [string]

Standby

VC.Standby
Puts VoxCommando into (Standby / Yellow) mode. VoxCommando will then only respond to special commands.

StopEventTimer

VC.StopEventTimer
Stops and removes ALL timers with a matching <EventName> regardless of their remaining time or their payloads (if any).

Events for these timers will not be generated.

• Parameters: 1

1. EventName : Timers with this EventName will be stopped [string]

StopMacro

VC.StopMacro
Stops execution of the current macro (command)

TellVox

VC.TellVox
Emulates speech recognition using <Command>. Should have the same effect as saying <string>. Spelling must be correct.
If possible use VC.TriggerEvent instead.

• Parameters: 1

1. Command : the words to simulate [string]

TriggerEvent

VC.TriggerEvent
Triggers any commands that contain "Event"

Add as many extra parameters as you like, they will be treated as payloads.

• Parameters: 1+

1. Event : Name of event to trigger [string]
2. Payload1 : optional payload [string]
3. Payload2 : optional payload [string]
4. Payload3 : optional payload [string]

Window

Various actions to control to focus and control windows.

Close

Window.Close
Close the window belonging to <Process>

if no parameter is used the Currently Focused window will close.

example:
Window.Close Chrome

The process name can be viewed in task manager and is usually the filename of the program. Use the name only and not the '.exe'

• Parameters: 1

1. Process : Name of the process to close [string]

Focus

Window.Focus
focuses the progam with the process name <string>

I am still working on this, it is not 100% reliable. Some programs work better than others.

To see a list of process names for all running processes use the Windows Task Manager (ctrl-shift-esc) and click the "processes" tab.

• Parameters: 1

1. String : <string> [string]

Maximize

Window.Maximize
maximize the currently focused window

Minimize

Window.Minimize
If no parameter is specified then it will minimize the currently focused window.

Otherwise it will attempt to minimize the window belonging to <Process>

• Parameters: 0-1

1. Process : [string]

Normalize

Window.Normalize
normalizes the currently focused window.

VCHide

Window.VCHide
Minimizes VoxCommando to the tray (notification) icon area.

VCShow

Window.VCShow
Makes sure VoxCommando is visible. Restores VoxCommando from the tray (notification) icon area.

VCTrayToggle

Window.VCTrayToggle
Shows or Hides VoxCommando.
Toggles VoxCommando to and from the tray (notification) icon area.

WOL

WOL
Sends a "magic packet" to wake a computer on the LAN. The parameter should be the MAC address of the computer to wake.

• Parameters: 1

1. MacAddr : Mac Address of machine to wake [string]