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 > IConcertClient

Light Theme

Dark Theme

IConcertClient

Interface for Concert client

Windows

MacOS

Linux

References

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

Syntax

class IConcertClient

Remarks

Interface for Concert client

Destructors

	Name	Description
	~IConcertClient()

Functions

	Name	Description
TFuture< ECo...	ArchiveSession ( const FGuid& ServerAdminEndpointId, const FConcertArchiveSessionArgs& ... )	Archive a live session on the server hosting the session.
bool	CanAutoConnect()	Returns true if the client is configured for auto connection.
void	Configure ( const UConcertClientConfig* In... )	Configure the client settings and its information.
TFuture< ECo...	CopySession ( const FGuid& ServerAdminEndpointId, const FConcertCopySessionArgs& Cop... )	Copy a live or and archived session into a new live session on server, matching the configured settings.
TFuture< ECo...	CreateSession ( const FGuid& ServerAdminEndpointId, const FConcertCreateSessionArgs& C... )	Create a session on the server, matching the client configured settings.
TFuture< ECo...	DeleteSession ( const FGuid& ServerAdminEndpointId, const FGuid& SessionId )	Delete a live or archived session from the server if the client is the owner of the session.
void	DisconnectSession()	Disconnect from the current session.
TFuture< FCo...	DropSessionRepositories ( const FGuid& ServerAdminEndpointId, const TArray< FGuid >& RepositoryI... )	Drop a set of repositories (and delete the files) from the server.
TFuture< FCo...	GetArchivedSessions ( const FGuid& ServerAdminEndpointId )	Get the list of the archived sessions data from a server
const FConce...	GetClientInfo()	Get the client information passed to Configure() if the client is not in a session, otherwise, returns the current session client info as returned by IConcertClientSession::GetLocalClientInfo().
const UConce...	GetConfiguration()	Return The configuration of this client, or null if it hasn't been configured.
TSharedPtr< ...	GetCurrentSession()	Get the current client session (if any).
TArray< FCon...	GetKnownServers()	Get the list of discovered server information
FConcertConn...	GetLastConnectionError()	Get the last connection error
TFuture< FCo...	GetLiveSessions ( const FGuid& ServerAdminEndpointId )	Get the list of the live sessions data from a server
const FStrin...	GetRole()	Get the role of this client (eg, MultiUser, DisasterRecovery, etc)
TFuture< FCo...	GetServerSessions ( const FGuid& ServerAdminEndpointId )	Get the list of sessions available on a server
TFuture< FCo...	GetSessionActivities ( const FGuid& ServerAdminEndpointId, const FGuid& SessionId, int64 FromActivityId, int64 ActivityCount, bool bIncludeDetails )	Get the specified session activities, ordered by Activity ID (ascending) from a live or archived session without being connected to it.
TFuture< FCo...	GetSessionClients ( const FGuid& ServerAdminEndpointId, const FGuid& SessionId )	Get the list of clients connected to a session on the server
EConcertConn...	GetSessionConnectionStatus()	Get the connection status of client session or disconnected if no session is present
TFuture< FCo...	GetSessionRepositories ( const FGuid& ServerAdminEndpointId )	Request the list of existing session repositories from the server.
bool	IsAutoConnecting()	Returns true if the client has an active auto connection routine.
bool	IsConfigured()	Return true if the client has been configured.
bool	IsDiscoveryEnabled()	Returns true if server discovery is enabled.
bool	IsOwnerOf ( const FConcertSessionInfo& InSessi... )	Does the client think he is the owner of the session?
bool	IsSessionSuspended()	Does the current session have live-updates suspended?
bool	IsStarted()	Returns if the client has already been started up.
TFuture< ECo...	JoinSession ( const FGuid& ServerAdminEndpointId, const FGuid& SessionId )	Join a session on the server, the settings of the sessions needs to be compatible with the client settings or the connection will be refused.
TFuture< FCo...	MountSessionRepository ( const FGuid& ServerAdminEndpointId, const FString& RepositoryRootDir, const FGuid& RepositoryId, bool bCreateIfNotExist, bool bAsDefault )	Create or load a repository (directory structure) containing sessions.
FOnConcertCl...	OnGetPreConnectionTasks()	Get the delegate that is called to get the pre-connection tasks for a client session
FSimpleMulti...	OnKnownServersUpdated()	Get the delegate callback for when the known server list is updated
FOnConcertCl...	OnSessionConnectionChanged()	Get the delegate that is called when the session connection state changes
FOnConcertCl...	OnSessionShutdown()	Get the delegate that is called right before the client session shutdown
FOnConcertCl...	OnSessionStartup()	Get the delegate that is called right before the client session startup
TFuture< ECo...	RenameSession ( const FGuid& ServerAdminEndpointId, const FGuid& SessionId, const FString& NewName )	Rename a live or archived session if the client has the permission.
TFuture< ECo...	RestoreSession ( const FGuid& ServerAdminEndpointId, const FConcertCopySessionArgs& Res... )	Copy an archived session into a new live session on the server, matching the client configured settings.
void	ResumeSession()	Resume live-updates for the current session (must be paired with a call to SuspendSession).
void	Shutdown()	Shutdown the client, its discovery and session, if any.
void	StartAutoConnect()	Start attempting to auto connect the client to the default session on the default server.
void	StartDiscovery()	Start the discovery service for the client This will look for Concert server and populate the known servers list
void	Startup()	Startup the client, this can be called multiple time Configure needs to be called before startup
void	StopAutoConnect()	Stop the current auto connection if currently enabled.
void	StopDiscovery()	Stop the discovery service for the client
void	SuspendSession()	Suspend live-updates for the current 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