ADTF  3.18.2
IPlayerabstract

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

Inheritance diagram for IPlayer:
[legend]

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. More...
 
virtual adtf::services::elasto::IPlayer::tLoopMode GetLoopMode () const =0
 Retrieves the looping mode of the player. More...
 
virtual tResult SetPlaybackSpeed (float fPlaybackSpeed)=0
 Sets the playback speed of the player. More...
 
virtual float GetPlaybackSpeed () const =0
 Retrieves the current playback speed of the player. More...
 
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. More...
 
- 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. More...
 
virtual tResult ExtractAttachedFiles (const char *strAdtfDatFileNames, const char *strDestinationDirectory)=0
 Extracts all attached files from the given ADTF DAT files. More...
 
- 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. More...
 
virtual tTimeStamp GetLastTime () const =0
 Retrieves the last (chunk) time of the currently loaded files. More...
 
virtual uint64_t GetChunkCount () const =0
 Retrieves the (chunk) count of the currently loaded files. More...
 
virtual const char * GetCurrentFileNames () const =0
 Retrieves the list of the currently loaded files. More...
 
virtual tTimeStamp GetCurrentTime ()=0
 Retrieves the current (chunk) time of the player points to at time of call. More...
 
virtual int8_t GetState () const =0
 Retrieves the current state of the player as integer. More...
 
virtual tResult Play ()=0
 Sends a command to set the state to Playing state. More...
 
virtual tResult Pause ()=0
 Sends a command to set the state to Paused state. More...
 
virtual tResult SeekToTime (tTimeStamp tmTime)=0
 Sends a command to seek the chunk index to the given value. More...
 
virtual tResult SeekToChunkIndex (uint64_t ui64ChunkIndex)=0
 Sends a command to seek the chunk index to the given value. More...
 
virtual tResult Open (const char *strFileNames)=0
 Sends a command to open given filenames. More...
 
virtual tResult Close ()=0
 Sends a command to close current files. More...
 

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 adtf::services::ant::IRPCObjectServerRegistry.
 

Detailed Description

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

See also
adtf::remote::ant::cADTFRemoteSystem, adtf::services::ant::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]eLoopModethe 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]fPlaybackSpeedthe 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]nStepsThe number of steps to be done.
[in]eDirectionThe direction to step to.
[in]eItemsThe items to consider.
[in]bWaitWhether to block until the operation has finished or not.