wsrmacros Wiki Rss Feed

UPDATED WIKI: disambiguate

alex_avila — Fri, 30 Jan 2009 21:11:32 GMT

<disambiguate>

The <disambiguate> executor is used to disambiguate potentially ambigous properties or text from a recognition result.
If the item is ambigous a dialog box will be displayed to the user allowing him/her to choose the specific item from the list.

• Attributes:

propname (required)

The propname attribute of the <disambiguate> executor specifies the name of the property that will be disambiguated.

!!!!!!timeout (optional)
The timeout attribute of the <disambiguate> executor specifies how long, in seconds, should the executor wait for an answer. If the user do not respond in the given timeout the command is canceled. The default is INFINITE.

!!!!!!title (optional)
The title attribute of the <disambiguate> executor specifies the title of the dialog box.

!!!!!!prompt
The prompt attribute of the <disambiguate> executor specifies the text prompted to the user in the dialog box.

The following example allows plays music by artist name and allows for disambiguation of similar artists names:

<speechMacros>
     <command>
	<listenFor>Play ?the ?artist [Artists]</listenFor>
	<disambiguate title="Which artist do you want to play?" prompt="Choose an Artist" timeout="25" propname="Artist" />
	<wmpMediaControl command="pause" />
	<speak>Playing Artist {[Artist]}</speak>
	<wmpMediaPlay attrname="WM/AlbumArtist" attrvalue="{[Artist]}" /> 
     </command>
     <wmpMediaItems name="Artists" propname="Artist" attrname="WM/AlbumArtist" useSubset="true" /> 
</speechMacros>

UPDATED WIKI: mouse

alex_avila — Fri, 30 Jan 2009 21:06:21 GMT

<mouse>

The <mouse> executor manipulates the mouse pointer.

• Attributes:

button (optional)

The button attribute of the <mouse> executor specifies which button to press. Available values are "left","right", and "middle"; it defaults to "left".

command(required)

The command attribute of the <mouse> executor specifies what action the mouse should perform. Values are "click", "dblclick" and "scroll".

modifierKeys(optional)

The modifierKeys attribute of the <mouse> executor allows for using CTRL (^), ALT (%), and SHIFT (+) keys while manipulating the mouse pointer.

position (optional)

The position attribute of the <mouse> executor indicates horizontal (x) and vertical (y) coordinates of where to locate the mouse cursor.

positionStyle (optional)

The positionStyle of the <mouse> executor indicates the position style of the mouse pointer. If assigned to "absolute" the x and y coordinates are mapped to the computer's screen resolution.
If assigned to "virtual" the coordinates are mapped to the "virtual" system in which the top left corner coordinates are 0,0; the middle of the screen coordinates are 32768,32768 and bottom right corner coordinates are 65536,65536. It defaults to "absolute".

The following example moves the mouse cursor to the bottom right corner and double clicks on the date:

scrollAmount (optional)

The scrollAmount of the <mouse> executor indicates the scroll increment.

scrollDirection (optional)

The scrollDirection of the <mouse> executor indicates the scrolling direction. Values are "up" or "down".

<speechMacros>
<command>
 
<listenFor>Click on today's date</listenFor>
<mouse button="left" command="dblclick" position="65536,65536" positionStyle="virtual" /> 
 
</command>
</speechMacros>

UPDATED WIKI: prompt

alex_avila — Fri, 30 Jan 2009 21:05:51 GMT

<prompt>

The <prompt> executor prompts the user with a dialog box that contains manipulable text.

• Attributes:

title (optional)

The title attribute of the <prompt> executor specifies the title of the dialog box.

timeout (optional)

The timeout attribute of the <prompt> executor specifies how long in seconds will the dialog box appear for. If the user do not respond to the timeout the command is canceled. The default value is INFINITE.

defaultValue (optional)

The defaultValue attribute of the <prompt> executor specifies what the default value of the edit control should be. It defaults to an empty string.

resultState (required)

The resultState attribute of the <prompt> executor specifies what state should be modified to contain the new value of the dialog box upon successful completion of the dialog.

• Text between <prompt> executor:
The text within <prompt> tags specifies the text prompted to the user in the dialog box.

The following example allows you to generate the subject line of a thank you email using the <prompt> executor:

