UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | List of all members
FMediaSoundGenerator Class Reference

#include <MediaSoundComponent.h>

+ Inheritance diagram for FMediaSoundGenerator:

Classes

struct  FSoundGeneratorParams
 

Public Member Functions

 FMediaSoundGenerator (FSoundGeneratorParams &InParams)
 
virtual ~FMediaSoundGenerator ()
 
virtual void OnEndGenerate () override
 
virtual int32 OnGenerateAudio (float *OutAudio, int32 NumSamples) override
 
void SetCachedData (float InCachedRate, const FTimespan &InCachedTime)
 
void SetLastPlaySampleTime (const FTimespan &InLastPlaySampleTime)
 
void SetEnableSpectralAnalysis (bool bInSpectralAnlaysisEnabled)
 
void SetEnableEnvelopeFollowing (bool bInEnvelopeFollowingEnabled)
 
void SetSpectrumAnalyzerSettings (Audio::FSpectrumAnalyzerSettings::EFFTSize InFFTSize, const TArray< float > &InFrequenciesToAnalyze)
 
void SetEnvelopeFollowingSettings (int32 InAttackTimeMsec, int32 InReleaseTimeMsec)
 
void SetSampleQueue (TSharedPtr< FMediaAudioSampleQueue, ESPMode::ThreadSafe > &InSampleQueue)
 
TArray< FMediaSoundComponentSpectralData > GetSpectralData () const
 
TArray< FMediaSoundComponentSpectralData > GetNormalizedSpectralData () const
 
float GetCurrentEnvelopeValue () const
 
FTimespan GetLastPlayTime () const
 
- Public Member Functions inherited from ISoundGenerator
ENGINE_API ISoundGenerator ()
 
virtual ENGINE_API ~ISoundGenerator ()
 
virtual int32 GetDesiredNumSamplesToRenderPerCallback () const
 
virtual void OnBeginGenerate ()
 
virtual bool IsFinished () const
 
virtual float GetRelativeRenderCost () const
 
ENGINE_API int32 GetNextBuffer (float *OutAudio, int32 NumSamples, bool bRequireNumberSamples=false)
 
virtual Audio::AudioTaskQueueId GetSynchronizedRenderQueueId () const
 

Additional Inherited Members

- Protected Member Functions inherited from ISoundGenerator
ENGINE_API void SynthCommand (TFunction< void()> Command)
 

Constructor & Destructor Documentation

◆ FMediaSoundGenerator()

FMediaSoundGenerator::FMediaSoundGenerator ( FSoundGeneratorParams &  InParams)

◆ ~FMediaSoundGenerator()

FMediaSoundGenerator::~FMediaSoundGenerator ( )
virtual

Member Function Documentation

◆ GetCurrentEnvelopeValue()

float FMediaSoundGenerator::GetCurrentEnvelopeValue ( ) const
inline

◆ GetLastPlayTime()

FTimespan FMediaSoundGenerator::GetLastPlayTime ( ) const
inline

◆ GetNormalizedSpectralData()

TArray< FMediaSoundComponentSpectralData > FMediaSoundGenerator::GetNormalizedSpectralData ( ) const

◆ GetSpectralData()

TArray< FMediaSoundComponentSpectralData > FMediaSoundGenerator::GetSpectralData ( ) const

◆ OnEndGenerate()

void FMediaSoundGenerator::OnEndGenerate ( )
overridevirtual

Reimplemented from ISoundGenerator.

◆ OnGenerateAudio()

int32 FMediaSoundGenerator::OnGenerateAudio ( float *  OutAudio,
int32  NumSamples 
)
overridevirtual

Implements ISoundGenerator.

◆ SetCachedData()

void FMediaSoundGenerator::SetCachedData ( float  InCachedRate,
const FTimespan &  InCachedTime 
)

◆ SetEnableEnvelopeFollowing()

void FMediaSoundGenerator::SetEnableEnvelopeFollowing ( bool  bInEnvelopeFollowingEnabled)

◆ SetEnableSpectralAnalysis()

void FMediaSoundGenerator::SetEnableSpectralAnalysis ( bool  bInSpectralAnlaysisEnabled)

◆ SetEnvelopeFollowingSettings()

void FMediaSoundGenerator::SetEnvelopeFollowingSettings ( int32  InAttackTimeMsec,
int32  InReleaseTimeMsec 
)

◆ SetLastPlaySampleTime()

void FMediaSoundGenerator::SetLastPlaySampleTime ( const FTimespan &  InLastPlaySampleTime)

◆ SetSampleQueue()

void FMediaSoundGenerator::SetSampleQueue ( TSharedPtr< FMediaAudioSampleQueue, ESPMode::ThreadSafe > &  InSampleQueue)

◆ SetSpectrumAnalyzerSettings()

void FMediaSoundGenerator::SetSpectrumAnalyzerSettings ( Audio::FSpectrumAnalyzerSettings::EFFTSize  InFFTSize,
const TArray< float > &  InFrequenciesToAnalyze 
)
The documentation for this class was generated from the following files: