Navigation
API > API/Plugins > API/Plugins/Concert
Inheritance Hierarchy
- IConcertSession
- IConcertClientSession
References
| Module | Concert |
| Header | /Engine/Plugins/Developer/Concert/ConcertMain/Source/Concert/Public/IConcertSession.h |
| Include | #include "IConcertSession.h" |
Syntax
class IConcertClientSession : public IConcertSession
Remarks
Interface for Concert client sessions
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | Connect () |
Start the connection handshake with the server session |
 |
void | Disconnect () |
Disconnect gracefully from the server session |
  |
EConcertConnectionStatus | Get the session connection status to the server session | |
  |
const FConcertClientInfo & | Get the local user's ClientInfo | |
  |
EConcertSendReceiveState | Get the send/receive state for this session. | |
 |
FConcertSequencedCustomEventManager & | Manager for helping sequence custom events on client sessions. | |
  |
FGuid | Get the client endpoint ID | |
  |
FGuid | Get the server endpoint ID | |
 |
FOnConcertClientSessionConnectionChanged & | Callback when the session connection state changes | |
 |
FOnConcertClientSessionClientChanged & | Callback when a session client state changes | |
 |
FOnConcertSessionRenamed & | Callback when the session name changes. | |
 |
FOnConcertClientSessionTick & | OnTick () |
Callback when a connected client session gets ticked |
 |
void | SetSendReceiveState
(
EConcertSendReceiveState InSendReceiveState |
Set the send/receive state for this session. |
 |
void | UpdateLocalClientInfo
(
const FConcertClientInfoUpdate& UpdatedFields |
Update the local user's ClientInfo |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
   |
bool | IsSuspended () |
Use GetSendReceiveState to query the live update status. |
  |
void | Resume () |
Use SetSendReceiveState to change live update status. |
  |
void | Suspend () |
Use SetSendReceiveState to change live update status. |