IPlayer

The Remote Player interface provides access to retrieve information about and control the current IPlayer within a ADTF System instance. More...

#include <adtf_remote_player_intf.h>

Inheritance diagram for IPlayer:

Public Member Functions
	ADTF_IID (IPlayer, "player.elasto.remote.adtf")
virtual tResult	SetLoopMode (const adtf::services::elasto::IPlayer::tLoopMode &eLoopMode)=0
	Sets the looping mode of the player.
virtual adtf::services::elasto::IPlayer::tLoopMode	GetLoopMode () const =0
	Retrieves the looping mode of the player.
virtual tResult	SetPlaybackSpeed (float fPlaybackSpeed)=0
	Sets the playback speed of the player.
virtual float	GetPlaybackSpeed () const =0
	Retrieves the current playback speed of the player.
virtual tResult	Step (uint64_t nSteps, const adtf::services::elasto::IPlayer::tStepDirection &eDirection, adtf::services::elasto::IPlayer::tStepItems eItems, bool bWait)=0
	Steps n samples in given direction.
Public Member Functions inherited from IPlayer
	ADTF_IID (IPlayer, "player.bat.remote.adtf")
virtual const char *	GetMarkers () const =0
	Returns all marker information in an XML string.
virtual tResult	ExtractAttachedFiles (const char *strAdtfDatFileNames, const char *strDestinationDirectory)=0
	Extracts all attached files from the given ADTF DAT files.
Public Member Functions inherited from IPlayer
	ADTF_IID (IPlayer, "player.ant.remote.adtf")
virtual tTimeStamp	GetFirstTime () const =0
	Retrieves the first (chunk) time of the currently loaded files.
virtual tTimeStamp	GetLastTime () const =0
	Retrieves the last (chunk) time of the currently loaded files.
virtual uint64_t	GetChunkCount () const =0
	Retrieves the (chunk) count of the currently loaded files.
virtual const char *	GetCurrentFileNames () const =0
	Retrieves the list of the currently loaded files.
virtual tTimeStamp	GetCurrentTime ()=0
	Retrieves the current (chunk) time of the player points to at time of call.
virtual int8_t	GetState () const =0
	Retrieves the current state of the player as integer.
virtual tResult	Play ()=0
	Sends a command to set the state to Playing state.
virtual tResult	Pause ()=0
	Sends a command to set the state to Paused state.
virtual tResult	SeekToTime (tTimeStamp tmTime)=0
	Sends a command to seek the chunk index to the given value.
virtual tResult	SeekToChunkIndex (uint64_t ui64ChunkIndex)=0
	Sends a command to seek the chunk index to the given value.
virtual tResult	Open (const char *strFileNames)=0
	Sends a command to open given filenames.
virtual tResult	Close ()=0
	Sends a command to close current files.

Additional Inherited Members
Static Public Attributes inherited from IPlayer
static constexpr const tChar *const	DEFAULT_NAME = "player"
	The default name the player is registered to the IRPCObjectServerRegistry.

Detailed Description

The Remote Player interface provides access to retrieve information about and control the current IPlayer within a ADTF System instance.

See also

cADTFRemoteSystem, IPlayer.

Definition at line 156 of file adtf_remote_player_intf.h.

Member Function Documentation

GetLoopMode()

virtual adtf::services::elasto::IPlayer::tLoopMode GetLoopMode ( ) const

pure virtual

Retrieves the looping mode of the player.

Throws if loop mode cannot be queried.

Returns

the current looping mode

GetPlaybackSpeed()

virtual float GetPlaybackSpeed ( ) const

pure virtual

Retrieves the current playback speed of the player.

Throws if playback speed cannot be queried.

Returns

the current playback speed

SetLoopMode()

virtual tResult SetLoopMode ( const adtf::services::elasto::IPlayer::tLoopMode & eLoopMode )

pure virtual

Sets the looping mode of the player.

Throws if changing loop cannot be done.

Parameters

[in]

eLoopMode

the loop mode to be set

SetPlaybackSpeed()

virtual tResult SetPlaybackSpeed ( float fPlaybackSpeed )

pure virtual

Sets the playback speed of the player.

Throws if changing playback speed cannot be done.

Parameters

[in]

fPlaybackSpeed

the playback speed to be set

Step()

virtual tResult Step ( uint64_t nSteps, const adtf::services::elasto::IPlayer::tStepDirection & eDirection, adtf::services::elasto::IPlayer::tStepItems eItems, bool bWait )

pure virtual

Steps n samples in given direction.

Parameters

[in]	nSteps	The number of steps to be done.
[in]	eDirection	The direction to step to.
[in]	eItems	The items to consider.
[in]	bWait	Whether to block until the operation has finished or not.