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

#include <SlidingWindow.h>

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

Public Member Functions

 TScopedSlidingWindow (TSlidingBuffer< InSampleType > &InSlidingBuffer, TArrayView< const InSampleType > InNewBuffer, bool bDoFlush=false)
 
virtual ~TScopedSlidingWindow ()
 
- Public Member Functions inherited from Audio::TSlidingWindow< InSampleType >
 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
 

Additional Inherited Members

- Protected Attributes inherited from Audio::TSlidingWindow< InSampleType >
TArrayView< const InSampleType > StorageBuffer
 
TArrayView< const InSampleType > NewBuffer
 
const int32 NumWindowSamples
 
const int32 NumHopSamples
 

Detailed Description

template<class InSampleType>
class Audio::TScopedSlidingWindow< InSampleType >

TScopedSlidingWindow

TScopedSlidingWindow provides a sliding window iterator interface over arrays. When TScopedSlidingWindow is destructed, it calls StoreForFutureWindow(...) on the TSlidingBuffer passed into the constructor.

Constructor & Destructor Documentation

◆ TScopedSlidingWindow()

template<class InSampleType >
Audio::TScopedSlidingWindow< InSampleType >::TScopedSlidingWindow ( TSlidingBuffer< InSampleType > &  InSlidingBuffer,
TArrayView< const InSampleType >  InNewBuffer,
bool  bDoFlush = false 
)
inline

TScopedSlidingWindow 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.

◆ ~TScopedSlidingWindow()

template<class InSampleType >
virtual Audio::TScopedSlidingWindow< InSampleType >::~TScopedSlidingWindow ( )
inlinevirtual

Calls InSlidingBuffer.StoreForFutureWindows(InNewBuffer).

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