<speechMacros>
<command>
	<listenFor>Send thank you email to [person]</listenFor>
	<prompt title="thankYou" timeout="10" defaultValue="Dear {[person]}, Thank you so much Sincerely Alex" 
	resultState="ThankYouText">Thank you greeting:</prompt>
	<run command="mailto:{[person.email]}?subject={[ThankYouText]}" />
</command>
<rule name="person"> 
     <list propname="email">
          <p valstr="john@email.com">John</p>
          <p valstr="kris@email.com">Kris</p>
          <p valstr="travis@email.com">Travis</p>
     </list>
</rule>
</speechMacros>

UPDATED WIKI: closeApp

alex_avila — Fri, 30 Jan 2009 21:05:12 GMT

<closeApp>

The <closeApp> executor is used to close a specified application.

Note. Currently this executor does not disambiguate if more than one application matches the search.

• Attributes:

windowTitle

The windowTitle attribute of the <closeApp> executor specifies the exact title of the window to close.

windowTitleContains

The windowTitleContains attribute of the <closeApp> executor specifies a subset of the title of the window to close.

Only one of these attributes must be specified. They cannot be used in conjunction.

The following examples closes Notepad if opened:

<speechMacros>
     <command>
	<listenFor>Close my favorite application</listenFor>
	<closeApp windowTitleContains="Notepad" /> 
     </command>
</speechMacros>

UPDATED WIKI: restoreApp

alex_avila — Fri, 30 Jan 2009 21:04:28 GMT

<restoreApp>

The <restoreApp> executor is used to restore a specified application.

Note. Currently this executor does not disambiguate if more than one application matches the search.

• Attributes:

windowTitle

The windowTitle attribute of the <restoreApp> executor specifies the exact title of the window to restore.

windowTitleContains

The windowTitleContains attribute of the <restoreApp> executor specifies a subset of the title of the window to restore.

Only one of these attributes must be specified. They cannot be used in conjunction.

The following example restores Notepad if opened:

<speechMacros>
     <command>
	<listenFor>Restore my favorite application</listenFor>
	<restoreApp windowTitleContains="Notepad" /> 
     </command>
</speechMacros>

UPDATED WIKI: maximizeApp

alex_avila — Fri, 30 Jan 2009 21:04:01 GMT

<maximizeApp>

The <maximizeApp> executor is used to maximize a specified application.

Note. Currently this executor does not disambiguate if more than one application matches the search.

• Attributes:

windowTitle

The windowTitle attribute of the <maximizeApp> executor specifies the exact title of the window to maximize.

windowTitleContains

The windowTitleContains attribute of the <maximizeApp> executor specifies a subset of the title of the window to maximize.

Only one of these attributes must be specified. They cannot be used in conjunction.

The following example maximizes an instance of Notepad:

<speechMacros>
     <command>
	<listenFor>Maximize my favorite application</listenFor>
	<maximizeApp windowTitleContains="Notepad" /> 
     </command>
</speechMacros>

UPDATED WIKI: minimizeApp

alex_avila — Fri, 30 Jan 2009 21:03:33 GMT

<minimizeApp>

The <minimizeApp> executor is used to minimize a specified application.

Note. Currently this executor does not disambiguate if more than one application matches the search.

• Attributes:

windowTitle

The windowTitle attribute of the <minimizeApp> executor specifies the exact title of the window to minimize.

windowTitleContains

The windowTitleContains attribute of the <minimizeApp> executor specifies a subset of the title of the window to minimize.

Only one of these attributes must be specified. They cannot be used in conjunction.

The following example minimizes Notepad if opened:

<speechMacros>
     <command>
	<listenFor>Minimize my favorite application</listenFor>
	<minimizeApp windowTitleContains="Notepad" /> 
     </command>
</speechMacros>

UPDATED WIKI: switchToApp

alex_avila — Fri, 30 Jan 2009 21:02:52 GMT

<switchToApp>

The <switchToApp> executor is used to switch to a specified application.

Note. Currently this executor does not disambiguate if more than one application matches the search.

• Attributes:

windowTitle

The windowTitle attribute of the <switchToApp> executor specifies the exact title of the window to switch to.

windowTitleContains

The windowTitleContains attribute of the <switchToApp> executor specifies a subset of the title of the window to switch to.

Only one of these attributes must be specified. They cannot be used in conjunction.

The following example shifts focus to Notepad:

<speechMacros>
     <command>
	<listenFor>Switch to my favorite application</listenFor>
	<switchToApp windowTitleContains="Notepad" /> 
     </command>
</speechMacros>

UPDATED WIKI: setState

alex_avila — Fri, 30 Jan 2009 21:02:26 GMT

<setState>

The <setState> executor is used to set a named state to a specific value.

• Attributes:

name (required)

The name attribute of the <setState> executor specifies the state's name that will be set.

value (optional)

The value attribute of the <setState> executor specifies the value the state will be set to.

An example that demonstrates how to set several states using setState (for a complete explanation on this macro go to <stateIsSet> Condition):

<speechMacros>
<command>
    <listenFor>Good morning computer</listenFor>
     <speak>Good morning</speak>
     <setState name = "aConversation" value ="morning" />
     <waitFor seconds = "5"/>
     <setState name ="aConversation" />
</command>
 
<command>
     <listenFor>Good night computer</listenFor>
     <speak>Good night</speak>
     <setState name = "aConversation" value ="night" />
     <waitFor seconds = "5"/>
     <setState name ="aConversation" />
</command>
 
<command>
     <stateIsSet name = "aConversation" value ="morning" />
     <listenFor>what are you drinking</listenFor>
     <speak>a glass of milk </speak>
     <setState name ="aConversation" />
</command>
 
<command>
     <stateIsSet name = "aConversation" value ="night" />
     <listenFor>what are you eating</listenFor>
     <speak>rice and beans</speak>
     <setState name ="aConversation" />
</command>
</speechMacros>

UPDATED WIKI: sendMessages

alex_avila — Fri, 30 Jan 2009 21:01:51 GMT

<sendMessage>

The <sendMessage> executor provides limited means to send Windows messages to applications.

• Attributes:

windowName (required)

The windowName attribute of the <sendMessage> specifies the name of the target window.

className (required)

The className attribute of the <sendMessage> executor specifies the class name of the target window.

message (required)

The message attribute of the <sendMessage> executor specifies the message number to send to the target window.

wParam (optional)

The wParam attribute of the <sendMessage> executor specifies the wParam argument of the message sent.

lParam (optional)

The lParam attribute of the <sendMessage> executor specifies the lParam argument of the message sent.

• Text between <sendMessage> executor:
The text within <sendMessage> tags only works in conjunction with a WM_COPYDATA message. It specifies a block of text to be sent as the lpData part of the COPYDATASTRUCT structure associated with this message.

<speechMacros>
     <command>
	<listenFor>Turn speech recognition off</listenFor>
	<sendMessage windowName="" className="MS:SpeechTopLevel" message="0X0111" wParam="102" /> 	
     </command>
</speechMacros>

UPDATED WIKI: wmpMediaControl

alex_avila — Fri, 30 Jan 2009 21:01:28 GMT

<wmpMediaControl>

The <wmpMediaControl> executor is used to control Windows Media Player in a variety of ways, play, pause, stop, etc.

• Attributes:

command (required)

The command attribute of the <wmpMediaControl> executor specifies the command to execute on Windows Media Player.
Valid values are:
play
pause
stop
next
previous
loop_on
loop_off
loop_toggle
shuffle_on
shuffle_off
shuffle_toggle

times (optional)

The times attribute of the <wmpMediaControl> executor specifies the number of times the command will be sent to Windows Media Player. Default is 1.

The following example allows you to play the next track in your Windows Media Player list by saying "next track":

<speechMacros>
     <command>
	<listenFor>Next track</listenFor>
	<wmpMediaControl command="pause" />
	<speak>Playing the next track</speak>
	<wmpMediaControl command="next" />
	<waitFor seconds=".5" /> 
	<wmpMediaControl command="play" />
     </command> 
</speechMacros>

UPDATED WIKI: wmpMediaPlay

alex_avila — Fri, 30 Jan 2009 21:01:05 GMT

<wmpMediaPlay>

The <wmpMediaPlay> executor is used to play music in Windows Media Player.

• Attributes:

attrname (required)

The attrname attribute of the <wmpMediaPlay> specifies the attribute name that will be used to play music in Windows Media Player.

Common values for the attrname attribute are:
Name
Artist
WM/AlbumArtist
Title
WM/AlbumTitle
Genre
WM/Genre
WM/TrackNumber

