Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Sound
Inheritance Hierarchy
- ISoundGenerator
- FMediaSoundGenerator
- FMetasoundGenerator
- FMetasoundConstGraphGenerator
- FMetasoundDynamicGraphGenerator
- FMotoSynthEngine
- FSoundGeneratorNull
- FToneGenerator
- FWebRTCSoundGenerator
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Classes/Sound/SoundGenerator.h |
| Include | #include "Sound/SoundGenerator.h" |
Syntax
class ISoundGenerator
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
int32 | Returns the number of samples to render per callback. | |
 |
int32 | GetNextBuffer
(
float* OutAudio, |
Retrieves the next buffer of audio from the generator, called from the audio mixer. |
   |
Audio::AudioTaskQueueId | ||
   |
bool | IsFinished () |
Optional. Can be overridden to end the sound when generating is finished. |
  |
void | Optional. Called on audio generator thread right when the generator begins generating. | |
  |
void | Optional. Called on audio generator thread right when the generator ends generating. | |
 |
int32 | OnGenerateAudio
(
float* OutAudio, |
Called when a new buffer is required. |
 |
void | SynthCommand
(
TUniqueFunction< void()> Command |
Protected method to execute lambda in audio render thread Used for conveying parameter changes or events to the generator thread. |