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

#include <SoundWaveScrubber.h>

+ Inheritance diagram for Audio::FSoundWaveScrubberGenerator:

Public Member Functions

UE_API void Init (FSoundWaveProxyPtr InSoundWaveProxyPtr, float InSampleRate, int32 InNumChannels, float InPlayheadTimeSeconds=0.0f)
 
virtual UE_API int32 OnGenerateAudio (float *OutAudio, int32 NumSamples) override
 
virtual UE_API int32 GetDesiredNumSamplesToRenderPerCallback () const override
 
virtual UE_API bool IsFinished () const override
 
UE_API void SetIsScrubbing (bool bInIsScrubbing)
 
UE_API void SetIsScrubbingWhileStationary (bool bInScrubWhileStationary)
 
UE_API void SetPlayheadTime (float InPlayheadTimeSeconds)
 
UE_API void SetGrainDurationRange (const FVector2D &InGrainDurationRange)
 
- Public Member Functions inherited from ISoundGenerator
ENGINE_API ISoundGenerator ()
 
virtual ENGINE_API ~ISoundGenerator ()
 
virtual void OnBeginGenerate ()
 
virtual void OnEndGenerate ()
 
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)
 

Member Function Documentation

◆ GetDesiredNumSamplesToRenderPerCallback()

int32 Audio::FSoundWaveScrubberGenerator::GetDesiredNumSamplesToRenderPerCallback ( ) const
overridevirtual

Reimplemented from ISoundGenerator.

◆ Init()

void Audio::FSoundWaveScrubberGenerator::Init ( FSoundWaveProxyPtr  InSoundWaveProxyPtr,
float  InSampleRate,
int32  InNumChannels,
float  InPlayheadTimeSeconds = 0.0f 
)

◆ IsFinished()

bool Audio::FSoundWaveScrubberGenerator::IsFinished ( ) const
overridevirtual

Reimplemented from ISoundGenerator.

◆ OnGenerateAudio()

int32 Audio::FSoundWaveScrubberGenerator::OnGenerateAudio ( float *  OutAudio,
int32  NumSamples 
)
overridevirtual

Implements ISoundGenerator.

◆ SetGrainDurationRange()

void Audio::FSoundWaveScrubberGenerator::SetGrainDurationRange ( const FVector2D &  InGrainDurationRange)

◆ SetIsScrubbing()

void Audio::FSoundWaveScrubberGenerator::SetIsScrubbing ( bool  bInIsScrubbing)

◆ SetIsScrubbingWhileStationary()

void Audio::FSoundWaveScrubberGenerator::SetIsScrubbingWhileStationary ( bool  bInScrubWhileStationary)

◆ SetPlayheadTime()

void Audio::FSoundWaveScrubberGenerator::SetPlayheadTime ( float  InPlayheadTimeSeconds)
The documentation for this class was generated from the following files: