Remote Control Reference
VIOSO 6 and VIOSO 6 SIM (Blackbox) utilize the same remote control interface. Using this, a lot of application features can be controlled via TCP/IP.
Last updated
VIOSO 6 and VIOSO 6 SIM (Blackbox) utilize the same remote control interface. Using this, a lot of application features can be controlled via TCP/IP.
Last updated
The network control interface must be enabled. You can find the network related options in the application menu: “Options → Settings → Remote Control”.
You must enable the desired interface type first. Then you should configure the network adapter and port to use. The special adapter ip 0.0.0.0 represents all available network adapter of used pc. After an restart of the application, the configured interface is available.
There are two ways to send commands.
You can use each browser application to send a command request. Please type the command string with leading ip and port address in the address bar and press the enter button. e.g. “http://192.168.2.20:8080/player.htm?state=play“. The server will answer with a HTTP response header and attached HTTP side or attached response string.
You can use your own network tool, media control solution or with the installation distributed test tools, to send command to the server. There a two ways to send the command string:
You can send a simple command string, terminated with “\r” or “” character(s) ( 0xD 0xA hexadecimal, <CR><LF> or 0xA hexadecimal, <LF>). E.g. “player.htm?state=play\r\n“ If you use the TCP interface, the server will answer with a simple response string. If you use the UDP interface, the server will send no answer (fire and forget).
If you use the TCP interface, you can send a command request encapsulated in a minimum HTTP header, using the GET method. E.g. “GET /player.htm?state=play HTTP/1.1\r\n\r“ The server will answer with a HTTP response header and attached HTTP side or attached response string.
If you have chosen install „Shared Components“ during Installation, there are several tools to equip you to test:
TCP-/ UDP-interface
command behavior
spy/ record network communication with third party software
You can execute/ find the test tools over the application startmenu entry; sub-entry “Tools”. Except TCP Test Tool 2, each of the described test tools below, have a command line interface. With the command line interface you are able to use the test tools in scripts, links and so on. You can find a documentation of available command line options inside sub-entry “Manuals”.
With the TCP Test Tool 2 you can test the TCP interface using a permanent (long live) connection to one target. This tool also display a log of all network operations.
You can specify one target by adding the IP of the remote pc to the target list. By pressing the “Send” button, the tool:
creates a connection to the current treated target
sends the command string as simple string (see above)
waits for response
depicts the response string inside the response area on right side of the application
and closes the connection to the current treated target.
Software location after installation of VIOSO Anyblend, Anyblend VR&SIM or VIOSO Player:
Via Windows Start Menu: All Programs / VIOSO 6 / Tools / TCP Test Tool
Exe file location: C:\Program Files\VIOSO6\Shared Tools\ VIOSO_TCP_Test.exe
Available parameters:
Example:
Sends the command "control.htm?present=1" to 192.168.2.2, using port 801 automatically.
Exit code:
VIOSO_TCP_Test2.exe returns an exit code on exit:
0 : successful
1 : an error occurred (Command could not be sent to all destinations.)
The TCP Test Tool is the predecessor to TCP Test Tool 2.
This tool does the same actions as it successor TCP Test Tool 2, but does not use a permanent connection and does not monitor all network traffic. It just outputs the response of the target.
We recommend to use TCP Test Tool 2 whenever possible.
Software location after installation of VIOSO Anyblend, Anyblend VR&SIM or VIOSO Player:
Via Windows Start Menu: All Programs / VIOSO 6 / Tools / TCP Test Tool 2
Exe file location: C:\Program Files\VIOSO6\Shared Tools\ VIOSO_TCP_Test2.exe
See previous chapter for command line parameters.
With the UDP Test Tool you are able to test the UDP interface.
You can specify one ore more targets by adding the IP of a desired PC to the target list. Beside this option, the tool is able to send the command string as broadcast to all computers in network.
By pressing the “Send” button, the tool sends a datagram, containing the command string, to all selected targets successively. If you use the broadcast option, the tool sends a broadcast datagram.
Via Windows Start Menu: All Programs / VIOSO 6 / Tools / UDP Test Tool
Exe file location: C:\Program Files\VIOSO6\Shared Tools\ VIOSO_UDP_Test.exe
Available parameters:
Example:
Sends the command "control.htm?present=1" to 192.168.2.2, using port 801 automatically.
Exit code:
VIOSO_TCP_Test2.exe returns an exit code on exit:
0 : successful
1 : an error occurred (Command could not be sent to all destinations.)
Provides Player related actions. Use playcontrol.htm to get human readable response.
Interface to receive informations about available media files
Interface to receive preview images of playlist items
Get/set presenter pipeline specific parameters
3D-model depended computation control
Interface to control the script engine
Interface to retrieve various meta- and system information.
Interface to control the project manager.
| Parameter | Description |
|---|
| Parameter | Description |
|---|
| TCP/IP and UDP | description | version |
|---|
| TCP/IP and UDP | description | version |
|---|
| TCP/IP and UDP | description | version |
|---|
| TCP/IP and UDP | description | version |
|---|
| TCP/IP and UDP | description | version |
|---|
| TCP/IP and UDP | description | version |
|---|
| TCP/IP and UDP | description | version |
|---|
| TCP/IP and UDP | description | version |
|---|
| TCP/IP and UDP | description | version |
|---|
| ip of the destination if |
|
|
| " |
| if set, the application tries to send the command and closes app automatically |
| ip of the destination if |
|
|
| " |
| if set, the application tries to send the command and closes app automatically |
| Sets the playback state, which starts the playback at the currently selected playlist item. | 1.0 |
| Pauses the current playback. | 1.0 |
| Stops the current playback, the seeker is set to the beginning of the currently selected playlist item. | 1.0 |
| Selects the next item of the playlist. If playback state is set, the playback of the selected item starts. | 1.0 |
| Selects the previous item of the playlist. If playback state is set, the playback of the selected item starts. | 1.0 |
| Selects the first item of the playlist. If playback state is set, the playback of the selected item starts. | 1.0 |
| Selects the last item of the playlist. If playback state is set, the playback of the selected item starts. | 1.0 |
| Mutes the player audio output temporary. | 1.2 |
| Re-Enables the player's audio output. | 1.2 |
| Sets the global audio level to | 1.2 |
| Sets the autoplay state active. | 1.2 |
| Sets the autoplay state inactive. | 1.2 |
| Loads a playlist XML file from disk, specified by | 1.2 |
| Saves the current playlist to a file specified by | 1.2 |
| Adds a file or playlist item. If the additional parameter | 1.2 |
| Moves the playlist entry | 1.2 |
| Activates the playlist item | 1.2 |
| Deactivates the playlist item | 1.2 |
| Activates the loop behaviour of item | 1.7 |
| Dectivates the loop behaviour of item | 1.7 |
| Deletes entry | 1.2 |
| Refreshes the meta-data (size, date, etc.) of the item | 1.2 |
| In case of an image sequence item this command changes the display time of each image; | 1.2 |
| Retrieves a comma separated list with status information
| 1.7 |
| Retrieves the index of currently selected/ played item in playlist
| 1.7 |
| Retrieves the number of items in the playlist | 1.7 |
| Retrieves the state of the current selected/played item
| 1.7 |
| Retrieves an overview of useful information as comma separated list. Format: a,b,c,d,e,f,g
| 1.7 |
| Retrieves the current audio volume setting.
| 1.7 |
| Retrieves the current audio balance setting.
| 1.7 |
| Retrieves informations about the play state of the playlist.
| 1.7 |
| Retrieves the current showmode state
| 1.7 |
| Retrieves the current selected playlist item position | 1.7 |
| Retrieves the current stream position in percent
| 1.7 |
| Retrieves the current stream position in more detailed mode. Format:
| 1.7 |
| Retrieves a list of all items in playlist. One item per line. Per line contained information:
| 1.7 |
| Retrieves media informations about the current selecteded playlist item if no select parameter is specified, or about playlist item
| 1.8 |
| Sets the stream position of an active playing stream based playlist item to a specific position. The presenter pipeline must be in showmode on state and the current played playlist item must be in play or pause state. | 1.7 |
| Used to change the stream position of an active playing stream based playlist item by a specified portion. The presenter pipeline must be in showmode on state and the current played playlist item must be in play or pause state. | 1.7 |
| Toggles the smooth border presenter feature | 1.7 |
| Toggles the fullscreen presenter pipeline feature. | 1.7 |
| Toggles the blank screen(s) presenter pipeline feature. | 1.8 |
| Retrieves a list of all available media files onto the server (comma separated list). | 1.7 |
| Retrieves a list of all available playlist files onto the server (comma separated list). | 1.8 |
| Retrieves a list of all available calibration files onto the server (comma separated list). | 1.8 |
| Retrieves the preview image of playlist entry [p] . e.g.: | 1.7 |
| Retrieves the current global color settings (comma separated list).
| 1.7 |
| Retrieves the current fullscreen presenter feature setting state.
| 1.7 |
| Retrieves the current smooth border presenter feature setting state.
| 1.7 |
| Retrieves the current blank screen(s) presenter feature setting state.
| 1.8 |
| Sets new global color values. The presenter pipeline has to be in showmode on state. | 1.7 |
| Enables, disables the smooth border presenter pipeline feature. | 1.7 |
| Enables, disables the fullscreen presenter pipeline feature. | 1.7 |
| Enables, disables the blank screen(s) presenter pipeline feature. | 1.8 |
| Enables show mode while Output is displayed. | 1.0 |
| Disable show mode while Output is displayed. | 1.0 |
| Shuts down the operating system. | 1.0 |
| Shuts down the operating system and reboots. | 1.0 |
| Close the currently addressed running instance of the application. | 1.0 |
| Starts a camera-based recalibration on a single client system without any user interaction (1-click recalibration). | 1.0 |
| Stops a running calibration without changing the currently used calibration ona single client systen | 1.0 |
| Starts a camera based multiclient recalibration without any user interaction (1-click recalibration) | 1.0 |
| Stops a running multiclient calibration without changing the currently used calibration. | 1.0 |
| Returns 1, in case a calibration is running, 0 otherwise | 1.8 |
| Executes the specified file. The executable has to be located inside the subdirectory | 1.0 |
| Loads the calibration file “Preset[x].sps” that must located inside the default calibration folder. | 1.0 |
| Loads the calibration file “Settings[x].sps” that must located inside the default calibration folder. | 1.0 |
| Clears configurations and data.
example: | 1.7 |
| Saves the current calibration state to specified “filename”
| 2.0 |
| Makes all current output windows invisible (on master) | 2.3 |
| Makes all current invisible output windows visible again (on master) | 2.3 |
| Retrieves the current status of the 3D-model engine, as text string.
| 1.6 |
| Starts the 3D-model computation, based on current settings. Available response strings:
| 1.6 |
| Retrieves a list of all available displays | 1.7 |
| Retrieves a list of all available desktop displays | 2.5 |
| Shows an identification window on the specified place
| 2.4 |
| Retrieves the current status of the project manager.
Other lines: a,”b”,”c”: This lines contain informations about available project steps.
| 6.0.2 |
| Tries to load the specified project. A
| 6.0.2 |
| Tries to start the specified project step
| 6.0.2 |
| Retrieves the current status of the script engine, as text string.
| 1.6 |
| Executes the specified script file. Available response strings (defined in c conform string format definition):
In additional to the script file name to execute, a parameter string can be defined to define variables. A variable can defined by:
No format specificaton implies a string value. More than one variable can defined by a semicolon separated list. Example: The script | 1.6 |
| Aborts the execution of a currently processed script. | 1.6 |
| Retrieves a list of all available displays | 1.7 |
