adtf::services::flash::IReferenceClock Class Reference

The IReferenceClock interface provides the reference time source for the filter graph. More...

#include <reference_clock_intf.h>

Inherits adtf::services::ant::IReferenceClock.

Inherited by adtf::services::giant::IReferenceClock.

Classes
class	IClock
class	ISync2RefChannel
struct	tReferenceClockEvent

Public Member Functions
	ADTF_IID (IReferenceClock, "reference_clock.flash.streaming.adtf.iid")
virtual base::flash::tNanoSeconds	GetTimeNs () const =0
virtual base::flash::tNanoSeconds	GetStreamTimeNs () const =0
virtual tResult	GetSync2RefChannel (adtf::ucom::ant::iobject_ptr< ISync2RefChannel > &pSync2RefChannel, const char *strName=nullptr, const char *strMethod=nullptr) const =0
virtual tResult	GetSync2RefChannel (adtf::ucom::ant::iobject_ptr< ISync2RefChannel > &pSync2RefChannel, const char *strName=nullptr, const char *strMethod=nullptr) const=0
Public Member Functions inherited from adtf::services::ant::IReferenceClock
	ADTF_IID (IReferenceClock, "reference_clock.ant.streaming.adtf.iid")
virtual tTimeStamp	GetTime () const =0
virtual tTimeStamp	GetStreamTime () const =0
virtual tResult	RegisterClock (const adtf::ucom::ant::iobject_ptr< IClock > &pClock)=0
virtual tResult	UnregisterClock (const adtf::ucom::ant::iobject_ptr< IClock > &pClock)=0
virtual tResult	GetClocks (IClockListCallback &oCallback) const =0
virtual tResult	GetClock (const char *strName, adtf::ucom::ant::iobject_ptr< IClock > &pClock) const =0
virtual tResult	SetMainClock (const char *strName)=0
virtual tResult	GetMainClock (adtf::base::ant::IString &&strName) const =0
virtual tResult	SetStreamClock (const char *strName)=0
virtual tResult	GetStreamClock (adtf::base::ant::IString &&strName) const =0
virtual tResult	RegisterSync2RefFactory (const adtf::ucom::ant::iobject_ptr< ISync2RefChannelFactory > &oSync2RefFactory)=0
virtual tResult	UnregisterSync2RefFactory (const adtf::ucom::ant::iobject_ptr< ISync2RefChannelFactory > &oSync2RefFactory)=0
virtual tResult	ListSync2RefMethods (ISync2RefListCallback &oCallback)=0
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Protected Member Functions
	~IReferenceClock ()=default
	not destructable
Protected Member Functions inherited from adtf::services::ant::IReferenceClock
	~IReferenceClock ()=default
	not destructable
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Additional Inherited Members
Public Types inherited from adtf::services::ant::IReferenceClock
enum	tReferenceClockEventId { EVENT_TimeResetBegin = 0x0000 , EVENT_TimeResetEnd = 0x0001 , EVENT_TimeUpdate = 0x0004 }
Static Public Attributes inherited from adtf::services::ant::IReferenceClock
static const int	ADTF_MAX_CLOCK_NAME_LENGTH = 256

Detailed Description

The IReferenceClock interface provides the reference time source for the filter graph.

See also Clock Handling for further information on timings within ADTF. Default implementation of provide service is reached by CID_ADTF_REFERENCE_CLOCK.

Member Function Documentation

ADTF_IID()

adtf::services::flash::IReferenceClock::ADTF_IID	(	IReferenceClock	,
		"reference_clock.flash.streaming.adtf.iid"	)

Marks the IReferenceClock to be castable with the adtf::ucom::ant::ucom_cast

See also

ADTF_IID(_interface, _striid)

GetSync2RefChannel() [1/2]

virtual tResult adtf::services::flash::IReferenceClock::GetSync2RefChannel ( adtf::ucom::ant::iobject_ptr< ISync2RefChannel > & pSync2RefChannel, const char * strName = nullptr, const char * strMethod = nullptr ) const

pure virtual

Returns a new instance of a Sync2Ref Channel implementation.

Parameters

[out]	pSync2RefChannel	The pointer to the new instance.
[in]	strName	An optional name of the channel (for logging purposes, need not be unique)
[in]	strMethod	If given this method will be used, otherwise the set default.

Return values

ERR_NOT_FOUND

There is no such Sync2Ref method available

Deprecated

Use GetSync2RefChannel(adtf::ucom::ant::iobject_ptr<ISync2RefChannel>& pSync2RefChannel, const char* strName = nullptr, const char* strMethod = nullptr) instead.

Implemented in adtf::services::giant::IReferenceClock, adtf::services::IReferenceClock, adtf::services::osborn::IReferenceClock, adtf::services::riddler::IReferenceClock, and adtf::services::vision::IReferenceClock.

GetSync2RefChannel() [2/2]

virtual tResult adtf::services::ant::IReferenceClock::GetSync2RefChannel ( adtf::ucom::ant::iobject_ptr< ISync2RefChannel > & pSync2RefChannel, const char * strName = nullptr, const char * strMethod = nullptr ) const

virtual

Returns a new instance of a Sync2Ref Channel implementation.

Parameters

[out]	pSync2RefChannel	The pointer to the new instance.
[in]	strName	An optional name of the channel (for logging purposes, need not be unique)
[in]	strMethod	If given this method will be used, otherwise the set default.

Return values

ERR_NOT_FOUND

There is no such Sync2Ref method available

Deprecated

Use GetSync2RefChannel(adtf::ucom::ant::iobject_ptr<ISync2RefChannel>& pSync2RefChannel, const char* strName = nullptr, const char* strMethod = nullptr) instead.

Implements adtf::services::ant::IReferenceClock.

Reimplemented in adtf::services::giant::IReferenceClock, adtf::services::IReferenceClock, adtf::services::osborn::IReferenceClock, adtf::services::riddler::IReferenceClock, and adtf::services::vision::IReferenceClock.

---

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

• src/libraries/streaming3/include/adtfstreaming3/reference_clock_intf.h