UTimedDataMonitorSubsystem

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

TimedDataMonitor

Header

/Engine/Plugins/VirtualProduction/TimedDataMonitor/Source/TimedDataMonitor/Public/TimedDataMonitorSubsystem.h

Include

#include "TimedDataMonitorSubsystem.h"

Syntax

UCLASS()
class UTimedDataMonitorSubsystem : public UEngineSubsystem

Variables

Name Description

Public variable UProperty Category, Meta BlueprintAssignable

FTimedDataIdent...

 

OnIdentifierListChanged_Dynamic

Delegate of when an element is added or removed.

Functions

Name Description

Public function UFunction BlueprintCallable, Category

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

Public function

void

 

BeginFrameCallback()

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

Public function UFunction BlueprintCallable, Category, Meta

void

 

CalibrateLatent

(
    UObject* WorldContextObject,
    FLatentActionInfo LatentInfo,
    const FTimedDataMonitorCalibrationP...,
    FTimedDataMonitorCalibrationResult ...
)

Change the Timecode Provider offset to align all inputs and channels.

Public function UFunction BlueprintCallable, Category

bool

 

DoesChannelExist

(
    const FTimedDataMonitorChannelIdent...
)

Return true if the identifier is a valid channel.

Public function UFunction BlueprintCallable, Category

bool

 

DoesInputExist

(
    const FTimedDataMonitorInputIdentif...
)

Return true if the identifier is a valid input.

Public function

void

 

EndFrameCallback()

Used to update statistics once all TimedData are processed.

Public function UFunction BlueprintCallable, Category

TArray< FTim...

 

GetAllChannels()

Get the list of all the channels.

Public function UFunction BlueprintCallable, Category

TArray< FTim...

 

GetAllEnabledChannels()

Get the list of all the channels that are enabled.

Public function UFunction BlueprintCallable, Category

TArray< FTim...

 

GetAllInputs()

Get the list of all the inputs.

Public function UFunction BlueprintCallable, Category

int32

 

GetChannelBufferOverflowStat

(
    const FTimedDataMonitorChannelIdent...
)

Returns the number of buffer overflows detected by that input since the last reset.

Public function UFunction BlueprintCallable, Category

int32

 

GetChannelBufferUnderflowStat

(
    const FTimedDataMonitorChannelIdent...
)

Returns the number of buffer underflows detected by that input since the last reset.

Public function UFunction BlueprintCallable, Category

ETimedDataIn...

 

GetChannelConnectionState

(
    const FTimedDataMonitorChannelIdent...
)

Get the state the channel.

Public function UFunction BlueprintCallable, Category

int32

 

GetChannelDataBufferSize

(
    const FTimedDataMonitorChannelIdent...
)

If the channel does support it, get the current maximum sample count of channel.

Public function UFunction BlueprintCallable, Category

FText

 

GetChannelDisplayName

(
    const FTimedDataMonitorChannelIdent...
)

Return the display name of an input.

Public function UFunction BlueprintCallable, Category

float

 

GetChannelEvaluationDistanceToNewestSampleMean

(
    const FTimedDataMonitorChannelIdent...
)

Returns the average distance, in seconds, between evaluation time and newest sample

Public function UFunction BlueprintCallable, Category

float

 

GetChannelEvaluationDistanceToNewestSampleStandardDeviation

(
    const FTimedDataMonitorChannelIdent...
)

Returns the standard deviation of the distance, in seconds, between evaluation time and newest sample

Public function UFunction BlueprintCallable, Category

float

 

GetChannelEvaluationDistanceToOldestSampleMean

(
    const FTimedDataMonitorChannelIdent...
)

Returns the average distance, in seconds, between evaluation time and oldest sample

Public function UFunction BlueprintCallable, Category

float

 

GetChannelEvaluationDistanceToOldestSampleStandardDeviation

(
    const FTimedDataMonitorChannelIdent...
)

Returns the standard deviation of the distance, in seconds, between evaluation time and oldest sample

Public function UFunction BlueprintCallable, Category

ETimedDataMo...

 

GetChannelEvaluationState

(
    const FTimedDataMonitorChannelIdent...
)

Get the evaluation state of the channel.

Public function UFunction BlueprintCallable, Category

int32

 

GetChannelFrameDroppedStat

(
    const FTimedDataMonitorChannelIdent...
)

Returns the number of frames dropped by that input since the last reset.

Public function UFunction BlueprintCallable, Category

FTimedDataMo...

 

GetChannelInput

(
    const FTimedDataMonitorChannelIdent...
)

Return the input of this channel.

Public function UFunction BlueprintCallable, Category

void

 

GetChannelLastEvaluationDataStat

Retrieves information about last evaluation Returns true if identifier was found

Public function UFunction BlueprintCallable, Category

FTimedDataCh...

 

GetChannelNewestDataTime

(
    const FTimedDataMonitorChannelIdent...
)

Get the channel latest sample time.

Public function UFunction BlueprintCallable, Category

int32

 

GetChannelNumberOfSamples

(
    const FTimedDataMonitorChannelIdent...
)

Get the number of data samples available.

Public function UFunction BlueprintCallable, Category

FTimedDataCh...

 

GetChannelOldestDataTime

(
    const FTimedDataMonitorChannelIdent...
)

Get the channel oldest sample time.

Public function UFunction BlueprintCallable, Category

ETimedDataMo...

 

GetEvaluationState()

Get the worst evaluation state of all the inputs.

Public function Static

double

 

GetEvaluationTime

(
    ETimedDataInputEvaluationType Evalu...
)

Get the current evaluation time.

Public function

float

 

GetEvaluationTimeOffsetInSeconds

(
    ETimedDataInputEvaluationType Evalu...
)

Get offset applied to global evaluation time. Only works when a Timecode Provider is used

Public function UFunction BlueprintCallable, Category

TArray< FTim...

 

GetInputChannels

(
    const FTimedDataMonitorInputIdentif...
)

Return the list of all channels that are part of the input.

Public function UFunction BlueprintCallable, Category

ETimedDataIn...

 

GetInputConnectionState

(
    const FTimedDataMonitorInputIdentif...
)

Get the worst state of all the channels of that input.

Public function UFunction BlueprintCallable, Category

int32

 

GetInputDataBufferSize

(
    const FTimedDataMonitorInputIdentif...
)

Get the size of the buffer used by the input.

Public function UFunction BlueprintCallable, Category

FText

 

GetInputDisplayName

(
    const FTimedDataMonitorInputIdentif...
)

Return the display name of an input.

Public function UFunction BlueprintCallable, Category

ETimedDataMo...

 

GetInputEnabled

(
    const FTimedDataMonitorInputIdentif...
)

Is the input enabled in the monitor.

Public function UFunction BlueprintCallable, Category

float

 

GetInputEvaluationDistanceToNewestSampleMean

(
    const FTimedDataMonitorInputIdentif...
)

Returns the max average distance, in seconds, between evaluation time and newest sample

Public function UFunction BlueprintCallable, Category

float

 

GetInputEvaluationDistanceToNewestSampleStandardDeviation

(
    const FTimedDataMonitorInputIdentif...
)

Returns the standard deviation of the distance, in seconds, between evaluation time and newest sample

Public function UFunction BlueprintCallable, Category

float

 

GetInputEvaluationDistanceToOldestSampleMean

(
    const FTimedDataMonitorInputIdentif...
)

Returns the min average distance, in seconds, between evaluation time and oldest sample

Public function UFunction BlueprintCallable, Category

float

 

GetInputEvaluationDistanceToOldestSampleStandardDeviation

(
    const FTimedDataMonitorInputIdentif...
)

Returns the standard deviation of the distance, in seconds, between evaluation time and oldest sample

Public function UFunction BlueprintCallable, Category

float

 

GetInputEvaluationOffsetInSeconds

(
    const FTimedDataMonitorInputIdentif...
)

Get the offset in seconds or frames (see GetEvaluationType) used at evaluation.

Public function UFunction BlueprintCallable, Category

ETimedDataMo...

 

GetInputEvaluationState

(
    const FTimedDataMonitorInputIdentif...
)

Get the worst evaluation state of all the channels of that input.

Public function UFunction BlueprintCallable, Category

ETimedDataIn...

 

GetInputEvaluationType

(
    const FTimedDataMonitorInputIdentif...
)

Get how the input is evaluated type.

Public function UFunction BlueprintCallable, Category

FFrameRate

 

GetInputFrameRate

(
    const FTimedDataMonitorInputIdentif...
)

Get the frame rate at which the samples is produce.

Public function UFunction BlueprintCallable, Category

FTimedDataCh...

 

GetInputNewestDataTime

(
    const FTimedDataMonitorInputIdentif...
)

Get the latest sample time of all the channel in this input.

Public function UFunction BlueprintCallable, Category

FTimedDataCh...

 

GetInputOldestDataTime

(
    const FTimedDataMonitorInputIdentif...
)

Get the oldest sample time of all the channel in this input.

Public function

ITimedDataIn...

 

GetTimedDataChannel

(
    const FTimedDataMonitorChannelIdent...
)

Get the interface for a specific channel identifier.

Public function

ITimedDataIn...

 

GetTimedDataInput

(
    const FTimedDataMonitorInputIdentif...
)

Get the interface for a specific input identifier.

Public function UFunction BlueprintCallable, Category

bool

 

IsChannelEnabled

(
    const FTimedDataMonitorChannelIdent...
)

Is the channel enabled in the monitor.

Public function UFunction BlueprintCallable, Category

bool

 

IsDataBufferSizeControlledByInput

(
    const FTimedDataMonitorInputIdentif...
)

Does the channel support a different buffer size than it's input.

Public function

FSimpleMulti...

 

OnIdentifierListChanged()

Delegate of when an element is added or removed.

Public function UFunction BlueprintCallable, Category

void

 

ResetAllBufferStats()

Reset the stat of all the inputs.

Public function UFunction BlueprintCallable, Category

void

 

SetChannelDataBufferSize

(
    const FTimedDataMonitorChannelIdent...,
    int32 BufferSize
)

If the channel does support it, set the maximum sample count of the channel.

Public function UFunction BlueprintCallable, Category

void

 

SetChannelEnabled

(
    const FTimedDataMonitorChannelIdent...,
    bool bEnabled
)

Enable or disable an input from the monitor.

Public function UFunction BlueprintCallable, Category

void

 

SetInputDataBufferSize

(
    const FTimedDataMonitorInputIdentif...,
    int32 BufferSize
)

Set the size of the buffer used by the input.

Public function UFunction BlueprintCallable, Category

void

 

SetInputEnabled

(
    const FTimedDataMonitorInputIdentif...,
    bool bInEnabled
)

Set all channels for the input enabled in the monitor.

Public function UFunction BlueprintCallable, Category

void

 

SetInputEvaluationOffsetInSeconds

(
    const FTimedDataMonitorInputIdentif...,
    float Seconds
)

Set the offset in seconds or frames (see GetEvaluationType) used at evaluation.

Public function UFunction BlueprintCallable, Category

void

 

SetInputEvaluationType

(
    const FTimedDataMonitorInputIdentif...,
    ETimedDataInputEvaluationType Evalu...
)

Set how the input is evaluated type.

Overridden from USubsystem

Name Description

Public function Virtual

void

 

Deinitialize()

Implement this for deinitialization of instances of the system

Public function Virtual

void

 

Initialize

(
    FSubsystemCollectionBase& Collecti...
)

Implement this for initialization of instances of the system