TMediaSampleSource< SampleType > Class Template Reference

#include <MediaSampleSource.h>

Inheritance diagram for TMediaSampleSource< SampleType >:

Public Member Functions
virtual bool	Dequeue (TSharedPtr< SampleType, ESPMode::ThreadSafe > &OutSample)=0
virtual bool	Peek (TSharedPtr< SampleType, ESPMode::ThreadSafe > &OutSample)=0
virtual void	GetSampleTimes (TArray< TRange< FMediaTimeStamp > > &OutSampleTimeRanges)=0
virtual bool	Pop ()=0
virtual	~TMediaSampleSource ()

Detailed Description

template<typename SampleType>
class TMediaSampleSource< SampleType >

Interface for media sample sources.

This interface declares the read side of media sample queues.

See also

TMediaSampleQueue

Constructor & Destructor Documentation

~TMediaSampleSource()

template<typename SampleType >

virtual TMediaSampleSource< SampleType >::~TMediaSampleSource ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

Dequeue()

template<typename SampleType >

virtual bool TMediaSampleSource< SampleType >::Dequeue ( TSharedPtr< SampleType, ESPMode::ThreadSafe > &  OutSample )

pure virtual

Remove and return the next sample in the queue.

Parameters

OutSample

Will contain the sample if the queue is not empty.

Returns

true if a sample has been returned, false if the queue was empty.

See also

Peek, Pop

Implemented in TMediaSampleQueue< SampleType, SinkType >.

GetSampleTimes()

template<typename SampleType >

virtual void TMediaSampleSource< SampleType >::GetSampleTimes ( TArray< TRange< FMediaTimeStamp > > &  OutSampleTimeRanges )

pure virtual

Returns the sample start and end times of all samples currently in the queue.

Parameters

OutSampleTimeRanges

Will contain the sample time ranges.

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

Peek()

template<typename SampleType >

virtual bool TMediaSampleSource< SampleType >::Peek ( TSharedPtr< SampleType, ESPMode::ThreadSafe > &  OutSample )

pure virtual

Peek at the next sample in the queue without removing it.

Parameters

OutSample

Will contain the sample if the queue is not empty.

Returns

true if a sample has been returned, false if the queue was empty.

See also

Dequeue, Pop

Implemented in TMediaSampleQueue< SampleType, SinkType >.

Pop()

template<typename SampleType >

virtual bool TMediaSampleSource< SampleType >::Pop ( )

pure virtual

Remove the next sample from the queue.

Returns

true if a sample was removed, false otherwise.

See also

Dequeue, Peek

Implemented in TMediaSampleQueue< SampleType, SinkType >, TMediaSampleQueue< class IMediaAudioSample, class FMediaAudioSampleSink >, 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/MediaSampleSource.h