Navigation
API > API/Runtime > API/Runtime/Engine
Interface class to decompress various types of audio data
| Name | ICompressedAudioInfo |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/AudioDecompress.h |
| Include Path | #include "AudioDecompress.h" |
Syntax
class ICompressedAudioInfo
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ICompressedAudioInfo() |
AudioDecompress.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ICompressedAudioInfo() |
Virtual destructor. | AudioDecompress.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void EnableHalfRate
(
bool HalfRate |
Sets decode to half-rate | AudioDecompress.h | |
void ExpandFile
(
uint8* DstBuffer, |
Decompress an entire data file to a TArray | AudioDecompress.h | |
virtual int32 GetCurrentChunkIndex() |
Gets the chunk index that was last read from (for Streaming Manager requests) | AudioDecompress.h | |
virtual int32 GetCurrentChunkOffset() |
Gets the offset into the chunk that was last read to (for Streaming Manager priority) | AudioDecompress.h | |
uint32 GetSourceBufferSize() |
Gets the size of the source buffer originally passed to the info class (bytes) | AudioDecompress.h | |
int GetStreamBufferSize() |
Gets the preferred size for a streaming buffer for this decompression scheme | AudioDecompress.h | |
virtual const FSoundWaveProxyPtr & GetStreamingSoundWave () |
Return the streaming sound wave used by this decoder. | AudioDecompress.h | |
virtual bool HasError() |
Returns true if a non-recoverable error has occurred. | AudioDecompress.h | |
virtual bool IsStreamedCompressedInfo () |
Returns whether this instance can be cast to a IStreamedCompressedInfo. | AudioDecompress.h | |
bool ReadCompressedData
(
uint8* Destination, |
Decompresses data to raw PCM data. | AudioDecompress.h | |
bool ReadCompressedInfo
(
const uint8* InSrcBufferData, |
Reads the header information of a compressed format | AudioDecompress.h | |
virtual 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. | AudioDecompress.h | |
void SeekToFrame
(
const uint32 Frame |
Seeks to specific frame in the audio (Some formats might not be seekable) | AudioDecompress.h | |
void SeekToTime
(
const float SeekTime |
Seeks to time (Some formats might not be seekable) | AudioDecompress.h | |
virtual bool StreamCompressedData
(
uint8* Destination, |
Decompresses streamed data to raw PCM data. | AudioDecompress.h | |
bool StreamCompressedInfo
(
USoundWave* Wave, |
Streams the header information of a compressed format | AudioDecompress.h | |
bool StreamCompressedInfo
(
const FSoundWaveProxyPtr& Wave, |
AudioDecompress.h | ||
virtual bool SupportsStreaming () |
Following functions are optional if streaming is supported //. | AudioDecompress.h | |
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 | AudioDecompress.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool StreamCompressedInfoInternal
(
const FSoundWaveProxyPtr& InWaveProxy, |
Internal override implemented by subclasses. | AudioDecompress.h | |
bool WantsFilteredLogging() |
AudioDecompress.h |