Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > StageMonitor > IStageMonitorSession

Light Theme

Dark Theme

IStageMonitorSession

Interface describing a session of data received by the monitor Can be exported and reimported for future analysis

Windows

MacOS

Linux

References

Module	StageMonitor
Header	/Engine/Plugins/VirtualProduction/StageMonitoring/Source/StageMonitor/Public/IStageMonitorSession.h
Include	#include "IStageMonitorSession.h"

Syntax

class IStageMonitorSession

Remarks

Interface describing a session of data received by the monitor Can be exported and reimported for future analysis

Destructors

	Name	Description
	~IStageMonitorSession()

Functions

	Name	Description
bool	AddProvider ( const FGuid& Identifier, const FStageInstanceDescriptor& De..., const FMessageAddress& Address )	Adds a new provider to the ones we're handling data for. Returns true if a provider was added
void	AddProviderMessage ( UScriptStruct* Type, const FStageProviderMessage* M... )	Adds a message to the session
void	ClearAll()	Clear every activities of the session
void	ClearUnresponsiveProviders()	Clear unresponsive providers from active list
void	GetAllEntries ( TArray< TSharedPtr< FStageDataEntry... )	Returns all entries that have been received
TConstArrayV...	GetClearedProviders()	Get providers that were connected at some point but got cleared
TArray< FNam...	GetCriticalStateHistorySources()	Returns a list of all sources that triggered a critical state
TArray< FNam...	GetCriticalStateSources ( double TimeInSeconds )	Returns a list of all sources that triggered a critical state during TimeInSeconds.
FName	GetCurrentCriticalStateSource()	Returns Source name of the current critical state. Returns None if not active
TSharedPtr< ...	GetLatest ( const FGuid& Identifier, UScriptStruct* Type )	Returns the state of the desired provider
bool	GetProvider ( const FGuid& Identifier, FStageSessionProviderEntry& OutPro..., EGetProviderFlags Flags )	Get ProviderEntry associated to an identifier
TConstArrayV...	GetProviders()	Get all providers that have been connected to the monitor
TArray< FMes...	GetProvidersAddress()	Returns the addresses of the providers currently monitored
EStageDataPr...	GetProviderState ( const FGuid& Identifier )	Returns the state of the desired provider
FString	GetSessionName()	Returns the name of that session.
void	HandleDiscoveredProvider ( const FGuid& Identifier, const FStageInstanceDescriptor& De..., const FMessageAddress& Address )	Handles discovery response of a provider. Might already be found, unresponsive or a new one
bool	IsStageInCriticalState()	Returns true if stage monitor currently in critical state (i.e. recording)
bool	IsTimePartOfCriticalState ( double TimeInSeconds )	Returns true if the given time is part of a critical state time range.
FOnStageData...	OnStageDataProviderListChanged()
FOnStageData...	OnStageDataProviderStateChanged()
FOnStageSess...	OnStageSessionDataCleared()
FOnStageSess...	OnStageSessionNewDataReceived()
void	SetProviderState ( const FGuid& Identifier, EStageDataProviderState State )	Changes a provider's monitoring state

Typedefs

Name	Description
FOnStageDataProviderListChanged	Callback triggered when provider list changed
FOnStageDataProviderStateChanged	Callback triggered when provider state has changed
FOnStageSessionDataCleared	Callback triggered when data from the session has been cleared
FOnStageSessionNewDataReceived	Callback triggered when new data has been added to the session

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss