FADPCMAudioInfo

Windows
MacOS
Linux

Inheritance Hierarchy

ICompressedAudioInfo

FADPCMAudioInfo

Syntax

class FADPCMAudioInfo : public ICompressedAudioInfo

Variables

Name Description

Public variable

uint32

 

BlockSize

Public variable

uint32

 

CompressedBlockSize

Public variable

const uint8 ...

 

CurCompressedChunkData

Public variable

uint32

 

CurrentChunkBufferOffset

Public variable

uint32

 

CurrentChunkDataSize

Public variable

uint32

 

CurrentChunkIndex

Public variable

uint32

 

CurrentCompressedBlockIndex

Public variable

uint32

 

CurrentUncompressedBlockSampleIndex

Public variable

uint32

 

FirstChunkSampleDataOffset

Public variable

int32

 

Format

Public variable

int32

 

NumChannels

Public variable

uint32

 

SamplesPerBlock

Public variable

const uint8 ...

 

SrcBufferData

Public variable

uint32

 

SrcBufferDataSize

Public variable

int32

 

StreamBufferSize

Public variable

USoundWave *...

 

StreamingSoundWave

Public variable

uint32

 

TotalCompressedBlocksPerChannel

Public variable

uint32

 

TotalDecodedSize

Public variable

uint32

 

TotalSamplesPerChannel

Public variable

uint32

 

TotalSamplesStreamed

Public variable

uint8 *

 

UncompressedBlockData

Public variable

uint32

 

UncompressedBlockSize

Public variable

FWaveModInfo

 

WaveInfo

Constructors

Name Description

Public function

FADPCMAudioInfo()

Destructors

Name Description

Public function Virtual

~FADPCMAudioInfo()

Overridden from ICompressedAudioInfo

Name Description

Public function Virtual

void

 

EnableHalfRate

(
    bool HalfRate
)

Sets decode to half-rate

Public function Virtual

void

 

ExpandFile

(
    uint8* DstBuffer,
    FSoundQualityInfo* QualityInfo
)

Decompress an entire data file to a TArray

Public function Virtual Const

int32

 

GetCurrentChunkIndex()

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

Public function Virtual Const

int32

 

GetCurrentChunkOffset()

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

Public function Virtual Const

uint32

 

GetSourceBufferSize()

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

Public function Virtual Const

int

 

GetStreamBufferSize()

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

Public function Virtual

bool

 

ReadCompressedData

(
    uint8* Destination,
    bool bLooping,
    uint32 BufferSize
)

Decompresses data to raw PCM data.

Public function Virtual

bool

 

ReadCompressedInfo

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

Reads the header information of a compressed format

Public function Virtual

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
)

Decompresses streamed data to raw PCM data.

Public function Virtual

bool

 

StreamCompressedInfo

(
    USoundWave* Wave,
    FSoundQualityInfo* QualityInfo
)

Streams the header information of a compressed format

Public function Virtual Const

bool

 

SupportsStreaming()

Additional overrides for streaming.

Public function Virtual Const

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

References

Module

Engine

Header

Runtime/Engine/Public/ADPCMAudioInfo.h

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback