IConcertServer

Interface for Concert server

Windows
MacOS
Linux

References

Module

Concert

Header

/Engine/Plugins/Developer/Concert/ConcertMain/Source/Concert/Public/IConcertServer.h

Include

#include "IConcertServer.h"

Syntax

class IConcertServer

Remarks

Interface for Concert server

Destructors

Name Description

Public function Virtual

~IConcertServer()

Functions

Name Description

Public function

FGuid

 

ArchiveSession

(
    const FGuid& SessionId,
    const FString& ArchiveNameOverride,
    const FConcertSessionFilter& Sessi...,
    FText& OutFailureReason
)

Archive a Concert session on the server.

Public function

void

 

Configure

(
    const UConcertServerConfig* Se...
)

Configure the Concert settings and its information

Public function

TSharedPtr< ...

 

CopySession

(
    const FGuid& SrcSessionId,
    const FConcertSessionInfo& NewSess...,
    const FConcertSessionFilter& Sessi...,
    FText& OutFailureReason
)

Create a new live server session from another session.

Public function

TSharedPtr< ...

 

CreateSession

(
    const FConcertSessionInfo& Session...,
    FText& OutFailureReason
)

Create a new Concert server session based on the passed session info

Public function Const

FConcertSess...

 

CreateSessionInfo()

Create a session description for this server

Public function

bool

 

DestroySession

(
    const FGuid& SessionId,
    FText& OutFailureReason
)

Destroy a live or archived Concert server session.

Public function

bool

 

ExportSession

(
    const FGuid& SessionId,
    const FConcertSessionFilter& Sessi...,
    const FString& DestDir,
    bool bAnonymizeData,
    FText& OutFailureReason
)

Copy the session data to a destination folder for external usage.

Public function Const

FGuid

 

GetArchivedSessionIdByName

(
    const FString& InName
)

Get the ID of an archived session from its name.

Public function Const

const UConce...

 

GetConfiguration()

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

Public function Const

FGuid

 

GetLiveSessionIdByName

(
    const FString& InName
)

Get the ID of a live session from its name.

Public function Const

const FStrin...

 

GetRole()

Get the role of this server (eg, MultiUser, DisasterRecovery, etc)

Public function Const

const FConce...

 

GetServerInfo()

Get the server information set by Configure

Public function Const

TSharedPtr< ...

 

GetSession

(
    const FGuid& SessionId
)

Get a server session

Public function Const

TArray< FCon...

 

GetSessionClients

(
    const FGuid& SessionId
)

Get the list of clients for a session

Public function Const

TArray< TSha...

 

GetSessions()

Get all server sessions

Public function Const

TArray< FCon...

 

GetSessionsInfo()

Get the sessions information list

Public function Const

bool

 

IsConfigured()

Return true if the server has been configured.

Public function Const

bool

 

IsStarted()

Returns if the server has already been started up.

Public function

bool

 

RenameSession

(
    const FGuid& SessionId,
    const FString& NewName,
    FText& OutFailureReason
)

Rename a live or archived Concert session on the server.

Public function

TSharedPtr< ...

 

RestoreSession

(
    const FGuid& SessionId,
    const FConcertSessionInfo& Session...,
    const FConcertSessionFilter& Sessi...,
    FText& OutFailureReason
)

Restore an archived Concert server session based on the passed session info

Public function

void

 

Shutdown()

Shutdown the server, this can be called multiple time with no ill effect.

Public function

void

 

Startup()

Startup the server, this can be called multiple time Configure needs to be called before startup

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