1. Epic GamesDeveloper
  3. ICompressedAudioInfo

ICompressedAudioInfo

Interface class to decompress various types of audio data

Unreal Engine C++ API Reference > Runtime > Engine

Inheritance Hierarchy

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

  Type Name Description
Protected variable FSoundWaveProxyPtr StreamingSoundWave  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual   Virtual destructor.

Functions

  Type Name Description
Public function void

EnableHalfRate ( bool HalfRate
)

 Sets decode to half-rate
Public function void

ExpandFile ( uint8* DstBuffer,
FSoundQualityInfo* QualityInfo
)

 Decompress an entire data file to a TArray
Public function Virtual Const int32 Gets the chunk index that was last read from (for Streaming Manager requests)
Public function Virtual Const int32 Gets the offset into the chunk that was last read to (for Streaming Manager priority)
Public function Const uint32 Gets the size of the source buffer originally passed to the info class (bytes)
Public function Const int Gets the preferred size for a streaming buffer for this decompression scheme
Public function Virtual const FSoundWaveProxyPtr & Return the streaming sound wave used by this decoder.
Public function Virtual Const bool Returns true if a non-recoverable error has occurred.
Public function Virtual Const bool Returns whether this instance can be cast to a IStreamedCompressedInfo.
Public function bool

ReadCompressedData ( uint8* Destination,
bool bLooping,
uint32 BufferSize
)

 Decompresses data to raw PCM data.
Public function bool

ReadCompressedInfo ( const uint8* InSrcBufferData,
uint32 InSrcBufferDataSize,
FSoundQualityInfo* QualityInfo
)

 Reads the header information of a compressed format
Public function 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.
Public function void

SeekToTime ( const float SeekTime
)

 Seeks to time (Some formats might not be seekable)
Public function Virtual bool

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

 Decompresses streamed data to raw PCM data.
Public function bool Streams the header information of a compressed format
Public function bool

StreamCompressedInfo ( const FSoundWaveProxyPtr& Wave,
FSoundQualityInfo* QualityInfo
)

 Streams the header information of a compressed format
Protected function bool

StreamCompressedInfoInternal ( const FSoundWaveProxyPtr& InWaveProxy,
FSoundQualityInfo* QualityInfo
)

 Internal override implemented by subclasses.
Public function Virtual Const bool Following functions are optional if streaming is supported //.
Public function Const bool 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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page