Navigation
API > API/Runtime > API/Runtime/Engine
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Public/Audio.h |
| Include | #include "Audio.h" |
Syntax
class FSoundBuffer
Variables
| 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. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
FSoundBuffer
(
FAudioDevice* InAudioDevice |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| 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 | Forces any pending async realtime source tasks to finish for the buffer | |
 |
FString | Turn the number of channels into a string description | |
   |
int32 | Gets the chunk index that was last read from (for Streaming Manager requests) | |
   |
int32 | Gets the offset into the chunk that was last read to (for Streaming Manager priority) | |
  |
int32 | GetSize () |
|
 |
FName | Return the name of the sound class for this buffer | |
  |
bool | Returns whether or not a real-time decoding buffer is ready for playback | |
  |
bool | ReadCompressedData
(
uint8* Destination, |
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 |