Navigation
API > API/Plugins > API/Plugins/AvalancheMedia
Base sync response with Status and Error information
| Name | FAvaMediaSyncResponse |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheMedia/Public/ModularFeature/AvaMediaSyncProviderFeatureTypes.h |
| Include Path | #include "ModularFeature/AvaMediaSyncProviderFeatureTypes.h" |
Syntax
USTRUCT ()
struct FAvaMediaSyncResponse
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAvaMediaSyncResponse() |
Default constructor | ModularFeature/AvaMediaSyncProviderFeatureTypes.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ConnectionInfo | FAvaMediaSyncConnectionInfo | Holds data about local project and send to remote for it to display as result status | ModularFeature/AvaMediaSyncProviderFeatureTypes.h | |
| ErrorText | FText | In case of error, a localized text describing what went wrong | ModularFeature/AvaMediaSyncProviderFeatureTypes.h | |
| Status | EAvaMediaSyncResponseResult | Status of the response, error or success | ModularFeature/AvaMediaSyncProviderFeatureTypes.h | |
| StatusText | FText | In case of success, an optional localized text describing status of the operation | ModularFeature/AvaMediaSyncProviderFeatureTypes.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool HasError() |
Returns whether Status is in Error State and ErrorText is filled with error information | ModularFeature/AvaMediaSyncProviderFeatureTypes.h | |
bool IsValid() |
Returns whether Status is in Success state | ModularFeature/AvaMediaSyncProviderFeatureTypes.h | |
FString ToString() |
Returns string representation | ModularFeature/AvaMediaSyncProviderFeatureTypes.h |