ADTF  3.18.3
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.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 124 of file adtf_remote_player_intf.h.

Member Function Documentation

◆ ExtractAttachedFiles()

virtual tResult ExtractAttachedFiles ( const char *  strAdtfDatFileNames,
const char *  strDestinationDirectory 
)
pure virtual

Extracts all attached files from the given ADTF DAT files.

This method also registers macros in the following form: "AF:<tag_name>".

Parameters
strAdtfDatFileNames[in] A comma separated list of file names.
strDestinationDirectory[in] The directory where the files should be extracted to.
Returns
Standard result.

◆ GetMarkers()

virtual const char* GetMarkers ( ) const
pure virtual

Returns all marker information in an XML string.

Returns
all marker information in an XML string.