Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > MediaUtils > TMediaSampleQueue

Light Theme

Dark Theme

TMediaSampleQueue

Template for media sample queues.

Windows

MacOS

Linux

Inheritance Hierarchy

TMediaSampleSink

TMediaSampleSource

TMediaSampleQueue

References

Module	MediaUtils
Header	/Engine/Source/Runtime/MediaUtils/Public/MediaSampleQueue.h
Include	#include "MediaSampleQueue.h"

Syntax

template<typename SampleType>
class TMediaSampleQueue :
public TMediaSampleSink< SampleType >,
public TMediaSampleSource< SampleType >

Remarks

Template for media sample queues.

Variables

	Name	Description
int32	NumSamples	Number of samples in the queue.
int32	PendingFlushes	Number of pending flushes.
TQueue< TShared...	Samples	Audio sample queue.

Constructors

	Name	Description
	TMediaSampleQueue()	Default constructor.

Destructors

	Name	Description
	~TMediaSampleQueue()	Virtual destructor.

Functions

		Name	Description
	void	DoPendingFlushes()	Perform any pending flushes.

Overridden from TMediaSampleSink

	Name	Description
bool	Enqueue ( const TSharedRef< SampleType, ESPMo... )	Add a sample to the head of the queue.
int32	Num()	Get the number of samples in the queue.
void	RequestFlush()	Request to flush the queue. To be called only from producer thread.

Name

Description

bool

Enqueue

(
const TSharedRef< SampleType, ESPMo...
)

Add a sample to the head of the queue.

int32

Num()

Get the number of samples in the queue.

void

RequestFlush()

Request to flush the queue.

To be called only from producer thread.

Overridden from TMediaSampleSource

	Name	Description
bool	Dequeue ( TSharedPtr< SampleType, ESPMode::Th... )	Remove and return the next sample in the queue.
bool	Peek ( TSharedPtr< SampleType, ESPMode::Th... )	Peek at the next sample in the queue without removing it.
bool	Pop()	Remove the next sample from the queue.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss