FOggVorbisEncoder

Windows
MacOS
Linux

Inheritance Hierarchy

IAudioEncoder

FOggVorbisEncoder

References

Module

SignalProcessing

Header

/Engine/Source/Runtime/SignalProcessing/Public/DSP/Encoders/OggVorbisEncoder.h

Include

#include "DSP/Encoders/OggVorbisEncoder.h"

Syntax

class FOggVorbisEncoder : public Audio::IAudioEncoder

Constructors

Name Description

Public function

FOggVorbisEncoder

(
    const FSoundQualityInfo& InInfo,
    int32 AverageBufferCallbackSize
)

Overridden from IAudioEncoder

Name Description

Protected function Virtual

bool

 

EncodeChunk

(
    const TArray< float >& InAudio,
    TArray< uint8 >& OutBytes
)

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

Protected function Virtual

bool

 

EndFile

(
    TArray< uint8 >& OutBytes
)

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

Public function Virtual Const

int32

 

GetCompressedPacketSize()

From IAudioEncoder: returns 0, since Ogg Vorbis is not built for networked streaming.

Protected function Virtual Const

int64

 

SamplesRequiredPerEncode()

From IAudioEncoder:

Protected function Virtual

bool

 

StartFile

(
    const FSoundQualityInfo& InQuality...,
    TArray< uint8 >& OutFileStart
)

This should be overridden to, give the properties in InQualityInfo, write a header into OutFileStart.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss