Documentation

General Instructions

Getting started

To download, install, or compile OpenViBE from sources, see the various links on the downloads page.

The video tutorials, available in english and french, cover most of the aspects of getting started with OpenViBE.

In addition, OpenViBE FAQ answers many common questions.

OpenViBE features

Using OpenViBE

These documents describe how to work with different OpenViBE applications and components. Tutorials and examples are included.

Acquisition Server documentation

Designer documentation

Video tutorials

Various publications, slides, etc

Tutorials

Box documentation

Example scenarios

Connecting OpenViBE and other applications

Miscellaneous manual pages

Modifying OpenViBE

Developers interested in changing the OpenViBE source code can find information about the developer tools and internal mechanisms of OpenViBE in this section.

Source code handling

Architecture and practices

Acquisition drivers

Box plugins

Data formats documentation

Developer tools

Code snippet

Knowledge base

Various documents that may be of use.

Data-analysis

Troubleshooting

Design notes

Development

Deprecated and old documents

DoxyGen Documentation

Lastly, DoxyGen documentation contains description of the c++ code for the latest OpenViBE version.

Similarly, the box documentation contains the complete description of all OpenViBE Boxes.

Doxygen documentation for older OpenViBE versions is also available.