Navigation
API > API/Runtime > API/Runtime/SignalProcessing > API/Runtime/SignalProcessing/DSP > API/Runtime/SignalProcessing/DSP/Encoders
Inheritance Hierarchy
- IAudioEncoder
- FOggVorbisEncoder
- FOpusEncoder
- FWavEncoder
References
| Module | SignalProcessing |
| Header | /Engine/Source/Runtime/SignalProcessing/Public/DSP/Encoders/IAudioEncoder.h |
| Include | #include "DSP/Encoders/IAudioEncoder.h" |
Syntax
class IAudioEncoder
Remarks
IAudioEncoder Interface used to implement a runtime audio encoder.
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
IAudioEncoder
(
uint32 AudioBufferSlack, |
Must be constructed with AudioBufferSlack. |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
bool | EncodeChunk
(
const TArray< float >& InAudio, |
Override this to compress InAudio to OutBytes. Returns true on success, false on failure. |
 |
bool | If you'd like to run audio encoding on a separate thread, use this call. | |
 |
bool | EndFile
(
TArray< uint8 >& OutBytes |
Override this to compress InAudio to OutBytes. Returns true on success, false on failure. |
 |
int64 | Finalize () |
Call this once you are finished pushing audio. |
  |
int32 | Used for internet streaming. | |
 |
void | Init
(
const FSoundQualityInfo& InQualityInfo |
Should be called in the constructor of any implementation of IAudioEncoder. |
 |
int32 | PopData
(
uint8* OutData, |
Pop compressed data. |
 |
bool | PushAudio
(
const float* InBuffer, |
Call this function when audio is available. |
  |
int64 | How many samples of decoded audio that are required for a single compression operation. | |
 |
bool | StartFile
(
const FSoundQualityInfo& InQualityInfo, |
This should be overridden to, give the properties in InQualityInfo, write a header into OutFileStart. |