description: Gather the shader metadata exposed by the data provider payload.

code: virtual void GetShaderParameters ( TCHAR const * UID, [FShaderParametersMetadataBuilder](API\Runtime\RenderCore\FShaderParametersMetadataBuilder) & InOutBuilder, [FShaderParametersMetadataAllocations](API\Plugins\ComputeFramework\ComputeFramework\FShaderParameter-) & InOutAllocations ) const


description: Gather any extra struct types that this data provider relies on.

module: ComputeFramework

code: virtual void GetStructDeclarations ( [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & OutStructsSeen, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutStructs ) const


description: If the data interface HLSL comes from a file this should fill the virtual file path. This is used to resolve shader compilation errors.

code: virtual TCHAR const * GetShaderVirtualPath() const


description: Get the data interface functions available to fulfill external outputs of a kernel.

code: virtual void GetSupportedOutputs ( [TArray](API\Runtime\Core\Containers\TArray)< [FShaderFunctionDefinition](API\Plugins\ComputeFramework\ComputeFramework\FShaderFunctionDefinition) > & OutFunctions ) const


description: Get the data interface functions available to fulfill external inputs of a kernel.

code: virtual void GetSupportedInputs ( [TArray](API\Runtime\Core\Containers\TArray)< [FShaderFunctionDefinition](API\Plugins\ComputeFramework\ComputeFramework\FShaderFunctionDefinition) > & OutFunctions ) const


description: Does the associatedUComputeDataProviderprovide invocations and thread counts. One and only one data interface per kernel should return true.

code: virtual bool IsExecutionInterface() const


className: UComputeDataInterface

description: Compute Data Interface required to compile a Compute Graph. Compute Kernels require Data Interfaces to fulfill their external functions. Compute Data Interfaces define how Compute Data Providers will actually marshal data in and out of Kernels.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, Const) class UComputeDataInterface : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


description: Get an associated render thread proxy object. Currently these are created and destroyed per frame by theFComputeGraphInstance.


description: Return false if the provider has not been fully initialized.

code: virtual bool IsValid() const


className: UComputeDataProvider

description: Compute Framework Data Provider. A concrete instance of this is responsible for supplying data declared by aUComputeDataInterface. One of these must be created for eachUComputeDataInterfaceobject in an instance of a Compute Graph.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract) class UComputeDataProvider : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: void BeginCacheForCookedPlatformData ( [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) const * TargetPlatform )


description: Clear all cached cooked platform data


code: void ClearCachedCookedPlatformData ( [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) const * TargetPlatform )


description: CreateUComputeDataProviderobjects to match the currentUComputeDataInterfaceobjects. We attempt to setup bindings from the InBindingObjects. The caller is responsible for any data provider binding not handled by the default behavior.

code: void CreateDataProviders ( int32 InBindingIndex, [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UObject](API\Runtime\CoreUObject\UObject\UObject) > & InBindingObject, [TArray](API\Runtime\Core\Containers\TArray)< [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UComputeDataProvider](API\Plugins\ComputeFramework\ComputeFramework\UComputeDataProvider) > > & InOutDataProviders ) const


description: Get the render proxy which is a copy of all data required by the render thread.

code: FComputeGraphRenderProxy const * GetRenderProxy() const


code: bool IsCachedCookedPlatformDataLoaded ( [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) const * TargetPlatform )


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: Called each time that a single kernel shader compilation is completed.

code: virtual void OnKernelCompilationComplete ( int32 InKernelIndex, [FComputeKernelCompileResults](API\Plugins\ComputeFramework\ComputeFramework\FComputeKernelCompileResults) const & InCompileResults )


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Call after changing the graph to build the graph resources for rendering. This will trigger any required shader compilation.

code: void UpdateResources()


description: Returns true if graph is valid. A valid graph should be guaranteed to compile, assuming the underlying shader code is well formed.

code: bool ValidateGraph ( [FString](API\Runtime\Core\Containers\FString) * OutErrors )


description: Returns true if there is a valid DataProvider entry for each of our DataInterfaces.

code: bool ValidateProviders ( [TArray](API\Runtime\Core\Containers\TArray)< [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UComputeDataProvider](API\Plugins\ComputeFramework\ComputeFramework\UComputeDataProvider) > > const & DataProviders ) const


code: UComputeGraph ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


code: UComputeGraph ( [FVTableHelper](API\Runtime\CoreUObject\UObject\FVTableHelper) & Helper )


code: virtual ~UComputeGraph()


description: Create all the Data Provider objects for a given binding object of the ComputeGraph.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Compute") void CreateDataProviders ( int32 InBindingIndex, [UObject](API\Runtime\CoreUObject\UObject\UObject) * InBindingObject )


description: Destroy all associated DataProvider objects.


className: UComputeGraph

description: Class representing a Compute Graph. This holds the basic topology of the graph and is responsible for linking Kernels with Data Interfaces and compiling the resulting shader code. Multiple Compute Graph asset types can derive from this to specialize the graph creation process. For example the Animation Deformer system provides a UI for creatingUComputeGraphassets.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UComputeGraph : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

Bindings

type: TArray<TObject...

description: Registered binding object class types.

DataInterfaces

description: Data interfaces in the graph.

DataInterfaceToBinding

type: TArray< int32 >

description: Mapping of DataInterfaces array index to Bindings index.

GraphEdges

type: TArray<FComput...

description: Edges in the graph between kernels and data interfaces.

KernelInvocations

description: Kernels in the graph.


description: Queue the graph for execution at the next render update.


description: Called to send dynamic data for this component to the rendering thread


description: Return true if CreateRenderState() should be called

code: virtual bool ShouldCreateRenderState() const


description: Function called every frame on this ActorComponent. Override this function to implement custom logic to be executed every frame. Only executes if the component is registered, and also PrimaryComponentTick.bCanEverTick must be set to true.

code: virtual void TickComponent ( float DeltaTime, enum ELevelTick TickType, [FActorComponentTickFunction](API\Runtime\Engine\Engine\FActorComponentTickFunction) * ThisTickFunction )


code: UComputeGraphComponent()


code: ~UComputeGraphComponent()


className: UComputeGraphComponent

description: Component which holds a context for aUComputeGraph. This object binds the graph to its data providers, and queues the execution.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, Meta=(BlueprintSpawnableComponent)) class UComputeGraphComponent : public [UActorComponent](API\Runtime\Engine\Components\UActorComponent)

ComputeGraph

type: TObjectPtr<UCo...

description: The Compute Graph asset.


className: UComputeKernel

description: Base class representing a kernel that will be run as a shader on the GPU.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(HideCategories=(Object)) class UComputeKernel : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

KernelFlags

description: Specifying certain memory access flags allows for optimizations such as kernel fusing.

KernelSource

description: The compute kernel source asset.


description: Get kernel source code ready for HLSL compilation.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetSource() const


description: This alternate version of PostEditChange is called when properties inside structs are modified. The property that was actually modified is located at the tail of the list. The head of the list of theFStructPropertymember variable that contains the property that was modified.

code: virtual void PostEditChangeChainProperty ( [FPropertyChangedChainEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedChainEvent) & PropertyChangedEvent )


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: This alternate version of PreEditChange is called when properties inside structs are modified. The property that was actually modified is located at the tail of the list. The head of the list of theFStructPropertymember variable that contains the property that was modified.

code: virtual void PreEditChange ( [FEditPropertyChain](API\Runtime\CoreUObject\UObject\FEditPropertyChain) & PropertyAboutToChange )


description: Parse the kernel source to get the kernel external functions and other data.

code: void ReparseKernelSourceText()


className: UComputeKernelFromText

description: Class responsible for loading HLSL text and parsing the options available.

SourceFile

type: FFilePath

description: Filepath to the source file containing the kernel entry points and all options for parsing.


className: UComputeKernelSource

description: Class representing the source for aUComputeKernelWe derive from this for each authoring mechanism. (HLSL text, VPL graph, ML Meta Lang, etc.)

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, EditInlineNew) class UComputeKernelSource : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

AdditionalSources

description: An array of additional independent source assets that the kernel source depends on.

DefinitionsSet

type: FComputeKernelD...

description: Base environment defines for kernel compilation.

EntryPoint

type: FString

description: Kernel entry point.

ExternalInputs

type: TArray<FShader...

description: Named external inputs for the kernel. These must be fulfilled by linked data providers.

ExternalOutputs

description: Named external outputs for the kernel. These must be fulfilled by linked data providers.

GroupSize

type: FIntVector

description: Kernel group size.

PermutationSet

type: FComputeKernelP...

description: Base permutations exposed by the kernel.


description: Get source code ready for HLSL compilation.


description: Get virtual file path for the source code. This will be the file name shown in any compilation errors.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetVirtualPath() const


className: UComputeSource

description: Class representing some source for inclusion in aUComputeKernel. We derive from this for each authoring mechanism. (HLSL text, VPL graph, ML Meta Lang, etc.)

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract) class UComputeSource : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

AdditionalSources

description: Array of additional source objects. This allows us to specify source dependencies.


description: Parse the source to get metadata.

code: void ReparseSourceText()


className: UComputeSourceFromText

description: Class responsible for loading HLSL text and parsing any metadata available.


className: IComputeFrameworkEditorModule

module: ComputeFrameworkEditor

code: class IComputeFrameworkEditorModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


module: Concert

code: namespace ConcertServerEvents { [FArchiveSession_WithSession](API\Plugins\Concert\FArchiveSession_WithSession) & ConcertServerEvents::ArchiveSession_WithSession() }


code: namespace ConcertServerEvents { [FArchiveSession_WithWorkingDir](API\Plugins\Concert\FArchiveSession_WithWorkingDir) & ConcertServerEvents::ArchiveSession_WithWorkingDir() }


code: namespace ConcertServerEvents { [FCopySession](API\Plugins\Concert\FCopySession) & ConcertServerEvents::CopySession() }


code: namespace ConcertServerEvents { [FExportSession](API\Plugins\Concert\FExportSession) & ConcertServerEvents::ExportSession() }


code: namespace ConcertServerEvents { [FOnArchivedSessionCreated](API\Plugins\Concert\FOnArchivedSessionCreated) & ConcertServerEvents::OnArchivedSessionCreated() }


code: namespace ConcertServerEvents { [FOnArchivedSessionDestroyed](API\Plugins\Concert\FOnArchivedSessionDestroyed) & ConcertServerEvents::OnArchivedSessionDestroyed() }


code: namespace ConcertServerEvents { [FOnLiveSessionCreated](API\Plugins\Concert\FOnLiveSessionCreated) & ConcertServerEvents::OnLiveSessionCreated() }


code: namespace ConcertServerEvents { [FOnArchivedSessionRenamed](API\Plugins\Concert\FOnArchivedSessionRenamed) & ConcertServerEvents::OnArchivedSessionRenamed() }


code: namespace ConcertServerEvents { [FOnLiveSessionDestroyed](API\Plugins\Concert\FOnLiveSessionDestroyed) & ConcertServerEvents::OnLiveSessionDestroyed() }


code: namespace ConcertServerEvents { [FRestoreSession](API\Plugins\Concert\FRestoreSession) & ConcertServerEvents::RestoreSession() }


code: namespace ConcertServerEvents { [FOnLiveSessionRenamed](API\Plugins\Concert\FOnLiveSessionRenamed) & ConcertServerEvents::OnLiveSessionRenamed() }


description: Copy the specified data size from a source archive into a destination archive.

code: namespace ConcertUtil { bool ConcertUtil::Copy ( [FArchive](API\Runtime\Core\Serialization\FArchive) & DstAr, [FArchive](API\Runtime\Core\Serialization\FArchive) & SrcAr, int64 Size ) }


description: Factory function for use with FConcertTransportLoggerFactory

code: namespace ConcertUtil { [IConcertTransportLoggerRef](API\Plugins\ConcertTransport\IConcertTransportLoggerRef) ConcertUtil::CreateLogger ( const [FConcertEndpointContext](API\Plugins\ConcertTransport\FConcertEndpointContext) & InOwnerContext, [FLogListener](API\Plugins\Concert\FLogListener) LogListenerFunc ) }


description: Delete a directory tree via a move and delete

code: namespace ConcertUtil { bool ConcertUtil::DeleteDirectoryTree ( const TCHAR * InDirectoryToDelete, const TCHAR * InMoveToDirBeforeDelete ) }


description: Turn on verbose logging for all loggers (including console loggers).

code: namespace ConcertUtil { void ConcertUtil::SetVerboseLogging ( bool bInState ) }


className: EBatchSessionDeletionFlags

code: enum EBatchSessionDeletionFlags { Strict, SkipForbiddenSessions = 0x01, }


className: EConcertClientStatus

description: Status for Concert session clients

code: enum EConcertClientStatus { Connected, Disconnected, Updated, }


className: EConcertCompressionDetails

code: enum EConcertCompressionDetails { Uncompressed = 0, Compressed = 1 << 0, CompressWithOodle = 1 << 1, CompressForSpeed = 1 << 2, CompressForSize = 1 << 3, }


className: EConcertConnectionResult

description: Connection Result for Concert client session

code: enum EConcertConnectionResult { None, ConnectionAccepted, ConnectionRefused, AlreadyConnected, }


className: EConcertConnectionStatus

description: Connection status for Concert client sessions

code: enum EConcertConnectionStatus { Connecting, Connected, Disconnecting, Disconnected, }


className: EConcertLogMessageAction

code: enum EConcertLogMessageAction { None, Send, Publish, Receive, Queue, Discard, Duplicate, TimeOut, Process, EndpointDiscovery, EndpointTimeOut, EndpointClosure, }


className: EConcertPayloadCompressionType

code: enum EConcertPayloadCompressionType { None = 0, Heuristic, Always, }


className: EConcertPayloadSerializationMethod

code: enum EConcertPayloadSerializationMethod { Standard = 0, Cbor, }


className: EConcertServerFlags

code: enum EConcertServerFlags { None = 0, IgnoreSessionRequirement = 1 << 0, }


className: EConcertSendReceiveState

code: enum EConcertSendReceiveState { Default, SendOnly, ReceiveOnly, }


description: Response code returned when trying to mount a session repository on the server.

code: enum EConcertSessionRepositoryMountResponseCode { None, Mounted, AlreadyMounted, NotFound, }


className: EConcertSessionResponseCode

description: Response codes for a session custom request

code: enum EConcertSessionResponseCode { Success, Failed, InvalidRequest, }


className: EConcertSessionState

code: enum EConcertSessionState { Normal = 0, Transient, }


className: EConcertVersionValidationMode

description: Modes that can be used when validating Concert version information

code: enum EConcertVersionValidationMode { Identical, Compatible, }


className: FActivityID

code: typedef int64 FActivityID


code: typedef TMulticastDelegate_SixParams< void, bool, const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) &, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertServerSession](API\Plugins\Concert\IConcertServerSession) >, const [FString](API\Runtime\Core\Containers\FString) &, const [FConcertSessionInfo](API\Plugins\Concert\FConcertSessionInfo) &, const [FConcertSessionFilter](API\Plugins\Concert\FConcertSessionFilter) & > FArchiveSession_WithSession


code: typedef TMulticastDelegate_SixParams< void, bool, const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) &, const [FString](API\Runtime\Core\Containers\FString) &, const [FString](API\Runtime\Core\Containers\FString) &, const [FConcertSessionInfo](API\Plugins\Concert\FConcertSessionInfo) &, const [FConcertSessionFilter](API\Plugins\Concert\FConcertSessionFilter) & > FArchiveSession_WithWorkingDir


description: Create an archived copy of a live session.

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_ArchiveSessionRequest : public [FConcertRequestData](API\Plugins\ConcertTransport\FConcertRequestData)

ArchiveNameOverride

description: The override for the archive.

DeviceName

description: The caller device name.

SessionFilter

type: FConcertSession...

description: The filter controlling which activities from the session should be archived.

SessionId

type: FGuid

description: The ID of the session to archive (must be a live session).

UserName

description: The caller user name.


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_ArchiveSessionResponse : public [FConcertResponseData](API\Plugins\ConcertTransport\FConcertResponseData)

ArchiveId

description: The ID of the new archived session (on success).

ArchiveName

description: The name of the new archived session (on success).

SessionId

description: The ID of the session that was requested to be archived.

SessionName

description: The name of the session that was requested to be archived.


description: Deletes several archived and/or live sessions.

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_BatchDeleteSessionRequest : public [FConcertRequestData](API\Plugins\ConcertTransport\FConcertRequestData)

Flags

type: EBatchSessionDe...

description: How the operation input is supposed to be interpreted

SessionIds

type: TSet<FGuid>

description: The ID of the session to delete.

UserName

description: For now only the user name and device name of the client is used to id it as the owner of a session.


description: Answer by server

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_BatchDeleteSessionResponse : public [FConcertResponseData](API\Plugins\ConcertTransport\FConcertResponseData)

DeletedItems

type: TArray<FDelete...

description: The IDs of the session that were requested to be deleted.

NotOwnedByClient

description: Contains the sessions that were skipped ifFConcertAdmin_BatchDeleteSessionRequest::Flagshas the SkipForbiddenSessions flag set.


description: Used to copy a live session or restore an archived one.

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_CopySessionRequest : public [FConcertRequestData](API\Plugins\ConcertTransport\FConcertRequestData)

bRestoreOnly

type: bool

description: True to constrain the session to copy to be an archive (implying a restore operation).

OwnerClientInfo

type: FConcertClientI...

description: Information about the owner of the copied session.

SessionFilter

description: The filter controlling which activities from the session should be copied over.

SessionId

description: The ID of the session to copy or restore.

SessionName

description: The name of the session to create.

SessionSettings

description: Settings to apply to the copied session.

VersionInfo

description: Version information of the client requesting the copy.


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_CreateSessionRequest : public [FConcertRequestData](API\Plugins\ConcertTransport\FConcertRequestData)


description: Delete an archived or live session.

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_DeleteSessionRequest : public [FConcertRequestData](API\Plugins\ConcertTransport\FConcertRequestData)

SessionId

description: The ID of the session to delete.


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_DeleteSessionResponse : public [FConcertResponseData](API\Plugins\ConcertTransport\FConcertResponseData)

description: The ID of the session that was requested to be deleted.

SessionName

description: The name of the session that was was requested to be deleted.


ClientAuthenticationKey

description: If a server was configured to restrict access to specific client(s), it will search for this key in its list of authorized keys.

RequiredRole

description: The required role of the server (eg, MultiUser, DisasterRecovery, etc)

RequiredVersion

description: The required version of the server (eg, 4.22, 4.23, etc)


description: Drop one or more session repositories from the server, deleting all the contained files.

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_DropSessionRepositoriesRequest : public [FConcertRequestData](API\Plugins\ConcertTransport\FConcertRequestData)

RepositoryIds

type: TArray<FGuid>

description: The list of repository IDs to drop.


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_DropSessionRepositoriesResponse : public [FConcertResponseData](API\Plugins\ConcertTransport\FConcertResponseData)

DroppedRepositoryIds

description: The list of repository IDs successfully dropped (not found == dropped).


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_FindSessionRequest : public [FConcertRequestData](API\Plugins\ConcertTransport\FConcertRequestData)


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_GetAllSessionsRequest : public [FConcertRequestData](API\Plugins\ConcertTransport\FConcertRequestData)


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_GetAllSessionsResponse : public [FConcertResponseData](API\Plugins\ConcertTransport\FConcertResponseData)

ArchivedSessions

type: TArray<FConcer...


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_GetArchivedSessionsRequest : public [FConcertRequestData](API\Plugins\ConcertTransport\FConcertRequestData)


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_GetLiveSessionsRequest : public [FConcertRequestData](API\Plugins\ConcertTransport\FConcertRequestData)


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_GetSessionActivitiesRequest : public [FConcertRequestData](API\Plugins\ConcertTransport\FConcertRequestData)


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_GetSessionActivitiesResponse : public [FConcertResponseData](API\Plugins\ConcertTransport\FConcertResponseData)

Activities

description: The list of activities.

EndpointClientInfoMap

type: TMap<FGuid,FC...

description: Maps each activity endpoint to its client info.


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_GetSessionClientsRequest : public [FConcertRequestData](API\Plugins\ConcertTransport\FConcertRequestData)


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_GetSessionClientsResponse : public [FConcertResponseData](API\Plugins\ConcertTransport\FConcertResponseData)


description: Returns the list of repositories known of the server.

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_GetSessionRepositoriesRequest : public [FConcertRequestData](API\Plugins\ConcertTransport\FConcertRequestData)


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_GetSessionRepositoriesResponse : public [FConcertResponseData](API\Plugins\ConcertTransport\FConcertResponseData)


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_GetSessionsResponse : public [FConcertResponseData](API\Plugins\ConcertTransport\FConcertResponseData)


description: Mount a session repository used to store session files.

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_MountSessionRepositoryRequest : public [FConcertRequestData](API\Plugins\ConcertTransport\FConcertRequestData)

bAsServerDefault

description: Whether this repository is set as the default one used by server to store new sessions.

bCreateIfNotExist

description: Whether the repository should be created if it was not found.

RepositoryId

description: The repository unique Id. Must be valid.

RepositoryRootDir

description: The repository root dir (absolute path) where the repository should be found/created.


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_MountSessionRepositoryResponse : public [FConcertResponseData](API\Plugins\ConcertTransport\FConcertResponseData)

MountStatus

type: EConcertSession...


description: Rename a session.

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_RenameSessionRequest : public [FConcertRequestData](API\Plugins\ConcertTransport\FConcertRequestData)

NewName

description: The new session name.

SessionId

description: The ID of the session to rename.

UserName

description: For now only the user name and device name of the client is used to id it as the owner of a session.


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_RenameSessionResponse : public [FConcertResponseData](API\Plugins\ConcertTransport\FConcertResponseData)

OldName

description: The old session name (if the session exist).

SessionId

description: The ID of the session that was requested to be renamed.


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertAdmin_SessionInfoResponse : public [FConcertResponseData](API\Plugins\ConcertTransport\FConcertResponseData)


InstanceInfo

type: FConcertInstanc...

description: Basic information about the server instance

ServerFlags

type: EConcertServerF...

description: Contains information on the server settings

ServerName

description: Server designated name


code: bool Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Initialize this client information based on the current environment

code: void Initialize()


code: bool operator== ( const [FConcertClientInfo](API\Plugins\Concert\FConcertClientInfo) & Other ) const


code: bool operator!= ( const [FConcertClientInfo](API\Plugins\Concert\FConcertClientInfo) & Other ) const


description: Create a user friendly display string for using in things such as tooltips.


className: FConcertClientInfo

description: Holds info on a client connected through concert

AvatarColor

type: FLinearColor

description: Holds the color of the user avatar in a session.

bHasEditorData

description: True if this instance was built with editor-data

bRequiresCookedData

description: True if this platform requires cooked data

DesktopAvatarActorClass

type: FString

description: Holds the string representation of the desktop actor class to be used as the avatar for a representation of a client

DeviceName

description: Holds the name of the device that the instance is running on.

DisplayName

description: Holds the display name of the user that owns this instance.

PlatformName

description: Holds the name of the platform that the instance is running on.

Tags

type: TArray<FName>

description: Holds an array of tags that can be used for grouping and categorizing.

UserName

description: Holds the name of the user that owns this instance.

VRAvatarActorClass

description: Holds the string representation of the VR actor class to be used as the avatar for a representation of a client


description: Applies the valid optional fields to the specified client info, and return true if the client info was modified, false otherwise.

code: bool ApplyTo ( [FConcertClientInfo](API\Plugins\Concert\FConcertClientInfo) & InOutInfo ) const


className: FConcertClientInfoUpdate

description: Contains theFConcertClientInfofields that can be updated.

code: struct FConcertClientInfoUpdate

AvatarColor

type: TOptional<FLin...

DesktopAvatarActorClass

type: TOptional<FStr...


className: FConcertClientLogEvent

code: typedef TMulticastDelegate_TwoParams< void, const [IConcertClient](API\Plugins\ConcertClient\IConcertClient) &, const [FConcertLog](API\Plugins\Concert\FConcertLog) & > FConcertClientLogEvent


description: Initialize this version info from the given version

code: void Initialize ( const [FCustomVersion](API\Runtime\Core\Serialization\FCustomVersion) & InVersion )


description: Validate this version info against another

code: bool Validate ( const [FConcertCustomVersionInfo](API\Plugins\Concert\FConcertCustomVersionInfo) & InOther, const [EConcertVersionValidationMode](API\Plugins\Concert\EConcertVersionValidationMode) InValidationMode, [FText](API\Runtime\Core\Internationalization\FText) * OutFailureReason ) const


className: FConcertCustomVersionInfo

description: Holds custom version information

FriendlyName

type: FName

description: Friendly name of the version

Key

type: FGuid

description: Unique custom key

Version

description: Custom version


code: void Initialize ( const [FEngineVersion](API\Runtime\Core\Misc\FEngineVersion) & InVersion )


code: bool Validate ( const [FConcertEngineVersionInfo](API\Plugins\Concert\FConcertEngineVersionInfo) & InOther, const [EConcertVersionValidationMode](API\Plugins\Concert\EConcertVersionValidationMode) InValidationMode, [FText](API\Runtime\Core\Internationalization\FText) * OutFailureReason ) const


className: FConcertEngineVersionInfo

description: Holds engine version information

Changelist

description: Changelist number. This is used to arbitrate when Major/Minor/Patch version numbers match

Major

description: Major version number

Minor

description: Minor version number

Patch

description: Patch version number


description: Initialize this version info from the compiled in data


code: bool Validate ( const [FConcertFileVersionInfo](API\Plugins\Concert\FConcertFileVersionInfo) & InOther, const [EConcertVersionValidationMode](API\Plugins\Concert\EConcertVersionValidationMode) InValidationMode, [FText](API\Runtime\Core\Internationalization\FText) * OutFailureReason ) const


className: FConcertFileVersionInfo

description: Holds file version information

FileVersion

description: UE4 File version

FileVersionLicensee

description: Licensee file version

description: UE5 File version


description: Initialize this instance information based on the current environment


code: bool operator== ( const [FConcertInstanceInfo](API\Plugins\Concert\FConcertInstanceInfo) & Other ) const


code: bool operator!= ( const [FConcertInstanceInfo](API\Plugins\Concert\FConcertInstanceInfo) & Other ) const


description: Create a user friendly display string for using in things such as tooltips.


className: FConcertInstanceInfo

description: Holds info on an instance communicating through concert

InstanceId

description: Holds the instance identifier.

InstanceName

description: Holds the instance name.

InstanceType

description: Holds the instance type (Editor, Game, Server, etc).


className: FConcertLog

MessageAction

type: EConcertLogMess...

SerializedPayload

type: FConcertSession...

Timestamp

type: FDateTime


code: FConcertSequencedCustomEvent &40; int32 InIndex &41;


className: FConcertSequencedCustomEvent

code: struct FConcertSequencedCustomEvent


code: bool CanSend ( const [FConcertSequencedCustomEvent](API\Plugins\Concert\FConcertSequencedCustomEvent) & InEventId ) const


code: void FillPendingSequenceEvent ( const [FConcertSequencedCustomEvent](API\Plugins\Concert\FConcertSequencedCustomEvent) & InEventId, [FPendingCustomEvent](API\Plugins\Concert\FConcertSequencedCustomEventMana-\FPendingCustomEvent) InEventData )


className: FPendingCustomEvent

code: struct FPendingCustomEvent

Annotations

type: TMap<FName,FS...

Flags

type: EConcertMessage...


code: void RemoveSequencedEvent ( const [FConcertSequencedCustomEvent](API\Plugins\Concert\FConcertSequencedCustomEvent) & EventDetails )


code: FConcertSequencedCustomEventManager()


code: ~FConcertSequencedCustomEventManager()


className: FConcertSequencedCustomEventManager

description: Allows users to reserve a spot in the outbound queues.


description: Initialize this server information based on the current environment

code: void Initialize()


className: FConcertServerInfo

description: Holds info on a Concert server

AdminEndpointId

description: Server endpoint for performing administration tasks (FConcertAdmin_X messages)

InstanceInfo

description: Basic server information

ServerFlags

description: Contains information on the server settings


className: FConcertServerLogEvent

code: typedef TMulticastDelegate_TwoParams< void, const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) &, const [FConcertLog](API\Plugins\Concert\FConcertLog) & > FConcertServerLogEvent


className: FConcertSessionClientInfo

description: Holds information on session client

ClientInfo

type: FConcertClientI...


code: static bool CommonBuildCustomEvent ( const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * EventType, const void * EventData, const [FGuid](API\Runtime\Core\Misc\FGuid) & SourceEndpointId, const [TArray](API\Runtime\Core\Containers\TArray)< [FGuid](API\Runtime\Core\Misc\FGuid) > & DestinationEndpointIds, [FConcertSession_CustomEvent](API\Plugins\Concert\FConcertSession_CustomEvent) & OutCustomEvent )


code: static bool CommonBuildCustomRequest ( const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * RequestType, const void * RequestData, const [FGuid](API\Runtime\Core\Misc\FGuid) & SourceEndpointId, const [FGuid](API\Runtime\Core\Misc\FGuid) & DestinationEndpointId, [FConcertSession_CustomRequest](API\Plugins\Concert\FConcertSession_CustomRequest) & OutCustomRequest )


code: void CommonClearCustomEventHandler ( const [FName](API\Runtime\Core\UObject\FName) & EventMessageType )


code: bool CommonFindSessionClient ( const [FGuid](API\Runtime\Core\Misc\FGuid) & EndpointId, [FConcertSessionClientInfo](API\Plugins\Concert\FConcertSessionClientInfo) & OutSessionClientInfo ) const


code: const [FGuid](API\Runtime\Core\Misc\FGuid) & CommonGetId() const


code: [FConcertScratchpadPtr](API\Plugins\ConcertTransport\Scratchpad\FConcertScratchpadPtr) CommonGetClientScratchpad ( const [FGuid](API\Runtime\Core\Misc\FGuid) & ClientEndpointId ) const


code: const [FString](API\Runtime\Core\Containers\FString) & CommonGetName() const


code: [TArray](API\Runtime\Core\Containers\TArray)< [FGuid](API\Runtime\Core\Misc\FGuid) > CommonGetSessionClientEndpointIds() const


code: [TArray](API\Runtime\Core\Containers\TArray)< [FConcertSessionClientInfo](API\Plugins\Concert\FConcertSessionClientInfo) > CommonGetSessionClients() const


code: const [FConcertSessionInfo](API\Plugins\Concert\FConcertSessionInfo) & CommonGetSessionInfo() const


code: void CommonHandleCustomEvent ( const [FConcertMessageContext](API\Plugins\ConcertTransport\FConcertMessageContext) & Context )


code: [TFuture](API\Runtime\Core\Async\TFuture)< [FConcertSession_CustomResponse](API\Plugins\Concert\FConcertSession_CustomResponse) > CommonHandleCustomRequest ( const [FConcertMessageContext](API\Plugins\ConcertTransport\FConcertMessageContext) & Context )


code: static void CommonHandleCustomResponse ( const [FConcertSession_CustomResponse](API\Plugins\Concert\FConcertSession_CustomResponse) & Response, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertSessionCustomResponseHandler](API\Plugins\Concert\IConcertSessionCustomResponseHan-) > & Handler )


code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) CommonRegisterCustomEventHandler ( const [FName](API\Runtime\Core\UObject\FName) & EventMessageType, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertSessionCustomEventHandler](API\Plugins\Concert\IConcertSessionCustomEventHandle-) > & Handler )


code: void CommonRegisterCustomRequestHandler ( const [FName](API\Runtime\Core\UObject\FName) & RequestMessageType, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertSessionCustomRequestHandler](API\Plugins\Concert\IConcertSessionCustomRequestHand-) > & Handler )


code: void CommonSetName ( const [FString](API\Runtime\Core\Containers\FString) & NewName )


