Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Sound
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- USoundBase
- USoundWave
- USoundWaveProcedural
- UMetaSoundSource
- USoundModWave
- USynthSound
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Classes/Sound/SoundWaveProcedural.h |
| Include | #include "Sound/SoundWaveProcedural.h" |
Syntax
class USoundWaveProcedural : public USoundWave
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
int32 | NumBufferUnderrunSamples | Number of samples to pad with 0 if there isn't enough audio available. |
 |
int32 | NumSamplesToGeneratePerCallback | The number of PCM samples we want to generate. This can't be larger than SamplesNeeded in GeneratePCMData callback, but can be less. |
 |
FOnSoundWaveProceduralUnderflow | OnSoundWaveProceduralUnderflow | Called when GeneratePCMData is called but not enough data is available. |
 |
int32 | SampleByteSize | Size in bytes of a single sample of audio in the procedural audio buffer. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
USoundWaveProcedural
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
int32 | Query bytes queued for playback | |
  |
int32 | OnGeneratePCMAudio
(
TArray< uint8 >& OutAudio, |
Virtual function to generate PCM audio from the audio render thread. |
 |
void | QueueAudio
(
const uint8* AudioData, |
Add data to the FIFO that feeds the audio device. |
 |
void | ResetAudio () |
Remove all queued data from the FIFO. |
Overridden from USoundWave
| Type | Name | Description | |
|---|---|---|---|
  |
void | BeginGetCompressedData
(
FName Format, |
|
  |
int32 | GeneratePCMData
(
uint8* PCMData, |
This is only used for DTYPE_Procedural audio. |
  |
FByteBulkData * | GetCompressedData
(
FName Format, |
Gets the compressed data from derived data cache for the specified platform Warning, the returned pointer isn't valid after we add new formats |
  |
int32 | GetResourceSizeForFormat
(
FName Format |
|
   |
bool | HasCompressedData
(
FName Format, |
|
  |
void | InitAudioResource
(
FByteBulkData& CompressedData |
Copy the compressed audio data from the bulk data |
  |
bool | InitAudioResource
(
FName Format |
Copy the compressed audio data from derived data cache |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
   |
void | GetAssetRegistryTags
(
TArray< FAssetRegistryTag >& OutTags |
Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects |
  |
void | Handles reading, writing, and reference collecting using FArchive. |