Navigation
API > API/Plugins > API/Plugins/AVCodecsCore
Inheritance Hierarchy
- FAVResult
- TAVResult
References
| Module | AVCodecsCore |
| Header | /Engine/Plugins/Experimental/AVCodecs/AVCodecsCore/Source/AVCodecsCore/Public/AVResult.h |
| Include | #include "AVResult.h" |
Syntax
struct FAVResult
Remarks
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.
Variables
| Type | Name | Description | |
|---|---|---|---|
| uint8: 1 | bHandled | Bitflag for whether this result has been handled (or whether is still must be logged). | |
| FString | Message | Optional message alongside AV result code. | |
| EAVResult | Value | AV result code. | |
| FString | Vendor | Optional vendor where this error occured. | |
| int32 | VendorValue | Optional result code supplied by the vendor. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
FAVResult () |
|||
Destructors
| Type | Name | Description | |
|---|---|---|---|
~FAVResult () |
Functions
| Type | Name | Description | |
|---|---|---|---|
| FAVResult & | Handle () |
Flag this result as handled, so that it won't be logged. | |
| FORCEINLINEbool | IsError () |
||
| FORCEINLINEbool | IsFatal () |
||
| FORCEINLINEbool | IsNotError () |
||
| FORCEINLINEbool | IsNotFatal () |
||
| FORCEINLINEbool | IsNotPending () |
||
| FORCEINLINEbool | IsNotSuccess () |
||
| FORCEINLINEbool | IsNotWarning () |
||
| FORCEINLINEbool | IsPending () |
||
| FORCEINLINEbool | IsSuccess () |
||
| FORCEINLINEbool | IsWarning () |
||
| void | Log () |
Logs this result to the internal AVCodecCore log category. | |
| FORCEINLINEvoid | Statically log a result without constructing and returning it. | ||
| FString | ToString () |
Convert this error into a readable string. |
Operators
| Type | Name | Description | |
|---|---|---|---|
| FORCEINLINE | |||
| FORCEINLINEbool | operator!=
(
EAVResult OtherValue |
||
| FORCEINLINEFAVResult & | |||
| FORCEINLINEbool | operator==
(
EAVResult OtherValue |
Constants
| Name | Description |
|---|---|
| EMPTY_VENDOR_VALUE |