Navigation
API > API/Plugins > API/Plugins/AvalancheMedia > API/Plugins/AvalancheMedia/ModularFeature
Inheritance Hierarchy
- IModularFeature
- IAvaMediaSyncProvider
References
| Module | AvalancheMedia |
| Header | /Engine/Plugins/Experimental/Avalanche/Source/AvalancheMedia/Public/ModularFeature/IAvaMediaSyncProvider.h |
| Include | #include "ModularFeature/IAvaMediaSyncProvider.h" |
Syntax
class IAvaMediaSyncProvider : public IModularFeature
Remarks
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)
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | CompareWithRemote
(
const FString& InRemoteName, |
Issue a "compare" request to a given remote, and calls back the completion delegate with status payload. | |
| IAvaMediaSyncProvider * | Get () |
Returns the first registered implementation based on GetModularFeatureName(), if there is one available | |
| FName | |||
| FName | GetName () |
Returns underlying feature implementation name | |
| FOnAvaMediaSyncPackageModified & | Delegate called when a package is modified by a sync write operation, either being added or modified. | ||
| void | PullFromRemote
(
const FString& InRemoteName, |
Sends a "pull" request to a specific remote (either a playback server or client name) | |
| void | PushToRemote
(
const FString& InRemoteName, |
Sends a "push" request to a specific remote (either a playback server or client name) | |
| void | Broadcasts a "sync" request to all connected remotes on the local network. |