OpenViBE Documentation 3.6.0
Scenario Player

Classes

struct  OpenViBE::SInitCmd
 Command that drives the initialization of the tool. More...
 
struct  OpenViBE::SLoadKernelCmd
 Command that drives kernel loading. More...
 
struct  OpenViBE::SLoadScenarioCmd
 Command that drives scenario loading. More...
 
struct  OpenViBE::SUpdateScenarioCmd
 Command that drives scenario update and export. More...
 
struct  OpenViBE::SResetCmd
 Command that drives tool reset to its initial state. More...
 
struct  OpenViBE::SRunScenarioCmd
 Command that drives the execution of a list of scenarios. More...
 
struct  OpenViBE::SSetupScenarioCmd
 Command that drives the setup of a scenario. More...
 
class  OpenViBE::CommandFileParser
 Parser implementation that parses command a file. More...
 
class  OpenViBE::CommandLineOptionParser
 Parser implementation that parses command from command-line arguments. More...
 
class  OpenViBE::CKernelFacade
 Wrapper class used to access Kernel features. More...
 
struct  OpenViBE::SCommand
 Base abstract struct for commands. More...
 
class  OpenViBE::ICommandParser
 Base abstract class for command parser. More...
 
struct  OpenViBE::SProgramOptionsTraits
 Helper class for ProgramOptions type checking. More...
 
class  OpenViBE::ProgramOptions< TFirst, TTypes >
 Command-line options parser. More...
 

Enumerations

enum class  OpenViBE::EPlayerReturnCodes {
  OpenViBE::EPlayerReturnCodes::Success = 0 , OpenViBE::EPlayerReturnCodes::InvalidArg , OpenViBE::EPlayerReturnCodes::MissingMandatoryArgument , OpenViBE::EPlayerReturnCodes::BadArg ,
  OpenViBE::EPlayerReturnCodes::OpeningFileFailure , OpenViBE::EPlayerReturnCodes::ParsingCommandFailure , OpenViBE::EPlayerReturnCodes::UnkownFailure , OpenViBE::EPlayerReturnCodes::KernelLoadingFailure ,
  OpenViBE::EPlayerReturnCodes::KernelInvalidDesc , OpenViBE::EPlayerReturnCodes::KernelInvalidContext , OpenViBE::EPlayerReturnCodes::KernelInternalFailure , OpenViBE::EPlayerReturnCodes::ScenarioNotLoaded
}
 Scenario player list of potential return code. More...
 
enum class  OpenViBE::EPlayerPlayMode { Standard = 0 , Fastfoward }
 Way of playing a scenario.
 

Detailed Description

Enumeration Type Documentation

◆ EPlayerReturnCodes

enum class OpenViBE::EPlayerReturnCodes
strong

Scenario player list of potential return code.

Enumerator
Success 

No error during execution.

InvalidArg 

Invalid command-line options.

MissingMandatoryArgument 

A mandatory argument is missing.

BadArg 

An argument is given with a wrong value.

OpeningFileFailure 

A file could not be opened.

ParsingCommandFailure 

General parsing command error.

UnkownFailure 

Error of unknown type.

KernelLoadingFailure 

Kernel loading failed.

KernelInvalidDesc 

Invalid kernel descriptor.

KernelInvalidContext 

Invalid kernel context.

KernelInternalFailure 

Generic error type for kernel internal error.

ScenarioNotLoaded 

Error triggered when an action is requested on an unknown scenario.