UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | Protected Attributes | Friends | List of all members
Audio::TSlidingWindow< InSampleType > Class Template Reference

#include <SlidingWindow.h>

+ Inheritance diagram for Audio::TSlidingWindow< InSampleType >:

Classes

class  TSlidingWindowIterator
 

Public Member Functions

 TSlidingWindow (const TSlidingBuffer< InSampleType > &InSlidingBuffer, TArrayView< const InSampleType > InNewBuffer, bool bDoFlush)
 
virtual ~TSlidingWindow ()
 
template<typename InAllocator = FDefaultAllocator>
TSlidingWindowIterator< InAllocator > begin (TArray< InSampleType, InAllocator > &OutWindowBuffer) const
 
template<typename InAllocator = FDefaultAllocator>
TSlidingWindowIterator< InAllocator > end (TArray< InSampleType, InAllocator > &OutWindowBuffer) const
 

Protected Attributes

TArrayView< const InSampleType > StorageBuffer
 
TArrayView< const InSampleType > NewBuffer
 
const int32 NumWindowSamples
 
const int32 NumHopSamples
 

Friends

class TSlidingWindowIterator
 

Detailed Description

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

TSlidingWindow

TSlidingWindow allows windows of samples to be iterated over with STL like iterators.

Constructor & Destructor Documentation

◆ TSlidingWindow()

template<typename InSampleType >
Audio::TSlidingWindow< InSampleType >::TSlidingWindow ( const TSlidingBuffer< InSampleType > &  InSlidingBuffer,
TArrayView< const InSampleType >  InNewBuffer,
bool  bDoFlush 
)
inline

TSlidingWindow constructor

InSlidingBuffer Holds the previous samples which were not completely used in previous sliding windows. It also defines the window and hop size. InNewBuffer Holds new samples which have not yet been ingested by the InSlidingBuffer. bDoFlush Controls whether zeros to the final output windows until all possible windows with data from InNewBuffer have been covered.

◆ ~TSlidingWindow()

template<typename InSampleType >
virtual Audio::TSlidingWindow< InSampleType >::~TSlidingWindow ( )
inlinevirtual

Member Function Documentation

◆ begin()

template<typename InSampleType >
template<typename InAllocator = FDefaultAllocator>
TSlidingWindowIterator< InAllocator > Audio::TSlidingWindow< InSampleType >::begin ( TArray< InSampleType, InAllocator > &  OutWindowBuffer) const
inline

Creates STL like iterator which slides over samples.

OutWindowBuffer Used to construct the TSlidingWindowIterator. The iterator will populate the window with samples when the * operator is called.

◆ end()

template<typename InSampleType >
template<typename InAllocator = FDefaultAllocator>
TSlidingWindowIterator< InAllocator > Audio::TSlidingWindow< InSampleType >::end ( TArray< InSampleType, InAllocator > &  OutWindowBuffer) const
inline

Creates STL like iterator denotes the end of the sliding window.

OutWindowBuffer Used to construct the TSlidingWindowIterator. The iterator will populate the window with samples when the * operator is called.

Friends And Related Symbol Documentation

◆ TSlidingWindowIterator

template<typename InSampleType >
friend class TSlidingWindowIterator
friend

Member Data Documentation

◆ NewBuffer

template<typename InSampleType >
TArrayView<const InSampleType> Audio::TSlidingWindow< InSampleType >::NewBuffer
protected

◆ NumHopSamples

template<typename InSampleType >
const int32 Audio::TSlidingWindow< InSampleType >::NumHopSamples
protected

◆ NumWindowSamples

template<typename InSampleType >
const int32 Audio::TSlidingWindow< InSampleType >::NumWindowSamples
protected

◆ StorageBuffer

template<typename InSampleType >
TArrayView<const InSampleType> Audio::TSlidingWindow< InSampleType >::StorageBuffer
protected
The documentation for this class was generated from the following file: