unreal.TimedDataMonitorSubsystem

class unreal.TimedDataMonitorSubsystem(outer=None, name='None')

Bases: unreal.EngineSubsystem

Timed Data Monitor Subsystem

C++ Source:

  • Plugin: TimedDataMonitor

  • Module: TimedDataMonitor

  • File: TimedDataMonitorSubsystem.h

Editor Properties: (see get_editor_property/set_editor_property)

  • on_identifier_list_changed_dynamic (TimedDataIdentifierListChangedSignature): [Read-Write] Delegate of when an element is added or removed.

apply_time_correction(identifier, time_correction_parameters)TimedDataMonitorTimeCorrectionResult

Assume all data samples were produce at the same time and align them with the current platform’s time

Parameters
Returns

Return type

TimedDataMonitorTimeCorrectionResult

calibrate_latent(world_context_object, latent_info, calibration_parameters)TimedDataMonitorCalibrationResult

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

Parameters
Returns

result (TimedDataMonitorCalibrationResult):

Return type

TimedDataMonitorCalibrationResult

does_channel_exist(identifier)bool

Return true if the identifier is a valid channel.

Parameters

identifier (TimedDataMonitorChannelIdentifier) –

Returns

Return type

bool

does_input_exist(identifier)bool

Return true if the identifier is a valid input.

Parameters

identifier (TimedDataMonitorInputIdentifier) –

Returns

Return type

bool

get_all_channels()

Get the list of all the channels.

Returns

Return type

Array(TimedDataMonitorChannelIdentifier)

get_all_enabled_channels()

Get the list of all the channels that are enabled.

Returns

Return type

Array(TimedDataMonitorChannelIdentifier)

get_all_inputs()

Get the list of all the inputs.

Returns

Return type

Array(TimedDataMonitorInputIdentifier)

get_channel_buffer_overflow_stat(identifier)int32

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

Parameters

identifier (TimedDataMonitorChannelIdentifier) –

Returns

Return type

int32

get_channel_buffer_underflow_stat(identifier)int32

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

Parameters

identifier (TimedDataMonitorChannelIdentifier) –

Returns

Return type

int32

get_channel_connection_state(identifier)TimedDataInputState

Get the state the channel.

Parameters

identifier (TimedDataMonitorChannelIdentifier) –

Returns

Return type

TimedDataInputState

get_channel_data_buffer_size(identifier)int32

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

Parameters

identifier (TimedDataMonitorChannelIdentifier) –

Returns

Return type

int32

get_channel_display_name(identifier)Text

Return the display name of an input.

Parameters

identifier (TimedDataMonitorChannelIdentifier) –

Returns

Return type

Text

get_channel_evaluation_distance_to_newest_sample_mean(identifier)float

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

Parameters

identifier (TimedDataMonitorChannelIdentifier) –

Returns

Return type

float

get_channel_evaluation_distance_to_newest_sample_standard_deviation(identifier)float

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

Parameters

identifier (TimedDataMonitorChannelIdentifier) –

Returns

Return type

float

get_channel_evaluation_distance_to_oldest_sample_mean(identifier)float

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

Parameters

identifier (TimedDataMonitorChannelIdentifier) –

Returns

Return type

float

get_channel_evaluation_distance_to_oldest_sample_standard_deviation(identifier)float

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

Parameters

identifier (TimedDataMonitorChannelIdentifier) –

Returns

Return type

float

get_channel_evaluation_state(identifier)TimedDataMonitorEvaluationState

Get the evaluation state of the channel.

Parameters

identifier (TimedDataMonitorChannelIdentifier) –

Returns

Return type

TimedDataMonitorEvaluationState

get_channel_frame_dropped_stat(identifier)int32

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

Parameters

identifier (TimedDataMonitorChannelIdentifier) –

Returns

Return type

int32

get_channel_input(identifier)TimedDataMonitorInputIdentifier

Return the input of this channel.

Parameters

identifier (TimedDataMonitorChannelIdentifier) –

Returns

Return type

TimedDataMonitorInputIdentifier

get_channel_last_evaluation_data_stat(identifier)TimedDataInputEvaluationData

Retrieves information about last evaluation Returns true if identifier was found

Parameters

identifier (TimedDataMonitorChannelIdentifier) –

Returns

result (TimedDataInputEvaluationData):

Return type

TimedDataInputEvaluationData

get_channel_newest_data_time(identifier)TimedDataChannelSampleTime

Get the channel latest sample time.

Parameters

identifier (TimedDataMonitorChannelIdentifier) –

Returns

Return type

TimedDataChannelSampleTime

get_channel_number_of_samples(identifier)int32

