Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > ICompressedAudioInfo

Light Theme

Dark Theme

ICompressedAudioInfo

Interface class to decompress various types of audio data

Windows

MacOS

Linux

Inheritance Hierarchy

ICompressedAudioInfo

FADPCMAudioInfo

IStreamedCompressedInfo

FOpusAudioInfo

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/AudioDecompress.h
Include	#include "AudioDecompress.h"

Syntax

class ICompressedAudioInfo

Remarks

Interface class to decompress various types of audio data

Variables

		Name	Description
	USoundWave *...	StreamingSoundWave

Constructors

	Name	Description
	ICompressedAudioInfo()

Destructors

	Name	Description
	~ICompressedAudioInfo()	Virtual destructor.

Functions

	Name	Description
void	EnableHalfRate ( bool HalfRate )	Sets decode to half-rate
void	ExpandFile ( uint8* DstBuffer, FSoundQualityInfo* QualityInfo )	Decompress an entire data file to a TArray
int32	GetCurrentChunkIndex()	Gets the chunk index that was last read from (for Streaming Manager requests)
int32	GetCurrentChunkOffset()	Gets the offset into the chunk that was last read to (for Streaming Manager priority)
uint32	GetSourceBufferSize()	Gets the size of the source buffer originally passed to the info class (bytes)
int	GetStreamBufferSize()	Gets the preferred size for a streaming buffer for this decompression scheme
USoundWave &...	GetStreamingSoundWave()	Return the streaming sound wave used by this decoder.
bool	HasError()	Returns true if a non-recoverable error has occurred.
bool	ReadCompressedData ( uint8* Destination, bool bLooping, uint32 BufferSize )	Decompresses data to raw PCM data.
bool	ReadCompressedInfo ( const uint8* InSrcBufferData, uint32 InSrcBufferDataSize, FSoundQualityInfo* QualityInfo )	Reads the header information of a compressed format
bool	ReleaseStreamChunk ( bool bBlockUntilReleased )	This can be called to explicitly release this decoder's reference to a chunk of compressed audio without destroying the decoder itself.
void	SeekToTime ( const float SeekTime )	Seeks to time (Some formats might not be seekable)
bool	StreamCompressedData ( uint8* Destination, bool bLooping, uint32 BufferSize )	Decompresses streamed data to raw PCM data.
bool	StreamCompressedInfo ( USoundWave* Wave, FSoundQualityInfo* QualityInfo )	Streams the header information of a compressed format
bool	StreamCompressedInfoInternal ( USoundWave* Wave, FSoundQualityInfo* QualityInfo )	Internal override implemented by subclasses.
bool	SupportsStreaming()	Following functions are optional if streaming is supported //.
bool	UsesVorbisChannelOrdering()	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

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss