Navigation
API > API/Runtime > API/Runtime/MediaUtils
Template for media sample queues.
| Name | TMediaSampleQueue |
| Type | class |
| Header File | /Engine/Source/Runtime/MediaUtils/Public/MediaSampleQueue.h |
| Include Path | #include "MediaSampleQueue.h" |
Syntax
template<typename SampleType, typename SinkType>
class TMediaSampleQueue :
public TMediaSampleSink< SampleType > ,
public TMediaSampleSource< SampleType >
Inheritance Hierarchy
- TMediaSampleSink → TMediaSampleQueue
- TMediaSampleSource → TMediaSampleQueue
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TMediaSampleQueue
(
int32 InMaxSamplesInQueue |
MediaSampleQueue.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~TMediaSampleQueue() |
Virtual destructor. | MediaSampleQueue.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool Discard
(
const TRange< FMediaTimeStamp >& TimeRange, |
MediaSampleQueue.h | ||
EMediaSampleQueueFetchResult FetchBestSampleForTimeRange
(
const TRange< FMediaTimeStamp >& TimeRange, |
MediaSampleQueue.h | ||
uint32 GetNumDroppedSamples
(
bool bInClearToZero |
Returns the number of samples that were dropped in any of the member functions. | MediaSampleQueue.h | |
uint32 PurgeOutdatedSamples
(
const FMediaTimeStamp& ReferenceTime, |
MediaSampleQueue.h | ||
void PurgeUntilSequenceIndex
(
int32 InUntilIndex |
MediaSampleQueue.h |
Overridden from TMediaSampleSink
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanAcceptSamples
(
int32 NumSamples |
Check if sink can accept new samplesOverride in implementation as needed | MediaSampleQueue.h | |
virtual bool Enqueue
(
const TSharedRef< SampleType, ESPMode::ThreadSafe >& Sample |
Add a sample to the head of the queue. | MediaSampleQueue.h | |
virtual uint32 GetFlushCount() |
Returns the number of times the queue has been requested to flush already. | MediaSampleQueue.h | |
virtual int32 Num () |
Get the number of samples in the queue. | MediaSampleQueue.h | |
virtual void RequestFlush () |
Request to flush the queue.To be called only from producer thread. | MediaSampleQueue.h |
Overridden from TMediaSampleSource
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool Dequeue
(
TSharedPtr< SampleType, ESPMode::ThreadSafe >& OutSample |
Remove and return the next sample in the queue. | MediaSampleQueue.h | |
virtual void GetSampleTimes
(
TArray< TRange< FMediaTimeStamp > >& OutSampleTimeRanges |
Returns the sample start and end times of all samples currently in the queue. | MediaSampleQueue.h | |
virtual bool Peek
(
TSharedPtr< SampleType, ESPMode::ThreadSafe >& OutSample |
Peek at the next sample in the queue without removing it. | MediaSampleQueue.h | |
virtual bool Pop () |
Remove the next sample from the queue. | MediaSampleQueue.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void FindRangeInQueue
(
const TRange< FMediaTimeStamp >& TimeRange, |
MediaSampleQueue.h |