List of all members
IPlayerContext Class Referenceabstract
Kernel components » Scenario playback | Kernel components

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...

Inheritance diagram for IPlayerContext:
IKernelObject IObject

Public Member Functions

Messages sending
virtual OpenViBE::boolean sendSignal (const OpenViBE::Kernel::IMessageSignal &rMessageSignal)=0
 Sends signal to the kernel. More...
 
virtual OpenViBE::boolean sendMessage (const OpenViBE::Kernel::IMessageEvent &rMessageEvent, const OpenViBE::CIdentifier &rTargetIdentifier)=0
 Sends a message to another box. More...
 
virtual OpenViBE::boolean sendMessage (const OpenViBE::Kernel::IMessageEvent &rMessageEvent, const OpenViBE::CIdentifier *pTargetIdentifier, const OpenViBE::uint32 ui32TargetIdentifierCount)=0
 Broadcasts a message to several other boxes. More...
 
Time management
virtual OpenViBE::uint64 getCurrentTime (void) const =0
 Gets the current player time. More...
 
virtual OpenViBE::uint64 getCurrentLateness (void) const =0
 Gets the current player lateness. More...
 
virtual OpenViBE::float64 getCurrentCPUUsage (void) const =0
 Gets the current CPU use for the running processing unit. More...
 
virtual OpenViBE::float64 getCurrentFastForwardMaximumFactor (void) const =0
 Gets the current fast forward factor to be used when the getStatus states the player runs in fast forward mode. More...
 
Player control
virtual OpenViBE::boolean stop (void)=0
 Stops player execution. More...
 
virtual OpenViBE::boolean pause (void)=0
 Pauses player execution. More...
 
virtual OpenViBE::boolean play (void)=0
 Makes player run normal speed. More...
 
virtual OpenViBE::boolean forward (void)=0
 Makes player run as fast as possible. More...
 
virtual OpenViBE::Kernel::EPlayerStatus getStatus (void) const =0
 Gets current player status. More...
 
Give access to some managers
virtual OpenViBE::Kernel::IConfigurationManager & getConfigurationManager (void) const =0
 Gets the current player's configuration manager. More...
 
virtual OpenViBE::Kernel::IAlgorithmManager & getAlgorithmManager (void) const =0
 Gets the current player's algorithm manager. More...
 
virtual OpenViBE::Kernel::ILogManager & getLogManager (void) const =0
 Gets the current player's log manager. More...
 
virtual OpenViBE::Kernel::IErrorManager & getErrorManager (void) const =0
 Gets the current player's error manager. More...
 
virtual OpenViBE::Kernel::IScenarioManager & getScenarioManager (void) const =0
 Gets the current player's scenario manager. More...
 
virtual OpenViBE::Kernel::ITypeManager & getTypeManager (void) const =0
 Gets the current player's type manager. More...
 
virtual bool canCreatePluginObject (const OpenViBE::CIdentifier &pluginIdentifier) const =0
 
virtual OpenViBE::Plugins::IPluginObject * createPluginObject (const OpenViBE::CIdentifier &pluginIdentifier) const =0
 
virtual bool releasePluginObject (OpenViBE::Plugins::IPluginObject *pluginObject) const =0
 
- Public Member Functions inherited from IObject
virtual OpenViBE::CIdentifier getClassIdentifier (void) const =0
 Returns the final class identifier of the concrete class. More...
 
virtual OpenViBE::boolean isDerivedFromClass (const OpenViBE::CIdentifier &rClassIdentifier) const
 Checks if this object is compatible with a class identifier. More...
 
virtual OpenViBE::boolean acceptVisitor (OpenViBE::IObjectVisitor &rObjectVisitor)
 Requests this object to accept a visitor. More...
 

Detailed Description

Player interface for plugin objects

Instances of this class are given to plugin object so they can communicate with the platform kernel, providing services such as message sending etc...

Author
Yann Renard (INRIA/IRISA)
Date
2006-07-07

Member Function Documentation

virtual OpenViBE::boolean sendSignal ( const OpenViBE::Kernel::IMessageSignal &  rMessageSignal)
pure virtual

Sends signal to the kernel.

