IPlayer

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:

Public Member Functions
	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...

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.

Definition at line 26 of file adtf_remote_player_intf.h.

Member Function Documentation

Close()

virtual tResult Close ( )

pure virtual

Sends a command to close current files.

Returns

standard error code

GetChunkCount()

virtual uint64_t 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* 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 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 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 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 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 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 Pause ( )

pure virtual

Sends a command to set the state to Paused state.

Returns

standard error code

Play()

virtual tResult Play ( )

pure virtual

Sends a command to set the state to Playing state.

Returns

standard error code

SeekToChunkIndex()

virtual tResult 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 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