Navigation
API > API/Plugins > API/Plugins/StageMonitorCommon
Settings for the StageMonitoring plugin modules. Data Provider, Monitor and shared settings are contained here to centralize access through project settings
| Name | UStageMonitoringSettings |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/StageMonitoring/Source/StageMonitorCommon/Public/StageMonitoringSettings.h |
| Include Path | #include "StageMonitoringSettings.h" |
Syntax
UCLASS (Config=Game)
class UStageMonitoringSettings : public UDeveloperSettings
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UDeveloperSettings → UStageMonitoringSettings
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UStageMonitoringSettings() |
StageMonitoringSettings.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bUseSessionId | bool | If true, Stage monitor will only listen to Stage Providers with same sessionId | StageMonitoringSettings.h |
|
| CommandLineFriendlyName | FName | A friendly name for that instance given through command line (-StageFriendlyName=) to identify it when monitoring. | StageMonitoringSettings.h | |
| CommandLineSessionId | TOptional< int32 > | The current SessionId in a virtual production context read from the command line. | StageMonitoringSettings.h | |
| ExportSettings | FStageDataExportSettings | Settings for Data Providers | StageMonitoringSettings.h |
|
| MonitorSettings | FStageMonitorSettings | Settings for monitors | StageMonitoringSettings.h |
|
| ProviderSettings | FStageDataProviderSettings | Settings for Data Providers | StageMonitoringSettings.h |
|
| TimeoutInterval | float | Interval threshold between message reception before dropping out a provider or a monitor | StageMonitoringSettings.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetStageSessionId() |
Returns current SessionId either based on settings or overriden by commandline | StageMonitoringSettings.h |
Overridden from UDeveloperSettings
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FName GetCategoryName() |
StageMonitoringSettings.h | ||
virtual FText GetSectionText() |
StageMonitoringSettings.h |