1. Epic GamesDeveloper
  3. IStreamedCompressedInfo

IStreamedCompressedInfo

Default implementation of a streamed compressed audio format.

API > API/Runtime > API/Runtime/Engine

Default implementation of a streamed compressed audio format. Can be subclassed to support streaming of a specific asset format. Handles all the platform independent aspects of file format streaming for you (dealing with UE streamed assets)

   
Name IStreamedCompressedInfo
Type class
Header File /Engine/Source/Runtime/Engine/Public/AudioDecompress.h
Include Path #include "AudioDecompress.h"

Syntax

class IStreamedCompressedInfo : public ICompressedAudioInfo

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

IStreamedCompressedInfo()

   AudioDecompress.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IStreamedCompressedInfo()

   AudioDecompress.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CreateDecoder()

 Create the compression format dependent decoder object. AudioDecompress.h  

FDecodeResult Decode ( const uint8* CompressedData,
const int32 CompressedDataSize,
uint8* OutPCMData,
const int32 OutputPCMDataSize
)

 Decode the input compressed frame data into output PCMData buffer. AudioDecompress.h  

int32 GetFrameSize()

 Return the size of the current compression frame AudioDecompress.h  

uint32 GetMaxFrameSizeSamples()

 The size of the decode PCM buffer size. AudioDecompress.h  

int32 GetStreamSeekBlockIndex()

   AudioDecompress.h  

int32 GetStreamSeekBlockOffset()

   AudioDecompress.h  

bool ParseHeader ( const uint8* InSrcBufferData,
uint32 InSrcBufferDataSize,
FSoundQualityInfo* QualityInfo
)

 Parse the header information from the input source buffer data. AudioDecompress.h  

virtual void PrepareToLoop()

 Optional method to allow decoder to prepare to loop. AudioDecompress.h  

Overridden from ICompressedAudioInfo

Name Remarks Include Path Unreal Specifiers

virtual void EnableHalfRate ( bool HalfRate
)

 Sets decode to half-rate AudioDecompress.h  

virtual void ExpandFile ( uint8* DstBuffer,
FSoundQualityInfo* QualityInfo
)

 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  

virtual uint32 GetSourceBufferSize()

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

virtual int GetStreamBufferSize()

 Gets the preferred size for a streaming buffer for this decompression scheme AudioDecompress.h  

virtual bool IsStreamedCompressedInfo ()

 Returns whether this instance can be cast to a IStreamedCompressedInfo. AudioDecompress.h  

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

 Decompresses data to raw PCM data. AudioDecompress.h  

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

 Reads the header information of a compressed format AudioDecompress.h  

virtual void SeekToFrame ( const uint32 Frame
)

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

virtual void SeekToTime ( const float SeekTime
)

 Seeks to time (Some formats might not be seekable) AudioDecompress.h  

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

 Decompresses streamed data to raw PCM data. AudioDecompress.h  

virtual bool StreamCompressedInfoInternal ( const FSoundWaveProxyPtr& InWaveProxy,
FSoundQualityInfo* QualityInfo
)

 Internal override implemented by subclasses. AudioDecompress.h  

virtual bool SupportsStreaming ()

 Following functions are optional if streaming is supported //. AudioDecompress.h  

virtual 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

int32 DecompressToPCMBuffer ( uint16 FrameSize
)

 Decompresses a frame of data to PCM buffer AudioDecompress.h  
Gets the current chunks seektable instance (or creates one) AudioDecompress.h  
  AudioDecompress.h  

const uint8 * GetLoadedChunk ( const FSoundWaveProxyPtr& InSoundWave,
uint32 ChunkIndex,
uint32& OutChunkSize
)

 Helper function for getting a chunk of compressed audio. AudioDecompress.h  

uint32 IncrementCurrentSampleCount ( uint32 NewSamples
)

 Adds to the count of samples that have currently been decoded AudioDecompress.h  

uint32 Read ( void* Outbuffer,
uint32 DataSize
)

 Reads from the internal source audio buffer stream of the given data size. AudioDecompress.h  

void RetainNextChunkInSequence ( const FSoundWaveProxyPtr& InSoundWave,
const uint32 InChunkIndex
)

   AudioDecompress.h  

uint32 WriteFromDecodedPCM ( uint8* Destination,
uint32 BufferSize
)

 Writes data from decoded PCM buffer, taking into account whether some PCM has been written before AudioDecompress.h  

uint32 ZeroBuffer ( uint8* Destination,
uint32 BufferSize
)

 Zeroes the contents of a buffer AudioDecompress.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page