1. Epic GamesDeveloper
  3. IConcertServerEventSink

IConcertServerEventSink

Interface for events that Concert server can emit

API > API/Plugins > API/Plugins/Concert

Interface for events that Concert server can emit

   
Name IConcertServerEventSink
Type class
Header File /Engine/Plugins/Developer/Concert/ConcertMain/Source/Concert/Public/IConcertServerEventSink.h
Include Path #include "IConcertServerEventSink.h"

Syntax

class IConcertServerEventSink

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool ArchiveSession ( const IConcertServer& InServer,
TSharedRef< IConcertServerSession > InLiveSession,
const FString& InArchivedSessionRoot,
const FConcertSessionInfo& InArchivedSessionInfo,
const FConcertSessionFilter& InSessionFilter
)

 Called to migrate the data for a live session into an archived session. IConcertServerEventSink.h  

bool ArchiveSession ( const IConcertServer& InServer,
const FString& InLiveSessionWorkingDir,
const FString& InArchivedSessionRoot,
const FConcertSessionInfo& InArchivedSessionInfo,
const FConcertSessionFilter& InSessionFilter
)

 Called to migrate the data of an offline live session into and offline archived session. IConcertServerEventSink.h  

bool CopySession ( const IConcertServer& InServer,
TSharedRef< IConcertServerSession > InLiveSession,
const FString& NewSessionRoot,
const FConcertSessionFilter& InSessionFilter
)

 Called to copy the data of a live session into another live session. IConcertServerEventSink.h  

bool ExportSession ( const IConcertServer& InServer,
const FGuid& InSessionId,
const FString& DestDir,
const FConcertSessionFilter& InSessionFilter,
bool bAnonymizeData
)

 Called to migrate and gather the data of a live or archived session to a directory for external usage. IConcertServerEventSink.h  

void GetSessionsFromPath ( const IConcertServer& InServer,
const FString& InPath,
TArray< FConcertSessionInfo >& OutSessionInfos,
TArray< FDateTime >* OutSessionCreationTimes
)

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

bool GetUnmutedSessionActivities ( const IConcertServer& InServer,
const FGuid& SessionId,
int64 FromActivityId,
int64 ActivityCount,
TArray< FConcertSessionSerializedPayload >& OutActivities,
TMap< FGuid, FConcertClientInfo >& OutEndpointClientInfoMap,
bool bIncludeDetails
)

 Called to get the all activities that are not muted (i.e. don't have EConcertSyncActivityFlags::Muted flag set) for an archived or a live session without being connected to it. IConcertServerEventSink.h  

bool OnArchivedSessionCreated ( const IConcertServer& InServer,
const FString& InArchivedSessionRoot,
const FConcertSessionInfo& InArchivedSessionInfo
)

 Called after the session has been created. IConcertServerEventSink.h  

void OnArchivedSessionDestroyed ( const IConcertServer& InServer,
const FGuid& InArchivedSessionId
)

 Called before the session is destroyed. IConcertServerEventSink.h  

void OnArchivedSessionRenamed ( const IConcertServer& InServer,
const FString& InArchivedSessionRoot,
const FConcertSessionInfo& InArchivedSessionInfo
)

 Called when an archived session is renamed. IConcertServerEventSink.h  

bool OnLiveSessionCreated ( const IConcertServer& InServer,
TSharedRef< IConcertServerSession > InLiveSession,
const FInternalLiveSessionCreationParams& AdditionalParams
)

 Called after the session has been created (and before Startup has been called on it). IConcertServerEventSink.h  

void OnLiveSessionDestroyed ( const IConcertServer& InServer,
TSharedRef< IConcertServerSession > InLiveSession
)

 Called before the session is destroyed (and before Shutdown is called on it). IConcertServerEventSink.h  

void OnLiveSessionRenamed ( const IConcertServer& InServer,
TSharedRef< IConcertServerSession > InLiveSession
)

 Called when a live session is renamed. IConcertServerEventSink.h  

bool RestoreSession ( const IConcertServer& InServer,
const FGuid& InArchivedSessionId,
const FString& InLiveSessionRoot,
const FConcertSessionInfo& InLiveSessionInfo,
const FConcertSessionFilter& InSessionFilter
)

 Called to migrate the data for an archived session into a live session. IConcertServerEventSink.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page