Command Line Arguments
The following are the arguments and corresponding options you can use when launching Intuiface Player and Player Classic from the command line. This is particularly useful when using a .bat file or Windows shortcut.
NOTE:
- All of these command line arguments are case-sensitive. Type them exactly as you see them written here.
- For users of Player Classic, refer to the Player Configuration file article for details regarding the use of the IntuifacePlayerApp.exe.config file instead of command line options.
Silent installation and uninstallation
Both Player and Player Classic can be installed and uninstalled silently, meaning they won't require any manual interaction.
- Player
-
/S
NOTES: - It must be an uppercase S.
- The uninstaller is located in the Player installation folder. The command to uninstall Player silently is the following:
"C:\Users\$USER\AppData\Local\Programs\intuiface-player\Uninstall intuiface-player.exe /S"
-
- Player Classic (use both options)
/VERYSILENT-
/SUPPRESSMSGBOXES
NOTES: - Use uppercase letters
- The uninstaller is located in the Player Classic installation folder. The command to uninstall Player Classic silently is the following:
"C:\Program Files\IntuiLab\Intuiface\Player\unins000.exe" /VERYSILENT /SUPPRESSMSGBOXES
Specify the screen(s) to use in a multi-screen setup
NOTE:
To correctly calculate the size and position of Intuiface Player, the value of the Windows OS setting "Display" -> "Scale and layout" -> "Scale" must be identical for all displays. Otherwise, Player and Player Classic won't be displayed in the proper location or at the proper size. NOTE: The Windows-reported "ScreenID" might not be the same as the one identified by Player.
Use either - but not both - of the following two options:
-
/extendeddisplay
Will expand your experience to run across all displays connected to the Windows PC. This option is usually used with either the/playLastExperienceoption or with the path to a specific Intuiface experience.
OR
- Player:
/screen=[ScreenID]| Player Classic:/ownerscreen=[ScreenID]
Replace "ScreenID" with the integer corresponding to the display on which you want Intuiface Player or Player Classic to run. For this option, you must specify which Intuiface experience to play; see the example below.
NOTE: By default, Player and Player Classic will run on the main display, where ScreenID=0. To find out a screen's ID, see this article and then subtract 1 from the derived value. However, these numbers are occasionally inaccurate, so it's best to cycle through numbers, starting with 0 for the main display.
Specify the size and position of Player and Player Classic on the desktop
-
/width=[pixels]and/height=[pixels]
Specify the width and height of Player and Player Classic, measured in pixels. Only positive values are accepted. For example, to set Player's size to 1024 x 768, use/width=1024 /height=768. -
/x=[pixels]and/y=[pixels]
Specify the horizontal and vertical distance, measured in pixels, that Player and Player Classic's upper-left corner should be from the upper-left corner of the display. Only positive values are accepted. For example, to locate Player's upper-left corner at 250 pixels to the right and below the upper-left corner of the display, use/x=250 /y=250.
When using a multi-screen setup, the /extendeddisplay argument must be combined with the x,y position arguments. The /ownerscreen=[ScreenID] argument will not be considered when using x, y position arguments.
Specify which experience to play
There are two options:
-
/playLastExperience
Will restart the most recently run Intuiface experience.
OR
-
/id=[experience ID]
For experiences already downloaded - either through Player's Experiences panel or via the Share & Deploy Console for remote deployment - you can specify which one to run using its Experience ID. You will find this ID on an Experience's details panel accessed through the My Experiences tab of the Share & Deploy Console.
OR (Player Classic)
-
"c:\full\path\to\your\experience\your-experience.ifx"
A reference to a specific Intuiface experience. Include the double quotes. For a look at the structure of an Intuiface project, see this article.
When neither of these two options is used, Player and Player Classic will launch and display the Experiences panel - with one exception. If, in the Share and Deploy console, the option "Run the last opened experience" is turned on for Player or Player Classic, that option will override a launch into the Experiences panel.
Specify the port to use for remote actions
(For Player Classic only)
If you want to use a port other than the default IP port - port 8000 - for remote actions, use the following option. In this example, we specify port 8001 for remote actions.
/remoteActionPort=8001
This is especially useful if you want to launch and target several Player Classics on the same Windows device with remote actions.
Specify the port used for TUIO-based touch screens and or other TUIO-related parameters
(Player Classic only)
If you want to use a port other than the default IP port used by Intuiface for the TUIO protocol (port 3333), or if you want to change any other TUIO-related parameter, you must:
- Create a copy of the file
inputdevicesconfiguration.xmllocated beside the Intuiface Player Classic executable - Edit this copy and 1) change port 3333 to the new port, or 2) change any other TUIO-related parameter as indicated in Using touch displays that support TUIO protocol
- reference this copy in your command line arguments as shown below:
/inputDevicesConfigFile=copyOfinputedevicesconfiguration.xml
Hide Player from the Windows taskbar
(Player Classic only)
If you don't want to see Player Classic listed on the Windows taskbar, use the following command line argument:
-
/hideintaskbar- using this command, Player will not be listed on the Windows taskbar
Additional Notes
For information about how to run Intuiface Player and Player Classic on a Windows PC in kiosk mode, review this article
For information about how to run Intuiface Player and Player Classic on a multi-screen display wall, review this article
Examples
"C:\Program Files\IntuiLab\Intuiface\Player\IntuifacePlayerApp.exe" /screen=1 /playLastExperience
This will launch Intuiface Player on the display with Screen ID=1 and play the last run experience.
"C:\Program Files\IntuiLab\Intuiface\Player\IntuifacePlayerApp.exe" /ownerscreen=1 /width=1024 /height=768 /id[1-34b743ef-abcd-1234-6789-wxyzb03a0e50
This will launch Intuiface Player on the display with Screen ID=1, set Player's size to 1024 x 768, and play the already-downloaded experience with the indicated ID.
"C:\Program Files\IntuiLab\Intuiface\Player\IntuifacePlayerApp.exe" /extendeddisplay /playLastExperience
This will launch Intuiface Player across all displays connected to the Windows PC and play the last run experience.
Limitations
If using command line options:
- (Player Classic only) Remote deployment from the Share and Deploy console can use the Player Configuration file, but only one configuration file can be defined, so you cannot set up several configurations for several players running on the same PC.
If you attempt to run multiple Players or Player Classics on the same PC:
- do not use the Share and Deploy console to manage your Players.
- do not use Intuiface Analytics, as only one Player can collect data points.
- do not use remote actions, as only one Player (the one that was launched first) will receive remote actions
- (Player Classic only)
If one Player instance crashes, the Intuiface Player Agent service running in the background will first kill all other running Player Classic instances and then randomly relaunch only one, displayed on the main screen. We strongly recommend uninstalling the Intuiface Player Agent application to avoid unpredictable behavior if you intend to run multiple Player Classics on the same PC simultaneously.
NOTE: Every time you update Intuiface Player Classic, the Intuiface Player Agent service will be automatically reinstalled and run. Thus, after every Player Classic update, you'll have to uninstall the agent again.
Comments
0 comments
Article is closed for comments.