adtf::remote::ant::IPlayer Class Reference

#include <adtf_remote_player_intf.h>

Inherited by adtf::remote::bat::IPlayer.

Public Member Functions
	ADTF_IID (IPlayer, "player.ant.remote.adtf")
virtual tTimeStamp	GetFirstTime () const =0
virtual tTimeStamp	GetLastTime () const =0
virtual uint64_t	GetChunkCount () const =0
virtual const char *	GetCurrentFileNames () const =0
virtual tTimeStamp	GetCurrentTime ()=0
virtual int8_t	GetState () const =0
virtual tResult	Play ()=0
virtual tResult	Pause ()=0
virtual tResult	SeekToTime (tTimeStamp tmTime)=0
virtual tResult	SeekToChunkIndex (uint64_t ui64ChunkIndex)=0
virtual tResult	Open (const char *strFileNames)=0
virtual tResult	Close ()=0

Static Public Attributes
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.

Member Function Documentation

Close()

virtual tResult adtf::remote::ant::IPlayer::Close ( )

pure virtual

Sends a command to close current files

Returns

standard error code

GetChunkCount()

virtual uint64_t adtf::remote::ant::IPlayer::GetChunkCount ( ) const

pure virtual

Retrieves the (chunk) count of the currently loaded files.

Returns

chunk count

Return values

0	no files loaded

GetCurrentFileNames()

virtual const char * adtf::remote::ant::IPlayer::GetCurrentFileNames ( ) const

pure virtual

Retrieves the list of the currently loaded files.

Returns

comma separated list of the currently loaded files

Return values

""	if no files are loaded

GetCurrentTime()

virtual tTimeStamp adtf::remote::ant::IPlayer::GetCurrentTime ( )

pure virtual

Retrieves the current (chunk) time of the player points to at time of call.

Returns

the current time

Return values

-1	if no files are loaded

GetFirstTime()

virtual tTimeStamp adtf::remote::ant::IPlayer::GetFirstTime ( ) const

pure virtual

Retrieves the first (chunk) time of the currently loaded files.

Returns

The first (chunk) time of the currently loaded files

Return values

-1	no file loaded

GetLastTime()

virtual tTimeStamp adtf::remote::ant::IPlayer::GetLastTime ( ) const

pure virtual

Retrieves the last (chunk) time of the currently loaded files.

Returns

The last (chunk) time of the currently loaded files

Return values

-1	no file loaded

GetState()

virtual int8_t adtf::remote::ant::IPlayer::GetState ( ) const

pure virtual

Retrieves the current state of the player as integer.

Returns

the current state, see adtf::services::ant::IPlayer::tState

Return values

-1	if no player is loaded

Open()

virtual tResult adtf::remote::ant::IPlayer::Open ( const char * strFileNames )

pure virtual

Sends a command to open given filenames

Parameters

[in]

strFileNames

List of Files

Remarks

this must be a local path of the players process!

Returns

standard error code

Pause()

virtual tResult adtf::remote::ant::IPlayer::Pause ( )

pure virtual

Sends a command to set the state to Paused state

Returns

standard error code

Play()

virtual tResult adtf::remote::ant::IPlayer::Play ( )

pure virtual

Sends a command to set the state to Playing state

Returns

standard error code

SeekToChunkIndex()

virtual tResult adtf::remote::ant::IPlayer::SeekToChunkIndex ( uint64_t ui64ChunkIndex )

pure virtual

Sends a command to seek the chunk index to the given value

Parameters

[in]

ui64ChunkIndex

chunkindex within the range

Returns

standard error code

See also

GetChunkCount

SeekToTime()

virtual tResult adtf::remote::ant::IPlayer::SeekToTime ( tTimeStamp tmTime )

pure virtual

Sends a command to seek the chunk index to the given value

Parameters

[in]

tmTime

chunkindex within the range

Returns

standard error code

See also

GetFirstTime, GetLastTime

---

The documentation for this class was generated from the following file:

• src/libraries/adtfremotesdk/include/adtfremotesdk/adtf_remote_player_intf.h