ISoundGenerator Class Reference

#include <SoundGenerator.h>

Inheritance diagram for ISoundGenerator:

Public Member Functions
ENGINE_API	ISoundGenerator ()
virtual ENGINE_API	~ISoundGenerator ()
virtual int32	OnGenerateAudio (float *OutAudio, int32 NumSamples)=0
virtual int32	GetDesiredNumSamplesToRenderPerCallback () const
virtual void	OnBeginGenerate ()
virtual void	OnEndGenerate ()
virtual bool	IsFinished () const
virtual float	GetRelativeRenderCost () const
ENGINE_API int32	GetNextBuffer (float *OutAudio, int32 NumSamples, bool bRequireNumberSamples=false)
virtual Audio::AudioTaskQueueId	GetSynchronizedRenderQueueId () const

Protected Member Functions
ENGINE_API void	SynthCommand (TFunction< void()> Command)

Friends
class	USynthComponent

Constructor & Destructor Documentation

ISoundGenerator()

ISoundGenerator::ISoundGenerator

(

)

~ISoundGenerator()

ISoundGenerator::~ISoundGenerator ( )

virtual

Member Function Documentation

GetDesiredNumSamplesToRenderPerCallback()

virtual int32 ISoundGenerator::GetDesiredNumSamplesToRenderPerCallback ( ) const

inlinevirtual

Reimplemented in Audio::FSoundWaveScrubberGenerator.

GetNextBuffer()

int32 ISoundGenerator::GetNextBuffer	(	float *	OutAudio,
		int32	NumSamples,
		bool	bRequireNumberSamples = false
	)

GetRelativeRenderCost()

virtual float ISoundGenerator::GetRelativeRenderCost ( ) const

inlinevirtual

GetSynchronizedRenderQueueId()

virtual Audio::AudioTaskQueueId ISoundGenerator::GetSynchronizedRenderQueueId ( ) const

inlinevirtual

IsFinished()

virtual bool ISoundGenerator::IsFinished ( ) const

inlinevirtual

Reimplemented in Audio::FSoundWaveScrubberGenerator.

OnBeginGenerate()

virtual void ISoundGenerator::OnBeginGenerate ( )

inlinevirtual

OnEndGenerate()

virtual void ISoundGenerator::OnEndGenerate ( )

inlinevirtual

Reimplemented in FMediaSoundGenerator.

OnGenerateAudio()

virtual int32 ISoundGenerator::OnGenerateAudio ( float *  OutAudio, int32  NumSamples  )

pure virtual

Implemented in Audio::FSoundWaveScrubberGenerator, FSoundGeneratorNull, and FMediaSoundGenerator.

SynthCommand()

void ISoundGenerator::SynthCommand ( TFunction< void()>  Command )

protected

Friends And Related Symbol Documentation

USynthComponent

friend class USynthComponent

friend

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Engine/Classes/Sound/SoundGenerator.h
• Engine/Source/Runtime/Engine/Private/SoundGenerator.cpp