IProfilerClient

Interface for Profiler Client.

Unreal Engine C++ API Reference > 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
  ~IProfilerClient () Virtual destructor.

Functions

Type Name Description
void CancelLoading ( const FGuid InstanceId ) Cancels a capture file load that is in progress
const FStatM... GetStatMetaData ( const FGuid& InstanceId ) Gets the description for the given stat id
void LoadCapture ( const FString& DataFilepath, const FGuid& ProfileId ) Loads a Capture file
FProfilerLoa... OnLoadCancelled () Retrieves the load cancelled delegate.
FProfilerLoa... OnLoadCompleted () Retrieves the load completed delegate.
FProfilerLoa... OnLoadStarted () Retrieves the load started delegate.
FProfilerMet... OnMetaDataUpdated () Retrieves the profiler meta data update delegate.
FProfilerCli... OnProfilerClientConnected () Retrieves the profiler client connected delegate.
FProfilerCli... OnProfilerClientDisconnected () Retrieves the profiler client disconnected delegate.
FProfilerCli... OnProfilerData () Retrieves the profiler data delegate.
FProfilerFil... OnProfilerFileTransfer () Retrieves the profiler file transfer delegate.
void RequestLastCapturedFile ( const FGuid& InstanceId ) Requests the last captured file from the service.
void SetCaptureState ( const bool bRequestedCaptureState, const FGuid& InstanceId ) Changes the current state of the capturing data service-side.
void SetPreviewState ( const bool bRequestedPreviewState, const FGuid& InstanceId ) Changes the current state of the previewing capture data.
void Subscribe ( const FGuid& Session ) Subscribe to the given profiler session id
void Track ( const FGuid& Instance )  
void Unsubscribe () Unsubscribe from all sessions.
void Untrack ( const FGuid& Instance )  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library