UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Member Functions | List of all members
FOpusEncoder Class Reference

#include <OpusEncoder.h>

+ Inheritance diagram for FOpusEncoder:

Public Member Functions

 FOpusEncoder (const FSoundQualityInfo &InInfo, int32 AverageBufferCallbackSize, EOpusFrameSizes InFrameSize=EOpusFrameSizes::MediumLow, EOpusMode InMode=EOpusMode::File)
 
 ~FOpusEncoder ()
 
virtual int32 GetCompressedPacketSize () const override
 
- Public Member Functions inherited from Audio::IAudioEncoder
SIGNALPROCESSING_API IAudioEncoder (uint32 AudioBufferSlack, uint32 DataBufferSlack=4096)
 
virtual SIGNALPROCESSING_API ~IAudioEncoder ()
 
SIGNALPROCESSING_API bool PushAudio (const float *InBuffer, int32 NumSamples, bool bEncodeIfPossible=true)
 
SIGNALPROCESSING_API int32 PopData (uint8 *OutData, int32 DataSize)
 
SIGNALPROCESSING_API bool EncodeIfPossible ()
 
SIGNALPROCESSING_API int64 Finalize ()
 

Protected Member Functions

virtual int64 SamplesRequiredPerEncode () const override
 
virtual bool StartFile (const FSoundQualityInfo &InQualityInfo, TArray< uint8 > &OutFileStart) override
 
virtual bool EncodeChunk (const TArray< float > &InAudio, TArray< uint8 > &OutBytes) override
 
virtual bool EndFile (TArray< uint8 > &OutBytes) override
 
- Protected Member Functions inherited from Audio::IAudioEncoder
SIGNALPROCESSING_API void Init (const FSoundQualityInfo &InQualityInfo)
 

Constructor & Destructor Documentation

◆ FOpusEncoder()

FOpusEncoder::FOpusEncoder ( const FSoundQualityInfo &  InInfo,
int32  AverageBufferCallbackSize,
EOpusFrameSizes  InFrameSize = EOpusFrameSizes::MediumLow,
EOpusMode  InMode = EOpusMode::File 
)

◆ ~FOpusEncoder()

FOpusEncoder::~FOpusEncoder ( )

Member Function Documentation

◆ EncodeChunk()

virtual bool FOpusEncoder::EncodeChunk ( const TArray< float > &  InAudio,
TArray< uint8 > &  OutBytes 
)
overrideprotectedvirtual

Override this to compress InAudio to OutBytes. Returns true on success, false on failure.

Implements Audio::IAudioEncoder.

◆ EndFile()

virtual bool FOpusEncoder::EndFile ( TArray< uint8 > &  OutBytes)
overrideprotectedvirtual

Override this to compress InAudio to OutBytes. Returns true on success, false on failure.

Implements Audio::IAudioEncoder.

◆ GetCompressedPacketSize()

virtual int32 FOpusEncoder::GetCompressedPacketSize ( ) const
overridevirtual

Used for internet streaming. Should return the amount of bytes required for a self contained packet.

Implements Audio::IAudioEncoder.

◆ SamplesRequiredPerEncode()

virtual int64 FOpusEncoder::SamplesRequiredPerEncode ( ) const
overrideprotectedvirtual

How many samples of decoded audio that are required for a single compression operation.

Implements Audio::IAudioEncoder.

◆ StartFile()

virtual bool FOpusEncoder::StartFile ( const FSoundQualityInfo &  InQualityInfo,
TArray< uint8 > &  OutFileStart 
)
overrideprotectedvirtual

This should be overridden to, give the properties in InQualityInfo, write a header into OutFileStart. returns true on success, or false on failure.

Implements Audio::IAudioEncoder.

The documentation for this class was generated from the following file: