UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FVoiceDelayBuffer< SampleType > Class Template Reference

#include <VoiceDelayBuffer.h>

Public Member Functions

void Init (int32 MaxLength)
 
void SetDelay (int32 NumSamples)
 
int32 GetBufferCount ()
 
void PushSample (const SampleType &InSample)
 
void PushFrame (const SampleType *InFrame, int32 NumChannels)
 
SampleType PopSample ()
 
void ProcessSample (const SampleType &InSample, SampleType &OutSample)
 
int32 PopBufferedAudio (SampleType *OutBuffer, int32 MaxNumSamples)
 

Member Function Documentation

◆ GetBufferCount()

template<class SampleType >
int32 FVoiceDelayBuffer< SampleType >::GetBufferCount ( )
inline

◆ Init()

template<class SampleType >
void FVoiceDelayBuffer< SampleType >::Init ( int32  MaxLength)
inline

Allocates resources for a maximum buffer of MaxLength samples.

◆ PopBufferedAudio()

template<class SampleType >
int32 FVoiceDelayBuffer< SampleType >::PopBufferedAudio ( SampleType *  OutBuffer,
int32  MaxNumSamples 
)
inline

◆ PopSample()

template<class SampleType >
SampleType FVoiceDelayBuffer< SampleType >::PopSample ( )
inline

pop sample off of the buffer. Increments delay between read and write by one sample.

◆ ProcessSample()

template<class SampleType >
void FVoiceDelayBuffer< SampleType >::ProcessSample ( const SampleType &  InSample,
SampleType &  OutSample 
)
inline

Pushes InSample onto the buffer and pops OutSample.

◆ PushFrame()

template<class SampleType >
void FVoiceDelayBuffer< SampleType >::PushFrame ( const SampleType *  InFrame,
int32  NumChannels 
)
inline

◆ PushSample()

template<class SampleType >
void FVoiceDelayBuffer< SampleType >::PushSample ( const SampleType &  InSample)
inline

Pushes sample onto the buffer. Decrements delay between read and write by one sample.

◆ SetDelay()

template<class SampleType >
void FVoiceDelayBuffer< SampleType >::SetDelay ( int32  NumSamples)
inline

Sets delay between read and write in samples.


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