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

FMediaIOCoreSampleContainer

MediaIO container for different types of samples. Also a TimedData channel that can be monitored

Windows

MacOS

Linux

Inheritance Hierarchy

ITimedDataInputChannel

FMediaIOCoreSampleContainer

References

Module	MediaIOCore
Header	/Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Public/MediaIOCoreSampleContainer.h
Include	#include "MediaIOCoreSampleContainer.h"

Syntax

template<typename SampleType>
class FMediaIOCoreSampleContainer : public ITimedDataInputChannel

Remarks

MediaIO container for different types of samples. Also a TimedData channel that can be monitored

Variables

	Name	Description
bool	bIsChannelEnabled	Should this channel be considered available
bool	bIsStatEnabled	Stats logging enabled or not
TAtomic< int32 ...	BufferOverflow
TAtomic< int32 ...	BufferUnderflow	Evaluation statistics we keep track of
FTimedDataInput...	CachedEvaluationData	Last evaluation data for that channel
TArray< FTimedD...	CachedSamplesData	Samples are consumed by the the facade layer when evaluating and sending to render thread.
FName	ChannelName	Name of this channel
FCriticalSectio...	CriticalSection	Sample container: We add at the beginning of the array [0] and we pop at the end [Size-1].
FMediaIOSamplin...	EvaluationSettings	Channel settings
TAtomic< int32 ...	FrameDrop
TArray< TShared...	Samples

Constructors

	Name	Description
	FMediaIOCoreSampleContainer ( FName InChannelName )
	FMediaIOCoreSampleContainer ( const FMediaIOCoreSampleContainer& )

Destructors

	Name	Description
	~FMediaIOCoreSampleContainer()

Functions

	Name	Description
bool	AddSample ( const TSharedRef< SampleType, ESPMo... )	Add the given sample to the cache.
void	CacheState ( FTimespan PlayerTime )	Caches the current sample container states before samples will be taken out of it
void	EnableChannel ( ITimedDataInput* Input, bool bShouldEnable )	Channel is disabled by default. It won't be added to the Timed Data collection if not enabled
bool	FetchSample ( TRange< FTimespan > TimeRange, TSharedPtr< SampleType, ESPMode::Th... )
void	FlushSamples()
FTimespan	GetNextSampleTime()	Get next sample time from the sample list.
int32	NumSamples()	Get the number of queued samples.
bool	PopSample()	Pop a sample from the cache.
void	UpdateSettings ( const FMediaIOSamplingSettings& In... )	Update this sample container settings

Overridden from ITimedDataInputChannel

	Name	Description
int32	GetBufferOverflowStat()	Return buffer overflow count detected by this input
int32	GetBufferUnderflowStat()	Return buffer underflow count detected by this input
int32	GetDataBufferSize()	If the channel does support it, get the current maximum sample count of channel.
TArray< FTim...	GetDataTimes()	Get the time of all the data samples available.
FText	GetDisplayName()	Get the channel's display name.
int32	GetFrameDroppedStat()	Return frame dropped count detected by this input
void	GetLastEvaluationData ( FTimedDataInputEvaluationData& Out... )	Get data about last evaluation. Samples used, expected, number of samples.
FTimedDataCh...	GetNewestDataTime()	Get the time of the newest data sample available.
int32	GetNumberOfSamples()	Get the number of data samples available.
FTimedDataCh...	GetOldestDataTime()	Get the time of the oldest data sample available.
ETimedDataIn...	GetState()	Get the current state of the channel.
bool	IsBufferStatsEnabled()	Is tracking of stats enabled for this input
void	ResetBufferStats()	Resets internal stat counters
void	SetBufferStatsEnabled ( bool bEnable )	Enables or disables stats tracking for this input
void	SetDataBufferSize ( int32 BufferSize )	If the channel does support it, set the maximum sample count of the channel.

Operators

		Name	Description
	FMediaIOCore...	operator= ( const FMediaIOCoreSampleContainer& )

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

Take our survey

Dismiss