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

#include <ADPCMAudioInfo.h>

+ Inheritance diagram for FADPCMAudioInfo:

Public Member Functions

ADPCMAUDIODECODER_API FADPCMAudioInfo (void)
 
virtual ADPCMAUDIODECODER_API ~FADPCMAudioInfo (void)
 
virtual ADPCMAUDIODECODER_API bool ReadCompressedInfo (const uint8 *InSrcBufferData, uint32 InSrcBufferDataSize, struct FSoundQualityInfo *QualityInfo)
 
virtual ADPCMAUDIODECODER_API bool ReadCompressedData (uint8 *Destination, bool bLooping, uint32 BufferSize)
 
virtual ADPCMAUDIODECODER_API void SeekToTime (const float SeekTime)
 
virtual ADPCMAUDIODECODER_API void SeekToFrame (const uint32 SeekFrame)
 
virtual ADPCMAUDIODECODER_API void ExpandFile (uint8 *DstBuffer, struct FSoundQualityInfo *QualityInfo)
 
virtual void EnableHalfRate (bool HalfRate)
 
virtual uint32 GetSourceBufferSize () const
 
virtual bool UsesVorbisChannelOrdering () const
 
virtual int GetStreamBufferSize () const
 
virtual bool SupportsStreaming () const override
 
virtual bool StreamCompressedInfoInternal (const FSoundWaveProxyPtr &InWaveProxy, struct FSoundQualityInfo *QualityInfo) override
 
virtual bool StreamCompressedData (uint8 *Destination, bool bLooping, uint32 BufferSize, int32 &OutNumBytesStreamed) override
 
virtual int32 GetCurrentChunkIndex () const override
 
virtual int32 GetCurrentChunkOffset () const override
 
virtual bool ReleaseStreamChunk (bool bBlockUntilReleased) override
 
uint16 GetFormatTag ()
 
int32 GetNumChannels ()
 
- Public Member Functions inherited from ICompressedAudioInfo
ENGINE_API ICompressedAudioInfo ()
 
virtual ENGINE_API ~ICompressedAudioInfo ()
 
virtual bool IsStreamedCompressedInfo () const
 
ENGINE_API bool StreamCompressedInfo (USoundWave *Wave, struct FSoundQualityInfo *QualityInfo)
 
ENGINE_API bool StreamCompressedInfo (const FSoundWaveProxyPtr &Wave, struct FSoundQualityInfo *QualityInfo)
 
virtual ENGINE_API bool HasError () const
 
virtual const FSoundWaveProxyPtr & GetStreamingSoundWave () const
 

Additional Inherited Members

- Protected Member Functions inherited from ICompressedAudioInfo
bool WantsFilteredLogging () const
 
- Protected Attributes inherited from ICompressedAudioInfo
bool bHasError = false
 
bool bWantsFilteredLogging = false
 
FSoundWaveProxyPtr StreamingSoundWave
 

Constructor & Destructor Documentation

◆ FADPCMAudioInfo()

FADPCMAudioInfo::FADPCMAudioInfo ( void  )

◆ ~FADPCMAudioInfo()

FADPCMAudioInfo::~FADPCMAudioInfo ( void  )
virtual

Member Function Documentation

◆ EnableHalfRate()

virtual void FADPCMAudioInfo::EnableHalfRate ( bool  HalfRate)
inlinevirtual

Sets decode to half-rate

Parameters
HalfRateWhether Half rate is enabled

Implements ICompressedAudioInfo.

◆ ExpandFile()

void FADPCMAudioInfo::ExpandFile ( uint8 *  DstBuffer,
struct FSoundQualityInfo *  QualityInfo 
)
virtual

Decompress an entire data file to a TArray

Implements ICompressedAudioInfo.

◆ GetCurrentChunkIndex()

virtual int32 FADPCMAudioInfo::GetCurrentChunkIndex ( ) const
inlineoverridevirtual

Gets the chunk index that was last read from (for Streaming Manager requests)

Reimplemented from ICompressedAudioInfo.

◆ GetCurrentChunkOffset()

virtual int32 FADPCMAudioInfo::GetCurrentChunkOffset ( ) const
inlineoverridevirtual

Gets the offset into the chunk that was last read to (for Streaming Manager priority)

