FWaveModInfo Class Reference

#include <Audio.h>

Public Member Functions
	FWaveModInfo ()
ENGINE_API bool	ReadWaveInfo (const uint8 *WaveData, int32 WaveDataSize, FString *ErrorMessage=NULL, bool InHeaderDataOnly=false, void **OutFormatHeader=NULL)
ENGINE_API bool	ReadWaveHeader (const uint8 *RawWaveData, int32 Size, int32 Offset)
ENGINE_API void	ReportImportFailure () const
ENGINE_API uint32	GetNumSamples () const
ENGINE_API bool	IsFormatSupported () const
ENGINE_API bool	IsFormatUncompressed () const

Static Public Member Functions
static uint32	Pad16Bit (uint32 InDW)
static ENGINE_API const TArray< uint32 > &	GetRequiredWaveChunkIds ()
static ENGINE_API const TArray< uint32 > &	GetOptionalWaveChunkIds ()
static ENGINE_API const uint32	GetChunkId (const char ChunkID[4])

Public Attributes
const uint32 *	pSamplesPerSec
const uint32 *	pAvgBytesPerSec
const uint16 *	pBlockAlign
const uint16 *	pBitsPerSample
const uint16 *	pChannels
uint16 *	pFormatTag
const uint32 *	pWaveDataSize
const uint32 *	pMasterSize
const uint8 *	SampleDataStart
const uint8 *	SampleDataEnd
uint32	SampleDataSize
const uint8 *	WaveDataEnd
uint32	NewDataSize
TArray< FWaveCue >	WaveCues
TArray< FWaveSampleLoop >	WaveSampleLoops
TPimplPtr< FSoundWaveTimecodeInfo, EPimplPtrMode::DeepCopy >	TimecodeInfo

Static Public Attributes
static constexpr uint16	WAVE_INFO_FORMAT_PCM = 0x0001
static constexpr uint16	WAVE_INFO_FORMAT_ADPCM = 0x0002
static constexpr uint16	WAVE_INFO_FORMAT_IEEE_FLOAT = 0x0003
static constexpr uint16	WAVE_INFO_FORMAT_DVI_ADPCM = 0x0011
static constexpr uint16	WAVE_INFO_FORMAT_OODLE_WAVE = 0xFFFF

Constructor & Destructor Documentation

FWaveModInfo()

FWaveModInfo::FWaveModInfo ( )

inline

Member Function Documentation

GetChunkId()

const uint32 FWaveModInfo::GetChunkId ( const char  ChunkID[4] )

static

GetNumSamples()

uint32 FWaveModInfo::GetNumSamples

(

)

const

Return total number of samples

GetOptionalWaveChunkIds()

const TArray< uint32 > & FWaveModInfo::GetOptionalWaveChunkIds ( )

static

GetRequiredWaveChunkIds()

const TArray< uint32 > & FWaveModInfo::GetRequiredWaveChunkIds ( )

static

Wave Chunk Id utils

IsFormatSupported()

bool FWaveModInfo::IsFormatSupported

(

)

const

Return whether file format is supported for import

IsFormatUncompressed()

bool FWaveModInfo::IsFormatUncompressed

(

)

const

Return whether file format contains uncompressed PCM data

Pad16Bit()

static uint32 FWaveModInfo::Pad16Bit ( uint32  InDW )

inlinestatic

ReadWaveHeader()

bool FWaveModInfo::ReadWaveHeader	(	const uint8 *	RawWaveData,
		int32	Size,
		int32	Offset
	)

Read a wave file header from bulkdata

ReadWaveInfo()

bool FWaveModInfo::ReadWaveInfo	(	const uint8 *	WaveData,
		int32	WaveDataSize,
		FString *	ErrorMessage = NULL,
		bool	InHeaderDataOnly = false,
		void **	OutFormatHeader = NULL
	)

ReportImportFailure()

void FWaveModInfo::ReportImportFailure

(

)

const

Member Data Documentation

NewDataSize

uint32 FWaveModInfo::NewDataSize

pAvgBytesPerSec

const uint32* FWaveModInfo::pAvgBytesPerSec

pBitsPerSample

const uint16* FWaveModInfo::pBitsPerSample

pBlockAlign

const uint16* FWaveModInfo::pBlockAlign

pChannels

const uint16* FWaveModInfo::pChannels

pFormatTag

uint16* FWaveModInfo::pFormatTag

pMasterSize

const uint32* FWaveModInfo::pMasterSize

pSamplesPerSec

const uint32* FWaveModInfo::pSamplesPerSec

pWaveDataSize

const uint32* FWaveModInfo::pWaveDataSize

SampleDataEnd

const uint8* FWaveModInfo::SampleDataEnd

SampleDataSize

uint32 FWaveModInfo::SampleDataSize

SampleDataStart

const uint8* FWaveModInfo::SampleDataStart

TimecodeInfo

TPimplPtr<FSoundWaveTimecodeInfo, EPimplPtrMode::DeepCopy> FWaveModInfo::TimecodeInfo

WAVE_INFO_FORMAT_ADPCM

constexpr uint16 FWaveModInfo::WAVE_INFO_FORMAT_ADPCM = 0x0002

staticconstexpr

WAVE_INFO_FORMAT_DVI_ADPCM

constexpr uint16 FWaveModInfo::WAVE_INFO_FORMAT_DVI_ADPCM = 0x0011

staticconstexpr

WAVE_INFO_FORMAT_IEEE_FLOAT

constexpr uint16 FWaveModInfo::WAVE_INFO_FORMAT_IEEE_FLOAT = 0x0003

staticconstexpr

WAVE_INFO_FORMAT_OODLE_WAVE

constexpr uint16 FWaveModInfo::WAVE_INFO_FORMAT_OODLE_WAVE = 0xFFFF

staticconstexpr

WAVE_INFO_FORMAT_PCM

constexpr uint16 FWaveModInfo::WAVE_INFO_FORMAT_PCM = 0x0001

staticconstexpr

WaveCues

TArray<FWaveCue> FWaveModInfo::WaveCues

WaveDataEnd

const uint8* FWaveModInfo::WaveDataEnd

WaveSampleLoops

TArray<FWaveSampleLoop> FWaveModInfo::WaveSampleLoops

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Engine/Public/Audio.h
• Engine/Source/Runtime/Engine/Private/Audio.cpp