FSoundWaveData

API > API/Runtime > API/Runtime/Engine

   
Name FSoundWaveData
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Sound/SoundWave.h
Include Path #include "Sound/SoundWave.h"

Syntax

class FSoundWaveData : public TSharedFromThis< FSoundWaveData >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  Sound/SoundWave.h  

FSoundWaveData ( const USoundWave& InWave
)

   Sound/SoundWave.h  
  Sound/SoundWave.h  
  Sound/SoundWave.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FSoundWaveData()

 Dtor Sound/SoundWave.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bHasError uint8   Sound/SoundWave.h  
bHasSubtitleAssetUserData uint8   Sound/SoundWave.h  
bIsLooping uint8 Shared flags Sound/SoundWave.h  
bIsSeekable uint8   Sound/SoundWave.h  
bIsStreaming uint8   Sound/SoundWave.h  
bIsTemplate uint8   Sound/SoundWave.h  
bLoadedFromCookedData uint8   Sound/SoundWave.h  
bLoadingBehaviorOverridden uint8   Sound/SoundWave.h  
bShouldUseStreamCaching uint8   Sound/SoundWave.h  
CompressedFormatData FFormatContainer   Sound/SoundWave.h  
CuePoints TArray< FSoundWaveCuePoint >   Sound/SoundWave.h  
CurrentChunkRevision int32   Sound/SoundWave.h  
Duration float   Sound/SoundWave.h  
FirstChunk FAudioChunkHandle   Sound/SoundWave.h  
LoadingBehavior ESoundWaveLoadingBehavior   Sound/SoundWave.h  
LoadZerothChunkDataCriticalSection FCriticalSection   Sound/SoundWave.h  
LoopRegions TArray< FSoundWaveCuePoint >   Sound/SoundWave.h  
NameCached FName   Sound/SoundWave.h  
NumChannels uint32   Sound/SoundWave.h  
NumFrames int32   Sound/SoundWave.h  
PackageNameCached FName   Sound/SoundWave.h  
ResourceData FBulkDataBuffer< uint8 >   Sound/SoundWave.h  
ResourceSize int32   Sound/SoundWave.h  
RunningPlatformData FStreamedAudioPlatformData The following members are mutable to allow lazy initialization in const getters (This way we can hand out immutable refrences to objects of this type) The streaming derived data for this sound on this platform. Sound/SoundWave.h  
RuntimeFormat FName   Sound/SoundWave.h  
SampleRate float   Sound/SoundWave.h  
SizeOfFirstAudioChunkInSeconds FPerPlatformFloat Set by CacheInheritedLoadingBehavior after traversing the Soundclass hierarchy. Sound/SoundWave.h  
SoundAssetCompressionType ESoundAssetCompressionType   Sound/SoundWave.h  
SoundWaveKeyCached FObjectKey   Sound/SoundWave.h  
WaveGuid FGuid   Sound/SoundWave.h  
ZerothChunkData FBulkDataBuffer< uint8 > Mutable for lazy-init in GetZerothChunkData() Sound/SoundWave.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 FindChunkIndexForSeeking ( uint32 InTimeInAudioFrames
) const

   Sound/SoundWave.h  

FStreamedAudioChunk & GetChunk ( uint32 ChunkIndex
) const

   Sound/SoundWave.h  

bool GetChunkData ( int32 ChunkIndex,
uint8** OutChunkData,
bool bMakeSureChunkIsLoaded
) const

   Sound/SoundWave.h  

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

   Sound/SoundWave.h  

FByteBulkData * GetCompressedData ( FName Format,
const FPlatformAudioCookOverrides* CompressionOverrides
) const

   Sound/SoundWave.h  

const TArray< FSoundWaveCuePoint > & GetCuePoints()

   Sound/SoundWave.h  

const TArray< FSoundWaveCuePoint > GetCuePointsAndLoopRegions()

   Sound/SoundWave.h  

int32 GetCurrentChunkRevision()

   Sound/SoundWave.h  

FString GetDerivedDataKey()

   Sound/SoundWave.h  

float GetDuration()

   Sound/SoundWave.h  

const FName & GetFName()

   Sound/SoundWave.h  

const FObjectKey & GetFObjectKey()

   Sound/SoundWave.h  

const FGuid & GetGUID()

   Sound/SoundWave.h  

ESoundWaveLoadingBehavior GetLoadingBehavior()

   Sound/SoundWave.h  

const TArray< FSoundWaveCuePoint > & GetLoopRegions()

   Sound/SoundWave.h  

uint32 GetNumChannels ()

   Sound/SoundWave.h  

uint32 GetNumChannels ()

   Sound/SoundWave.h  

uint32 GetNumChunks()

   Sound/SoundWave.h  

int32 GetNumFrames()

   Sound/SoundWave.h  

const FName & GetPackageName()

   Sound/SoundWave.h  

const uint8 * GetResourceData()

   Sound/SoundWave.h  

int32 GetResourceSize()

   Sound/SoundWave.h  

const FName & GetRuntimeFormat()

   Sound/SoundWave.h  

float GetSampleRate()

   Sound/SoundWave.h  

uint32 GetSizeOfChunk ( uint32 ChunkIndex
) const

   Sound/SoundWave.h  

FPerPlatformFloat GetSizeOfFirstAudioChunkInSeconds()

   Sound/SoundWave.h  

ESoundAssetCompressionType GetSoundCompressionType()

   Sound/SoundWave.h  

TArrayView< const uint8 > GetZerothChunk ( bool bForImmediatePlayback
) const

   Sound/SoundWave.h  

const TArrayView< uint8 > GetZerothChunkDataView()

   Sound/SoundWave.h  

bool HasChunkSeekTable ( int32 InChunkIndex
) const

   Sound/SoundWave.h  

bool HasCompressedData ( FName Format,
ITargetPlatform* TargetPlatform
) const

   Sound/SoundWave.h  

bool HasError()

   Sound/SoundWave.h  

bool HasSubtitleAssetUserData()

   Sound/SoundWave.h  

void InitializeDataFromSoundWave ( const USoundWave& InWave
)

 Non-const arg for internal call to FAudioDevice::GetRuntimeFormat Sound/SoundWave.h  

bool IsLooping()

   Sound/SoundWave.h  

bool IsRetainingAudio()

   Sound/SoundWave.h  

bool IsSeekable()

   Sound/SoundWave.h  

bool IsStreaming()

   Sound/SoundWave.h  

bool IsTemplate()

   Sound/SoundWave.h  

bool IsZerothChunkDataLoaded()

   Sound/SoundWave.h  

bool LoadZerothChunk ()

 Returns true if the zeroth chunk is loaded, or attempts to load it if not already loaded, returning true if the load was successful. Sound/SoundWave.h  

void OverrideRuntimeFormat ( const FName& InRuntimeFormat
)

   Sound/SoundWave.h  

void ReleaseCompressedAudio()

   Sound/SoundWave.h  

bool ResetError()

   Sound/SoundWave.h  

void SetAllCuePoints ( const TArray< FSoundWaveCuePoint >& InCuePoints
)

   Sound/SoundWave.h  

void SetError ( const TCHAR* InErrorMsg
)

   Sound/SoundWave.h  

void SetNumFrames ( const int32 InNumFrames
)

   Sound/SoundWave.h  

void SetSampleRate ( const int32 InSampleRate
)

   Sound/SoundWave.h  

bool ShouldUseStreamCaching()

   Sound/SoundWave.h  

bool WasLoadingBehaviorOverridden()

   Sound/SoundWave.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Sound/SoundWave.h  
  Sound/SoundWave.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page