Reimplemented from ICompressedAudioInfo.

◆ GetFormatTag()

uint16 FADPCMAudioInfo::GetFormatTag ( )
inline

◆ GetNumChannels()

int32 FADPCMAudioInfo::GetNumChannels ( )
inline

◆ GetSourceBufferSize()

virtual uint32 FADPCMAudioInfo::GetSourceBufferSize ( ) const
inlinevirtual

Gets the size of the source buffer originally passed to the info class (bytes)

Implements ICompressedAudioInfo.

◆ GetStreamBufferSize()

int FADPCMAudioInfo::GetStreamBufferSize ( ) const
virtual

Gets the preferred size for a streaming buffer for this decompression scheme

Implements ICompressedAudioInfo.

◆ ReadCompressedData()

bool FADPCMAudioInfo::ReadCompressedData ( uint8 *  Destination,
bool  bLooping,
uint32  BufferSize 
)
virtual

Decompresses data to raw PCM data.

Parameters
Destinationwhere to place the decompressed sound
bLoopingwhether to loop the sound by seeking to the start, or pad the buffer with zeroes
BufferSizenumber of bytes of PCM data to create
Returns
bool true if the end of the data was reached (for both single shot and looping sounds)

Implements ICompressedAudioInfo.

◆ ReadCompressedInfo()

bool FADPCMAudioInfo::ReadCompressedInfo ( const uint8 *  InSrcBufferData,
uint32  InSrcBufferDataSize,
struct FSoundQualityInfo *  QualityInfo 
)
virtual

Reads the header information of a compressed format

Parameters
InSrcBufferDataSource compressed data
InSrcBufferDataSizeSize of compressed data
QualityInfoQuality Info (to be filled out). This can be null in the case of most implementations of FSoundBuffer::ReadCompressedInfo

Implements ICompressedAudioInfo.

◆ ReleaseStreamChunk()

bool FADPCMAudioInfo::ReleaseStreamChunk ( bool  bBlockUntilReleased)
overridevirtual

This can be called to explicitly release this decoder's reference to a chunk of compressed audio without destroying the decoder itself.

Parameters
bBlockUntilReleasedwhen set to true will cause this call to block if the decoder is currently using the chunk.
Returns
true if the chunk was released, false otherwise.

Reimplemented from ICompressedAudioInfo.

◆ SeekToFrame()

void FADPCMAudioInfo::SeekToFrame ( const uint32  Frame)
virtual

Seeks to specific frame in the audio (Some formats might not be seekable)

Implements ICompressedAudioInfo.

◆ SeekToTime()

void FADPCMAudioInfo::SeekToTime ( const float  SeekTime)
virtual

Seeks to time (Some formats might not be seekable)

Implements ICompressedAudioInfo.

◆ StreamCompressedData()

bool FADPCMAudioInfo::StreamCompressedData ( uint8 *  Destination,
bool  bLooping,
uint32  BufferSize,
int32 &  OutNumBytesStreamed 
)
overridevirtual

Decompresses streamed data to raw PCM data.

Parameters
Destinationwhere to place the decompressed sound
bLoopingwhether to loop the sound by seeking to the start, or pad the buffer with zeros
BufferSizenumber of bytes of PCM data to create
Returns
bool true if the end of the data was reached (for both single shot and looping sounds)

Reimplemented from ICompressedAudioInfo.

◆ StreamCompressedInfoInternal()

bool FADPCMAudioInfo::StreamCompressedInfoInternal ( const FSoundWaveProxyPtr &  InWaveProxy,
struct FSoundQualityInfo *  QualityInfo 
)
overridevirtual

Internal override implemented by subclasses.

Implements ICompressedAudioInfo.

◆ SupportsStreaming()

virtual bool FADPCMAudioInfo::SupportsStreaming ( ) const
inlineoverridevirtual

Whether this decompression class supports streaming decompression

Reimplemented from ICompressedAudioInfo.

◆ UsesVorbisChannelOrdering()

virtual bool FADPCMAudioInfo::UsesVorbisChannelOrdering ( ) const
inlinevirtual

Whether the decompressed audio will be arranged using Vorbis' channel ordering See http://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-800004.3.9 for details

Implements ICompressedAudioInfo.

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