IPlayerContext Class Referenceabstract

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

Inherits IKernelObject.

Inherited by TKernelObject< OpenViBE::Kernel::IPlayerContext >.

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...
 
virtual OpenViBE::boolean sendMessage (const OpenViBE::Kernel::IMessageWithData &message, OpenViBE::uint32 outputIndex)=0
 Sends a message to a box message output, forward the call to CSimulatedBox then CScheduler. More...
 
virtual
OpenViBE::Kernel::IMessageWithData
createMessage (void)=0
 Creates a message in the CSimulatedBox. More...
 
Time management
virtual OpenViBE::uint64 getCurrentTime (void)=0
 Gets the current player time. 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)=0
 Gets the current player' configuration manager. More...
 
virtual
OpenViBE::Kernel::IAlgorithmManager
getAlgorithmManager (void)=0
 Gets the current player' algorithm manager. More...
 
virtual
OpenViBE::Kernel::ILogManager
getLogManager (void)=0
 Gets the current player' log manager. More...
 
virtual
OpenViBE::Kernel::IScenarioManager
getScenarioManager (void)=0
 Gets the current player' scenario manager. More...
 
virtual
OpenViBE::Kernel::ITypeManager
getTypeManager (void)=0
 Gets the current player' type manager. 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::boolean sendMessage ( const OpenViBE::Kernel::IMessageWithData message,
OpenViBE::uint32  outputIndex 
)
pure virtual

Sends a message to a box message output, forward the call to CSimulatedBox then CScheduler.

Parameters
message[in] : the message to send
outputIndex[in] : the index of the message output to send the message from
Returns
true in case of success, false in other cases.
virtual OpenViBE::Kernel::IMessageWithData& createMessage ( void  )
pure virtual

Creates a message in the CSimulatedBox.

Returns
a reference to the created message
Warning
Messages are erased at each cycle so the reference is only valid for one cycle
virtual OpenViBE::uint64 getCurrentTime ( void  )
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::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  )
pure virtual

Gets the current player' configuration manager.

Returns
The current player' configuration manager
virtual OpenViBE::Kernel::IAlgorithmManager& getAlgorithmManager ( void  )
pure virtual

Gets the current player' algorithm manager.

Returns
The current player' algorithm manager
virtual OpenViBE::Kernel::ILogManager& getLogManager ( void  )
pure virtual

Gets the current player' log manager.

Returns
The current player' log manager
virtual OpenViBE::Kernel::IScenarioManager& getScenarioManager ( void  )
pure virtual

Gets the current player' scenario manager.

Returns
The current player' scenario manager
virtual OpenViBE::Kernel::ITypeManager& getTypeManager ( void  )
pure virtual

Gets the current player' type manager.

Returns
The current player' type manager