Audio::TSlidingBuffer< InSampleType > Class Template Reference

#include <SlidingWindow.h>

Public Member Functions
	TSlidingBuffer (const int32 InNumWindowSamples, const int32 InNumHopSamples)
	TSlidingBuffer ()
	TSlidingBuffer (const TSlidingBuffer &)=default
	TSlidingBuffer (TSlidingBuffer &&)=default
TSlidingBuffer &	operator= (const TSlidingBuffer &InOther)=default
TSlidingBuffer &	operator= (TSlidingBuffer &&InOther)=default
int32	GetNumWindowSamples () const
int32	GetNumHopSamples () const
int32	GetNumUnderflowSamples () const
TArrayView< const InSampleType >	GetStorage () const
void	StoreForFutureWindows (TArrayView< const InSampleType > InBuffer)
void	Reset ()

Detailed Description

template<typename InSampleType>
class Audio::TSlidingBuffer< InSampleType >

TSlidingBuffer

TSlidingBuffer defines the window size and hop size of the sliding window, and it stores any samples needed to produce additional windows.

TSlidingBuffer should be used in conjunction with the TSlidingWindow, TScopedSlidingWindow or TAutoSlidingWindow classes.

Constructor & Destructor Documentation

TSlidingBuffer() [1/4]

template<typename InSampleType >

Audio::TSlidingBuffer< InSampleType >::TSlidingBuffer ( const int32  InNumWindowSamples, const int32  InNumHopSamples  )

inline

Constructs a TSlidingBuffer with a constant window and hop size

TSlidingBuffer() [2/4]

template<typename InSampleType >

Audio::TSlidingBuffer< InSampleType >::TSlidingBuffer ( )

inline

TSlidingBuffer() [3/4]

template<typename InSampleType >

Audio::TSlidingBuffer< InSampleType >::TSlidingBuffer ( const TSlidingBuffer< InSampleType > &  )

default

TSlidingBuffer() [4/4]

template<typename InSampleType >

Audio::TSlidingBuffer< InSampleType >::TSlidingBuffer ( TSlidingBuffer< InSampleType > &&  )

default

Member Function Documentation

GetNumHopSamples()

template<typename InSampleType >

int32 Audio::TSlidingBuffer< InSampleType >::GetNumHopSamples ( ) const

inline

Returns the number of samples between windows.

GetNumUnderflowSamples()

template<typename InSampleType >

int32 Audio::TSlidingBuffer< InSampleType >::GetNumUnderflowSamples ( ) const

inline

Returns the number of underflow samples (when hopsize > windowsize)

GetNumWindowSamples()

template<typename InSampleType >

int32 Audio::TSlidingBuffer< InSampleType >::GetNumWindowSamples ( ) const

inline

Returns the number of samples in a window.

GetStorage()

template<typename InSampleType >

TArrayView< const InSampleType > Audio::TSlidingBuffer< InSampleType >::GetStorage ( ) const

inline

operator=() [1/2]

template<typename InSampleType >

TSlidingBuffer & Audio::TSlidingBuffer< InSampleType >::operator= ( const TSlidingBuffer< InSampleType > &  InOther )

default

operator=() [2/2]

template<typename InSampleType >

TSlidingBuffer & Audio::TSlidingBuffer< InSampleType >::operator= ( TSlidingBuffer< InSampleType > &&  InOther )

default

Reset()

template<typename InSampleType >

void Audio::TSlidingBuffer< InSampleType >::Reset ( )

inline

Resets the internal storage.

StoreForFutureWindows()

template<typename InSampleType >

void Audio::TSlidingBuffer< InSampleType >::StoreForFutureWindows ( TArrayView< const InSampleType >  InBuffer )

inline

StoreForFutureWindows stores the necessary samples from InBuffer which will be needed for future windows. It ignores all values in InBuffer which can already be composed as a complete window.

---

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

• Engine/Source/Runtime/SignalProcessing/Public/DSP/SlidingWindow.h