Navigation
API > API/Plugins > API/Plugins/ElectraDecoders
| Name | IElectraDecoder |
| Type | class |
| Header File | /Engine/Plugins/Media/ElectraCodecs/Source/ElectraDecoders/Public/IElectraDecoder.h |
| Include Path | #include "IElectraDecoder.h" |
Syntax
class IElectraDecoder : public TSharedFromThis< IElectraDecoder, ESPMode::ThreadSafe >
Inheritance Hierarchy
- TSharedFromThis< IElectraDecoder, ESPMode::ThreadSafe > → IElectraDecoder
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IElectraDecoder() |
IElectraDecoder.h |
Structs
| Name | Remarks |
|---|---|
| FError |
Enums
Public
| Name | Remarks |
|---|---|
| ECSDCompatibility | |
| EDecoderError | |
| EOutputStatus | |
| EType |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FInputAccessUnit | FElectraDecoderInputAccessUnit | IElectraDecoder.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Close () |
Closes the decoder instance. | IElectraDecoder.h | |
TSharedPtr< IElectraDecoderBitstreamProcessor, ESPMode::ThreadSafe > CreateBitstreamProcessor() |
Creates a processor to pre-parse the decoder input bitstream. | IElectraDecoder.h | |
EDecoderError DecodeAccessUnit
(
const FInputAccessUnit& InInputAccessUnit, |
Decodes one access unit. | IElectraDecoder.h | |
| Flushes the decoder to discard any pending input. | IElectraDecoder.h | ||
FError GetError() |
Returns the most recent error that you should retrieve when either method returns failure. | IElectraDecoder.h | |
void GetFeatures
(
TMap< FString, FVariant >& OutFeatures |
Populates the provided map with decoder features or required options. | IElectraDecoder.h | |
TSharedPtr< IElectraDecoderOutput, ESPMode::ThreadSafe > GetOutput () |
Returns the next pending output. | IElectraDecoder.h | |
| Returns the type of this decoder instance. | IElectraDecoder.h | ||
| Checks for available decoded output. | IElectraDecoder.h | ||
ECSDCompatibility IsCompatibleWith
(
const TMap< FString, FVariant >& CSDAndAdditionalOptions |
When a change in decoder specific data is detected, call this method to determine if the decoder can just continue decoding with the new CSD or if it needs to be drained or drained first and then reset. | IElectraDecoder.h | |
bool ResetToCleanStart () |
Tries to reset the decoder to a clean start state. | IElectraDecoder.h | |
void Resume() |
IElectraDecoder.h | ||
| Sends an end-of-data notification to have the decoder process all pending input and generate as much output as possible. | IElectraDecoder.h | ||
void Suspend() |
IElectraDecoder.h |