ITraceController | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/SessionServices

Interface for monitoring known trace service instances. ITraceController is a singleton which tracks all known instances and provides callback for status updates and interfaces to issue commands to one or more remote instances.

Example usage: //I'vefoundthesessioninstancethatwewanttocontrolFGuidInstanceId=...;//GetthecontrollerTSharedPtrTraceController=SessionServicesModule.GetTraceController();//Tocontroljustasingleinstanceusethesessioninstanceid.TraceController->WithInstance(InstanceId,const[FTraceStatus](API/Runtime/SessionServices/FTraceStatus)&Status,[ITraceControllerCommands](API/Runtime/SessionServices/ITraceControllerCommands)&Commands{Commands.Send("localhost","audio,audiomixer,bookmark,log");Commands.Bookmark("Myremotebookmark");});


Name	ITraceController
Type	class
Header File	/Engine/Source/Runtime/SessionServices/Public/ITraceController.h
Include Path	#include "ITraceController.h"

Syntax

class ITraceController

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~ITraceController()		ITraceController.h

Classes

Name	Remarks
FStatusRecievedEvent	Generic event for updates of status

Typedefs

Name	Type	Remarks	Include Path
FCallback	TFunction< void(const FTraceStatus &, ITraceControllerCommands &)>		ITraceController.h

Functions

Public

Name	Remarks	Include Path
bool HasAvailableInstance ( const FGuid& InstanceId )	Return true if an instance with the provided Id exists and has been discovered.	ITraceController.h
FStatusRecievedEvent & OnStatusReceived ()	Event triggered whenever status is updated for any known session.	ITraceController.h
void SendChannelUpdateRequest()	Request update of channel status from all sessions and instances.	ITraceController.h
void SendDiscoveryRequest ()	Request to discover all instances	ITraceController.h
void SendDiscoveryRequest ( const FGuid& SessionId, const FGuid& InstanceId ) const	Request to discover a specific instance	ITraceController.h
void SendSettingsUpdateRequest()	Request update of setting state from all sessions and instances.	ITraceController.h
void SendStatusUpdateRequest()	Request update of the status from all sessions and instances.	ITraceController.h
void WithInstance ( FGuid InstanceId, FCallback Func )	Execute a function on a specific session.	ITraceController.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static TSharedPtr< ITraceController > Create ( TSharedPtr< class IMessageBus >& MessageBus )	Create an instance using a custom message bus	ITraceController.h

Navigation