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 > Plugins > Concert > IConcertSession

Light Theme

Dark Theme

IConcertSession

Interface for Concert sessions

Windows

MacOS

Linux

Inheritance Hierarchy

IConcertSession

	IConcertClientSession
	IConcertServerSession

References

Module	Concert
Header	/Engine/Plugins/Developer/Concert/ConcertMain/Source/Concert/Public/IConcertSession.h
Include	#include "IConcertSession.h"

Syntax

class IConcertSession

Remarks

Interface for Concert sessions

Destructors

	Name	Description
	~IConcertSession()

Functions

	Name	Description
void	ClearCustomEventHandler()	Clear a custom event handler for this session
bool	FindSessionClient ( const FGuid& EndpointId, FConcertSessionClientInfo& OutSess... )	Find the the client for the specified endpoint ID
FConcertScra...	GetClientScratchpad ( const FGuid& ClientEndpointId )	Get the scratchpad associated with the given client ID.
const FGuid ...	GetId()
const FStrin...	GetName()
FConcertScra...	GetScratchpad()	Get the scratchpad associated with this concert session.
TArray< FGui...	GetSessionClientEndpointIds()	Get the list of connected client endpoint IDs
TArray< FCon...	GetSessionClients()	Get the information about all connected clients
const FConce...	GetSessionInfo()
FString	GetSessionWorkingDirectory()	Give the working directory for this session
void	InternalClearCustomEventHandler ( const FName& EventMessageType )	Clear a custom event handler for this session
FDelegateHan...	InternalRegisterCustomEventHandler ( const FName& EventMessageType, const TSharedRef< IConcertSessionCu... )	Register a custom event handler for this session
void	InternalRegisterCustomRequestHandler ( const FName& RequestMessageType, const TSharedRef< IConcertSessionCu... )	Register a custom request handler for this session
void	InternalSendCustomEvent ( const UScriptStruct* EventType, const void* EventData, const TArray< FGuid >& Destination..., EConcertMessageFlags Flags )	Send a custom event event to the given endpoints
void	InternalSendCustomRequest ( const UScriptStruct* RequestTy..., const void* RequestData, const FGuid& DestinationEndpointId, const TSharedRef< IConcertSessionCu... )	Send a custom request to the given endpoint
void	InternalUnregisterCustomEventHandler ( const FName& EventMessageType, const FDelegateHandle EventHandle )	Unregister a custom event handler for this session
void	InternalUnregisterCustomEventHandler ( const FName& EventMessageType, const void* EventHandler )
void	InternalUnregisterCustomRequestHandler ( const FName& RequestMessageType )	Unregister a custom request handler for this session
FDelegateHan...	RegisterCustomEventHandler ( typename TConcertFunctionSessionCus... )	Register a custom event handler for this session
FDelegateHan...	RegisterCustomEventHandler ( HandlerType* Handler, typename TConcertRawSessionCustomEv... )	Register a custom event handler for this session
void	RegisterCustomRequestHandler ( typename TConcertFunctionSessionCus... )	Register a custom request handler for this session
void	RegisterCustomRequestHandler ( HandlerType* Handler, typename TConcertRawSessionCustomRe... )	Register a custom request handler for this session
void	SendCustomEvent ( const EventType& Event, const FGuid& DestinationEndpointId, EConcertMessageFlags Flags )	Send a custom event event to the given endpoint
void	SendCustomEvent ( const EventType& Event, const TArray< FGuid >& Destination..., EConcertMessageFlags Flags )	Send a custom event event to the given endpoints
TFuture< Res...	SendCustomRequest ( const RequestType& Request, const FGuid& DestinationEndpointId )	Send a custom request to the given endpoint
void	Shutdown()
void	Startup()
void	UnregisterCustomEventHandler ( const FDelegateHandle EventHandle )	Unregister a custom event handler for this session
void	UnregisterCustomEventHandler ( HandlerType* EventHandler )	Unregister a custom event handler for this session
void	UnregisterCustomRequestHandler()	Unregister a custom request handler for this session

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

Take our survey

Dismiss