TMediaSampleQueue

Template for media sample queues.

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Protected variable

FCriticalSectio...

 

CriticalSection

Protected variable

TArray< TShared...

 

Samples

Constructors

Name Description

Public function

TMediaSampleQueue()

Default constructor.

Destructors

Name Description

Public function Virtual

~TMediaSampleQueue()

Virtual destructor.

Functions

Name Description

Public function Virtual

bool

 

Enqueue

(
    const TSharedRef< SampleType, ESPMo...
)

Public function

bool

 

FetchBestSampleForTimeRange

(
    const TRange< FMediaTimeStamp >& T...,
    TSharedPtr< SampleType, ESPMode::Th...,
    bool bReverse
)

Public function Const

int32

 

Num()

Get the number of samples in the queue.

Public function

uint32

 

PurgeOutdatedSamples

(
    const FMediaTimeStamp& ReferenceTi...,
    bool bReversed
)

Public function Virtual

void

 

RequestFlush()

Overridden from TMediaSampleSource

Name Description

Public function Virtual

bool

 

Dequeue

(
    TSharedPtr< SampleType, ESPMode::Th...
)

Remove and return the next sample in the queue.

Public function Virtual

bool

 

Peek

(
    TSharedPtr< SampleType, ESPMode::Th...
)

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

Public function Virtual

bool

 

Pop()

Remove the next sample from the queue.