UStageMonitoringSettings

Settings for the StageMonitoring plugin modules.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

StageMonitorCommon

Header

/Engine/Plugins/VirtualProduction/StageMonitoring/Source/StageMonitorCommon/Public/StageMonitoringSettings.h

Include

#include "StageMonitoringSettings.h"

Syntax

UCLASS(Config=Game)
class UStageMonitoringSettings : public UDeveloperSettings

Remarks

Settings for the StageMonitoring plugin modules. Data Provider, Monitor and shared settings are contained here to centralize access through project settings

Variables

Name Description

Public variable UProperty Category, EditAnywhere Config

bool

 

bUseSessionId

If true, Stage monitor will only listen to Stage Providers with same sessionId

Public variable

FName

 

CommandLineFriendlyName

A friendly name for that instance given through command line (-StageFriendlyName=) to identify it when monitoring.

Public variable

TOptional< int3...

 

CommandLineSessionId

The current SessionId in a virtual production context read from the command line.

Public variable UProperty Category, EditAnywhere Config

FStageDataExpor...

 

ExportSettings

Settings for Data Providers

Public variable UProperty Category, EditAnywhere Config

FStageMonitorSe...

 

MonitorSettings

Settings for monitors

Public variable UProperty Category, EditAnywhere Config

FStageDataProvi...

 

ProviderSettings

Settings for Data Providers

Protected variable UProperty Category, EditAnywhere Config

int32

 

StageSessionId

The projects Stage SessionId to differentiate data sent over network.

Public variable UProperty Category, EditAnywhere, Meta Config

float

 

TimeoutInterval

Interval threshold between message reception before dropping out a provider or a monitor

Constructors

Name Description

Public function

UStageMonitoringSettings()

Functions

Name Description

Public function Const

int32

 

GetStageSessionId()

Returns current SessionId either based on settings or overriden by commandline

Overridden from UDeveloperSettings

Name Description

Public function Virtual Const

FName

 

GetCategoryName()

Gets the category for the settings, some high level grouping like, Editor, Engine, Game...etc.

Public function Virtual Const

FText

 

GetSectionText()

Gets the section text, uses the classes DisplayName by default.