Parameters
rMessageSignal[in] : the signal message to send
Returns
true in case of success, false in other cases.
virtual OpenViBE::boolean sendMessage ( const OpenViBE::Kernel::IMessageEvent &  rMessageEvent,
const OpenViBE::CIdentifier &  rTargetIdentifier 
)
pure virtual

Sends a message to another box.

Parameters
rMessageEvent[in] : the message to send to the other box
rTargetIdentifier[in] : the identifier of the other box
Returns
true in case of success, false in other cases.
virtual OpenViBE::boolean sendMessage ( const OpenViBE::Kernel::IMessageEvent &  rMessageEvent,
const OpenViBE::CIdentifier *  pTargetIdentifier,
const OpenViBE::uint32  ui32TargetIdentifierCount 
)
pure virtual

Broadcasts a message to several other boxes.

Parameters
rMessageEvent[in] : the message to send
pTargetIdentifier[in] : a pointer containing all the targets which should receive the sent message.
ui32TargetIdentifierCount[in] : the number of targets contained in the pTargetIdentifier array.
Returns
true in case of success, false in other cases.
virtual OpenViBE::uint64 getCurrentTime ( void  ) const
pure virtual

Gets the current player time.

Returns
the current player time.
Note
The time value is fixed point 32:32 representated in seconds
virtual OpenViBE::uint64 getCurrentLateness ( void  ) const
pure virtual

Gets the current player lateness.

Returns
the current player lateness
Note
The lateness is fixed point 32:32 representated in seconds
virtual OpenViBE::float64 getCurrentCPUUsage ( void  ) const
pure virtual

Gets the current CPU use for the running processing unit.

Returns
the current CPU use
virtual OpenViBE::float64 getCurrentFastForwardMaximumFactor ( void  ) const
pure virtual

Gets the current fast forward factor to be used when the getStatus states the player runs in fast forward mode.

Returns
the current fast forward factor
virtual OpenViBE::boolean stop ( void  )
pure virtual

Stops player execution.

Returns
true in case of success.
false in case of error.
Warning
Once the player is stopped, there's no way to restart it
virtual OpenViBE::boolean pause ( void  )
pure virtual

Pauses player execution.

Returns
true in case of success.
false in case of error.
virtual OpenViBE::boolean play ( void  )
pure virtual

Makes player run normal speed.

Returns
true in case of success.
false in case of error.
virtual OpenViBE::boolean forward ( void  )
pure virtual

Makes player run as fast as possible.

Returns
true in case of success.
false in case of error.
virtual OpenViBE::Kernel::EPlayerStatus getStatus ( void  ) const
pure virtual

Gets current player status.

Returns
current player status
virtual OpenViBE::Kernel::IConfigurationManager& getConfigurationManager ( void  ) const
pure virtual

Gets the current player's configuration manager.

Returns
The current player's configuration manager
Warning
The plugin object should not use this reference after it has finished its work, it could be deprecated.
virtual OpenViBE::Kernel::IAlgorithmManager& getAlgorithmManager ( void  ) const
pure virtual

Gets the current player's algorithm manager.

Returns
The current player's algorithm manager
Warning
The plugin object should not use this reference after it has finished its work, it could be deprecated.
virtual OpenViBE::Kernel::ILogManager& getLogManager ( void  ) const
pure virtual

Gets the current player's log manager.

Returns
The current player's log manager
Warning
The plugin object should not use this reference after it has finished its work, it could be deprecated.
virtual OpenViBE::Kernel::IErrorManager& getErrorManager ( void  ) const
pure virtual

Gets the current player's error manager.

Returns
The current player's error manager
Warning
The plugin object should not use this reference after it has finished its work, it could be deprecated.
virtual OpenViBE::Kernel::IScenarioManager& getScenarioManager ( void  ) const
pure virtual

Gets the current player's scenario manager.

Returns
The current player's scenario manager
Warning
The plugin object should not use this reference after it has finished its work, it could be deprecated.
virtual OpenViBE::Kernel::ITypeManager& getTypeManager ( void  ) const
pure virtual

Gets the current player's type manager.

Returns
The current player's type manager
Warning
The plugin object should not use this reference after it has finished its work, it could be deprecated.
Generated on Tue Jun 26 2012 15:25:54 for Documentation by  doxygen 1.7.4