Navigation
API > API/Plugins > API/Plugins/AVCodecsCore
Primary AV result type. Contains a result code, an optional message, and optional specific data about the platform vendor where the error occured. Automatically logs on warning and lower if not handled.
| Name | FAVResult |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/AVCodecs/AVCodecsCore/Source/AVCodecsCore/Public/AVResult.h |
| Include Path | #include "AVResult.h" |
Syntax
struct FAVResult
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| AVResult.h | |||
| AVResult.h | |||
FAVResult () |
AVResult.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FAVResult() |
AVResult.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| EMPTY_VENDOR_VALUE | int32 constexpr | AVResult.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHandled | uint8 | Bitflag for whether this result has been handled (or whether is still must be logged). | AVResult.h | |
| Message | FString | Optional message alongside AV result code. | AVResult.h | |
| Value | EAVResult | AV result code. | AVResult.h | |
| Vendor | FString | Optional vendor where this error occured. | AVResult.h | |
| VendorValue | int32 | Optional result code supplied by the vendor. | AVResult.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAVResult & Handle() |
Flag this result as handled, so that it won't be logged. | AVResult.h | |
bool IsError() |
AVResult.h | ||
bool IsFatal() |
AVResult.h | ||
bool IsNotError() |
AVResult.h | ||
bool IsNotFatal() |
AVResult.h | ||
bool IsNotPending() |
AVResult.h | ||
bool IsNotSuccess() |
AVResult.h | ||
bool IsNotWarning() |
AVResult.h | ||
bool IsPending() |
AVResult.h | ||
bool IsSuccess() |
AVResult.h | ||
bool IsWarning() |
AVResult.h | ||
void Log () |
Logs this result to the internal AVCodecCore log category. | AVResult.h | |
FString ToString() |
Convert this error into a readable string. | AVResult.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Statically log a result without constructing and returning it. | AVResult.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
operator bool() |
AVResult.h | ||
bool operator!=
(
EAVResult OtherValue |
AVResult.h | ||
| AVResult.h | |||
bool operator==
(
EAVResult OtherValue |
AVResult.h |