Navigation
API > API/Plugins > API/Plugins/ElectraBase
Abstract base class to pass into
| Name | IBaseDataReader |
| Type | class |
| Header File | /Engine/Plugins/Media/ElectraUtil/Source/ElectraBase/Public/Utilities/IElectraBaseDataReader.h |
| Include Path | #include "Utilities/IElectraBaseDataReader.h" |
Syntax
class IBaseDataReader
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IBaseDataReader() |
Utilities/IElectraBaseDataReader.h |
Enums
Public
| Name | Remarks |
|---|---|
| EResult |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FCancellationCheckDelegate | TBaseDelegate_NoParams< bool > | A delegate passed into the read methods through which the reader implementation can call into to see if the read request has been canceled. | Utilities/IElectraBaseDataReader.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int64 GetCurrentFileOffset () |
This method shall return the current file offset, which is initially zero unless the file has been opened such that the initial position for this reader is not zero. | Utilities/IElectraBaseDataReader.h | |
FString GetLastError() |
If a read error occurred and ReadData()_ returns EResult::ReadError_ a human-readable message of what caused the error should be returned. |
Utilities/IElectraBaseDataReader.h | |
int64 GetTotalFileSize () |
This method shall return the total size of the file. | Utilities/IElectraBaseDataReader.h | |
bool HasReachedEOF () |
A convenience method to return `true_ when all data has been read. | Utilities/IElectraBaseDataReader.h | |
int64 ReadData
(
void* InOutBuffer, |
This method reads data into the provided buffer from the specified absolute offset. | Utilities/IElectraBaseDataReader.h |