adtf::services::elasto::IPlayer Class Reference

ADTF Playback Service Control interface to control the ADTF Player. More...

#include <player_intf.h>

Inherits adtf::services::bat::IPlayer.

Inherited by adtf::services::quiet::IPlayer.

Public Types
enum class	tLoopMode : uint32_t { DontLoop = 0 , SeekToStart , ChangeRunlevel }
enum class	tStepDirection : uint32_t { Forward , Backward }
enum class	tStepItems : uint32_t { Any , Samples , StreamTypes , Triggers }
Public Types inherited from adtf::services::ant::IPlayer
enum	tState : uint32_t { Closed = 0 , Paused = 1 , Streaming = 2 }

Public Member Functions
	ADTF_IID (IPlayer, "player.elasto.remote.adtf")
virtual tResult	SetLoopMode (const tLoopMode &eLoopMode)=0
virtual tLoopMode	GetLoopMode () const =0
virtual tResult	SetPlaybackSpeed (float fPlaybackSpeed)=0
virtual float	GetPlaybackSpeed () const =0
virtual tResult	Step (uint64_t nSteps, tStepDirection eDirection, tStepItems eItems, bool bWait)=0
Public Member Functions inherited from adtf::services::bat::IPlayer
	ADTF_IID (IPlayer, "player.bat.services.adtf.iid")
	Interface ID for the playback service interface.
virtual tResult	GetMarkers (adtf::base::ant::IString &&strMarkers) const =0
virtual tResult	ExtractAttachedFiles (const char *strAdtfDatFileNames, const char *strDestinationDirectory)=0
Public Member Functions inherited from adtf::services::ant::IPlayer
	ADTF_IID (IPlayer, "player.ant.services.adtf.iid")
	Interface ID for the playback service interface.
virtual tResult	Open (const char *strFileNames, bool bLoadReferencedFiles)=0
	Opens one or more adtfdat files.
virtual tResult	Close ()=0
	Closes the current loaded files.
virtual tResult	GetTimeRange (tTimeStamp &tmFirstItem, tTimeStamp &tmLastItem) const =0
virtual uint64_t	GetChunkCount () const =0
virtual tResult	GetCurrentFileNames (base::ant::IString &&strFileNames) const =0
virtual tTimeStamp	GetCurrentTime () const =0
virtual IPlayer::tState	GetCurrentState () const =0
virtual tResult	Play ()=0
virtual tResult	Pause ()=0
virtual tResult	Reset ()=0
virtual tResult	SeekToTime (tTimeStamp tmTime)=0
virtual tResult	SeekToChunkIndex (uint64_t ui64ChunkIndex)=0
virtual tResult	SeekToStreamIndex (uint16_t ui16StreamId, uint64_t ui64StreamIndex)=0
virtual tResult	ListStreams (IListStreamCallback &oCallback)=0
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Additional Inherited Members
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

ADTF Playback Service Control interface to control the ADTF Player.

This interface enables you to control an instance of ADTF Playback Service. Usually the ADTF Playback Service will be controlled by the Player. By following code the service will be controlled by you. Make sure the property "enable_control" is set to false, if you want to control it by yourself.

ucom::object_ptr<IPlayer> pPlayer;
// MIND: This call will only succeed if player is present and it will be called _AFTER_ the PlaybackService was
initialized! if (IS_OK(get_player(pPlayer))
{
    if (IS_OK(pPlayer->Open("c:/temp/my_test_file.adtfdat", true)))
    {
        pPlayer->Play();
    }
}
 

Remarks

Usually this Playback interface and the states of the Player does NOT depend on the Runlevel. Only the concrete implementation of the Player maps it to the StreamingGraph State.

Member Enumeration Documentation

tLoopMode

enum class adtf::services::elasto::IPlayer::tLoopMode : uint32_t

strong

Enumerator
DontLoop	do not loop at all
SeekToStart	loop via seek
ChangeRunlevel	loop via a runlevel change sequence

tStepDirection

enum class adtf::services::elasto::IPlayer::tStepDirection : uint32_t

strong

Enumerator
Forward	step forward
Backward	step backward

tStepItems

enum class adtf::services::elasto::IPlayer::tStepItems : uint32_t

strong

Enumerator
Any	each stream item is considered
Samples	only samples are considered
StreamTypes	only stream types samples are considered
Triggers	only triggers are considered

Member Function Documentation

GetLoopMode()

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

pure virtual

Retrieves the loop mode of the player.

Returns

the current looping mode

GetPlaybackSpeed()

virtual float adtf::services::elasto::IPlayer::GetPlaybackSpeed ( ) const

pure virtual

Retrieves the current playback speed of the player.

Returns

the current playback speed

SetLoopMode()

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

pure virtual

Sets the loop mode of the player.

Parameters

[in]

eLoopMode

the loop mode to be set

Returns

Standard result.

SetPlaybackSpeed()

virtual tResult adtf::services::elasto::IPlayer::SetPlaybackSpeed ( float fPlaybackSpeed )

pure virtual

Sets the playback speed of the player.

Parameters

[in]

fPlaybackSpeed

the playback speed to be set

Returns

Standard result.

Step()

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

pure virtual

Steps n items 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.

Returns

Standard result.

---

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

• src/libraries/base/include/plugins/player_intf.h