ISoundGenerator

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Sound/SoundGenerator.h

Include

#include "Sound/SoundGenerator.h"

Syntax

class ISoundGenerator

Constructors

Name Description

Public function

ISoundGenerator()

Destructors

Name Description

Public function Virtual

~ISoundGenerator()

Functions

Name Description

Public function Virtual Const

int32

 

GetDesiredNumSamplesToRenderPerCallback()

Returns the number of samples to render per callback.

Public function

int32

 

GetNextBuffer

(
    float* OutAudio,
    int32 NumSamples,
    bool bRequireNumberSamples
)

Retrieves the next buffer of audio from the generator, called from the audio mixer.

Public function Virtual

void

 

OnBeginGenerate()

  1. Called on audio generator thread right when the generator begins generating.

Public function Virtual

void

 

OnEndGenerate()

  1. Called on audio generator thread right when the generator ends generating.

Public function

int32

 

OnGenerateAudio

(
    float* OutAudio,
    int32 NumSamples
)

Called when a new buffer is required.

Protected function

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.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss