FSoundWaveData Class Reference

#include <SoundWave.h>

Public Member Functions
	UE_NONCOPYABLE (FSoundWaveData)
	FSoundWaveData ()
ENGINE_API	~FSoundWaveData ()
ENGINE_API void	InitializeDataFromSoundWave (USoundWave &InWave)
ENGINE_API void	OverrideRuntimeFormat (const FName &InRuntimeFormat)
const FGuid &	GetGUID () const
const FName &	GetFName () const
const FName &	GetPackageName () const
const FName &	GetRuntimeFormat () const
const FObjectKey &	GetFObjectKey () const
float	GetSampleRate () const
uint32	GetNumChannels () const
const TArray< FSoundWaveCuePoint > &	GetCuePoints () const
const TArray< FSoundWaveCuePoint > &	GetLoopRegions () const
void	SetAllCuePoints (const TArray< FSoundWaveCuePoint > &InCuePoints)
ENGINE_API uint32	GetNumChunks () const
ENGINE_API uint32	GetSizeOfChunk (uint32 ChunkIndex) const
int32	GetNumFrames () const
float	GetDuration () const
ENGINE_API void	ReleaseCompressedAudio ()
ENGINE_API void	SetError (const TCHAR *InErrorMsg=nullptr)
ENGINE_API bool	HasError () const
ENGINE_API bool	ResetError ()
bool	IsStreaming () const
ESoundAssetCompressionType	GetSoundCompressionType () const
bool	IsLooping () const
bool	ShouldUseStreamCaching () const
bool	IsSeekable () const
bool	IsRetainingAudio () const
bool	WasLoadingBehaviorOverridden () const
ESoundWaveLoadingBehavior	GetLoadingBehavior () const
bool	IsTemplate () const
ENGINE_API bool	HasCompressedData (FName Format, ITargetPlatform *TargetPlatform=USoundWave::GetRunningPlatform()) const
ENGINE_API FByteBulkData *	GetCompressedData (FName Format, const FPlatformAudioCookOverrides *CompressionOverrides=USoundWave::GetPlatformCompressionOverridesForCurrentPlatform())
ENGINE_API bool	GetChunkData (int32 ChunkIndex, uint8 **OutChunkData, bool bMakeSureChunkIsLoaded=false)
ENGINE_API bool	IsZerothChunkDataLoaded () const
ENGINE_API const TArrayView< uint8 >	GetZerothChunkDataView () const
ENGINE_API bool	HasChunkSeekTable (int32 InChunkIndex) const
ENGINE_API int32	FindChunkIndexForSeeking (uint32 InTimeInAudioFrames) const
ENGINE_API bool	LoadZerothChunk ()
ENGINE_API FStreamedAudioChunk &	GetChunk (uint32 ChunkIndex)
ENGINE_API int32	GetChunkFromDDC (int32 ChunkIndex, uint8 **OutChunkData, bool bMakeSureChunkIsLoaded)
int32	GetResourceSize ()
const uint8 *	GetResourceData () const
uint32	GetNumChannels ()
void	SetSampleRate (const int32 InSampleRate)
void	SetNumFrames (const int32 InNumFrames)

Friends
class	USoundWave

Constructor & Destructor Documentation

FSoundWaveData()

FSoundWaveData::FSoundWaveData ( )

inline

~FSoundWaveData()

FSoundWaveData::~FSoundWaveData

(

)

Member Function Documentation

FindChunkIndexForSeeking()

int32 FSoundWaveData::FindChunkIndexForSeeking

(

uint32

InTimeInAudioFrames

)

const

GetChunk()

FStreamedAudioChunk & FSoundWaveData::GetChunk

(

uint32

ChunkIndex

)

GetChunkData()

bool FSoundWaveData::GetChunkData	(	int32	ChunkIndex,
		uint8 **	OutChunkData,
		bool	bMakeSureChunkIsLoaded = false
	)

GetChunkFromDDC()

int32 FSoundWaveData::GetChunkFromDDC	(	int32	ChunkIndex,
		uint8 **	OutChunkData,
		bool	bMakeSureChunkIsLoaded
	)

GetCompressedData()

FByteBulkData * FSoundWaveData::GetCompressedData	(	FName	Format,
		const FPlatformAudioCookOverrides *	CompressionOverrides = USoundWave::GetPlatformCompressionOverridesForCurrentPlatform()
	)

GetCuePoints()

const TArray< FSoundWaveCuePoint > & FSoundWaveData::GetCuePoints ( ) const

inline

GetDuration()

float FSoundWaveData::GetDuration ( ) const

inline

GetFName()

const FName & FSoundWaveData::GetFName ( ) const

inline

GetFObjectKey()

const FObjectKey & FSoundWaveData::GetFObjectKey ( ) const

inline

GetGUID()

const FGuid & FSoundWaveData::GetGUID ( ) const

inline

GetLoadingBehavior()

ESoundWaveLoadingBehavior FSoundWaveData::GetLoadingBehavior ( ) const

inline

GetLoopRegions()

const TArray< FSoundWaveCuePoint > & FSoundWaveData::GetLoopRegions ( ) const

inline

GetNumChannels() [1/2]

uint32 FSoundWaveData::GetNumChannels ( )

inline

GetNumChannels() [2/2]

uint32 FSoundWaveData::GetNumChannels ( ) const

inline

GetNumChunks()

uint32 FSoundWaveData::GetNumChunks

(

)

const

GetNumFrames()

int32 FSoundWaveData::GetNumFrames ( ) const

inline

GetPackageName()

const FName & FSoundWaveData::GetPackageName ( ) const

inline

GetResourceData()

const uint8 * FSoundWaveData::GetResourceData ( ) const

inline

GetResourceSize()

int32 FSoundWaveData::GetResourceSize ( )

inline

GetRuntimeFormat()

const FName & FSoundWaveData::GetRuntimeFormat ( ) const

inline

GetSampleRate()

float FSoundWaveData::GetSampleRate ( ) const

inline

GetSizeOfChunk()

uint32 FSoundWaveData::GetSizeOfChunk

(

uint32

ChunkIndex

)

const

GetSoundCompressionType()

ESoundAssetCompressionType FSoundWaveData::GetSoundCompressionType ( ) const

inline

GetZerothChunkDataView()

const TArrayView< uint8 > FSoundWaveData::GetZerothChunkDataView

(

)

const

HasChunkSeekTable()

bool FSoundWaveData::HasChunkSeekTable

(

int32

InChunkIndex

)

const

HasCompressedData()

bool FSoundWaveData::HasCompressedData	(	FName	Format,
		ITargetPlatform *	TargetPlatform = USoundWave::GetRunningPlatform()
	)		const

HasError()

bool FSoundWaveData::HasError

(

)

const

InitializeDataFromSoundWave()

void FSoundWaveData::InitializeDataFromSoundWave

(

USoundWave &

InWave

)

IsLooping()

bool FSoundWaveData::IsLooping ( ) const

inline

IsRetainingAudio()

bool FSoundWaveData::IsRetainingAudio ( ) const

inline

IsSeekable()

bool FSoundWaveData::IsSeekable ( ) const

inline

IsStreaming()

bool FSoundWaveData::IsStreaming ( ) const

inline

IsTemplate()

bool FSoundWaveData::IsTemplate ( ) const

inline

IsZerothChunkDataLoaded()

bool FSoundWaveData::IsZerothChunkDataLoaded

(

)

const

LoadZerothChunk()

bool FSoundWaveData::LoadZerothChunk

(

)

OverrideRuntimeFormat()

void FSoundWaveData::OverrideRuntimeFormat

(

const FName &

InRuntimeFormat

)

ReleaseCompressedAudio()

void FSoundWaveData::ReleaseCompressedAudio

(

)

ResetError()

bool FSoundWaveData::ResetError

(

)

SetAllCuePoints()

void FSoundWaveData::SetAllCuePoints

(

const TArray< FSoundWaveCuePoint > &

InCuePoints

)

SetError()

void FSoundWaveData::SetError

(

const TCHAR *

InErrorMsg = nullptr

)

SetNumFrames()

void FSoundWaveData::SetNumFrames ( const int32  InNumFrames )

inline

SetSampleRate()

void FSoundWaveData::SetSampleRate ( const int32  InSampleRate )

inline

ShouldUseStreamCaching()

bool FSoundWaveData::ShouldUseStreamCaching ( ) const

inline

UE_NONCOPYABLE()

FSoundWaveData::UE_NONCOPYABLE

(

FSoundWaveData

)

WasLoadingBehaviorOverridden()

bool FSoundWaveData::WasLoadingBehaviorOverridden ( ) const

inline

Friends And Related Symbol Documentation

USoundWave

friend class USoundWave

friend

---

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

• Engine/Source/Runtime/Engine/Classes/Sound/SoundWave.h
• Engine/Source/Runtime/Engine/Private/SoundWave.cpp