IStageMonitorSession

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

API > API/Plugins > API/Plugins/StageMonitor

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

   
Name IStageMonitorSession
Type class
Header File /Engine/Plugins/VirtualProduction/StageMonitoring/Source/StageMonitor/Public/IStageMonitorSession.h
Include Path #include "IStageMonitorSession.h"

Syntax

class IStageMonitorSession

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IStageMonitorSession()

   IStageMonitorSession.h  

Typedefs

Name Type Remarks Include Path
FOnStageDataProviderListChanged TMulticastDelegate_NoParams< void > Callback triggered when provider list changed IStageMonitorSession.h
FOnStageDataProviderStateChanged TMulticastDelegate_TwoParams< void, const FGuid &, EStageDataProviderState > Callback triggered when provider state has changed IStageMonitorSession.h
FOnStageSessionDataCleared TMulticastDelegate_NoParams< void > Callback triggered when data from the session has been cleared IStageMonitorSession.h
FOnStageSessionNewDataReceived TMulticastDelegate_OneParam< void, TSharedPtr< FStageDataEntry > > Callback triggered when new data has been added to the session IStageMonitorSession.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddProvider ( const FGuid& Identifier,
const FStageInstanceDescriptor& Descriptor,
const FMessageAddress& Address
)

 Adds a new provider to the ones we're handling data for. Returns true if a provider was added IStageMonitorSession.h  

void AddProviderMessage ( UScriptStruct* Type,
const FStageProviderMessage* MessageData
)

 Adds a message to the session IStageMonitorSession.h  

void ClearAll()

 Clear every activities of the session IStageMonitorSession.h  

void ClearUnresponsiveProviders()

 Clear unresponsive providers from active list IStageMonitorSession.h  

void GetAllEntries ( TArray< TSharedPtr< FStageDataEntry > >& OutEntries
)

 Returns all entries that have been received IStageMonitorSession.h  

TConstArrayView< FStageSessionProviderEntry > GetClearedProviders()

 Get providers that were connected at some point but got cleared IStageMonitorSession.h  

TArray< FName > GetCriticalStateHistorySources()

 Returns a list of all sources that triggered a critical state IStageMonitorSession.h  

TArray< FName > GetCriticalStateSources ( double TimeInSeconds
) const

 Returns a list of all sources that triggered a critical state during TimeInSeconds. IStageMonitorSession.h  

FName GetCurrentCriticalStateSource()

 Returns Source name of the current critical state. Returns None if not active IStageMonitorSession.h  

TSharedPtr< FStageDataEntry > GetLatest ( const FGuid& Identifier,
UScriptStruct* Type
)

 Returns the state of the desired provider IStageMonitorSession.h  

bool GetProvider ( const FGuid& Identifier,
FStageSessionProviderEntry& OutProviderEntry,
EGetProviderFlags Flags
) const

 Get ProviderEntry associated to an identifier IStageMonitorSession.h  

TConstArrayView< FStageSessionProviderEntry > GetProviders()

 Get all providers that have been connected to the monitor IStageMonitorSession.h  

TArray< FMessageAddress > GetProvidersAddress()

 Returns the addresses of the providers currently monitored IStageMonitorSession.h  

EStageDataProviderState GetProviderState ( const FGuid& Identifier
)

 Returns the state of the desired provider IStageMonitorSession.h  

FString GetSessionName()

 Returns the name of that session. IStageMonitorSession.h  

void HandleDiscoveredProvider ( const FGuid& Identifier,
const FStageInstanceDescriptor& Descriptor,
const FMessageAddress& Address
)

 Handles discovery response of a provider. Might already be found, unresponsive or a new one IStageMonitorSession.h  

bool IsStageInCriticalState()

 Returns true if stage monitor currently in critical state (i.e. recording) IStageMonitorSession.h  

bool IsTimePartOfCriticalState ( double TimeInSeconds
) const

 Returns true if the given time is part of a critical state time range. IStageMonitorSession.h  

FOnStageDataProviderListChanged & OnStageDataProviderListChanged()

   IStageMonitorSession.h  

FOnStageDataProviderStateChanged & OnStageDataProviderStateChanged()

   IStageMonitorSession.h  

FOnStageSessionDataCleared & OnStageSessionDataCleared()

   IStageMonitorSession.h  

FOnStageSessionNewDataReceived & OnStageSessionNewDataReceived()

   IStageMonitorSession.h  

void SetProviderState ( const FGuid& Identifier,
EStageDataProviderState State
)

 Changes a provider's monitoring state IStageMonitorSession.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page