Navigation
API > API/Plugins > API/Plugins/AvalancheMedia
Base Sync feature interface
TODO:
- Proper completion delegates handling for push and pull
- Handle errors and respond with error state (with error case either from local or remote)
| Name | IAvaMediaSyncProvider |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheMedia/Public/ModularFeature/IAvaMediaSyncProvider.h |
| Include Path | #include "ModularFeature/IAvaMediaSyncProvider.h" |
Syntax
class IAvaMediaSyncProvider : public IModularFeature
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IAvaMediaSyncProvider() |
ModularFeature/IAvaMediaSyncProvider.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CompareWithRemote
(
const FString& InRemoteName, |
Issue a "compare" request to a given remote, and calls back the completion delegate with status payload. | ModularFeature/IAvaMediaSyncProvider.h | |
FName GetName() |
Returns underlying feature implementation name | ModularFeature/IAvaMediaSyncProvider.h | |
FOnAvaMediaSyncPackageModified & GetOnAvaSyncPackageModified() |
Delegate called when a package is modified by a sync write operation, either being added or modified. | ModularFeature/IAvaMediaSyncProvider.h | |
void PullFromRemote
(
const FString& InRemoteName, |
Sends a "pull" request to a specific remote (either a playback server or client name) | ModularFeature/IAvaMediaSyncProvider.h | |
void PushToRemote
(
const FString& InRemoteName, |
Sends a "push" request to a specific remote (either a playback server or client name) | ModularFeature/IAvaMediaSyncProvider.h | |
| Broadcasts a "sync" request to all connected remotes on the local network. | ModularFeature/IAvaMediaSyncProvider.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IAvaMediaSyncProvider * Get() |
Returns the first registered implementation based on GetModularFeatureName(), if there is one available | ModularFeature/IAvaMediaSyncProvider.h | |
static FName GetModularFeatureName() |
ModularFeature/IAvaMediaSyncProvider.h |