Standalone scenario player

  • NB: Document was written for OpenViBE 2.0.1 (20.Feb.2018)

Since OpenViBE 2.0.0, we have included a stand-alone scenario player in OpenViBE. This application is a streamlined player component to run pre-made OpenViBE XML scenarios made with OpenViBE Designer.

The scenario-player can be used to run scenarios as part of build automation or continuous integration. It can also used as a more lightweight alternative to calling Designer with --no-gui or --invisible as it has much fewer dependencies. The codebase of the scenario player can also be used an example how to embed OpenViBE SDK/kernel in your own application.

The source code of the standalone scenario player is under sdk/applications/developer-tools/scenario-player/ in the OpenViBE source tree.

How to use

Although the scenario player is built by default, in OpenViBE 2.0.1 it still lacks a launcher that’d set the environment variables properly.

On Windows, you can successfully run it as follows from the command prompt,

# change to install folder's subfolder bin, e.g. 
# cd dist\bin
# cd "C:\Program Files (x86)\openvibe\bin"
openvibe-set-env.cmd
openvibe-scenario-player.exe --mode=x --scenario-file=C:\temp\some-scenario-to-run.xml

You can get more help about the command line options with the switch --help.

Clever Linux users can be expected to achieve the same on Linux without detailed instructions.

Limitations

Currently the player does not support any gui elements, so if your scenarios have any visualization elements in them (such as gtk boxes), the player will crash. This is intentional to keep the player lightweight and free of dependencies such as GTK or Ogre.

Happy hacking!

 

This entry was posted in Documentation, Miscellaneous manual pages, User documentation. Bookmark the permalink.