Kernel components

Classes

class  IAlgorithmContext
 Exectution context for algorithm objects. More...
class  IAlgorithmManager
 Manager for all kind of plugin algorithms. More...
class  IAlgorithmProto
 Prototype interface for algorithm. More...
class  IAlgorithmProxy
 Application interface to an algorithm plugin. More...
class  IConfigurationManager
 Manager for all kind of configuration. More...
class  ILogListener
 Log manager's listener interface. More...
class  ILogManager
 Log manager. More...
class  IConfigurable
 Configurable object interface. More...
class  IKernelDesc
 A kernel description. More...
class  IKernelObject
 Base class for all kernel objects. More...
class  IKernelObjectFactory
 Kernel object factory, creates all kernel objects. More...
class  IObjectVisitorContext
 Exectution context for visitor objects. More...
class  IParameter
 Generic parameter handler for configurable objects. More...
class  TParameterHandler< T >
 Helper class in order to manipulate IParameter and IParameter values natively. More...
class  IBoxAlgorithmContext
 Specific context to use for box algorithm pluginsThis 'context' is given by the player to an algorithm plugin so it has all the necessary tools to work. This algorithm context mainly consists in getting other contexts which could be defined and used more generically (such as the box interface or a global player interface for example). More...
class  IMessage
 Base message class. More...
class  IMessageClock
 Clock message. More...
class  IMessageEvent
 Event message. More...
class  IMessageSignal
 Signal message. More...
class  IMessageWithData
 A type of message that can contain different kinds of arbitrary dataA message that can contain different kinds of data. The intended usage is for the message to be exchanged between boxes. A message can hold four types of data: uint64, float64, CString and IMatrix. Each data item is accessed by its string identifier key using a getter/setter corresponding to the data type. The key is unique within the data type. More...
class  IPlayer
 The main player classA player is responsible for the playback of a specific scenario. This player scenario is provided at initialisation stage and should not be changed until the player terminates. The player idea of calling a "play" function forces the use of threads in order to avoid CPU locking. Thus we prefer the idea of having a "short-time" function that is to be called repeatedly until the player terminates. This is the role of the IPlayer::loop function, that should be called repeatedly by the outside application. More...
class  IPlayerContext
 Player interface for plugin objectsInstances of this class are given to plugin object so they can communicate with the platform kernel, providing services such as message sending etc... More...
class  IPlayerManager
 The manager responsible for scenario playbackThe player manager is responsible for creating the different player instances. Each player is responsible for the playback of a specific scenario. More...
class  IPluginManager
 Log manager. More...
class  IPluginModule
 Plugin module. More...
class  IPluginModuleContext
 Plugin context. More...
class  IAttributable
class  IBox
 Complete OpenViBE box interfaceThis interface can be used in order to fully describe an OpenViBE black box. It describes its identification values, its inputs, its outputs and its settings. More...
class  IBoxIO
 Main OpenViBE box interface to communicate with the kernelThis context allows the object which uses it to check inputs states, read them, write outputs while being in a dynamic context (used by player). More...
class  IBoxListenerContext
 Exectution context for box algorithm descriptors. More...
class  IBoxProto
 OpenViBE box prototypeThis class is used by a plugin algorithm descriptor to let the OpenViBE platform know what an algorithm box looks like. It declares several things, like it input types, output types and settings. More...
class  IComment
 A comment class for scenariosThis interface can be used in order to fully describe an OpenViBE comment in order to help the understanding of a given scenario. More...
class  ILink
 Link information between OpenViBE boxThis class collects informations between OpenViBE boxes : box identifiers and input / output indices. More...
class  IProcessingUnit
 Processing unit information for OpenViBE boxes. More...
class  IScenario
 A static OpenViBE scenarioThis class is a static scenario description. It is used to manipulate an OpenViBE box/connection collection... More...
class  IScenarioManager
 The scenario managerThis manager is responsible to organize and handle all the scenarios of the kernel. More...
class  IServerExtensionContext
 Static context of a Server Extension object. More...
class  IServerExtensionDynamicContext
 Dynamic context of a Server Extension objectThis class contains accessors to data structures made available by the driver running in the Acquisition Server during the acquisition. More...
class  IServerExtensionProto
 Prototype interface for a server extension. More...

Modules

 Algorithms management
 Configuration management
 Log and traces
 Scenario playback
 Plugins management
 Scenario management
 Visuals and displays