Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Developer > ProfilerClient > IProfilerClient

Light Theme

Dark Theme

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
	~IProfilerClient()	Virtual destructor.

Functions

	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 )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss