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