attrvalue

The attrvalue attribute of the <wmpMediaPlay> specifies the attribute value that will be used to play music in Windows Media Player.

The following example allows you to play music in Windows Media Player by artist name:

<speechMacros>
<command>
	<listenFor>Play ?the ?artist [Artists]</listenFor>
	<wmpMediaPlay attrname="WM/AlbumArtist" attrvalue="{[Artist]}" /> 
</command>
	<wmpMediaItems name="Artists" propname="Artist" attrname="WM/AlbumArtist" useSubset="true" /> 
</speechMacros>

UPDATED WIKI: script

alex_avila — Fri, 30 Jan 2009 21:00:31 GMT

<script>

The <script> executor is used to execute script code in the macro framework.

• Attributes:

language (required)

The language attribute of the <script> executor specifies the scripting language of the script. Valid values are "VBScript" or "JScript".

The following example shows you how to use VBScript to perform actions using the <script> executor:

<speechMacros> 
     <command>
	<listenFor>Can you count to ten</listenFor>
                <script language="VBScript">
                      Application.Speak("Yes I can")
                      For count = 1 to 10 
	           Application.Speak(count)
                      Next
                </script> 
     </command>
</speechMacros>

UPDATED WIKI: setTextFeedback

alex_avila — Fri, 30 Jan 2009 20:59:52 GMT

<setTextFeedback>

The <setTextFeedback> executor is used to set text on the feedback pane in the Speech UI.

• Attributes:

style(optional)

The style attribute of the <setTextFeedback> executor specifies if the text on the feedback pane should be displayed normally or as a warning. Valid values are "normal" and "warning". It defaults to "normal".

speak(optional)

The speak attribute of the <setTextFeedback> executor specifies if the text on the feedback pane should also be spoken in addition to be displayed. Valid values are "true" and "false". It defaults to "false".

<speechMacros>
     <command>
	<listenFor>Search the internet</listenFor>
	<setTextFeedback>Opening Internet Explorer and Live.com</setTextFeedback>
	<run command="iexplore.exe" params="http://www.live.com" />	
     </command>
</speechMacros>

UPDATED WIKI: confirm

alex_avila — Fri, 30 Jan 2009 20:58:02 GMT

<confirm>

The <confirm> executor provides the user with a dialog box to decide if execution should continue. The dialog box will contain "Yes" and "No" buttons.

• Attributes:

title(optional)

The title attribute of the <confirm> executor specifies the title of the dialog box.

timeout(optional)

The timeout attribute of the <confirm> executor specifies how long in seconds will the dialog box be displayed. Defaults to INFINITE.

• Text between <confirm> executor:
The text between the <confirm> tags specifies the message that will be displayed in the dialog box.

<speechMacros>
     <command>
	<listenFor>Send an email to [person]</listenFor>
                 <confirm title="Send email" timeout="10.0">Are you sure you want to send an email to {[person]}? </confirm> 
	<setTextFeedback>Sending email to {[person]}</setTextFeedback>
	<run command="mailto:{[person.email]}" />	
     </command>
 
     <rule name="person"> 
          <list propname="email">
               <p valstr="john@email.com">John</p>
               <p valstr="kris@email.com">Kris</p>
               <p valstr="travis@email.com">Travis</p>
          </list>
     </rule>
</speechMacros>

UPDATED WIKI: alert

alex_avila — Fri, 30 Jan 2009 20:57:18 GMT

<alert>

The <alert> executor is used to inform the user using a dialog box. This dialog box only contains an OK button.

• Attributes:

title(optional)

The title attribute of the <alert> executor specifies the title of the dialog box.

timeout(optional)

The timeout attribute of the <alert> executor specifies how long in seconds will the dialog box be displayed. Defaults to INFINITE.

• Text between <alert> executor
The text between the <alert> tags specifies the message that will be displayes in the dialog box.

<speechMacros>
     <command>
	<listenFor>Send email to [person]</listenFor>
	<setTextFeedback>Sending email to {[person]}</setTextFeedback>
	<run command="mailto:{[person.email]}" />	
     </command>
 
     <command>
	<listenFor>What's [person] email address</listenFor>
	<alert title="Email address" timeout="10.0">{[person]}'s email address is: {[person.email]} </alert>
     </command>
 
     <rule name="person"> 
          <list propname="email">
               <p valstr="john@email.com">John</p>
               <p valstr="kris@email.com">Kris</p>
               <p valstr="travis@email.com">Travis</p>
          </list>
     </rule>
