Navigation
API > API/Runtime > API/Runtime/Engine
| Name | ISoundGenerator |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Sound/SoundGenerator.h |
| Include Path | #include "Sound/SoundGenerator.h" |
Syntax
class ISoundGenerator
Derived Classes
ISoundGenerator derived class hierarchy
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ISoundGenerator() |
Sound/SoundGenerator.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ISoundGenerator() |
Sound/SoundGenerator.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CommandQueue | TMpscQueue< TUniqueFunction< void()> > | The command queue used to convey commands from game thread to generator thread. | Sound/SoundGenerator.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual int32 GetDesiredNumSamplesToRenderPerCallback() |
Returns the number of samples to render per callback. | Sound/SoundGenerator.h | |
int32 GetNextBuffer
(
float* OutAudio, |
Retrieves the next buffer of audio from the generator, called from the audio mixer. | Sound/SoundGenerator.h | |
virtual float GetRelativeRenderCost () |
Return the cost to render this sound generator. | Sound/SoundGenerator.h | |
virtual Audio::AudioTaskQueueId GetSynchronizedRenderQueueId() |
Sound/SoundGenerator.h | ||
virtual bool IsFinished() |
Optional. Can be overridden to end the sound when generating is finished. | Sound/SoundGenerator.h | |
virtual void OnBeginGenerate() |
Optional. Called on audio generator thread right when the generator begins generating. | Sound/SoundGenerator.h | |
virtual void OnEndGenerate() |
Optional. Called on audio generator thread right when the generator ends generating. | Sound/SoundGenerator.h | |
int32 OnGenerateAudio
(
float* OutAudio, |
Called when a new buffer is required. | Sound/SoundGenerator.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void SynthCommand
(
TFunction< void()> Command |
Protected method to execute lambda in audio render thread Used for conveying parameter changes or events to the generator thread. | Sound/SoundGenerator.h |