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

Light Theme

Dark Theme

IMediaSamples

Interface for access to a media player's sample queue.

Windows

MacOS

Linux

Inheritance Hierarchy

IMediaSamples

	FMediaIOCoreSamples
	FMediaSamples

References

Module	Media
Header	/Engine/Source/Runtime/Media/Public/IMediaSamples.h
Include	#include "IMediaSamples.h"

Syntax

class IMediaSamples

Remarks

Interface for access to a media player's sample queue.

Destructors

	Name	Description
	~IMediaSamples()	Virtual destructor.

Functions

	Name	Description
bool	CanReceiveAudioSamples ( uint32 Num )
bool	CanReceiveVideoSamples ( uint32 Num )
bool	FetchAudio ( TRange< FTimespan > TimeRange, TSharedPtr< IMediaAudioSample, ESPM... )	Fetch the next audio sample.
EFetchBestSa...	FetchBestVideoSampleForTimeRange ( const TRange< FMediaTimeStamp >& T..., TSharedPtr< IMediaTextureSample, ES..., bool bReverse )
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()
int32	NumCaption()
int32	NumMetadataSamples()
int32	NumSubtitleSamples()
int32	NumVideoSamples()
bool	PeekVideoSampleTime ( FMediaTimeStamp& TimeStamp )
uint32	PurgeOutdatedVideoSamples ( const FMediaTimeStamp& ReferenceTi..., bool bReversed )

Enums

	Name	Description
	EFetchBestSampleResult