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...
Inherits IKernelObject.
Inherited by TKernelObject< OpenViBE::Kernel::IPlayerManager >.
Public Member Functions | |
virtual OpenViBE::boolean | createPlayer (OpenViBE::CIdentifier &rPlayerIdentifier)=0 |
Creates a new player. More... | |
virtual OpenViBE::boolean | releasePlayer (const OpenViBE::CIdentifier &rPlayerIdentifier)=0 |
Releases a specific player. More... | |
virtual OpenViBE::Kernel::IPlayer & | getPlayer (const OpenViBE::CIdentifier &rPlayerIdentifier)=0 |
Gets a specific player instance, provided its identifier. More... | |
virtual OpenViBE::CIdentifier | getNextPlayerIdentifier (const OpenViBE::CIdentifier &rPreviousIdentifier) const =0 |
Gets next player identifier. More... | |
Detailed Description
The manager responsible for scenario playback
The player manager is responsible for creating the different player instances. Each player is responsible for the playback of a specific scenario.
- Date
- 2006-07-21
Member Function Documentation
|
pure virtual |
Creates a new player.
- Parameters
-
rPlayerIdentifier [out] : the identifier of the created player
- Returns
- true in case of success.
- false in case of error.
|
pure virtual |
Releases a specific player.
- Parameters
-
rPlayerIdentifier [in] : the identifier of the player to release
- Returns
- true in case of success.
- false in case of error.
Releasing a player means the player instance won't be used any more, thus the player manager can release any allocated resource / memory for this player.
|
pure virtual |
Gets a specific player instance, provided its identifier.
- Parameters
-
rPlayerIdentifier [in] : the identifier of the player instance to return
- Returns
- A reference on the player instance
- Warning
- Using a non player identifier will cause a crash
|
pure virtual |
Gets next player identifier.
- Parameters
-
rPreviousIdentifier [in] : The identifier for the preceeding player
- Returns
- The identifier of the next player in case of success.
-
OV_UndefinedIdentifier
on error.
- Note
- Giving
OV_UndefinedIdentifier
asrPreviousIdentifier
will cause this function to return the first player identifier.
Generated on Tue Jun 26 2012 15:25:54 for Documentation by
