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 > Plugins > TimedDataMonitor > UTimedDataMonitorSubsystem

Light Theme

Dark Theme

UTimedDataMonitorSubsystem

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USubsystem

UDynamicSubsystem

UEngineSubsystem

UTimedDataMonitorSubsystem

References

Module	TimedDataMonitor
Header	/Engine/Plugins/VirtualProduction/TimedDataMonitor/Source/TimedDataMonitor/Public/TimedDataMonitorSubsystem.h
Include	#include "TimedDataMonitorSubsystem.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UTimedDataMonitorSubsystem : public UEngineSubsystem

Variables

		Name	Description
	FTimedDataIdent...	OnIdentifierListChanged_Dynamic	Delegate of when an element is added or removed.

Functions

	Name	Description
FTimedDataMo...	ApplyTimeCorrection ( const FTimedDataMonitorInputIdentif..., const FTimedDataMonitorTimeCorrecti... )	Assume all data samples were produce at the same time and align them with the current platform's time
void	BeginFrameCallback()	Used to cache global (Engine TimecodeProvider) frame delay for the current frame.
void	CalibrateLatent ( UObject* WorldContextObject, FLatentActionInfo LatentInfo, const FTimedDataMonitorCalibrationP..., FTimedDataMonitorCalibrationResult ... )	Change the Timecode Provider offset to align all inputs and channels.
bool	DoesChannelExist ( const FTimedDataMonitorChannelIdent... )	Return true if the identifier is a valid channel.
bool	DoesInputExist ( const FTimedDataMonitorInputIdentif... )	Return true if the identifier is a valid input.
void	EndFrameCallback()	Used to update statistics once all TimedData are processed.
TArray< FTim...	GetAllChannels()	Get the list of all the channels.
TArray< FTim...	GetAllEnabledChannels()	Get the list of all the channels that are enabled.
TArray< FTim...	GetAllInputs()	Get the list of all the inputs.
int32	GetChannelBufferOverflowStat ( const FTimedDataMonitorChannelIdent... )	Returns the number of buffer overflows detected by that input since the last reset.
int32	GetChannelBufferUnderflowStat ( const FTimedDataMonitorChannelIdent... )	Returns the number of buffer underflows detected by that input since the last reset.
ETimedDataIn...	GetChannelConnectionState ( const FTimedDataMonitorChannelIdent... )	Get the state the channel.
int32	GetChannelDataBufferSize ( const FTimedDataMonitorChannelIdent... )	If the channel does support it, get the current maximum sample count of channel.
FText	GetChannelDisplayName ( const FTimedDataMonitorChannelIdent... )	Return the display name of an input.
float	GetChannelEvaluationDistanceToNewestSampleMean ( const FTimedDataMonitorChannelIdent... )	Returns the average distance, in seconds, between evaluation time and newest sample
float	GetChannelEvaluationDistanceToNewestSampleStandardDeviation ( const FTimedDataMonitorChannelIdent... )	Returns the standard deviation of the distance, in seconds, between evaluation time and newest sample
float	GetChannelEvaluationDistanceToOldestSampleMean ( const FTimedDataMonitorChannelIdent... )	Returns the average distance, in seconds, between evaluation time and oldest sample
float	GetChannelEvaluationDistanceToOldestSampleStandardDeviation ( const FTimedDataMonitorChannelIdent... )	Returns the standard deviation of the distance, in seconds, between evaluation time and oldest sample
ETimedDataMo...	GetChannelEvaluationState ( const FTimedDataMonitorChannelIdent... )	Get the evaluation state of the channel.
int32	GetChannelFrameDroppedStat ( const FTimedDataMonitorChannelIdent... )	Returns the number of frames dropped by that input since the last reset.
FTimedDataMo...	GetChannelInput ( const FTimedDataMonitorChannelIdent... )	Return the input of this channel.
void	GetChannelLastEvaluationDataStat ( const FTimedDataMonitorChannelIdent..., FTimedDataInputEvaluationData& Res... )	Retrieves information about last evaluation Returns true if identifier was found
FTimedDataCh...	GetChannelNewestDataTime ( const FTimedDataMonitorChannelIdent... )	Get the channel latest sample time.
int32	GetChannelNumberOfSamples ( const FTimedDataMonitorChannelIdent... )	Get the number of data samples available.
FTimedDataCh...	GetChannelOldestDataTime ( const FTimedDataMonitorChannelIdent... )	Get the channel oldest sample time.
ETimedDataMo...	GetEvaluationState()	Get the worst evaluation state of all the inputs.
double	GetEvaluationTime ( ETimedDataInputEvaluationType Evalu... )	Get the current evaluation time.
float	GetEvaluationTimeOffsetInSeconds ( ETimedDataInputEvaluationType Evalu... )	Get offset applied to global evaluation time. Only works when a Timecode Provider is used
TArray< FTim...	GetInputChannels ( const FTimedDataMonitorInputIdentif... )	Return the list of all channels that are part of the input.
ETimedDataIn...	GetInputConnectionState ( const FTimedDataMonitorInputIdentif... )	Get the worst state of all the channels of that input.
int32	GetInputDataBufferSize ( const FTimedDataMonitorInputIdentif... )	Get the size of the buffer used by the input.
FText	GetInputDisplayName ( const FTimedDataMonitorInputIdentif... )	Return the display name of an input.
ETimedDataMo...	GetInputEnabled ( const FTimedDataMonitorInputIdentif... )	Is the input enabled in the monitor.
float	GetInputEvaluationDistanceToNewestSampleMean ( const FTimedDataMonitorInputIdentif... )	Returns the max average distance, in seconds, between evaluation time and newest sample
float	GetInputEvaluationDistanceToNewestSampleStandardDeviation ( const FTimedDataMonitorInputIdentif... )	Returns the standard deviation of the distance, in seconds, between evaluation time and newest sample
float	GetInputEvaluationDistanceToOldestSampleMean ( const FTimedDataMonitorInputIdentif... )	Returns the min average distance, in seconds, between evaluation time and oldest sample
float	GetInputEvaluationDistanceToOldestSampleStandardDeviation ( const FTimedDataMonitorInputIdentif... )	Returns the standard deviation of the distance, in seconds, between evaluation time and oldest sample
float	GetInputEvaluationOffsetInSeconds ( const FTimedDataMonitorInputIdentif... )	Get the offset in seconds or frames (see GetEvaluationType) used at evaluation.
ETimedDataMo...	GetInputEvaluationState ( const FTimedDataMonitorInputIdentif... )	Get the worst evaluation state of all the channels of that input.
ETimedDataIn...	GetInputEvaluationType ( const FTimedDataMonitorInputIdentif... )	Get how the input is evaluated type.
FFrameRate	GetInputFrameRate ( const FTimedDataMonitorInputIdentif... )	Get the frame rate at which the samples is produce.
FTimedDataCh...	GetInputNewestDataTime ( const FTimedDataMonitorInputIdentif... )	Get the latest sample time of all the channel in this input.
FTimedDataCh...	GetInputOldestDataTime ( const FTimedDataMonitorInputIdentif... )	Get the oldest sample time of all the channel in this input.
ITimedDataIn...	GetTimedDataChannel ( const FTimedDataMonitorChannelIdent... )	Get the interface for a specific channel identifier.
ITimedDataIn...	GetTimedDataInput ( const FTimedDataMonitorInputIdentif... )	Get the interface for a specific input identifier.
bool	IsChannelEnabled ( const FTimedDataMonitorChannelIdent... )	Is the channel enabled in the monitor.
bool	IsDataBufferSizeControlledByInput ( const FTimedDataMonitorInputIdentif... )	Does the channel support a different buffer size than it's input.
FSimpleMulti...	OnIdentifierListChanged()	Delegate of when an element is added or removed.
void	ResetAllBufferStats()	Reset the stat of all the inputs.
void	SetChannelDataBufferSize ( const FTimedDataMonitorChannelIdent..., int32 BufferSize )	If the channel does support it, set the maximum sample count of the channel.
void	SetChannelEnabled ( const FTimedDataMonitorChannelIdent..., bool bEnabled )	Enable or disable an input from the monitor.
void	SetInputDataBufferSize ( const FTimedDataMonitorInputIdentif..., int32 BufferSize )	Set the size of the buffer used by the input.
void	SetInputEnabled ( const FTimedDataMonitorInputIdentif..., bool bInEnabled )	Set all channels for the input enabled in the monitor.
void	SetInputEvaluationOffsetInSeconds ( const FTimedDataMonitorInputIdentif..., float Seconds )	Set the offset in seconds or frames (see GetEvaluationType) used at evaluation.
void	SetInputEvaluationType ( const FTimedDataMonitorInputIdentif..., ETimedDataInputEvaluationType Evalu... )	Set how the input is evaluated type.

Overridden from USubsystem

		Name	Description
	void	Deinitialize()	Implement this for deinitialization of instances of the system
	void	Initialize ( FSubsystemCollectionBase& Collecti... )	Implement this for initialization of instances of the system

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

Take our survey

Dismiss