#include <sample_intf.h>

Inherits adtf::streaming::hollow::ISample.

Public Member Functions
	ADTF_IID (ISample, "sample.thor.streaming.adtf.iid")
	definition of interface id

virtual tResult	Set (const ant::ISample &oSample, size_t nOffset, size_t nSize)=0

virtual tResult	SetSampleBuffer (const ucom::ant::iobject_ptr< const ISampleBuffer > &pBuffer)=0

Public Member Functions inherited from adtf::streaming::hollow::ISample
	ADTF_IID (ISample, "sample.hollow.streaming.adtf.iid")
	definition of interface id

virtual uint32_t	GetSubStreamId () const =0

virtual void	SetSubStreamId (uint32_t nSubStreamId)=0

Public Member Functions inherited from adtf::streaming::flash::ISample
	ADTF_IID (ISample, "sample.flash.streaming.adtf.iid")
	definition of interface id

virtual base::flash::tNanoSeconds	GetTimeNs () const =0

virtual tResult	SetTime (base::flash::tNanoSeconds tmTimeStamp)=0

virtual tResult	Set (base::flash::tNanoSeconds tmTimeStamp, const void *pData, size_t szSize, uint32_t ui32Flags=0)=0

virtual tResult	SetTime (tTimeStamp tmTimeStamp)=0

virtual tResult	Set (const ISample &oSample)=0

virtual tResult	Set (tTimeStamp tmTimeStamp, const void *pData, size_t szSize, uint32_t ui32Flags=0)=0

Public Member Functions inherited from adtf::streaming::ant::ISample
	ADTF_IID (ISample, "sample.ant.streaming.adtf.iid")
	definition of interface id

virtual tResult	Lock (ucom::ant::iobject_ptr_shared_locked< const ISampleBuffer > &oSampleBuffer) const =0

virtual tResult	WriteLock (ucom::ant::iobject_ptr_locked< ISampleBuffer > &pSampleBuffer, size_t szPreAllocateSize)=0

virtual tResult	Set (const ISample &oSample)=0

virtual tResult	Get (ISample &oSample) const =0

virtual tResult	Reset ()=0

virtual uint32_t	GetFlags () const =0

virtual tResult	SetFlags (uint32_t ui32Flags)=0

virtual tResult	GetSampleBufferFactory (ucom::ant::iobject_ptr< ISampleBufferFactory > &oFactory) const =0

virtual tResult	GetSampleInfo (ucom::ant::iobject_ptr< const ISampleInfo > &oSampleInfo) const =0

virtual tResult	GetSampleInfo (ucom::ant::iobject_ptr< ISampleInfo > &oSampleInfo)=0

virtual tResult	GetSampleLog (ucom::ant::iobject_ptr< ISampleLog > &oSampleLog) const =0

virtual tTimeStamp	GetTime () const =0

Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Protected Member Functions
	~ISample ()=default
	not destructable

Protected Member Functions inherited from adtf::streaming::hollow::ISample
	~ISample ()=default
	not destructable

Protected Member Functions inherited from adtf::streaming::flash::ISample
	~ISample ()=default
	not destructable

Protected Member Functions inherited from adtf::streaming::ant::ISample
	~ISample ()=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::streaming::ant::ISample
enum	eFlags : uint32_t { SF_None = 0x0 , SF_SyncPoint = 0x2 , SF_AbsoluteTime = 0x4 , SF_DataFromADTF1 = 0x8 , SF_VideoKeyFrame = 0x10 , SF_SampleLogEnabled = 0x40 , SF_SampleLogPresent = 0x80 , SF_SampleInfoPresent = 0x100 , SF_AllowBufferSharing = 0x400 }

Detailed Description

The ISample interface sets and retrieves properties on samples .

For information on realtime safety please have a look at the documentation of the default implementation adtf::streaming::ant::cSample.

Member Function Documentation

◆ Set()

virtual tResult adtf::streaming::thor::ISample::Set	(	const ant::ISample &	oSample,
		size_t	nOffset,
		size_t	nSize )

pure virtual

Copies all meta data from a source sample and references a sub section of the source sample buffer.

Parameters

[in]	oSample	The source sample.
[in]	nOffset	The offset within the sample buffer of the source.
[in]	nSize	The size of the sub section.

Returns: Standard result.

◆ SetSampleBuffer()

virtual tResult adtf::streaming::thor::ISample::SetSampleBuffer ( const ucom::ant::iobject_ptr< const ISampleBuffer > & pBuffer )

pure virtual

Attaches the given sample buffer to the sample.

Parameters

[in] pBuffer The sample buffer.

Returns: Standard result.

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

src/libraries/streaming3/include/adtfstreaming3/sample_intf.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Set()

◆ SetSampleBuffer()