1. Epic GamesDeveloper
  3. UTimedDataMonitorSubsystem

UTimedDataMonitorSubsystem

API > API/Plugins > API/Plugins/TimedDataMonitor

   
Name UTimedDataMonitorSubsystem
Type class
Header File /Engine/Plugins/VirtualProduction/TimedDataMonitor/Source/TimedDataMonitor/Public/TimedDataMonitorSubsystem.h
Include Path #include "TimedDataMonitorSubsystem.h"

Syntax

UCLASS ()  
class UTimedDataMonitorSubsystem : public UEngineSubsystem

Inheritance Hierarchy

Structs

Name Remarks
FChannelStatisticLogging  
FTimeDataChannelItem  
FTimeDataInputItem  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnIdentifierListChanged_Dynamic FTimedDataIdentifierListChangedSignature Delegate of when an element is added or removed. TimedDataMonitorSubsystem.h
  • BlueprintAssignable
  • Category="Timed Data Monitor"
  • Meta=(DisplayName="OnSourceIdentifierListChanged")

Protected

Name Type Remarks Include Path Unreal Specifiers
bHasStatFileLoggingStarted bool   TimedDataMonitorSubsystem.h  
bRequestSourceListRebuilt bool   TimedDataMonitorSubsystem.h  
CachedConnectionState ETimedDataInputState   TimedDataMonitorSubsystem.h  
CachedEvaluationState ETimedDataMonitorEvaluationState Cached system state for evaluation and connection based on each input / channel and source that caused last change TimedDataMonitorSubsystem.h  
CachedTimecodeProviderFrameDelayInSeconds float   TimedDataMonitorSubsystem.h  
ChannelMap TMap< FTimedDataMonitorChannelIdentifier, FTimeDataChannelItem >   TimedDataMonitorSubsystem.h  
InputMap TMap< FTimedDataMonitorInputIdentifier, FTimeDataInputItem >   TimedDataMonitorSubsystem.h  
OnIdentifierListChanged_Delegate FSimpleMulticastDelegate   TimedDataMonitorSubsystem.h  
StatLoggingMap TMap< FTimedDataMonitorChannelIdentifier, FChannelStatisticLogging >   TimedDataMonitorSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FTimedDataMonitorTimeCorrectionResult ApplyTimeCorrection ( const FTimedDataMonitorInputIdentifier& Identifier,
const FTimedDataMonitorTimeCorrectionParameters& TimeCorrectionParameters
)

 Assume all data samples were produce at the same time and align them with the current platform's time TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor"

void BeginFrameCallback()

 Used to cache global (Engine TimecodeProvider) frame delay for the current frame. TimedDataMonitorSubsystem.h  

void CalibrateLatent ( UObject* WorldContextObject,
FLatentActionInfo LatentInfo,
const FTimedDataMonitorCalibrationParameters& CalibrationParameters,
FTimedDataMonitorCalibrationResult& Result
)

 Change the Timecode Provider offset to align all inputs and channels. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor"
  • Meta=(DisplayName="Calibrate", Latent, LatentInfo="LatentInfo", WorldContext="WorldContextObject")

bool DoesChannelExist ( const FTimedDataMonitorChannelIdentifier& Identifier
)

 Return true if the identifier is a valid channel. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"

bool DoesInputExist ( const FTimedDataMonitorInputIdentifier& Identifier
)

 Return true if the identifier is a valid input. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"
Used to update statistics once all TimedData are processed. TimedDataMonitorSubsystem.h  
Get the list of all the channels. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor"

TArray< FTimedDataMonitorChannelIdentifier > GetAllEnabledChannels()

 Get the list of all the channels that are enabled. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor"
Get the list of all the inputs. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor"

int32 GetChannelBufferOverflowStat ( const FTimedDataMonitorChannelIdentifier& Identifier
)

 Returns the number of buffer overflows detected by that input since the last reset. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"

int32 GetChannelBufferUnderflowStat ( const FTimedDataMonitorChannelIdentifier& Identifier
)

 Returns the number of buffer underflows detected by that input since the last reset. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"

ETimedDataInputState GetChannelConnectionState ( const FTimedDataMonitorChannelIdentifier& Identifier
)

 Get the state the channel. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"

int32 GetChannelDataBufferSize ( const FTimedDataMonitorChannelIdentifier& Identifier
)

 If the channel does support it, get the current maximum sample count of channel. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"

FText GetChannelDisplayName ( const FTimedDataMonitorChannelIdentifier& Identifier
)

 Return the display name of an input. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"

float GetChannelEvaluationDistanceToNewestSampleMean ( const FTimedDataMonitorChannelIdentifier& Identifier
)

 Returns the average distance, in seconds, between evaluation time and newest sample TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"

float GetChannelEvaluationDistanceToNewestSampleStandardDeviation ( const FTimedDataMonitorChannelIdentifier& Identifier
)

 Returns the standard deviation of the distance, in seconds, between evaluation time and newest sample TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"

float GetChannelEvaluationDistanceToOldestSampleMean ( const FTimedDataMonitorChannelIdentifier& Identifier
)

 Returns the average distance, in seconds, between evaluation time and oldest sample TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"

float GetChannelEvaluationDistanceToOldestSampleStandardDeviation ( const FTimedDataMonitorChannelIdentifier& Identifier
)

 Returns the standard deviation of the distance, in seconds, between evaluation time and oldest sample TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"

ETimedDataMonitorEvaluationState GetChannelEvaluationState ( const FTimedDataMonitorChannelIdentifier& Identifier
)

 Get the evaluation state of the channel. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"

TArray< FTimedDataChannelSampleTime > GetChannelFrameDataTimes ( const FTimedDataMonitorChannelIdentifier& Identifier
)

 Get the sample times for every frame in the channel TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"

int32 GetChannelFrameDroppedStat ( const FTimedDataMonitorChannelIdentifier& Identifier
)

 Returns the number of frames dropped by that input since the last reset. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"
Return the input of this channel. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"

void GetChannelLastEvaluationDataStat ( const FTimedDataMonitorChannelIdentifier& Identifier,
FTimedDataInputEvaluationData& Result
)

 Retrieves information about last evaluation Returns true if identifier was found TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"

FTimedDataChannelSampleTime GetChannelNewestDataTime ( const FTimedDataMonitorChannelIdentifier& Identifier
)

 Get the channel latest sample time. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"

int32 GetChannelNumberOfSamples ( const FTimedDataMonitorChannelIdentifier& Identifier
)

 Get the number of data samples available. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"

FTimedDataChannelSampleTime GetChannelOldestDataTime ( const FTimedDataMonitorChannelIdentifier& Identifier
)

 Get the channel oldest sample time. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"

ETimedDataMonitorEvaluationState GetEvaluationState()

 Get the worst evaluation state of all the inputs. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor"

float GetEvaluationTimeOffsetInSeconds ( ETimedDataInputEvaluationType EvaluationType
)

 Get offset applied to global evaluation time. Only works when a Timecode Provider is used TimedDataMonitorSubsystem.h  
Return the list of all channels that are part of the input. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

ETimedDataInputState GetInputConnectionState ( const FTimedDataMonitorInputIdentifier& Identifier
)

 Get the worst state of all the channels of that input. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

int32 GetInputDataBufferSize ( const FTimedDataMonitorInputIdentifier& Identifier
)

 Get the size of the buffer used by the input. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

FText GetInputDisplayName ( const FTimedDataMonitorInputIdentifier& Identifier
)

 Return the display name of an input. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

ETimedDataMonitorInputEnabled GetInputEnabled ( const FTimedDataMonitorInputIdentifier& Identifier
)

 Is the input enabled in the monitor. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

float GetInputEvaluationDistanceToNewestSampleMean ( const FTimedDataMonitorInputIdentifier& Identifier
)

 Returns the max average distance, in seconds, between evaluation time and newest sample TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

float GetInputEvaluationDistanceToNewestSampleStandardDeviation ( const FTimedDataMonitorInputIdentifier& Identifier
)

 Returns the standard deviation of the distance, in seconds, between evaluation time and newest sample TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

float GetInputEvaluationDistanceToOldestSampleMean ( const FTimedDataMonitorInputIdentifier& Identifier
)

 Returns the min average distance, in seconds, between evaluation time and oldest sample TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

float GetInputEvaluationDistanceToOldestSampleStandardDeviation ( const FTimedDataMonitorInputIdentifier& Identifier
)

 Returns the standard deviation of the distance, in seconds, between evaluation time and oldest sample TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

float GetInputEvaluationOffsetInFrames ( const FTimedDataMonitorInputIdentifier& Identifier
)

 Get the offset in frames (see GetEvaluationType) used at evaluation. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

float GetInputEvaluationOffsetInSeconds ( const FTimedDataMonitorInputIdentifier& Identifier
)

 Get the offset in seconds or frames (see GetEvaluationType) used at evaluation. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

ETimedDataMonitorEvaluationState GetInputEvaluationState ( const FTimedDataMonitorInputIdentifier& Identifier
)

 Get the worst evaluation state of all the channels of that input. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

ETimedDataInputEvaluationType GetInputEvaluationType ( const FTimedDataMonitorInputIdentifier& Identifier
)

 Get how the input is evaluated type. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

FFrameRate GetInputFrameRate ( const FTimedDataMonitorInputIdentifier& Identifier
)

 Get the frame rate at which the samples is produce. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

FTimedDataChannelSampleTime GetInputNewestDataTime ( const FTimedDataMonitorInputIdentifier& Identifier
)

 Get the latest sample time of all the channel in this input. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

FTimedDataChannelSampleTime GetInputOldestDataTime ( const FTimedDataMonitorInputIdentifier& Identifier
)

 Get the oldest sample time of all the channel in this input. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

ITimedDataInputChannel * GetTimedDataChannel ( const FTimedDataMonitorChannelIdentifier& Identifier
)

 Get the interface for a specific channel identifier. TimedDataMonitorSubsystem.h  

ITimedDataInput * GetTimedDataInput ( const FTimedDataMonitorInputIdentifier& Identifier
)

 Get the interface for a specific input identifier. TimedDataMonitorSubsystem.h  

bool IsChannelEnabled ( const FTimedDataMonitorChannelIdentifier& Identifier
)

 Is the channel enabled in the monitor. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"

bool IsDataBufferSizeControlledByInput ( const FTimedDataMonitorInputIdentifier& Identifier
)

 Does the channel support a different buffer size than it's input. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

FSimpleMulticastDelegate & OnIdentifierListChanged()

 Delegate of when an element is added or removed. TimedDataMonitorSubsystem.h  

void ResetAllBufferStats()

 Reset the stat of all the inputs. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor"

void SetChannelDataBufferSize ( const FTimedDataMonitorChannelIdentifier& Identifier,
int32 BufferSize
)

 If the channel does support it, set the maximum sample count of the channel. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"

void SetChannelEnabled ( const FTimedDataMonitorChannelIdentifier& Identifier,
bool bEnabled
)

 Enable or disable an input from the monitor. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Channel"

void SetInputDataBufferSize ( const FTimedDataMonitorInputIdentifier& Identifier,
int32 BufferSize
)

 Set the size of the buffer used by the input. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

void SetInputEnabled ( const FTimedDataMonitorInputIdentifier& Identifier,
bool bInEnabled
)

 Set all channels for the input enabled in the monitor. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

void SetInputEvaluationOffsetInFrames ( const FTimedDataMonitorInputIdentifier& Identifier,
float Frames
)

 Set the offset in frames (see GetEvaluationType) used at evaluation. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

void SetInputEvaluationOffsetInSeconds ( const FTimedDataMonitorInputIdentifier& Identifier,
float Seconds
)

 Set the offset in seconds or frames (see GetEvaluationType) used at evaluation. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

void SetInputEvaluationType ( const FTimedDataMonitorInputIdentifier& Identifier,
ETimedDataInputEvaluationType Evaluation
)

 Set how the input is evaluated type. TimedDataMonitorSubsystem.h
  • BlueprintCallable
  • Category="Timed Data Monitor|Input"

Overridden from USubsystem

Name Remarks Include Path Unreal Specifiers

virtual void Deinitialize()

   TimedDataMonitorSubsystem.h  

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

   TimedDataMonitorSubsystem.h  

Static

Name Remarks Include Path Unreal Specifiers

static double GetEvaluationTime ( ETimedDataInputEvaluationType EvaluationType
)

 Get the current evaluation time. TimedDataMonitorSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page