Get the number of data samples available.

Parameters

identifier (TimedDataMonitorChannelIdentifier) –

Returns

Return type

int32

get_channel_oldest_data_time(identifier)TimedDataChannelSampleTime

Get the channel oldest sample time.

Parameters

identifier (TimedDataMonitorChannelIdentifier) –

Returns

Return type

TimedDataChannelSampleTime

get_evaluation_state()TimedDataMonitorEvaluationState

Get the worst evaluation state of all the inputs.

Returns

Return type

TimedDataMonitorEvaluationState

get_input_channels(identifier)

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

Parameters

identifier (TimedDataMonitorInputIdentifier) –

Returns

Return type

Array(TimedDataMonitorChannelIdentifier)

get_input_connection_state(identifier)TimedDataInputState

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

Parameters

identifier (TimedDataMonitorInputIdentifier) –

Returns

Return type

TimedDataInputState

get_input_data_buffer_size(identifier)int32

Get the size of the buffer used by the input.

Parameters

identifier (TimedDataMonitorInputIdentifier) –

Returns

Return type

int32

get_input_display_name(identifier)Text

Return the display name of an input.

Parameters

identifier (TimedDataMonitorInputIdentifier) –

Returns

Return type

Text

get_input_enabled(identifier)TimedDataMonitorInputEnabled

Is the input enabled in the monitor.

Parameters

identifier (TimedDataMonitorInputIdentifier) –

Returns

Return type

TimedDataMonitorInputEnabled

get_input_evaluation_distance_to_newest_sample_mean(identifier)float

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

Parameters

identifier (TimedDataMonitorInputIdentifier) –

Returns

Return type

float

get_input_evaluation_distance_to_newest_sample_standard_deviation(identifier)float

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

Parameters

identifier (TimedDataMonitorInputIdentifier) –

Returns

Return type

float

get_input_evaluation_distance_to_oldest_sample_mean(identifier)float

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

Parameters

identifier (TimedDataMonitorInputIdentifier) –

Returns

Return type

float

get_input_evaluation_distance_to_oldest_sample_standard_deviation(identifier)float

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

Parameters

identifier (TimedDataMonitorInputIdentifier) –

Returns

Return type

float

get_input_evaluation_offset_in_seconds(identifier)float

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

Parameters

identifier (TimedDataMonitorInputIdentifier) –

Returns

Return type

float

get_input_evaluation_state(identifier)TimedDataMonitorEvaluationState

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

Parameters

identifier (TimedDataMonitorInputIdentifier) –

Returns

Return type

TimedDataMonitorEvaluationState

get_input_evaluation_type(identifier)TimedDataInputEvaluationType

Get how the input is evaluated type.

Parameters

identifier (TimedDataMonitorInputIdentifier) –

Returns

Return type

TimedDataInputEvaluationType

get_input_frame_rate(identifier)FrameRate

Get the frame rate at which the samples is produce.

Parameters

identifier (TimedDataMonitorInputIdentifier) –

Returns

Return type

FrameRate

get_input_newest_data_time(identifier)TimedDataChannelSampleTime

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

Parameters

identifier (TimedDataMonitorInputIdentifier) –

Returns

Return type

TimedDataChannelSampleTime

get_input_oldest_data_time(identifier)TimedDataChannelSampleTime

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

Parameters

identifier (TimedDataMonitorInputIdentifier) –

Returns

Return type

TimedDataChannelSampleTime

is_channel_enabled(identifier)bool

Is the channel enabled in the monitor.

Parameters

identifier (TimedDataMonitorChannelIdentifier) –

Returns

Return type

bool

is_data_buffer_size_controlled_by_input(identifier)bool

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

Parameters

identifier (TimedDataMonitorInputIdentifier) –

Returns

Return type

bool

property on_identifier_list_changed_dynamic

[Read-Write] Delegate of when an element is added or removed.

Type

(TimedDataIdentifierListChangedSignature)

reset_all_buffer_stats()None

Reset the stat of all the inputs.

set_channel_data_buffer_size(identifier, buffer_size)None

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

Parameters
set_channel_enabled(identifier, enabled)None

Enable or disable an input from the monitor. The input will still be evaluated but stats will not be tracked and the will not be used for calibration.

Parameters
set_input_data_buffer_size(identifier, buffer_size)None

Set the size of the buffer used by the input.

Parameters
set_input_enabled(identifier, enabled)None

Set all channels for the input enabled in the monitor.

Parameters
set_input_evaluation_offset_in_seconds(identifier, seconds)None

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

Parameters
set_input_evaluation_type(identifier, evaluation)None

Set how the input is evaluated type.

Parameters