</speechMacros>

UPDATED WIKI: speak

alex_avila — Fri, 30 Jan 2009 20:56:36 GMT

<speak>

The <speak> executor uses a TTS (Text To Speech) voice to speak back to the user.

• Attributes:

speakFlags (optional)

The speakFlags attribute of the <speak> executor allows to specify the SPEAKFLAGS value passed to the TTS engine. It defaults to SPF_IS_NOT_XML(16).
For more information about SPEAKFLAGS go to http://msdn.microsoft.com/en-us/library/ms717252(VS.85).aspx

The following example the computer greets back at the user:

<speechMacros>
     <command>
	<listenFor>Hello computer</listenFor>
	<speak>Hello user</speak>
     </command>
</speechMacros>

UPDATED WIKI: waitFor

alex_avila — Fri, 30 Jan 2009 20:04:45 GMT

<waitFor>

The <waitFor> executor waits for a specified amount of time.

• Attributes:

seconds (required)

The seconds attribute specifies how long in seconds the <waitFor> executor should wait before continuing. (The value can be specified as a floating point value)

anyStateNameIsSet (optional not allowed in conjuntion with allStateNamesAreSet)

The anyStateNameIsSet attribute specifies to wait until any of the named states are set to a value. The list of state names is separated by the vertical bar character "|".
Example:

<waitFor anyStateNameIsSet="stateOne|stateTwo|stateThree" seconds="10" />

allStateNamesAreSet (optional not allowed in conjunction with anyStateNameIsSet)

The allStateNamesAreSet attribute specifies to wait until all of the named states are set to a value. The list of state names is separated by the vertical bar character "|".
Example:

<waitFor allStateNamesAreSet="stateOne|stateTwo|stateThree" seconds="10" />

The following example uses the <waitFor> executor to wait for WordPad to load:

<speechMacros> 
     <command>
	<listenFor>Open my text editor with font menu</listenFor>
	<run command="wordpad.exe" /> 
	<waitFor seconds="1.0" />
                <sendKeys>%o</sendKeys>
                <waitFor seconds=".250" />
                <sendKeys>f</sendKeys>	 
      </command>
</speechMacros>

UPDATED WIKI: emulateRecognition

alex_avila — Fri, 30 Jan 2009 20:04:11 GMT

<emulateRecognition>

The <emulateRecognition> executor simulates speech recognition.

• Attributes:

waitForDisambiguation (optional)

The waitForDisambiguation attribute specifies the amount of time to wait for the speech recognition command to be disambiguated. Default value is 0 where the recognizer wont wait for disambiguation.

If a value is specified, the <emulateRecognition> executor will ensure that if disambiguation is necessary, the user will be given an amount of time to respond to the disambiguation prompt as specified in this attribute.

• Text between <emulateRecognition> executor:
The text contained within the <emulateRecognition> executor specifies the text of voice command to be emulated by the speech recognition engine.

Note: Emulate recognition does not validate the correction of the text between the tags therefore invalid characterers, extra white spaces and mispelled words may corrupt its execution and it may fail silently.

In the following example allows to copy the screen into paint:

<speechMacros>
     <command>
	<listenFor>Copy the screen into paint</listenFor>
                <emulateRecognition>Press print screen</emulateRecognition> 
	<run command="mspaint.exe" /> 
                <waitFor seconds="1.0" />
                <switchToApp windowTitleContains="Paint" />
                <waitFor seconds="1.0" />
                <sendKeys>^v</sendKeys>
     </command>
</speechMacros>

UPDATED WIKI: run

alex_avila — Fri, 30 Jan 2009 20:03:38 GMT

<run>

The <run> executor starts a new application.

• Attributes:

command (required)

The command attribute specifies what program to run.

params (optional)

The params attribute specifies the command line parameters to pass to the application.

directory (optional)

The directory attribute specifies what the current directory should be when running the application.

In the following example the <run> executor is used to open an internet explorer window with www.live.com as its default page:

<speechMacros>
     <command>
	<listenFor>Search the Internet</listenFor>
	<run command="iexplore.exe" params="http://www.live.com" /> 
     </command>
</speechMacros>