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 > FMediaSamples

Light Theme

Dark Theme

FMediaSamples

General purpose media sample queue.

Windows

MacOS

Linux

Inheritance Hierarchy

IMediaSamples

FMediaSamples

References

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

Syntax

class FMediaSamples : public IMediaSamples

Remarks

General purpose media sample queue.

Functions

	Name	Description
void	AddAudio ( const TSharedRef< IMediaAudioSample... )	Add the given audio sample to the cache.
void	AddCaption ( const TSharedRef< IMediaOverlaySamp... )	Add the given caption sample to the cache.
void	AddMetadata ( const TSharedRef< IMediaBinarySampl... )	Add the given audio sample to the cache.
void	AddSubtitle ( const TSharedRef< IMediaOverlaySamp... )	Add the given subtitle sample to the cache.
void	AddVideo ( const TSharedRef< IMediaTextureSamp... )	Add the given audio sample to the cache.

Overridden from IMediaSamples

	Name	Description
bool	CanReceiveAudioSamples ( uint32 Num )	Check if can receive more audio samples
bool	CanReceiveVideoSamples ( uint32 Num )	Check if can receive more video samples
bool	FetchAudio ( TRange< FTimespan > TimeRange, TSharedPtr< IMediaAudioSample, ESPM... )	Peek next video sample's timestamp
EFetchBestSa...	FetchBestVideoSampleForTimeRange ( const TRange< FMediaTimeStamp >& T..., TSharedPtr< IMediaTextureSample, ES..., bool bReverse )	Fetch video sample best suited for the given time range.
bool	FetchCaption ( TRange< FMediaTimeStamp > TimeRange, TSharedPtr< IMediaOverlaySample, ES... )
bool	FetchCaption ( TRange< FTimespan > TimeRange, TSharedPtr< IMediaOverlaySample, ES... )	Fetch the next caption sample.
bool	FetchMetadata ( TRange< FTimespan > TimeRange, TSharedPtr< IMediaBinarySample, ESP... )	Fetch the next metadata sample.
bool	FetchSubtitle ( TRange< FMediaTimeStamp > TimeRange, TSharedPtr< IMediaOverlaySample, ES... )
bool	FetchSubtitle ( TRange< FTimespan > TimeRange, TSharedPtr< IMediaOverlaySample, ES... )	Fetch the next subtitle sample.
bool	FetchVideo ( TRange< FMediaTimeStamp > TimeRange, TSharedPtr< IMediaTextureSample, ES... )
bool	FetchVideo ( TRange< FTimespan > TimeRange, TSharedPtr< IMediaTextureSample, ES... )	Fetch the next video sample.
void	FlushSamples()	Discard any outstanding media samples.
int32	NumAudio()	Get the number of queued audio samples.
int32	NumCaption()	Get the number of queued caption samples.
int32	NumMetadataSamples()	Get the number of queued metadata samples.
int32	NumSubtitleSamples()	Get the number of queued subtitle samples.
int32	NumVideoSamples()	Get the number of queued video samples.
bool	PeekVideoSampleTime ( FMediaTimeStamp& TimeStamp )
uint32	PurgeOutdatedVideoSamples ( const FMediaTimeStamp& ReferenceTi..., bool bReversed )	Remove any video samples from the queue that have no chance of being displayed anymore

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

Take our survey

Dismiss