Navigation
API > API/Runtime > API/Runtime/SignalProcessing
| Name | FOpusEncoder |
| Type | class |
| Header File | /Engine/Source/Runtime/SignalProcessing/Public/DSP/Encoders/OpusEncoder.h |
| Include Path | #include "DSP/Encoders/OpusEncoder.h" |
Syntax
class FOpusEncoder : public Audio::IAudioEncoder
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FOpusEncoder () |
DSP/Encoders/OpusEncoder.h | ||
FOpusEncoder
(
const FSoundQualityInfo& InInfo, |
DSP/Encoders/OpusEncoder.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FOpusEncoder() |
DSP/Encoders/OpusEncoder.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| GranulePos | uint32 | Used for .opus files only: | DSP/Encoders/OpusEncoder.h | |
| LastValidFrameSize | int32 | DSP/Encoders/OpusEncoder.h | ||
| NumChannels | int32 | DSP/Encoders/OpusEncoder.h | ||
| PacketIndex | uint32 | DSP/Encoders/OpusEncoder.h | ||
| PrivateOggEncapsulator | FOggEncapsulator * | Private state. Only used if we are generating a .opus file, which are ogg encapsulations of an opus stream. | DSP/Encoders/OpusEncoder.h | |
| PrivateOpusState | FOpusEncoderPrivateState * | Private state so that we don't have a public dependency on opus libraries. | DSP/Encoders/OpusEncoder.h | |
| SampleRate | int32 | DSP/Encoders/OpusEncoder.h | ||
| UncompressedFrameSize | int32 | DSP/Encoders/OpusEncoder.h |
Functions
Public
Overridden from IAudioEncoder
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual int32 GetCompressedPacketSize () |
Used for internet streaming. | DSP/Encoders/OpusEncoder.h |
Protected
Overridden from IAudioEncoder
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool EncodeChunk
(
const TArray< float >& InAudio, |
Override this to compress InAudio to OutBytes. Returns true on success, false on failure. | DSP/Encoders/OpusEncoder.h | |
virtual bool EndFile
(
TArray< uint8 >& OutBytes |
Override this to compress InAudio to OutBytes. Returns true on success, false on failure. | DSP/Encoders/OpusEncoder.h | |
virtual int64 SamplesRequiredPerEncode() |
How many samples of decoded audio that are required for a single compression operation. | DSP/Encoders/OpusEncoder.h | |
virtual bool StartFile
(
const FSoundQualityInfo& InQualityInfo, |
This should be overridden to, give the properties in InQualityInfo, write a header into OutFileStart. | DSP/Encoders/OpusEncoder.h |