IProfilerClient

Interface for Profiler Client.

Windows
MacOS
Linux

References

Module

ProfilerClient

Header

/Engine/Source/Developer/ProfilerClient/Public/IProfilerClient.h

Include

#include "IProfilerClient.h"

Syntax

class IProfilerClient

Remarks

Interface for Profiler Client.

Destructors

Name Description

Protected function Virtual

~IProfilerClient()

Virtual destructor.

Functions

Name Description

Public function

void

 

CancelLoading

(
    const FGuid InstanceId
)

Cancels a capture file load that is in progress

Public function Const

const FStatM...

 

GetStatMetaData

(
    const FGuid& InstanceId
)

Gets the description for the given stat id

Public function

void

 

LoadCapture

(
    const FString& DataFilepath,
    const FGuid& ProfileId
)

Loads a Capture file

Public function

FProfilerLoa...

 

OnLoadCancelled()

Retrieves the load cancelled delegate.

Public function

FProfilerLoa...

 

OnLoadCompleted()

Retrieves the load completed delegate.

Public function

FProfilerLoa...

 

OnLoadStarted()

Retrieves the load started delegate.

Public function

FProfilerMet...

 

OnMetaDataUpdated()

Retrieves the profiler meta data update delegate.

Public function

FProfilerCli...

 

OnProfilerClientConnected()

Retrieves the profiler client connected delegate.

Public function

FProfilerCli...

 

OnProfilerClientDisconnected()

Retrieves the profiler client disconnected delegate.

Public function

FProfilerCli...

 

OnProfilerData()

Retrieves the profiler data delegate.

Public function

FProfilerFil...

 

OnProfilerFileTransfer()

Retrieves the profiler file transfer delegate.

Public function

void

 

RequestLastCapturedFile

(
    const FGuid& InstanceId
)

Requests the last captured file from the service.

Public function

void

 

SetCaptureState

(
    const bool bRequestedCaptureState,
    const FGuid& InstanceId
)

Changes the current state of the capturing data service-side.

Public function

void

 

SetPreviewState

(
    const bool bRequestedPreviewState,
    const FGuid& InstanceId
)

Changes the current state of the previewing capture data.

Public function

void

 

Subscribe

(
    const FGuid& Session
)

Subscribe to the given profiler session id

Public function

void

 

Track

(
    const FGuid& Instance
)

Public function

void

 

Unsubscribe()

Unsubscribe from all sessions.

Public function

void

 

Untrack

(
    const FGuid& Instance
)