#include <SoundWave.h>

Inheritance diagram for FSoundWaveProxy:

Public Member Functions
	IMPL_AUDIOPROXY_CLASS (FSoundWaveProxy)

ENGINE_API	FSoundWaveProxy (USoundWave *InWave)

ENGINE_API	FSoundWaveProxy (const FSoundWaveProxy &Other)

ENGINE_API	~FSoundWaveProxy ()

ENGINE_API void	ReleaseCompressedAudio ()

ENGINE_API bool	LoadZerothChunk ()

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

ENGINE_API const FName &	GetFName () const

ENGINE_API const FName &	GetPackageName () const

ENGINE_API const FName &	GetRuntimeFormat () const

ENGINE_API const FObjectKey &	GetFObjectKey () const

ENGINE_API float	GetDuration () const

ENGINE_API float	GetSampleRate () const

ENGINE_API int32	GetNumFrames () const

ENGINE_API uint32	GetNumChunks () const

ENGINE_API uint32	GetNumChannels () const

ENGINE_API uint32	GetSizeOfChunk (uint32 ChunkIndex) const

ENGINE_API const TArray< FSoundWaveCuePoint > &	GetCuePoints () const

ENGINE_API const TArray< FSoundWaveCuePoint > &	GetLoopRegions () const

ENGINE_API const TArray< FSoundWaveCuePoint >	GetCuePointsAndLoopRegions () const

ENGINE_API bool	IsLooping () const

ENGINE_API bool	IsTemplate () const

ENGINE_API bool	IsStreaming () const

ENGINE_API bool	IsRetainingAudio () const

ENGINE_API bool	ShouldUseStreamCaching () const

ENGINE_API bool	IsSeekable () const

ENGINE_API bool	IsZerothChunkDataLoaded () const

ENGINE_API bool	WasLoadingBehaviorOverridden () const

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

ENGINE_API ESoundWaveLoadingBehavior	GetLoadingBehavior () const

ENGINE_API const TArrayView< uint8 >	GetZerothChunkDataView () const

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

ENGINE_API FStreamedAudioChunk &	GetChunk (uint32 ChunkIndex)

ENGINE_API int32	GetChunkFromDDC (int32 ChunkIndex, uint8 **OutChunkData, bool bMakeSureChunkIsLoaded)

ENGINE_API int32	GetResourceSize () const

ENGINE_API const uint8 *	GetResourceData () const

ENGINE_API const FSoundWavePtr	GetSoundWaveData ()

Public Member Functions inherited from Audio::TProxyData< FSoundWaveProxy >
	TProxyData ()

Public Member Functions inherited from Audio::IProxyData
virtual	~IProxyData ()=default

template<typename ProxyType >
bool	CheckTypeCast () const

FName	GetProxyTypeName () const

template<typename ProxyType >
ProxyType &	GetAs ()

template<typename ProxyType >
const ProxyType &	GetAs () const

	IProxyData (FName InProxyTypeName)

virtual TUniquePtr< IProxyData >	Clone () const

Static Public Member Functions
static ENGINE_API TArrayView< const uint8 >	GetZerothChunk (const FSoundWaveProxyPtr &SoundWaveProxy, bool bForImmediatePlayback=false)

Friends
uint32	GetTypeHash (const FSoundWaveProxy &InProxy)

Additional Inherited Members
Static Protected Attributes inherited from Audio::TProxyData< FSoundWaveProxy >
static constexpr bool	bWasAudioProxyClassImplemented

Constructor & Destructor Documentation

◆ FSoundWaveProxy() [1/2]

FSoundWaveProxy::FSoundWaveProxy ( USoundWave * InWave )

explicit

◆ FSoundWaveProxy() [2/2]

FSoundWaveProxy::FSoundWaveProxy ( const FSoundWaveProxy & Other )

default

◆ ~FSoundWaveProxy()

FSoundWaveProxy::~FSoundWaveProxy ( )

Member Function Documentation

◆ GetChunk()

FStreamedAudioChunk & FSoundWaveProxy::GetChunk ( uint32 ChunkIndex )

◆ GetChunkData()

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

◆ GetChunkFromDDC()

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

◆ GetCompressedData()

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

◆ GetCuePoints()

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

◆ GetCuePointsAndLoopRegions()

const TArray< FSoundWaveCuePoint > FSoundWaveProxy::GetCuePointsAndLoopRegions ( ) const

◆ GetDuration()

float FSoundWaveProxy::GetDuration ( ) const

◆ GetFName()

const FName & FSoundWaveProxy::GetFName ( ) const

◆ GetFObjectKey()

const FObjectKey & FSoundWaveProxy::GetFObjectKey ( ) const

◆ GetLoadingBehavior()

ESoundWaveLoadingBehavior FSoundWaveProxy::GetLoadingBehavior ( ) const

◆ GetLoopRegions()

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

◆ GetNumChannels()

uint32 FSoundWaveProxy::GetNumChannels ( ) const

◆ GetNumChunks()

uint32 FSoundWaveProxy::GetNumChunks ( ) const

◆ GetNumFrames()

int32 FSoundWaveProxy::GetNumFrames ( ) const

◆ GetPackageName()

const FName & FSoundWaveProxy::GetPackageName ( ) const

◆ GetResourceData()

const uint8 * FSoundWaveProxy::GetResourceData ( ) const

◆ GetResourceSize()

int32 FSoundWaveProxy::GetResourceSize ( ) const

◆ GetRuntimeFormat()

const FName & FSoundWaveProxy::GetRuntimeFormat ( ) const

◆ GetSampleRate()

float FSoundWaveProxy::GetSampleRate ( ) const

◆ GetSizeOfChunk()

uint32 FSoundWaveProxy::GetSizeOfChunk ( uint32 ChunkIndex ) const

◆ GetSoundWaveData()

const FSoundWavePtr FSoundWaveProxy::GetSoundWaveData ( )

◆ GetZerothChunk()

TArrayView< const uint8 > FSoundWaveProxy::GetZerothChunk	(	const FSoundWaveProxyPtr &	SoundWaveProxy,
		bool	bForImmediatePlayback = `false`
	)

static

◆ GetZerothChunkDataView()

const TArrayView< uint8 > FSoundWaveProxy::GetZerothChunkDataView ( ) const

◆ HasCompressedData()

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

◆ IMPL_AUDIOPROXY_CLASS()

FSoundWaveProxy::IMPL_AUDIOPROXY_CLASS ( FSoundWaveProxy )

◆ IsLooping()

bool FSoundWaveProxy::IsLooping ( ) const

◆ IsRetainingAudio()

bool FSoundWaveProxy::IsRetainingAudio ( ) const

◆ IsSeekable()

bool FSoundWaveProxy::IsSeekable ( ) const

◆ IsStreaming()

bool FSoundWaveProxy::IsStreaming ( ) const

◆ IsTemplate()

bool FSoundWaveProxy::IsTemplate ( ) const

◆ IsZerothChunkDataLoaded()

bool FSoundWaveProxy::IsZerothChunkDataLoaded ( ) const

◆ LoadZerothChunk()

bool FSoundWaveProxy::LoadZerothChunk ( )

◆ ReleaseCompressedAudio()

void FSoundWaveProxy::ReleaseCompressedAudio ( )

◆ ShouldUseStreamCaching()

bool FSoundWaveProxy::ShouldUseStreamCaching ( ) const

◆ WasLoadingBehaviorOverridden()

bool FSoundWaveProxy::WasLoadingBehaviorOverridden ( ) const

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( const FSoundWaveProxy & InProxy )

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

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members