adtf::streaming::ant::ISampleQueueEventSink Class Reference

#include <samplequeue_intf.h>

Public Types
enum	tSampleQueueEvent : uint8_t { SQE_SampleQueueInserted = 0 , SQE_SampleQueueErased = 1 }
	specifies the several types of events More...

Public Member Functions
virtual tResult	OnSampleQueueEvent (uint32_t ui32Event, int nParam1, int nParam2, tTimeStamp tmTimeRange)=0

Detailed Description

The ISampleQueueEventSink provides methods to act upon sample queue events emitted by a sample queue.

Member Enumeration Documentation

tSampleQueueEvent

enum adtf::streaming::ant::ISampleQueueEventSink::tSampleQueueEvent : uint8_t

specifies the several types of events

Enumerator
SQE_SampleQueueInserted	Used when a Sample is added to the Queue. nParam1 set to 1. nParam2 is not used.
SQE_SampleQueueErased	Used when a Sample is deleted from Queue. nParam1 set to the current erasing count of this action (the number of call by one action starting with 1). nParam2 is used for the reason of deletion (0 = MaxSize was reached, 1 = TimeRange was reached, 2 = Pop function was called, 3 = Queue was cleared).

Member Function Documentation

OnSampleQueueEvent()

virtual tResult adtf::streaming::ant::ISampleQueueEventSink::OnSampleQueueEvent ( uint32_t ui32Event, int nParam1, int nParam2, tTimeStamp tmTimeRange )

pure virtual

This method gets called when a sample queue emits an event

Parameters

ui32Event	[in] The event identifier
nParam1	[in] User parameter 1
nParam2	[in] User parameter 2
tmTimeRange	[in] The current time range of the queue

Returns

Standard Result Code

---

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

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