Navigation
API > API/Developer > API/Developer/ProfilerClient
References
| Module | ProfilerClient |
| Header | /Engine/Source/Developer/ProfilerClient/Public/IProfilerClient.h |
| Include | #include "IProfilerClient.h" |
Syntax
class IProfilerClient
Remarks
Interface for Profiler Client.
Destructors
| Type | Name | Description | |
|---|---|---|---|
| Virtual destructor. |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | CancelLoading
(
const FGuid InstanceId |
Cancels a capture file load that is in progress | |
| const FStatMetaData & | GetStatMetaData
(
const FGuid& InstanceId |
Gets the description for the given stat id | |
| void | LoadCapture
(
const FString& DataFilepath, |
Loads a Capture file | |
| FProfilerLoadCancelledDelegate & | Retrieves the load cancelled delegate. | ||
| FProfilerLoadCompletedDelegate & | Retrieves the load completed delegate. | ||
| FProfilerLoadStartedDelegate & | Retrieves the load started delegate. | ||
| FProfilerMetaDataUpdateDelegate & | Retrieves the profiler meta data update delegate. | ||
| FProfilerClientConnectedDelegate & | Retrieves the profiler client connected delegate. | ||
| FProfilerClientDisconnectedDelegate & | Retrieves the profiler client disconnected delegate. | ||
| FProfilerClientDataDelegate & | Retrieves the profiler data delegate. | ||
| FProfilerFileTransferDelegate & | Retrieves the profiler file transfer delegate. | ||
| void | RequestLastCapturedFile
(
const FGuid& InstanceId |
Requests the last captured file from the service. | |
| void | SetCaptureState
(
const bool bRequestedCaptureState, |
Changes the current state of the capturing data service-side. | |
| void | SetPreviewState
(
const bool bRequestedPreviewState, |
Changes the current state of the previewing capture data. | |
| void | Subscribe to the given profiler session id | ||
| void | |||
| void | Unsubscribe () |
Unsubscribe from all sessions. | |
| void |