EAVResult

Navigation

API > API/Plugins > API/Plugins/AVCodecsCore

HOW TO USE

Simple multi-level result wrapper. Allows consumers to be as specific as they want (or can be), but forces them to always return something.

1) Lowest level is a result code:

return EAVResult::Success;

2) Middle level is a wrapped struct:

return FAVResult(EAVResult::ErrorInvalidState, TEXT("Decoder is not open")); return FAVResult(EAVResult::ErrorCreating, TEXT("Could not create encoder"), TEXT("NVENC"), NvencErrorCode);

3) Highest level allows optional simultaneous return of a value.

TAVResult ReceivePacket() { // Success return Packet;

// Fail return FAVResult(EAVResult::PendingInput, TEXT("Not enough data to construct a packet")); } Low level AV result. Use specific result codes where possible for better logging. Result codes are laid out in 'ranges', ie. ErrorCreating/ErrorResolving/ErrorUnlocking are all in the Error range.

MAINTAINER NOTE: When adding a new result value, add a matching case statement to ToString(EAVResult).

Syntax

enum EAVResult  
{  
    Unknown                = 0,  
    Fatal                  = 1000,  
    FatalUnsupported,  
    Error                  = 2000,  
    ErrorUnsupported,  
    ErrorInvalidState,  
    ErrorCreating,  
    ErrorDestroying,  
    ErrorResolving,  
    ErrorMapping,  
    ErrorUnmapping,  
    ErrorLocking,  
    ErrorUnlocking,  
    Warning                = 3000,  
    WarningInvalidState,  
    Pending                = 4000,  
    PendingInput,  
    PendingOutput,  
    Success                = 5000,  
}  
Copy full snippet

enum EAVResult {     Unknown                = 0,     Fatal                  = 1000,     FatalUnsupported,     Error                  = 2000,     ErrorUnsupported,     ErrorInvalidState,     ErrorCreating,     ErrorDestroying,     ErrorResolving,     ErrorMapping,     ErrorUnmapping,     ErrorLocking,     ErrorUnlocking,     Warning                = 3000,     WarningInvalidState,     Pending                = 4000,     PendingInput,     PendingOutput,     Success                = 5000, }

Values