1. Epic GamesDeveloper
  3. Concert

Concert

Unreal Engine C++ API Reference > Plugins

Classes

  Type Name Description
Public struct UStruct FConcertAdmin_ArchiveSessionRequest Create an archived copy of a live session.  
Public struct UStruct FConcertAdmin_ArchiveSessionResponse    
Public struct UStruct FConcertAdmin_BatchDeleteSessionRequest Deletes several archived and/or live sessions.  
Public struct UStruct FConcertAdmin_BatchDeleteSessionResponse Answer by server  
Public struct UStruct FConcertAdmin_CopySessionRequest Used to copy a live session or restore an archived one.  
Public struct UStruct FConcertAdmin_CreateSessionRequest    
Public struct UStruct FConcertAdmin_DeleteSessionRequest Delete an archived or live session.  
Public struct UStruct FConcertAdmin_DeleteSessionResponse    
Public struct UStruct FConcertAdmin_DiscoverServersEvent    
Public struct UStruct FConcertAdmin_DropSessionRepositoriesRequest Drop one or more session repositories from the server, deleting all the contained files.  
Public struct UStruct FConcertAdmin_DropSessionRepositoriesResponse    
Public struct UStruct FConcertAdmin_FindSessionRequest    
Public struct UStruct FConcertAdmin_GetAllSessionsRequest    
Public struct UStruct FConcertAdmin_GetAllSessionsResponse    
Public struct UStruct FConcertAdmin_GetArchivedSessionsRequest    
Public struct UStruct FConcertAdmin_GetLiveSessionsRequest    
Public struct UStruct FConcertAdmin_GetSessionActivitiesRequest    
Public struct UStruct FConcertAdmin_GetSessionActivitiesResponse    
Public struct UStruct FConcertAdmin_GetSessionClientsRequest    
Public struct UStruct FConcertAdmin_GetSessionClientsResponse    
Public struct UStruct FConcertAdmin_GetSessionRepositoriesRequest Returns the list of repositories known of the server.  
Public struct UStruct FConcertAdmin_GetSessionRepositoriesResponse    
Public struct UStruct FConcertAdmin_GetSessionsResponse    
Public struct UStruct FConcertAdmin_MountSessionRepositoryRequest Mount a session repository used to store session files.  
Public struct UStruct FConcertAdmin_MountSessionRepositoryResponse    
Public struct UStruct FConcertAdmin_RenameSessionRequest Rename a session.  
Public struct UStruct FConcertAdmin_RenameSessionResponse    
Public struct UStruct FConcertAdmin_ServerDiscoveredEvent    
Public struct UStruct FConcertAdmin_SessionInfoResponse    
Public struct UStruct FConcertByteArray    
Public struct UStruct FConcertClientInfo Holds info on a client connected through concert  
Public struct FConcertClientInfoUpdate Contains the FConcertClientInfo fields that can be updated.  
Public struct UStruct FConcertCustomVersionInfo Holds custom version information  
Public struct UStruct FConcertEngineVersionInfo Holds engine version information  
Public struct UStruct FConcertFileVersionInfo Holds file version information  
Public struct UStruct FConcertInstanceInfo Holds info on an instance communicating through concert  
Public struct UStruct FConcertLog    
Public struct FConcertSequencedCustomEvent    
Public class FConcertSequencedCustomEventManager Allows users to reserve a spot in the outbound queues.  
Public struct UStruct FConcertServerInfo Holds info on a Concert server  
Public struct UStruct FConcertSession_ClientListUpdatedEvent    
Public struct UStruct FConcertSession_CustomEvent    
Public struct UStruct FConcertSession_CustomRequest    
Public struct UStruct FConcertSession_CustomResponse    
Public struct UStruct FConcertSession_DiscoverAndJoinSessionEvent    
Public struct UStruct FConcertSession_JoinSessionResultEvent    
Public struct UStruct FConcertSession_LeaveSessionEvent    
Public struct UStruct FConcertSession_SessionRenamedEvent    
Public struct UStruct FConcertSession_UpdateClientInfoEvent    
Public struct UStruct FConcertSessionClientInfo Holds information on session client  
Public class FConcertSessionCommonImpl Common implementation for Concert Client and Server sessions (This doesn't inherit from any session interface, but does implement some of their API with a "Common" prefix on the function names. Interface implementations can also inherit from this common impl and then call the "Common" functions from the interface overrides.  
Public struct FConcertSessionContext Context struct for session custom message handlers  
Public class FConcertSessionCustomEventHandlerBase Common implementation of a session custom event handler.  
Public struct UStruct FConcertSessionFilter Holds filter rules used when migrating session data  
Public struct UStruct FConcertSessionInfo Holds info on a session  
Public struct UStruct FConcertSessionRepositoryInfo Contains information about a session repository.  
Public struct UStruct FConcertSessionSerializedPayload    
Public struct UStruct FConcertSessionSettings    
Public struct UStruct FConcertSessionVersionInfo Holds version information for a session  
Public struct UStruct FDeletedSessionInfo    
Public struct FInternalLiveSessionCreationParams    
Public class IConcertClientSession Interface for Concert client sessions  
Public class IConcertModule Interface for the Main Concert module.  
Public class IConcertServerEventSink Interface for events that Concert server can emit  
Public class IConcertServerSession Interface for Concert server sessions  
Public class IConcertSession Interface for Concert sessions  
Public class IConcertSessionCustomEventHandler Interface for session custom event handler  
Public class IConcertSessionCustomRequestHandler Interface for session custom request handler  
Public class IConcertSessionCustomResponseHandler Interface for session custom request handler TODO: replace by a generalized erased promise/future pair??  
Public class TConcertFunctionSessionCustomEventHandler Implementation of a session custom event handler that calls a function with the correct event type in the handler function signature.  
Public class TConcertFunctionSessionCustomRequestHandler Implementation of a session custom request handler that calls a function with the correct request type in the handler function signature.  
Public class TConcertFutureSessionCustomResponseHandler Implementation of a session custom response handler that uses a future to dispatch back the response  
Public class TConcertRawSessionCustomEventHandler Implementation of a session custom event handler that uses a raw member function pointer with the correct event type in the handler function signature.  
Public class TConcertRawSessionCustomRequestHandler Implementation of a session custom request handler that calls a raw member function with the correct request type in the handler function signature.  

Typedefs

Name Description
FActivityID  
FArchiveSession_WithSession  
FArchiveSession_WithWorkingDir  
FConcertClientLogEvent  
FConcertServerLogEvent  
FConcertTransportLoggingEnabledChanged  
FCopySession  
FExportSession  
FLogListener  
FOnArchivedSessionCreated  
FOnArchivedSessionDestroyed  
FOnArchivedSessionRenamed  
FOnConcertClientSessionClientChanged  
FOnConcertClientSessionConnectionChanged  
FOnConcertClientSessionTick  
FOnConcertServerSessionClientChanged  
FOnConcertServerSessionTick  
FOnConcertSessionRenamed  
FOnLiveSessionCreated  
FOnLiveSessionDestroyed  
FOnLiveSessionRenamed  
FRestoreSession  

Enums

  Type Name Description
Public enum UEnum EBatchSessionDeletionFlags    
Public enum UEnum EConcertClientStatus Status for Concert session clients  
Public enum UEnum EConcertCompressionDetails    
Public enum UEnum EConcertConnectionResult Connection Result for Concert client session  
Public enum UEnum EConcertConnectionStatus Connection status for Concert client sessions  
Public enum UEnum EConcertLogMessageAction    
Public enum UEnum EConcertPayloadCompressionType    
Public enum UEnum EConcertPayloadSerializationMethod    
Public enum UEnum EConcertSendReceiveState    
Public enum UEnum EConcertServerFlags    
Public enum UEnum EConcertSessionRepositoryMountResponseCode Response code returned when trying to mount a session repository on the server.  
Public enum UEnum EConcertSessionResponseCode Response codes for a session custom request  
Public enum UEnum EConcertSessionState    
Public enum EConcertVersionValidationMode Modes that can be used when validating Concert version information  

Functions

  Type Name Description
Public function FArchiveSession_WithSession &  
Public function FArchiveSession_WithWorkingDir &  
Public function FCopySession &  
Public function FExportSession &  
Public function FOnArchivedSessionCreated &  
Public function FOnArchivedSessionDestroyed &  
Public function FOnArchivedSessionRenamed &  
Public function FOnLiveSessionCreated &  
Public function FOnLiveSessionDestroyed &  
Public function FOnLiveSessionRenamed &  
Public function FRestoreSession &  
Public function bool

ConcertUtil::Copy ( FArchive& DstAr,
FArchive& SrcAr,
int64 Size
)

 Copy the specified data size from a source archive into a destination archive.
Public function IConcertTransportLoggerRef

ConcertUtil::CreateLogger ( const FConcertEndpointContext& InOwnerContext,
FLogListener LogListenerFunc
)

 Factory function for use with FConcertTransportLoggerFactory
Public function bool

ConcertUtil::DeleteDirectoryTree ( const TCHAR* InDirectoryToDelete,
const TCHAR* InMoveToDirBeforeDelete
)

 Delete a directory tree via a move and delete
Public function void

ConcertUtil::SetVerboseLogging ( bool bInState
)

 Turn on verbose logging for all loggers (including console loggers).
Public function constexpr bool  
Public function constexpr bool  
Public function constexpr bool  
Public function constexpr EBatchSessionDeletionFlags  
Public function constexpr EConcertCompressionDetails  
Public function constexpr EConcertServerFlags  
Public function EBatchSessionDeletionFlags &  
Public function EConcertCompressionDetails &  
Public function EConcertServerFlags &  
Public function constexpr EConcertCompressionDetails  
Public function constexpr EConcertServerFlags  
Public function constexpr EBatchSessionDeletionFlags  
Public function EConcertCompressionDetails &  
Public function EConcertServerFlags &  
Public function EBatchSessionDeletionFlags &  
Public function constexpr EBatchSessionDeletionFlags  
Public function constexpr EConcertCompressionDetails  
Public function constexpr EConcertServerFlags  
Public function EConcertCompressionDetails &  
Public function EConcertServerFlags &  
Public function EBatchSessionDeletionFlags &  
Public function constexpr EConcertServerFlags  
Public function constexpr EBatchSessionDeletionFlags  
Public function constexpr EConcertCompressionDetails  
Public function bool Returns truen if the compression details is set to compressed format.
Public function bool Returns true if we are suppose to use Oodle for compression.
Public function bool Returns true if the compression details is set to uncompressed format.
Public function FName Get the named compression algorithm based on the provided details.
Public function FName Get the named compression algorithm to invoke with serializer and memory compressors.
Public function EConcertCompressionDetails Based on the data size return the current compression details to store.
Public function ECompressionFlags Get the default flags to use when invoking the compressor.
Public function EConcertCompressionDetails Add in the compression flags to the concert compression details enum.
Public function EConcertCompressionDetails

UE::Concert::Compression::GetCompressionFromNamedType ( FName NamedMethod,
ECompressionFlags Flags
)

 For a given named compression algorithm and compression flags convert it into a EConcertCompressionDetails
Public function ECompressionFlags Get the compression enum value given the concert compression settings.
Public function bool Based on the size of the data to compress indicate if we should invoke the compressor.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page