code: void CommonUnregisterCustomRequestHandler ( const [FName](API\Runtime\Core\UObject\FName) & RequestMessageType )


code: void CommonUnregisterCustomEventHandler ( const [FName](API\Runtime\Core\UObject\FName) & EventMessageType, const [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) EventHandle )


code: void CommonUnregisterCustomEventHandler ( const [FName](API\Runtime\Core\UObject\FName) & EventMessageType, const void * EventHandler )


className: FSessionClient

description: Map of clients connected to this session (excluding us if we're a client session)

code: struct FSessionClient

Scratchpad

type: FConcertScratch...


code: FConcertSessionCommonImpl ( const [FConcertSessionInfo](API\Plugins\Concert\FConcertSessionInfo) & InSessionInfo )


className: FConcertSessionCommonImpl

description: IConcertSessionfor the API description).

code: class FConcertSessionCommonImpl

CustomEventHandlers

type: TMap<FName,TA...

description: Map of custom event handlers for this session

CustomRequestHandlers

type: TMap<FName,TS...

description: Map of custom request handlers for this session

description: The scratchpad for this session

SessionClients

type: TMap<FGuid,FS...

SessionInfo

description: Information about this session


className: FConcertSessionContext

description: Context struct for session custom message handlers

code: struct FConcertSessionContext


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) GetHandle() const


code: FConcertSessionCustomEventHandlerBase ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) InHandle )


className: FConcertSessionCustomEventHandlerBase

description: Common implementation of a session custom event handler.

code: class FConcertSessionCustomEventHandlerBase : public [IConcertSessionCustomEventHandler](API\Plugins\Concert\IConcertSessionCustomEventHandle-)

Handle

type: FDelegateHandle


description: This function only tests the ID conditions, not any data specific checks like bOnlyLiveData and bIncludeIgnoredActivities.

code: bool ActivityIdPassesFilter ( const int64 InActivityId ) const


code: void SetLastModified ( const [FDateTime](API\Runtime\Core\Misc\FDateTime) & Value )


className: FConcertSessionFilter

description: Holds filter rules used when migrating session data

ActivityIdLowerBound

description: The lower-bound (inclusive) of activity IDs to include (unless explicitly excluded via ActivityIdsToExclude)

ActivityIdsToExclude

type: TArray< int64 >

description: Activity IDs to explicitly exclude, even if inside of the bounded-range specified above

ActivityIdsToInclude

description: Activity IDs to explicitly include, even if outside of the bounded-range specified above (takes precedence over ActivityIdsToExclude)

ActivityIdUpperBound

description: The upper-bound (inclusive) of activity IDs to include (unless explicitly excluded via ActivityIdsToExclude)

bIncludeIgnoredActivities

type: bool

description: True to include ignored activities

bMetaDataOnly

description: True to export the activity summaries without the package/transaction data to look at the log rather than replaying the activities.

bOnlyLiveData

description: True if only live data should be included (live transactions and head package revisions)


description: Create a user friendly display string for using in things such as tooltips.


className: FConcertSessionInfo

description: Holds info on a session

OwnerDeviceName

type: FString

Settings

description: Settings pertaining to project, change list number etc

State

type: EConcertSession...

description: Current state of the session used to determine joinability by clients.

VersionInfos

type: TArray<FConcer...

description: Version information for this session.


className: FConcertSessionRepositoryInfo

description: Contains information about a session repository.

bMounted

description: The mounted state of this repository.

RepositoryId

type: FGuid

description: The repository ID.


description: Extract the payload into an in-memory instance

code: bool GetPayload ( [FStructOnScope](API\Runtime\CoreUObject\UObject\FStructOnScope) & OutPayload ) const


code: bool GetPayload ( const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * InPayloadType, void * InOutPayloadData ) const


code: template<typename T> bool GetTypedPayload ( T & OutPayloadData ) const


code: template<typename T> bool IsTypeChildOf() const


code: bool IsTypeChildOf ( const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * InPayloadType ) const


description: Indicates if the stored payload has been compressed with any compression algorithm.

code: bool PayloadIsCompressed() const


description: Initialize this payload from the given data

code: bool SetPayload ( const [FStructOnScope](API\Runtime\CoreUObject\UObject\FStructOnScope) & InPayload, [EConcertPayloadCompressionType](API\Plugins\Concert\EConcertPayloadCompressionType) CompressionType )


code: bool SetPayload ( const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * InPayloadType, const void * InPayloadData, [EConcertPayloadCompressionType](API\Plugins\Concert\EConcertPayloadCompressionType) CompressionType )


code: template<typename T> bool SetTypedPayload ( const T & InPayloadData, [EConcertPayloadCompressionType](API\Plugins\Concert\EConcertPayloadCompressionType) CompressType )


code: FConcertSessionSerializedPayload ( [EConcertPayloadSerializationMethod](API\Plugins\Concert\EConcertPayloadSerializationMeth-) SerializeMethod )


code: FConcertSessionSerializedPayload()


className: FConcertSessionSerializedPayload

PayloadBytes

type: FConcertByteArr...

description: The data of the user-defined payload (potentially stored as compressed binary for compact transfer).

PayloadCompressionDetails

type: EConcertCompres...

description: Indicates how the serialized payload has been compressed.

PayloadSize

description: The uncompressed size of the user-defined payload data.

PayloadTypeName

type: FName

description: The typename of the user-defined payload.

SerializationMethod

type: EConcertPayload...

description: Specifies the serialization method used to pack the data


code: bool ValidateRequirements ( const [FConcertSessionSettings](API\Plugins\Concert\FConcertSessionSettings) & Other, [FText](API\Runtime\Core\Internationalization\FText) * OutFailureReason ) const


className: FConcertSessionSettings

ArchiveNameOverride

description: Override the default name chosen when archiving this session.

BaseRevision

description: Base Revision the session was created at.

ProjectName

