Navigation
API > API/Plugins > API/Plugins/StormSyncTransportClient
| Name | IStormSyncTransportClientModule |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/StormSync/Source/StormSyncTransportClient/Public/IStormSyncTransportClientModule.h |
| Include Path | #include "IStormSyncTransportClientModule.h" |
Syntax
class IStormSyncTransportClientModule : public IModuleInterface
Implements Interfaces
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< IStormSyncTransportClientLocalEndpoint > CreateClientLocalEndpoint
(
const FString& InEndpointFriendlyName |
IStormSyncTransportClientModule.h | ||
FString GetClientEndpointMessageAddressId() |
Returns Message Address UID for client endpoint if it is currently running, empty string otherwise | IStormSyncTransportClientModule.h | |
FMessageEndpointSharedPtr GetClientMessageEndpoint() |
Returns Message Address UID for client endpoint if it is currently running, empty string otherwise | IStormSyncTransportClientModule.h | |
| Send a synchronization (pull) request on a specific storm sync connected device | IStormSyncTransportClientModule.h | ||
| Send a synchronization (push) request on a specific storm sync connected device | IStormSyncTransportClientModule.h | ||
| Sends a status request | IStormSyncTransportClientModule.h | ||
void StartClientEndpoint
(
const FString& InEndpointFriendlyName |
Start transport client endpoint | IStormSyncTransportClientModule.h | |
| Broadcast a synchronization request on all storm sync connected devices | IStormSyncTransportClientModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IStormSyncTransportClientModule & Get () |
Singleton-like access to this module's interface. | IStormSyncTransportClientModule.h | |
static bool IsAvailable () |
Checks to see if this module is loaded and ready. | IStormSyncTransportClientModule.h |