TMediaSampleSink< SampleType > Class Template Reference

#include <MediaSampleSink.h>

Inheritance diagram for TMediaSampleSink< SampleType >:

Public Member Functions
virtual bool	Enqueue (const TSharedRef< SampleType, ESPMode::ThreadSafe > &Sample)=0
virtual int32	Num () const =0
virtual bool	CanAcceptSamples (int32 NumSamples) const
virtual void	RequestFlush ()=0
virtual uint32	GetFlushCount () const =0
void	ReceiveEvent (EMediaSampleSinkEvent Event, const FMediaSampleSinkEventData &Data)
	DECLARE_EVENT_TwoParams (TMediaSampleSink< SampleType >, FOnMediaSampleSinkEvent, EMediaSampleSinkEvent, const FMediaSampleSinkEventData &) FOnMediaSampleSinkEvent &OnMediaSampleSinkEvent()
virtual	~TMediaSampleSink ()

Detailed Description

template<typename SampleType>
class TMediaSampleSink< SampleType >

Interface for media sample sinks.

This interface declares the write side of media sample queues.

See also

TMediaSampleQueue

Constructor & Destructor Documentation

~TMediaSampleSink()

template<typename SampleType >

virtual TMediaSampleSink< SampleType >::~TMediaSampleSink ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

CanAcceptSamples()

template<typename SampleType >

virtual bool TMediaSampleSink< SampleType >::CanAcceptSamples ( int32  NumSamples ) const

inlinevirtual

Check if sink can accept new samples

Parameters

NumSamples

How many samples we would like the sink to accept

Returns

True if samples could be accepted, false otherwise

Note

Override in implementation as needed

Reimplemented in TMediaSampleQueue< SampleType, SinkType >, TMediaSampleQueue< class IMediaBinarySample >, TMediaSampleQueue< class IMediaOverlaySample >, and TMediaSampleQueue< class IMediaTextureSample >.

DECLARE_EVENT_TwoParams()

template<typename SampleType >

TMediaSampleSink< SampleType >::DECLARE_EVENT_TwoParams ( TMediaSampleSink< SampleType >  , FOnMediaSampleSinkEvent  , EMediaSampleSinkEvent  , const FMediaSampleSinkEventData &    ) &

inline

Register to receive events flowing to this sink

Enqueue()

template<typename SampleType >

virtual bool TMediaSampleSink< SampleType >::Enqueue ( const TSharedRef< SampleType, ESPMode::ThreadSafe > &  Sample )

pure virtual

Add a sample to the head of the queue.

Parameters

Sample

The sample to add.

Returns

true if the item was added, false otherwise.

See also

Num, RequestFlush

Implemented in TMediaSampleQueue< SampleType, SinkType >.

GetFlushCount()

template<typename SampleType >

virtual uint32 TMediaSampleSink< SampleType >::GetFlushCount ( ) const

pure virtual

Returns the number of times the queue has been requested to flush already.

Returns

Number of times RequestFlush() was called.

Implemented in TMediaSampleQueue< SampleType, SinkType >, TMediaSampleQueue< class IMediaBinarySample >, TMediaSampleQueue< class IMediaOverlaySample >, and TMediaSampleQueue< class IMediaTextureSample >.

Num()

template<typename SampleType >

virtual int32 TMediaSampleSink< SampleType >::Num ( ) const

pure virtual

Get the number of samples in the queue.

Returns

Number of samples.

See also

Enqueue, RequestFlush

Implemented in TMediaSampleQueue< SampleType, SinkType >, TMediaSampleQueue< class IMediaBinarySample >, TMediaSampleQueue< class IMediaOverlaySample >, and TMediaSampleQueue< class IMediaTextureSample >.

ReceiveEvent()

template<typename SampleType >

void TMediaSampleSink< SampleType >::ReceiveEvent ( EMediaSampleSinkEvent  Event, const FMediaSampleSinkEventData &  Data  )

inline

Receive event

RequestFlush()

template<typename SampleType >

virtual void TMediaSampleSink< SampleType >::RequestFlush ( )

pure virtual

Request to flush the queue.

Note

To be called only from producer thread.

See also

Enqueue, Num

Implemented in TMediaSampleQueue< SampleType, SinkType >, TMediaSampleQueue< class IMediaBinarySample >, TMediaSampleQueue< class IMediaOverlaySample >, and TMediaSampleQueue< class IMediaTextureSample >.

---

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

• Engine/Source/Runtime/MediaUtils/Public/MediaSampleSink.h