FSoundBuffer | Unreal Engine 5.7 Documentation


Name	FSoundBuffer
Type	class
Header File	/Engine/Source/Runtime/Engine/Public/Audio.h
Include Path	#include "Audio.h"

Syntax

class FSoundBuffer

Name	Remarks	Include Path	Unreal Specifiers
FSoundBuffer ( FAudioDevice* InAudioDevice )		Audio.h

Name	Remarks	Include Path	Unreal Specifiers
virtual ~FSoundBuffer()		Audio.h

Name	Type	Remarks	Include Path
AudioDevice	FAudioDevice *	Parent Audio Device used when creating the sound buffer.	Audio.h
bAllocationInPermanentPool	bool	Whether memory for this buffer has been allocated from permanent pool.	Audio.h
NumChannels	int32	Cumulative channels from all streams	Audio.h
ResourceID	int32	Unique ID that ties this buffer to a USoundWave	Audio.h
ResourceName	FString	Human readable name of resource, most likely name of UObject associated during caching.	Audio.h

Name	Remarks	Include Path
virtual FString Describe ( bool bUseLongName )	Describe the buffer (platform can override to add to the description, but should call the base class version)	Audio.h
virtual void EnsureRealtimeTaskCompletion()	Forces any pending async realtime source tasks to finish for the buffer	Audio.h
FString GetChannelsDesc()	Turn the number of channels into a string description	Audio.h
virtual int32 GetCurrentChunkIndex()	Gets the chunk index that was last read from (for Streaming Manager requests)	Audio.h
virtual int32 GetCurrentChunkOffset()	Gets the offset into the chunk that was last read to (for Streaming Manager priority)	Audio.h
virtual int32 GetSize()		Audio.h
FName GetSoundClassName ()	Return the name of the sound class for this buffer	Audio.h
virtual bool IsRealTimeSourceReady()	Returns whether or not a real-time decoding buffer is ready for playback	Audio.h
virtual bool ReadCompressedData ( uint8* Destination, int32 NumFramesToDecode, bool bLooping )	Reads the next compressed data chunk	Audio.h
virtual bool ReadCompressedInfo ( USoundWave* SoundWave )	Reads the compressed info of the given sound wave. Not implemented on all platforms.	Audio.h
virtual void Seek ( const float SeekTime )	Seeks the buffer to the given seek time	Audio.h