description: Name of the project of the session. Can be specified on the server cmd with `-CONCERTPROJECT=_


description: Return the version information in string represenation.


description: Validate this version info against another

code: bool Validate ( const [FConcertSessionVersionInfo](API\Plugins\Concert\FConcertSessionVersionInfo) & InOther, const [EConcertVersionValidationMode](API\Plugins\Concert\EConcertVersionValidationMode) InValidationMode, [FText](API\Runtime\Core\Internationalization\FText) * OutFailureReason ) const


description: Initialize this version info from the compiled in data

code: void Initialize ( bool bSupportMixedBuildTypes )


className: FConcertSessionVersionInfo

description: Holds version information for a session

CustomVersions

description: Custom version info

EngineVersion

type: FConcertEngineV...

description: Engine version info

FileVersion

type: FConcertFileVer...

description: File version info


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertSession_ClientListUpdatedEvent : public [FConcertEventData](API\Plugins\ConcertTransport\FConcertEventData)


code: virtual bool IsSafeToHandle() const


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertSession_CustomEvent : public [FConcertEventData](API\Plugins\ConcertTransport\FConcertEventData)

DestinationEndpointIds

type: TArray<FGuid>

SerializedPayload

type: FConcertSession...

description: The serialized payload that we're hosting.


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertSession_CustomRequest : public [FConcertRequestData](API\Plugins\ConcertTransport\FConcertRequestData)


description: Set the internal Concert response code from the custom response code from the request handler

code: void SetResponseCode ( const [EConcertSessionResponseCode](API\Plugins\Concert\EConcertSessionResponseCode) InResponseCode )


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertSession_CustomResponse : public [FConcertResponseData](API\Plugins\ConcertTransport\FConcertResponseData)


ConnectionResult

type: EConcertConnect...


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertSession_LeaveSessionEvent : public [FConcertEventData](API\Plugins\ConcertTransport\FConcertEventData)


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertSession_SessionRenamedEvent : public [FConcertEventData](API\Plugins\ConcertTransport\FConcertEventData)


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertSession_UpdateClientInfoEvent : public [FConcertEventData](API\Plugins\ConcertTransport\FConcertEventData)


className: FConcertTransportLoggingEnabledChanged

code: typedef TMulticastDelegate_OneParam< void, bool > FConcertTransportLoggingEnabledChanged


className: FCopySession

code: typedef TMulticastDelegate_FiveParams< void, bool, const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) &, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertServerSession](API\Plugins\Concert\IConcertServerSession) >, const [FString](API\Runtime\Core\Containers\FString) &, const [FConcertSessionFilter](API\Plugins\Concert\FConcertSessionFilter) & > FCopySession


className: FDeletedSessionInfo

SessionId

description: The ID of the session that was requested to be deleted.

SessionName

description: The name of the session that was was requested to be deleted.


className: FExportSession

code: typedef TMulticastDelegate_SixParams< void, bool, const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) &, const [FGuid](API\Runtime\Core\Misc\FGuid) &, const [FString](API\Runtime\Core\Containers\FString) &, const [FConcertSessionFilter](API\Plugins\Concert\FConcertSessionFilter) &, bool > FExportSession


className: FLogListener

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [FConcertLog](API\Plugins\Concert\FConcertLog) &)> FLogListener


className: FInternalLiveSessionCreationParams

OnModifiedCallback

type: FOnSessionModif...

description: Called when the session was modified


className: FOnArchivedSessionCreated

code: typedef TMulticastDelegate_FourParams< void, bool, const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) &, const [FString](API\Runtime\Core\Containers\FString) &, const [FConcertSessionInfo](API\Plugins\Concert\FConcertSessionInfo) & > FOnArchivedSessionCreated


className: FOnSessionModified

code: typedef TBaseDelegate_NoParams< void > FOnSessionModified


className: FOnArchivedSessionDestroyed

code: typedef TMulticastDelegate_TwoParams< void, const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) &, const [FGuid](API\Runtime\Core\Misc\FGuid) & > FOnArchivedSessionDestroyed


className: FOnArchivedSessionRenamed

code: typedef TMulticastDelegate_ThreeParams< void, const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) &, const [FString](API\Runtime\Core\Containers\FString) &, const [FConcertSessionInfo](API\Plugins\Concert\FConcertSessionInfo) & > FOnArchivedSessionRenamed


className: FOnConcertClientSessionClientChanged

code: typedef TMulticastDelegate_ThreeParams< void, [IConcertClientSession](API\Plugins\Concert\IConcertClientSession) &, [EConcertClientStatus](API\Plugins\Concert\EConcertClientStatus), const [FConcertSessionClientInfo](API\Plugins\Concert\FConcertSessionClientInfo) & > FOnConcertClientSessionClientChanged


code: typedef TMulticastDelegate_TwoParams< void, [IConcertClientSession](API\Plugins\Concert\IConcertClientSession) &, [EConcertConnectionStatus](API\Plugins\Concert\EConcertConnectionStatus) > FOnConcertClientSessionConnectionChanged


className: FOnConcertServerSessionClientChanged

code: typedef TMulticastDelegate_ThreeParams< void, [IConcertServerSession](API\Plugins\Concert\IConcertServerSession) &, [EConcertClientStatus](API\Plugins\Concert\EConcertClientStatus), const [FConcertSessionClientInfo](API\Plugins\Concert\FConcertSessionClientInfo) & > FOnConcertServerSessionClientChanged


className: FOnConcertClientSessionTick

code: typedef TMulticastDelegate_TwoParams< void, [IConcertClientSession](API\Plugins\Concert\IConcertClientSession) &, float > FOnConcertClientSessionTick


className: FOnConcertServerSessionTick

code: typedef TMulticastDelegate_TwoParams< void, [IConcertServerSession](API\Plugins\Concert\IConcertServerSession) &, float > FOnConcertServerSessionTick


className: FOnConcertSessionRenamed

code: typedef TMulticastDelegate_TwoParams< void, const [FString](API\Runtime\Core\Containers\FString) &, const [FString](API\Runtime\Core\Containers\FString) & > FOnConcertSessionRenamed


className: FOnLiveSessionCreated

code: typedef TMulticastDelegate_ThreeParams< void, bool, const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) &, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertServerSession](API\Plugins\Concert\IConcertServerSession) > > FOnLiveSessionCreated


className: FOnLiveSessionDestroyed

code: typedef TMulticastDelegate_TwoParams< void, const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) &, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertServerSession](API\Plugins\Concert\IConcertServerSession) > > FOnLiveSessionDestroyed


className: FOnLiveSessionRenamed

code: typedef TMulticastDelegate_TwoParams< void, const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) &, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertServerSession](API\Plugins\Concert\IConcertServerSession) > > FOnLiveSessionRenamed


className: FRestoreSession

code: typedef TMulticastDelegate_SixParams< void, bool, const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) &, const [FGuid](API\Runtime\Core\Misc\FGuid) &, const [FString](API\Runtime\Core\Containers\FString) &, const [FConcertSessionInfo](API\Plugins\Concert\FConcertSessionInfo) &, const [FConcertSessionFilter](API\Plugins\Concert\FConcertSessionFilter) & > FRestoreSession


description: Disconnect gracefully from the server session

code: void Disconnect()


description: Get the session connection status to the server session


description: Get the local user's ClientInfo

code: const [FConcertClientInfo](API\Plugins\Concert\FConcertClientInfo) & GetLocalClientInfo() const


description: Get the send/receive state for this session.


description: Manager for helping sequence custom events on client sessions.


description: Get the client endpoint ID


description: Get the server endpoint ID


description: Start the connection handshake with the server session

code: void Connect()


description: Does this session currently have live-updates suspended?

code: virtual bool IsSuspended() const


description: Callback when the session connection state changes


description: Callback when a session client state changes


description: Callback when a connected client session gets ticked


description: Callback when the session name changes.


description: Resume live-updates for this session (must be paired with a call to Suspend)

code: virtual void Resume()


description: Set the send/receive state for this session.

code: void SetSendReceiveState ( [EConcertSendReceiveState](API\Plugins\Concert\EConcertSendReceiveState) InSendReceiveState )


description: Suspend live-updates for this session

code: virtual void Suspend()


description: Update the local user's ClientInfo

code: void UpdateLocalClientInfo ( const [FConcertClientInfoUpdate](API\Plugins\Concert\FConcertClientInfoUpdate) & UpdatedFields )


className: IConcertClientSession

description: Interface for Concert client sessions

code: class IConcertClientSession : public [IConcertSession](API\Plugins\Concert\IConcertSession)


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [IConcertModule](API\Plugins\Concert\IConcertModule) & Get()


className: IConcertModule

description: Interface for the Main Concert module.

code: class IConcertModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description:
Checks to see if this module is loaded and ready. It is only valid to callGet()during shutdown ifIsAvailable()returns true.
True if the module is loaded and ready to use

code: static bool IsAvailable()


description: OnArchivedSessionCreated will be called if this archive was successful.

code: bool ArchiveSession ( const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) & InServer, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertServerSession](API\Plugins\Concert\IConcertServerSession) > InLiveSession, const [FString](API\Runtime\Core\Containers\FString) & InArchivedSessionRoot, const [FConcertSessionInfo](API\Plugins\Concert\FConcertSessionInfo) & InArchivedSessionInfo, const [FConcertSessionFilter](API\Plugins\Concert\FConcertSessionFilter) & InSessionFilter )


description: This function is use at boot time to auto-archive session that were not archived at shutdown because the server crashed or was killed.

code: bool ArchiveSession ( const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) & InServer, const [FString](API\Runtime\Core\Containers\FString) & InLiveSessionWorkingDir, const [FString](API\Runtime\Core\Containers\FString) & InArchivedSessionRoot, const [FConcertSessionInfo](API\Plugins\Concert\FConcertSessionInfo) & InArchivedSessionInfo, const [FConcertSessionFilter](API\Plugins\Concert\FConcertSessionFilter) & InSessionFilter )


description: Called to copy the data of a live session into another live session.

code: bool CopySession ( const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) & InServer, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertServerSession](API\Plugins\Concert\IConcertServerSession) > InLiveSession, const [FString](API\Runtime\Core\Containers\FString) & NewSessionRoot, const [FConcertSessionFilter](API\Plugins\Concert\FConcertSessionFilter) & InSessionFilter )


description: As opposed to archiving a session, once exported, the session is not tracked anymore by the server and the exported files can be copied/modified while the server is running.

code: bool ExportSession ( const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) & InServer, const [FGuid](API\Runtime\Core\Misc\FGuid) & InSessionId, const [FString](API\Runtime\Core\Containers\FString) & DestDir, const [FConcertSessionFilter](API\Plugins\Concert\FConcertSessionFilter) & InSessionFilter, bool bAnonymizeData )


description: Called to enumerate all the sessions under the given root path and retrieve their session info.

code: void GetSessionsFromPath ( const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) & InServer, const [FString](API\Runtime\Core\Containers\FString) & InPath, [TArray](API\Runtime\Core\Containers\TArray)< [FConcertSessionInfo](API\Plugins\Concert\FConcertSessionInfo) > & OutSessionInfos, [TArray](API\Runtime\Core\Containers\TArray)< [FDateTime](API\Runtime\Core\Misc\FDateTime) > * OutSessionCreationTimes )


description: If ActivityCount is negative, the function returns the last activities (the tail) from Max(1, TotalActivityCount + ActivityCount + 1)

code: bool GetUnmutedSessionActivities ( const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) & InServer, const [FGuid](API\Runtime\Core\Misc\FGuid) & SessionId, int64 FromActivityId, int64 ActivityCount, [TArray](API\Runtime\Core\Containers\TArray)< [FConcertSessionSerializedPayload](API\Plugins\Concert\FConcertSessionSerializedPayload) > & OutActivities, [TMap](API\Runtime\Core\Containers\TMap)< [FGuid](API\Runtime\Core\Misc\FGuid), [FConcertClientInfo](API\Plugins\Concert\FConcertClientInfo) > & OutEndpointClientInfoMap, bool bIncludeDetails )


description: Destroyed in this case means that the resources for the session should be closed/freed, but not that persistent data should be deleted from disk.

code: void OnArchivedSessionDestroyed ( const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) & InServer, const [FGuid](API\Runtime\Core\Misc\FGuid) & InArchivedSessionId )


description:
This function is called for both newly created sessions and after recovering an archived session during server start-up.
true if the session creation could be completed without error, false otherwise (ex if the database fails to open).

code: bool OnArchivedSessionCreated ( const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) & InServer, const [FString](API\Runtime\Core\Containers\FString) & InArchivedSessionRoot, const [FConcertSessionInfo](API\Plugins\Concert\FConcertSessionInfo) & InArchivedSessionInfo )


description: Called when an archived session is renamed.

code: void OnArchivedSessionRenamed ( const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) & InServer, const [FString](API\Runtime\Core\Containers\FString) & InArchivedSessionRoot, const [FConcertSessionInfo](API\Plugins\Concert\FConcertSessionInfo) & InArchivedSessionInfo )


description:
This function is called for both newly created sessions and after recovering a live session during server start-up.
true if the session creation could be completed without error, false otherwise (ex if the database fails to open).

code: bool OnLiveSessionCreated ( const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) & InServer, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertServerSession](API\Plugins\Concert\IConcertServerSession) > InLiveSession, const [FInternalLiveSessionCreationParams](API\Plugins\Concert\FInternalLiveSessionCreationPara-) & AdditionalParams )


code: void OnLiveSessionDestroyed ( const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) & InServer, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertServerSession](API\Plugins\Concert\IConcertServerSession) > InLiveSession )


description: Called when a live session is renamed.

code: void OnLiveSessionRenamed ( const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) & InServer, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertServerSession](API\Plugins\Concert\IConcertServerSession) > InLiveSession )


description: OnLiveSessionCreated will be called if this restoration was successful.

code: bool RestoreSession ( const [IConcertServer](API\Plugins\ConcertServer\IConcertServer) & InServer, const [FGuid](API\Runtime\Core\Misc\FGuid) & InArchivedSessionId, const [FString](API\Runtime\Core\Containers\FString) & InLiveSessionRoot, const [FConcertSessionInfo](API\Plugins\Concert\FConcertSessionInfo) & InLiveSessionInfo, const [FConcertSessionFilter](API\Plugins\Concert\FConcertSessionFilter) & InSessionFilter )


className: IConcertServerEventSink

description: Interface for events that Concert server can emit

code: class IConcertServerEventSink


description: Callback when a session message is acknowledged


description: Gets the client's address used by the messaging system. Can be fed into

code: [FMessageAddress](API\Runtime\Messaging\FMessageAddress) GetClientAddress ( const [FGuid](API\Runtime\Core\Misc\FGuid) & ClientEndpointId ) const


description: Callback when a session client state changes


description: Callback when a server session gets ticked


description: Rename the session.

code: void SetName ( const [FString](API\Runtime\Core\Containers\FString) & NewName )


className: IConcertServerSession

description: Interface for Concert server sessions

code: class IConcertServerSession : public [IConcertSession](API\Plugins\Concert\IConcertSession)


description: Clear a custom event handler for this session

code: template<typename EventType> void ClearCustomEventHandler()


description: Find the the client for the specified endpoint ID

code: bool FindSessionClient ( const [FGuid](API\Runtime\Core\Misc\FGuid) & EndpointId, [FConcertSessionClientInfo](API\Plugins\Concert\FConcertSessionClientInfo) & OutSessionClientInfo ) const


description: Get the scratchpad associated with the given client ID.

code: [FConcertScratchpadPtr](API\Plugins\ConcertTransport\Scratchpad\FConcertScratchpadPtr) GetClientScratchpad ( const [FGuid](API\Runtime\Core\Misc\FGuid) & ClientEndpointId ) const


code: const [FGuid](API\Runtime\Core\Misc\FGuid) & GetId() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetName() const


description: Get the list of connected client endpoint IDs

code: [TArray](API\Runtime\Core\Containers\TArray)< [FGuid](API\Runtime\Core\Misc\FGuid) > GetSessionClientEndpointIds() const


description: Get the scratchpad associated with this concert session.


description: Get the information about all connected clients

code: [TArray](API\Runtime\Core\Containers\TArray)< [FConcertSessionClientInfo](API\Plugins\Concert\FConcertSessionClientInfo) > GetSessionClients() const


code: const [FConcertSessionInfo](API\Plugins\Concert\FConcertSessionInfo) & GetSessionInfo() const


description: Give the working directory for this session


code: void InternalClearCustomEventHandler ( const [FName](API\Runtime\Core\UObject\FName) & EventMessageType )


description: Register a custom event handler for this session

code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) InternalRegisterCustomEventHandler ( const [FName](API\Runtime\Core\UObject\FName) & EventMessageType, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertSessionCustomEventHandler](API\Plugins\Concert\IConcertSessionCustomEventHandle-) > & Handler )


description: Register a custom request handler for this session

code: void InternalRegisterCustomRequestHandler ( const [FName](API\Runtime\Core\UObject\FName) & RequestMessageType, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertSessionCustomRequestHandler](API\Plugins\Concert\IConcertSessionCustomRequestHand-) > & Handler )


description: Send a custom event event to the given endpoints

code: void InternalSendCustomEvent ( const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * EventType, const void * EventData, const [TArray](API\Runtime\Core\Containers\TArray)< [FGuid](API\Runtime\Core\Misc\FGuid) > & DestinationEndpointIds, [EConcertMessageFlags](API\Plugins\ConcertTransport\EConcertMessageFlags) Flags, [TOptional](API\Runtime\Core\IO\TOptional)< [FConcertSequencedCustomEvent](API\Plugins\Concert\FConcertSequencedCustomEvent) > InSequenceId )


description: Send a custom request to the given endpoint

code: void InternalSendCustomRequest ( const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * RequestType, const void * RequestData, const [FGuid](API\Runtime\Core\Misc\FGuid) & DestinationEndpointId, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertSessionCustomResponseHandler](API\Plugins\Concert\IConcertSessionCustomResponseHan-) > & Handler )


description: Unregister a custom event handler for this session

code: void InternalUnregisterCustomEventHandler ( const [FName](API\Runtime\Core\UObject\FName) & EventMessageType, const [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) EventHandle )


code: void InternalUnregisterCustomEventHandler ( const [FName](API\Runtime\Core\UObject\FName) & EventMessageType, const void * EventHandler )


description: Unregister a custom request handler for this session

code: void InternalUnregisterCustomRequestHandler ( const [FName](API\Runtime\Core\UObject\FName) & RequestMessageType )


code: template<typename EventType> [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterCustomEventHandler ( typename [TConcertFunctionSessionCustomEventHandler](API\Plugins\Concert\TConcertFunctionSessionCustomEve-)< EventType >::FFuncType Func )


code: template<typename EventType, typename HandlerType> [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterCustomEventHandler ( HandlerType * Handler, typename [TConcertRawSessionCustomEventHandler](API\Plugins\Concert\TConcertRawSessionCustomEventHan-)< EventType, HandlerType >::FFuncType Func )


code: template<typename RequestType, typename ResponseType> void RegisterCustomRequestHandler ( typename [TConcertFunctionSessionCustomRequestHandler](API\Plugins\Concert\TConcertFunctionSessionCustomReq-)< RequestType, ResponseType >::FFuncType Func )


code: template<typename RequestType, typename ResponseType, typename HandlerType> void RegisterCustomRequestHandler ( HandlerType * Handler, typename [TConcertRawSessionCustomRequestHandler](API\Plugins\Concert\TConcertRawSessionCustomRequestH-)< RequestType, ResponseType, HandlerType >::FFuncType Func )


description: Send a custom event event to the given endpoint

code: template<typename EventType> void SendCustomEvent ( const EventType & Event, const [FGuid](API\Runtime\Core\Misc\FGuid) & DestinationEndpointId, [EConcertMessageFlags](API\Plugins\ConcertTransport\EConcertMessageFlags) Flags, [TOptional](API\Runtime\Core\IO\TOptional)< [FConcertSequencedCustomEvent](API\Plugins\Concert\FConcertSequencedCustomEvent) > SequencedId )


code: template<typename EventType> void SendCustomEvent ( const EventType & Event, const [TArray](API\Runtime\Core\Containers\TArray)< [FGuid](API\Runtime\Core\Misc\FGuid) > & DestinationEndpointIds, [EConcertMessageFlags](API\Plugins\ConcertTransport\EConcertMessageFlags) Flags, [TOptional](API\Runtime\Core\IO\TOptional)< [FConcertSequencedCustomEvent](API\Plugins\Concert\FConcertSequencedCustomEvent) > SequencedId )


code: template<typename RequestType, typename ResponseType> [TFuture](API\Runtime\Core\Async\TFuture)< ResponseType > SendCustomRequest ( const RequestType & Request, const [FGuid](API\Runtime\Core\Misc\FGuid) & DestinationEndpointId )


code: template<typename EventType> void UnregisterCustomEventHandler ( const [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) EventHandle )


code: template<typename EventType, typename HandlerType> void UnregisterCustomEventHandler ( HandlerType * EventHandler )


code: template<typename RequestType> void UnregisterCustomRequestHandler()


className: IConcertSession

description: Interface for Concert sessions

code: class IConcertSession


code: void HandleEvent ( const [FConcertSessionContext](API\Plugins\Concert\FConcertSessionContext) & Context, const void * EventData ) const


code: bool HasSameObject ( const void * InObject ) const


className: IConcertSessionCustomEventHandler

description: Interface for session custom event handler

code: class IConcertSessionCustomEventHandler


code: [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetResponseType() const


code: [EConcertSessionResponseCode](API\Plugins\Concert\EConcertSessionResponseCode) HandleRequest ( const [FConcertSessionContext](API\Plugins\Concert\FConcertSessionContext) & Context, const void * RequestData, void * ResponseData ) const


className: IConcertSessionCustomRequestHandler

description: Interface for session custom request handler


code: void HandleResponse ( const void * ResponseData )


className: IConcertSessionCustomResponseHandler

description: Interface for session custom request handler TODO: replace by a generalized erased promise/future pair??


className: operator&

code: constexpr [EConcertServerFlags](API\Plugins\Concert\EConcertServerFlags) operator& ( [EConcertServerFlags](API\Plugins\Concert\EConcertServerFlags) Lhs, [EConcertServerFlags](API\Plugins\Concert\EConcertServerFlags) Rhs )


code: constexpr [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) operator& ( [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) Lhs, [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) Rhs )


code: constexpr [EBatchSessionDeletionFlags](API\Plugins\Concert\EBatchSessionDeletionFlags) operator& ( [EBatchSessionDeletionFlags](API\Plugins\Concert\EBatchSessionDeletionFlags) Lhs, [EBatchSessionDeletionFlags](API\Plugins\Concert\EBatchSessionDeletionFlags) Rhs )


className: operator&=

code: [EConcertServerFlags](API\Plugins\Concert\EConcertServerFlags) & operator&= ( [EConcertServerFlags](API\Plugins\Concert\EConcertServerFlags) & Lhs, [EConcertServerFlags](API\Plugins\Concert\EConcertServerFlags) Rhs )


code: [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) & operator&= ( [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) & Lhs, [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) Rhs )


code: [EBatchSessionDeletionFlags](API\Plugins\Concert\EBatchSessionDeletionFlags) & operator&= ( [EBatchSessionDeletionFlags](API\Plugins\Concert\EBatchSessionDeletionFlags) & Lhs, [EBatchSessionDeletionFlags](API\Plugins\Concert\EBatchSessionDeletionFlags) Rhs )


className: operator~

code: constexpr [EConcertServerFlags](API\Plugins\Concert\EConcertServerFlags) operator~ ( [EConcertServerFlags](API\Plugins\Concert\EConcertServerFlags) E )


code: constexpr [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) operator~ ( [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) E )


code: constexpr [EBatchSessionDeletionFlags](API\Plugins\Concert\EBatchSessionDeletionFlags) operator~ ( [EBatchSessionDeletionFlags](API\Plugins\Concert\EBatchSessionDeletionFlags) E )


className: operator^

code: constexpr [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) operator^ ( [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) Lhs, [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) Rhs )


code: constexpr [EConcertServerFlags](API\Plugins\Concert\EConcertServerFlags) operator^ ( [EConcertServerFlags](API\Plugins\Concert\EConcertServerFlags) Lhs, [EConcertServerFlags](API\Plugins\Concert\EConcertServerFlags) Rhs )


code: constexpr [EBatchSessionDeletionFlags](API\Plugins\Concert\EBatchSessionDeletionFlags) operator^ ( [EBatchSessionDeletionFlags](API\Plugins\Concert\EBatchSessionDeletionFlags) Lhs, [EBatchSessionDeletionFlags](API\Plugins\Concert\EBatchSessionDeletionFlags) Rhs )


className: operator^=

code: [EConcertServerFlags](API\Plugins\Concert\EConcertServerFlags) & operator^= ( [EConcertServerFlags](API\Plugins\Concert\EConcertServerFlags) & Lhs, [EConcertServerFlags](API\Plugins\Concert\EConcertServerFlags) Rhs )


code: [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) & operator^= ( [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) & Lhs, [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) Rhs )


code: [EBatchSessionDeletionFlags](API\Plugins\Concert\EBatchSessionDeletionFlags) & operator^= ( [EBatchSessionDeletionFlags](API\Plugins\Concert\EBatchSessionDeletionFlags) & Lhs, [EBatchSessionDeletionFlags](API\Plugins\Concert\EBatchSessionDeletionFlags) Rhs )


className: operator!

code: constexpr bool operator! ( [EConcertServerFlags](API\Plugins\Concert\EConcertServerFlags) E )


code: constexpr bool operator! ( [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) E )


code: constexpr bool operator! ( [EBatchSessionDeletionFlags](API\Plugins\Concert\EBatchSessionDeletionFlags) E )


className: FFuncType

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [FConcertSessionContext](API\Plugins\Concert\FConcertSessionContext) &, const EventType &)> FFuncType


code: virtual void HandleEvent ( const [FConcertSessionContext](API\Plugins\Concert\FConcertSessionContext) & Context, const void * EventData ) const


code: virtual bool HasSameObject ( const void * InObject ) const


description: Implementation of a session custom event handler that calls a function with the correct event type in the handler function signature.

code: template<typename EventType> class TConcertFunctionSessionCustomEventHandler : public [FConcertSessionCustomEventHandlerBase](API\Plugins\Concert\FConcertSessionCustomEventHandle-)


code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< [EConcertSessionResponseCode](API\Plugins\Concert\EConcertSessionResponseCode)(const [FConcertSessionContext](API\Plugins\Concert\FConcertSessionContext) &, const RequestType &, ResponseType &)> FFuncType


code: TConcertFunctionSessionCustomEventHandler ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) InHandle, [FFuncType](API\Plugins\Concert\TConcertFunctionSessionCustomEve-\FFuncType) InFunc )


code: virtual [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetResponseType() const


code: virtual [EConcertSessionResponseCode](API\Plugins\Concert\EConcertSessionResponseCode) HandleRequest ( const [FConcertSessionContext](API\Plugins\Concert\FConcertSessionContext) & Context, const void * RequestData, void * ResponseData ) const


code: TConcertFunctionSessionCustomRequestHandler ( [FFuncType](API\Plugins\Concert\TConcertFunctionSessionCustomReq-\FFuncType) InFunc )


description: Implementation of a session custom request handler that calls a function with the correct request type in the handler function signature.

code: template<typename RequestType, typename ResponseType> class TConcertFunctionSessionCustomRequestHandler : public [IConcertSessionCustomRequestHandler](API\Plugins\Concert\IConcertSessionCustomRequestHand-)


code: [TFuture](API\Runtime\Core\Async\TFuture)< ResponseType > GetFuture()


code: virtual void HandleResponse ( const void * ResponseData )


description: Implementation of a session custom response handler that uses a future to dispatch back the response

code: template<typename ResponseType> class TConcertFutureSessionCustomResponseHandler : public [IConcertSessionCustomResponseHandler](API\Plugins\Concert\IConcertSessionCustomResponseHan-)


code: typedef void(HandlerType::* FFuncType


code: TConcertRawSessionCustomEventHandler ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) InHandle, HandlerType * InHandler, [FFuncType](API\Plugins\Concert\TConcertRawSessionCustomEventHan-\FFuncType) InFunc )


className: TConcertRawSessionCustomEventHandler

description: Implementation of a session custom event handler that uses a raw member function pointer with the correct event type in the handler function signature.

code: template<typename EventType, typename HandlerType> class TConcertRawSessionCustomEventHandler : public [FConcertSessionCustomEventHandlerBase](API\Plugins\Concert\FConcertSessionCustomEventHandle-)


code: TConcertRawSessionCustomRequestHandler ( HandlerType * InHandler, [FFuncType](API\Plugins\Concert\TConcertRawSessionCustomRequestH-\FFuncType) InFunc )


className: TConcertRawSessionCustomRequestHandler

description: Implementation of a session custom request handler that calls a raw member function with the correct request type in the handler function signature.

code: template<typename RequestType, typename ResponseType, typename HandlerType> class TConcertRawSessionCustomRequestHandler : public [IConcertSessionCustomRequestHandler](API\Plugins\Concert\IConcertSessionCustomRequestHand-)


className: WithSerializer

code: enum &123; WithSerializer = true &125;


code: template<> struct TStructOpsTypeTraits< FConcertByteArray > : public [TStructOpsTypeTraitsBase2< FConcertByteArray >](API\Runtime\CoreUObject\UObject\TStructOpsTypeTraitsBase2)


description: Returns truen if the compression details is set to compressed format.

code: namespace UE { namespace Concert { namespace Compression { bool UE::Concert::Compression::DataIsCompressed ( [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) InFormat ) } } }


description: Returns true if we are suppose to use Oodle for compression.

code: namespace UE { namespace Concert { namespace Compression { bool UE::Concert::Compression::DataIsCompressedWithOodle ( [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) InFormat ) } } }


description: Returns true if the compression details is set to uncompressed format.

code: namespace UE { namespace Concert { namespace Compression { bool UE::Concert::Compression::DataIsUncompressed ( [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) InFormat ) } } }


description: Get the named compression algorithm to invoke with serializer and memory compressors.

code: namespace UE { namespace Concert { namespace Compression { [FName](API\Runtime\Core\UObject\FName) UE::Concert::Compression::GetCompressionAlgorithm() } } }


description: Get the named compression algorithm based on the provided details. Current this is only Zlib or Oodle.

code: namespace UE { namespace Concert { namespace Compression { [FName](API\Runtime\Core\UObject\FName) UE::Concert::Compression::GetCompressionAlgorithm ( [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) InDetails ) } } }


description: Get the default flags to use when invoking the compressor.

code: namespace UE { namespace Concert { namespace Compression { ECompressionFlags UE::Concert::Compression::GetCompressionFlags() } } }


description: Add in the compression flags to the concert compression details enum.

code: namespace UE { namespace Concert { namespace Compression { [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) UE::Concert::Compression::GetCompressionFlags ( [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) InFormat ) } } }


description: For a given named compression algorithm and compression flags convert it into a EConcertCompressionDetails

code: namespace UE { namespace Concert { namespace Compression { [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) UE::Concert::Compression::GetCompressionFromNamedType ( [FName](API\Runtime\Core\UObject\FName) NamedMethod, ECompressionFlags Flags ) } } }


description: Based on the data size return the current compression details to store.

code: namespace UE { namespace Concert { namespace Compression { template<typename SizeType> [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) UE::Concert::Compression::GetCompressionDetails ( SizeType DataSize ) } } }


description: Get the compression enum value given the concert compression settings. This the value passed into the serializer and memory compressor.

code: namespace UE { namespace Concert { namespace Compression { ECompressionFlags UE::Concert::Compression::GetCoreCompressionFlags ( [EConcertCompressionDetails](API\Plugins\Concert\EConcertCompressionDetails) InFormat ) } } }


description: Based on the size of the data to compress indicate if we should invoke the compressor.

code: namespace UE { namespace Concert { namespace Compression { template<typename SizeType> bool UE::Concert::Compression::ShouldCompress ( SizeType DataSize ) } } }


className: EConcertConnectionTaskAction

description: Enum to indicate if any action were taken for the connection task

module: ConcertClient

code: enum EConcertConnectionTaskAction { None = 0, Cancel, Continue, }


className: EConcertServerType

code: enum EConcertServerType { Console, Slate, }


className: EConcertSourceValidationMode

code: enum EConcertSourceValidationMode { Hard = 0, Soft, SoftAutoProceed, }


className: FConcertArchiveSessionArgs

code: struct FConcertArchiveSessionArgs

ArchiveNameOverride

description: The override for the name used when archiving the session

SessionFilter

description: The filter controlling which activities from the session should be archived

SessionId

description: The ID of the archived session to archive


className: FConcertBatchDeleteSessionsArgs

code: struct FConcertBatchDeleteSessionsArgs

Flags

type: EBatchSessionDe...

SessionIds

type: TSet<FGuid>


className: FConcertClientSettings

AvatarColor

type: FLinearColor

description: The color used for the presence avatar in a session.

bReflectLevelEditorInGame

type: bool

description: When level editor changes are made, reflect those changes to the game equivalent property.

bSupportMixedBuildTypes

description: Enable extended version support when using Multi-user with precompiled and source builds.

ClientAuthenticationKey

description: A key used to identify the clients during server discovery.

DesktopAvatarActorClass

type: FSoftClassPath

description: The desktop representation of this editor's user to other connected users

DiscoveryTimeoutSeconds

description: The timespan at which discovered Multi-User server are considered stale if they haven't answered back

DisplayName

description: The display name to use when in a session.

LatencyCompensationMs

type: float

description: Amount of latency compensation to apply to time-synchronization sensitive interactions

ServerPort

description: The port to use to reach the server with static endpoints when launched through the editor.

SessionTickFrequencySeconds

description: The timespan at which session updates are processed.

Tags

type: TArray<FName>

description: Array of tags that can be used for grouping and categorizing.

VRAvatarActorClass

description: The VR representation of this editor's user to other connected users


className: FConcertCopySessionArgs

code: struct FConcertCopySessionArgs

ArchiveNameOverride

type: FString

description: The override for the name used when archiving the copied/restored session

bAutoConnect

description: True to auto-connect to the session after copying/restoring it

SessionFilter

description: The filter controlling which activities should be copied from the source session.

SessionId

type: FGuid

description: The ID of the session to copy or restore

SessionName

description: The desired name for new session


className: FConcertCreateSessionArgs

code: struct FConcertCreateSessionArgs

ArchiveNameOverride

description: The override for the name used when archiving this session

description: The desired name for the session


code: FConcertSourceControlSettings()


className: FConcertSourceControlSettings

ValidationMode

type: EConcertSourceV...


code: typedef TMulticastDelegate_TwoParams< void, const [IConcertClient](API\Plugins\ConcertClient\IConcertClient) &, [TArray](API\Runtime\Core\Containers\TArray)< [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IConcertClientConnectionTask](API\Plugins\ConcertClient\IConcertClientConnectionTask) > > & > FOnConcertClientSessionGetPreConnectionTasks


code: typedef TMulticastDelegate_OneParam< void, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertClientSession](API\Plugins\Concert\IConcertClientSession) > > FOnConcertClientSessionStartupOrShutdown


className: FOnConcertEvaluateHasRole

code: typedef TBaseDelegate_OneParam< bool, const [FGameplayTagContainer](API\Runtime\GameplayTags\FGameplayTagContainer) & > FOnConcertEvaluateHasRole


description:
Archive a live session on the server hosting the session.
A future that will contains the final response code of the request

code: [TFuture](API\Runtime\Core\Async\TFuture)< [EConcertResponseCode](API\Plugins\ConcertTransport\EConcertResponseCode) > ArchiveSession ( const [FGuid](API\Runtime\Core\Misc\FGuid) & ServerAdminEndpointId, const [FConcertArchiveSessionArgs](API\Plugins\ConcertClient\FConcertArchiveSessionArgs) & ArchiveSessionArgs )


description:
Deletes several live or archives sessions from the server. If the client is not sure whether the client has permission for it, it can set the SkipForbiddenSessions - the server will skip disallowed sessions instead of rejecting the entire operation.
A future that will contain the server's response (and optionally which sessions were skipped due to permissions)

code: [TFuture](API\Runtime\Core\Async\TFuture)< [FConcertAdmin_BatchDeleteSessionResponse](API\Plugins\Concert\FConcertAdmin_BatchDeleteSession-_1) > BatchDeleteSessions ( const [FGuid](API\Runtime\Core\Misc\FGuid) & ServerAdminEndpointId, const [FConcertBatchDeleteSessionsArgs](API\Plugins\ConcertClient\FConcertBatchDeleteSessionsArgs) & BatchDeletionArgs )


className: FConcertConnectionError

description: Struct to contain connection error Code is an integer instead of an enum since connection task can be extended, range under 10000 is reserved. Currently used code and their meaning are as follow No Error = 0: Success Pre Connection Canceled = 1: Pre connection validation was canceled by the user Connection Attempt Aborted = 2: Ongoing connection attempt was canceled by the user Server Not Responding = 3: Connection request to server timed out Server Request Failure = 4: Server refused the session connection request Workspace Validation Unknown Error = 100: Workspace validation unknown error Source Control Validation Unknown Error = 110: Unknown source control validation error Source Control Validation Canceled = 111: Source control validation was canceled by the user Source Control Validation Error = 112: Modified files not yet submitted were found in the workspace Dirty Packages Validation Error = 113: Dirty Packages were found before connecting to a session

code: struct FConcertConnectionError

ErrorCode

description: Code for the last connection error.

ErrorText

type: FText

description: Localized text associated with the error.


description: IfConfigure()is called while the client is in a session, some settings may be applied only once the client leave the session.

code: void Configure ( const [UConcertClientConfig](API\Plugins\ConcertClient\UConcertClientConfig) * InSettings )


description: Returns true if the client is configured for auto connection.

code: bool CanAutoConnect() const


description:
Copy a live or and archived session into a new live session on server, matching the configured settings. If the session is archived, this is equivalent to restoring it (because copying an archive into another archive is not useful). This also initiates the connection handshake for that session with the server when bAutoConnect is true in the CopySessionArgs.
A future that will contains the final response code of the request

code: [TFuture](API\Runtime\Core\Async\TFuture)< [EConcertResponseCode](API\Plugins\ConcertTransport\EConcertResponseCode) > CopySession ( const [FGuid](API\Runtime\Core\Misc\FGuid) & ServerAdminEndpointId, const [FConcertCopySessionArgs](API\Plugins\ConcertClient\FConcertCopySessionArgs) & CopySessionArgs )


description:
Create a session on the server, matching the client configured settings. This also initiates the connection handshake for that session with the client.
A future that will contains the final response code of the request

code: [TFuture](API\Runtime\Core\Async\TFuture)< [EConcertResponseCode](API\Plugins\ConcertTransport\EConcertResponseCode) > CreateSession ( const [FGuid](API\Runtime\Core\Misc\FGuid) & ServerAdminEndpointId, const [FConcertCreateSessionArgs](API\Plugins\ConcertClient\FConcertCreateSessionArgs) & CreateSessionArgs )


description:
Delete a live or archived session from the server if the client is the owner of the session. The server automatically detects if the session is live or archived. If the client is not the owner the request will be refused.
A future that will contains the final response code of the request

code: [TFuture](API\Runtime\Core\Async\TFuture)< [EConcertResponseCode](API\Plugins\ConcertTransport\EConcertResponseCode) > DeleteSession ( const [FGuid](API\Runtime\Core\Misc\FGuid) & ServerAdminEndpointId, const [FGuid](API\Runtime\Core\Misc\FGuid) & SessionId )


description: Disconnect from the current session.

code: void DisconnectSession()


description: Drop a set of repositories (and delete the files) from the server. All sessions stored in the unmounted repository will be unloaded and unreachable. The server can only drop the repository if it is not mounted or has mounted it itself.

code: [TFuture](API\Runtime\Core\Async\TFuture)< [FConcertAdmin_DropSessionRepositoriesResponse](API\Plugins\Concert\FConcertAdmin_DropSessionReposit-_1) > DropSessionRepositories ( const [FGuid](API\Runtime\Core\Misc\FGuid) & ServerAdminEndpointId, const [TArray](API\Runtime\Core\Containers\TArray)< [FGuid](API\Runtime\Core\Misc\FGuid) > & RepositoryIds ) const


description:
Get the list of the archived sessions data from a server
A future forFConcertAdmin_GetSessionsResponsewhich contains the list of the archived sessions.

code: [TFuture](API\Runtime\Core\Async\TFuture)< [FConcertAdmin_GetSessionsResponse](API\Plugins\Concert\FConcertAdmin_GetSessionsRespons-) > GetArchivedSessions ( const [FGuid](API\Runtime\Core\Misc\FGuid) & ServerAdminEndpointId ) const


description: Return The configuration of this client, or null if it hasn't been configured.

code: const [UConcertClientConfig](API\Plugins\ConcertClient\UConcertClientConfig) * GetConfiguration() const


description: Get the current client session (if any).

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IConcertClientSession](API\Plugins\Concert\IConcertClientSession) > GetCurrentSession() const


description: Get the client information passed toConfigure()if the client is not in a session, otherwise, returns the current session client info as returned byIConcertClientSession::GetLocalClientInfo().

code: const [FConcertClientInfo](API\Plugins\Concert\FConcertClientInfo) & GetClientInfo() const


description: Get the list of discovered server information

code: [TArray](API\Runtime\Core\Containers\TArray)< [FConcertServerInfo](API\Plugins\Concert\FConcertServerInfo) > GetKnownServers() const


description:
Get the last connection error
an error code along with a text description of the last connection error.


description: Get the role of this client (eg, MultiUser, DisasterRecovery, etc)

code: const [FString](API\Runtime\Core\Containers\FString) & GetRole() const


description: Get the send/receive state for this session.


description:
Get the list of sessions available on a server
A future forFConcertAdmin_GetAllSessionsResponsewhich contains a list of sessions

code: [TFuture](API\Runtime\Core\Async\TFuture)< [FConcertAdmin_GetAllSessionsResponse](API\Plugins\Concert\FConcertAdmin_GetAllSessionsResp-) > GetServerSessions ( const [FGuid](API\Runtime\Core\Misc\FGuid) & ServerAdminEndpointId ) const


description:
Get the specified session activities, ordered by Activity ID (ascending) from a live or archived session without being connected to it. The function is used to explore the history of a session, for example to implement the disaster recovery scenario. It is possible to get the total number of activities in a session using -1 as ActivityCount. The response will contain the last Activity and its ID. To get the N last activities, set ActivityCount = -N.
A future forFConcertAdmin_GetSessionActivitiesResponsewhich contains up toAbs(ActivityCount)activities or an error if it fails. The array of payload in the response can always be decoded asFConcertSyncActivityobjects. If bIncludeDetails is true, 'package' and 'transaction' can be decoded respectively asFConcertSyncPackageActivityandFConcertSyncTransactionActivity, providing extra information. The transaction event will contains the full transaction data. The package event contains the package event meta data only.

code: [TFuture](API\Runtime\Core\Async\TFuture)< [FConcertAdmin_GetSessionActivitiesResponse](API\Plugins\Concert\FConcertAdmin_GetSessionActiviti-_1) > GetSessionActivities ( const [FGuid](API\Runtime\Core\Misc\FGuid) & ServerAdminEndpointId, const [FGuid](API\Runtime\Core\Misc\FGuid) & SessionId, int64 FromActivityId, int64 ActivityCount, bool bIncludeDetails ) const


description:
Get the list of clients connected to a session on the server
A future forFConcertAdmin_GetSessionClientsResponsewhich contains a list of session clients

code: [TFuture](API\Runtime\Core\Async\TFuture)< [FConcertAdmin_GetSessionClientsResponse](API\Plugins\Concert\FConcertAdmin_GetSessionClientsR-_1) > GetSessionClients ( const [FGuid](API\Runtime\Core\Misc\FGuid) & ServerAdminEndpointId, const [FGuid](API\Runtime\Core\Misc\FGuid) & SessionId ) const


description: EConcertConnectionStatus


description:
Get the list of the live sessions data from a server
A future forFConcertAdmin_GetSessionsResponsewhich contains the list of the archived sessions.

code: [TFuture](API\Runtime\Core\Async\TFuture)< [FConcertAdmin_GetSessionsResponse](API\Plugins\Concert\FConcertAdmin_GetSessionsRespons-) > GetLiveSessions ( const [FGuid](API\Runtime\Core\Misc\FGuid) & ServerAdminEndpointId ) const


description: Request the list of existing session repositories from the server.

code: [TFuture](API\Runtime\Core\Async\TFuture)< [FConcertAdmin_GetSessionRepositoriesResponse](API\Plugins\Concert\FConcertAdmin_GetSessionReposito-_1) > GetSessionRepositories ( const [FGuid](API\Runtime\Core\Misc\FGuid) & ServerAdminEndpointId ) const


description: Return true if the client has been configured.

code: bool IsConfigured() const


description: Returns true if the client has an active auto connection routine.

code: bool IsAutoConnecting() const


description: Returns true if server discovery is enabled.

code: bool IsDiscoveryEnabled() const


description: Deprecated* Use GetSendReceiveState to query the live update status.

code: virtual bool IsSessionSuspended() const


description: Returns if the client has already been started up.

code: bool IsStarted() const


description:
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.
A future that will contains the final response code of the request

code: [TFuture](API\Runtime\Core\Async\TFuture)< [EConcertResponseCode](API\Plugins\ConcertTransport\EConcertResponseCode) > JoinSession ( const [FGuid](API\Runtime\Core\Misc\FGuid) & ServerAdminEndpointId, const [FGuid](API\Runtime\Core\Misc\FGuid) & SessionId )


description: Usually, a client would create a new empty repository and set it as default to populate it, then keep the ID to reload/drop it later.

code: [TFuture](API\Runtime\Core\Async\TFuture)< [FConcertAdmin_MountSessionRepositoryResponse](API\Plugins\Concert\FConcertAdmin_MountSessionReposi-_1) > MountSessionRepository ( const [FGuid](API\Runtime\Core\Misc\FGuid) & ServerAdminEndpointId, const [FString](API\Runtime\Core\Containers\FString) & RepositoryRootDir, const [FGuid](API\Runtime\Core\Misc\FGuid) & RepositoryId, bool bCreateIfNotExist, bool bAsDefault ) const


description: Get the delegate that is called to get the pre-connection tasks for a client session


description: Get the delegate callback for when the known server list is updated


description: Get the delegate that is called when the session connection state changes


description: Get the delegate that is called right before the client session shutdown


description: Does the client think it is the owner of the session?

code: bool IsOwnerOf ( const [FConcertSessionInfo](API\Plugins\Concert\FConcertSessionInfo) & InSessionInfo ) const


description:
Rename a live or archived session if the client has the permission. The server automatically detects if the session is live or archived. If the client is not the owner the request will be refused.
A future that will contains the final response code of the request

code: [TFuture](API\Runtime\Core\Async\TFuture)< [EConcertResponseCode](API\Plugins\ConcertTransport\EConcertResponseCode) > RenameSession ( const [FGuid](API\Runtime\Core\Misc\FGuid) & ServerAdminEndpointId, const [FGuid](API\Runtime\Core\Misc\FGuid) & SessionId, const [FString](API\Runtime\Core\Containers\FString) & NewName )


description: Get the delegate that is called right before the client session startup