Navigation
API > API/Plugins > API/Plugins/ChaosVD
Manager class used by Chaos VD to interact/control UE Trace systems
| Name | FChaosVDTraceManager |
| Type | class |
| Header File | /Engine/Plugins/ChaosVD/Source/ChaosVD/Public/Trace/ChaosVDTraceManager.h |
| Include Path | #include "Trace/ChaosVDTraceManager.h" |
Syntax
class FChaosVDTraceManager
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FChaosVDTraceManager() |
Trace/ChaosVDTraceManager.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FChaosVDTraceManager() |
Trace/ChaosVDTraceManager.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AnalysisSessionByName | TMap< FString, TSharedPtr< const TraceServices::IAnalysisSession > > | The trace analysis session. | Trace/ChaosVDTraceManager.h | |
| ChaosVDTraceModule | TSharedPtr< FChaosVDTraceModule > | Trace/ChaosVDTraceManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CloseSession
(
const FString& InSessionName |
Stops and de-registers a trace session registered with the provided session name | Trace/ChaosVDTraceManager.h | |
FString ConnectToLiveSession
(
FStringView InSessionHost, |
Connects to a live Trace Session and starts analyzing it. | Trace/ChaosVDTraceManager.h | |
FString ConnectToLiveSession_Direct
(
uint16& OutSessionPort, |
Opens up a direct trace stream and waits for data | Trace/ChaosVDTraceManager.h | |
FString ConnectToLiveSession_Relay
(
FGuid RemoteSessionID, |
Opens up a relay trace stream and waits for data | Trace/ChaosVDTraceManager.h | |
void EnumerateActiveSessions
(
FStringView InSessionHost, |
Trace/ChaosVDTraceManager.h | ||
void EnumerateActiveSessions
(
TVisitor Callback |
Trace/ChaosVDTraceManager.h | ||
FString GetLocalTraceStoreDirPath() |
Returns the path to the local trace store | Trace/ChaosVDTraceManager.h | |
TSharedPtr< const TraceServices::IAnalysisSession > GetSession
(
const FString& InSessionName |
Returns a ptr to the session registered with the provided session name. Null if no session is found | Trace/ChaosVDTraceManager.h | |
UE::Trace::FStoreClient::FTraceData GetTraceDataStreamFromStore
(
FStringView InSessionHost, |
Access the trace store at the provided host address, and returns a trace data stream ready to use | Trace/ChaosVDTraceManager.h | |
FString GetTraceFileNameFromStoreForSession
(
FStringView InSessionHost, |
Access the trace store at the provided host address, and returns the file name for the trace file | Trace/ChaosVDTraceManager.h | |
FString LoadTraceFile
(
const FString& InTraceFilename, |
Load a trace file and starts analyzing it | Trace/ChaosVDTraceManager.h | |
FString LoadTraceFile
(
TUniquePtr< IFileHandle >&& InFileHandle, |
Trace/ChaosVDTraceManager.h | ||
void StopSession
(
const FString& InSessionName |
Stops a trace session registered with the provided session name | Trace/ChaosVDTraceManager.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void EnumerateActiveSessions
(
FStringView InSessionHost, |
Trace/ChaosVDTraceManager.h | ||
static const UE::Trace::FStoreClient::FSessionInfo * GetTraceSessionInfo
(
FStringView InSessionHost, |
Trace/ChaosVDTraceManager.h |