Navigation
API > API/Runtime > API/Runtime/MediaUtils
Inheritance Hierarchy
- SinkType
- TMediaSampleSource
- TMediaSampleQueue
- FMediaAudioSampleQueue
References
| Module | MediaUtils |
| Header | /Engine/Source/Runtime/MediaUtils/Public/MediaSampleQueue.h |
| Include | #include "MediaSampleQueue.h" |
Syntax
template<typename SampleType, typename SinkType>
class TMediaSampleQueue :
public SinkType,
public TMediaSampleSource< SampleType >
Remarks
Template for media sample queues.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FCriticalSection | CriticalSection | |
 |
int32 | MaxSamplesInQueue | |
 |
TArray< TSharedPtr< SampleType, ESPMode::ThreadSafe > > | Samples |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
TMediaSampleQueue
(
int32 InMaxSamplesInQueue |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Virtual destructor. |
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
bool | CanAcceptSamples
(
int32 NumSamples |
|
 |
bool | Discard
(
const TRange< FMediaTimeStamp >& TimeRange, |
|
  |
bool | Enqueue
(
const TSharedRef< SampleType, ESPMode::ThreadSafe >& Sample |
|
 |
bool | FetchBestSampleForTimeRange
(
const TRange< FMediaTimeStamp >& TimeRange, |
|
 |
void | FindRangeInQueue
(
const TRange< FMediaTimeStamp >& TimeRange, |
|
  |
int32 | Num () |
Get the number of samples in the queue. |
 |
uint32 | PurgeOutdatedSamples
(
const FMediaTimeStamp& ReferenceTime, |
|
  |
void | RequestFlush () |
Overridden from TMediaSampleSource
| Type | Name | Description | |
|---|---|---|---|
  |
bool | Dequeue
(
TSharedPtr< SampleType, ESPMode::ThreadSafe >& OutSample |
Remove and return the next sample in the queue. |
  |
bool | Peek
(
TSharedPtr< SampleType, ESPMode::ThreadSafe >& OutSample |
Peek at the next sample in the queue without removing it. |
  |
bool | Pop () |
Remove the next sample from the queue. |