ITraceController | Unreal Engine 5.5 Documentation

API > API/Runtime > API/Runtime/SessionServices

References


Module	SessionServices
Header	/Engine/Source/Runtime/SessionServices/Public/ITraceController.h
Include	#include "ITraceController.h"

Syntax

class ITraceController

Remarks

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");});

Destructors

	Type	Name	Description
		~ITraceController ()

Functions

Type	Name	Description
TSharedPtr< ITraceController >	Create ( TSharedPtr< class IMessageBus >& MessageBus )	Create an instance using a custom message bus
bool	HasAvailableInstance ( const FGuid& InstanceId )	Return true if an instance with the provided Id exists and has been discovered.
FStatusRecievedEvent &	OnStatusReceived ()	Event triggered whenever status is updated for any known session.
void	SendChannelUpdateRequest ()	Request update of channel status from all sessions and instances.
void	SendDiscoveryRequest ()	Request to discover all instances
void	SendDiscoveryRequest ( const FGuid& SessionId, const FGuid& InstanceId )	Request to discover a specific instance
void	SendSettingsUpdateRequest ()	Request update of setting state from all sessions and instances.
void	SendStatusUpdateRequest ()	Request update of the status from all sessions and instances.
void	WithInstance ( FGuid InstanceId, FCallback Func )	Execute a function on a specific session.

Classes

	Type	Name	Description
	FStatusRecievedEvent	Generic event for updates of status

Typedefs

Name	Description
FCallback

Navigation