Navigation
API > API/Plugins > API/Plugins/TimedDataMonitor
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&40;&41;
class UTimedDataMonitorSubsystem : public UEngineSubsystem
Variables
| Type | Name | Description | |
|---|---|---|---|
| FTimedDataIdentifierListChangedSignature | OnIdentifierListChanged_Dynamic | Delegate of when an element is added or removed. |
Functions
| Type | Name | Description | |
|---|---|---|---|
| FTimedDataMonitorTimeCorrectionResult | ApplyTimeCorrection
(
const FTimedDataMonitorInputIdentifier& Identifier, |
Assume all data samples were produce at the same time and align them with the current platform's time | |
| void | Used to cache global (Engine TimecodeProvider) frame delay for the current frame. | ||
| void | CalibrateLatent
(
UObject* WorldContextObject, |
Change the Timecode Provider offset to align all inputs and channels. | |
| bool | DoesChannelExist
(
const FTimedDataMonitorChannelIdentifier& Identifier |
Return true if the identifier is a valid channel. | |
| bool | DoesInputExist
(
const FTimedDataMonitorInputIdentifier& Identifier |
Return true if the identifier is a valid input. | |
| void | Used to update statistics once all TimedData are processed. | ||
| TArray< FTimedDataMonitorChannelIdentifier > | Get the list of all the channels. | ||
| TArray< FTimedDataMonitorChannelIdentifier > | Get the list of all the channels that are enabled. | ||
| TArray< FTimedDataMonitorInputIdentifier > | GetAllInputs () |
Get the list of all the inputs. | |
| int32 | GetChannelBufferOverflowStat
(
const FTimedDataMonitorChannelIdentifier& Identifier |
Returns the number of buffer overflows detected by that input since the last reset. | |
| int32 | GetChannelBufferUnderflowStat
(
const FTimedDataMonitorChannelIdentifier& Identifier |
Returns the number of buffer underflows detected by that input since the last reset. | |
| ETimedDataInputState | GetChannelConnectionState
(
const FTimedDataMonitorChannelIdentifier& Identifier |
Get the state the channel. | |
| int32 | GetChannelDataBufferSize
(
const FTimedDataMonitorChannelIdentifier& Identifier |
If the channel does support it, get the current maximum sample count of channel. | |
| FText | GetChannelDisplayName
(
const FTimedDataMonitorChannelIdentifier& Identifier |
Return the display name of an input. | |
| float | GetChannelEvaluationDistanceToNewestSampleMean
(
const FTimedDataMonitorChannelIdentifier& Identifier |
Returns the average distance, in seconds, between evaluation time and newest sample | |
| float | Returns the standard deviation of the distance, in seconds, between evaluation time and newest sample | ||
| float | GetChannelEvaluationDistanceToOldestSampleMean
(
const FTimedDataMonitorChannelIdentifier& Identifier |
Returns the average distance, in seconds, between evaluation time and oldest sample | |
| float | Returns the standard deviation of the distance, in seconds, between evaluation time and oldest sample | ||
| ETimedDataMonitorEvaluationState | GetChannelEvaluationState
(
const FTimedDataMonitorChannelIdentifier& Identifier |
Get the evaluation state of the channel. | |
| TArray< FTimedDataChannelSampleTime > | GetChannelFrameDataTimes
(
const FTimedDataMonitorChannelIdentifier& Identifier |
Get the sample times for every frame in the channel | |
| int32 | GetChannelFrameDroppedStat
(
const FTimedDataMonitorChannelIdentifier& Identifier |
Returns the number of frames dropped by that input since the last reset. | |
| FTimedDataMonitorInputIdentifier | GetChannelInput
(
const FTimedDataMonitorChannelIdentifier& Identifier |
Return the input of this channel. | |
| void | GetChannelLastEvaluationDataStat
(
const FTimedDataMonitorChannelIdentifier& Identifier, |
Retrieves information about last evaluation Returns true if identifier was found | |
| FTimedDataChannelSampleTime | GetChannelNewestDataTime
(
const FTimedDataMonitorChannelIdentifier& Identifier |
Get the channel latest sample time. | |
| int32 | GetChannelNumberOfSamples
(
const FTimedDataMonitorChannelIdentifier& Identifier |
Get the number of data samples available. | |
| FTimedDataChannelSampleTime | GetChannelOldestDataTime
(
const FTimedDataMonitorChannelIdentifier& Identifier |
Get the channel oldest sample time. | |
| ETimedDataMonitorEvaluationState | Get the worst evaluation state of all the inputs. | ||
| double | GetEvaluationTime
(
ETimedDataInputEvaluationType EvaluationType |
Get the current evaluation time. | |
| float | GetEvaluationTimeOffsetInSeconds
(
ETimedDataInputEvaluationType EvaluationType |
Get offset applied to global evaluation time. Only works when a Timecode Provider is used | |
| TArray< FTimedDataMonitorChannelIdentifier > | GetInputChannels
(
const FTimedDataMonitorInputIdentifier& Identifier |
Return the list of all channels that are part of the input. | |
| ETimedDataInputState | GetInputConnectionState
(
const FTimedDataMonitorInputIdentifier& Identifier |
Get the worst state of all the channels of that input. | |
| int32 | GetInputDataBufferSize
(
const FTimedDataMonitorInputIdentifier& Identifier |
Get the size of the buffer used by the input. | |
| FText | GetInputDisplayName
(
const FTimedDataMonitorInputIdentifier& Identifier |
Return the display name of an input. | |
| ETimedDataMonitorInputEnabled | GetInputEnabled
(
const FTimedDataMonitorInputIdentifier& Identifier |
Is the input enabled in the monitor. | |
| float | GetInputEvaluationDistanceToNewestSampleMean
(
const FTimedDataMonitorInputIdentifier& Identifier |
Returns the max average distance, in seconds, between evaluation time and newest sample | |
| float | GetInputEvaluationDistanceToNewestSampleStandardDeviation
(
const FTimedDataMonitorInputIdentifier& Identifier |
Returns the standard deviation of the distance, in seconds, between evaluation time and newest sample | |
| float | GetInputEvaluationDistanceToOldestSampleMean
(
const FTimedDataMonitorInputIdentifier& Identifier |
Returns the min average distance, in seconds, between evaluation time and oldest sample | |
| float | GetInputEvaluationDistanceToOldestSampleStandardDeviation
(
const FTimedDataMonitorInputIdentifier& Identifier |
Returns the standard deviation of the distance, in seconds, between evaluation time and oldest sample | |
| float | GetInputEvaluationOffsetInFrames
(
const FTimedDataMonitorInputIdentifier& Identifier |
Get the offset in frames (see GetEvaluationType) used at evaluation. | |
| float | GetInputEvaluationOffsetInSeconds
(
const FTimedDataMonitorInputIdentifier& Identifier |
Get the offset in seconds or frames (see GetEvaluationType) used at evaluation. | |
| ETimedDataMonitorEvaluationState | GetInputEvaluationState
(
const FTimedDataMonitorInputIdentifier& Identifier |
Get the worst evaluation state of all the channels of that input. | |
| ETimedDataInputEvaluationType | GetInputEvaluationType
(
const FTimedDataMonitorInputIdentifier& Identifier |
Get how the input is evaluated type. | |
| FFrameRate | GetInputFrameRate
(
const FTimedDataMonitorInputIdentifier& Identifier |
Get the frame rate at which the samples is produce. | |
| FTimedDataChannelSampleTime | GetInputNewestDataTime
(
const FTimedDataMonitorInputIdentifier& Identifier |
Get the latest sample time of all the channel in this input. | |
| FTimedDataChannelSampleTime | GetInputOldestDataTime
(
const FTimedDataMonitorInputIdentifier& Identifier |
Get the oldest sample time of all the channel in this input. | |
| ITimedDataInputChannel * | GetTimedDataChannel
(
const FTimedDataMonitorChannelIdentifier& Identifier |
Get the interface for a specific channel identifier. | |
| ITimedDataInput * | GetTimedDataInput
(
const FTimedDataMonitorInputIdentifier& Identifier |
Get the interface for a specific input identifier. | |
| bool | IsChannelEnabled
(
const FTimedDataMonitorChannelIdentifier& Identifier |
Is the channel enabled in the monitor. | |
| bool | IsDataBufferSizeControlledByInput
(
const FTimedDataMonitorInputIdentifier& Identifier |
Does the channel support a different buffer size than it's input. | |
| FSimpleMulticastDelegate & | Delegate of when an element is added or removed. | ||
| void | Reset the stat of all the inputs. | ||
| void | SetChannelDataBufferSize
(
const FTimedDataMonitorChannelIdentifier& Identifier, |
If the channel does support it, set the maximum sample count of the channel. | |
| void | SetChannelEnabled
(
const FTimedDataMonitorChannelIdentifier& Identifier, |
Enable or disable an input from the monitor. | |
| void | SetInputDataBufferSize
(
const FTimedDataMonitorInputIdentifier& Identifier, |
Set the size of the buffer used by the input. | |
| void | SetInputEnabled
(
const FTimedDataMonitorInputIdentifier& Identifier, |
Set all channels for the input enabled in the monitor. | |
| void | SetInputEvaluationOffsetInFrames
(
const FTimedDataMonitorInputIdentifier& Identifier, |
Set the offset in frames (see GetEvaluationType) used at evaluation. | |
| void | SetInputEvaluationOffsetInSeconds
(
const FTimedDataMonitorInputIdentifier& Identifier, |
Set the offset in seconds or frames (see GetEvaluationType) used at evaluation. | |
| void | SetInputEvaluationType
(
const FTimedDataMonitorInputIdentifier& Identifier, |
Set how the input is evaluated type. |
Overridden from USubsystem
| Type | Name | Description | |
|---|---|---|---|
| void | Deinitialize () |
Implement this for deinitialization of instances of the system | |
| void | Initialize
(
FSubsystemCollectionBase& Collection |
Implement this for initialization of instances of the system |