FSoundBuffer | Unreal Engine 4.27 Documentation

References


Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/Audio.h
Include	#include "Audio.h"

class FSoundBuffer

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

	Type	Name	Description
		FSoundBuffer ( FAudioDevice* InAudioDevice )

	Type	Name	Description
		~FSoundBuffer ()

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