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

#include <SampleBuffer.h>

Public Member Functions

 TSampleBuffer ()
 
 TSampleBuffer (const TSampleBuffer &Other)
 
 TSampleBuffer (const FAlignedFloatBuffer &InData, int32 InNumChannels, int32 InSampleRate)
 
 TSampleBuffer (const float *InBufferPtr, int32 InNumSamples, int32 InNumChannels, int32 InSampleRate)
 
 TSampleBuffer (const int16 *InBufferPtr, int32 InNumSamples, int32 InNumChannels, int32 InSampleRate)
 
TSampleBufferoperator= (const TSampleBuffer &Other)
 
template<class OtherSampleType >
TSampleBufferoperator= (const TSampleBuffer< OtherSampleType > &Other)
 
void CopyFrom (const TArray< SampleType > &InArray, int32 InNumChannels, int32 InSampleRate)
 
template<class OtherSampleType >
void Append (const OtherSampleType *InputBuffer, int32 InNumSamples)
 
template<class OtherSampleType >
void Append (const OtherSampleType *InputBuffer, int32 InNumSamples, int32 InNumChannels, int32 InSampleRate)
 
 ~TSampleBuffer ()
 
void Reset ()
 
const SampleType * GetData () const
 
TArrayView< SampleType > GetArrayView ()
 
TArrayView< const SampleType > GetArrayView () const
 
int32 GetNumSamples () const
 
int32 GetNumFrames () const
 
int32 GetNumChannels () const
 
int32 GetSampleRate () const
 
float GetSampleDuration () const
 
void MixBufferToChannels (int32 InNumChannels)
 
void Clamp (float Ceiling=1.0f)
 
void ZeroPad (int32 NumFramesToAppend=0)
 
void SetNumFrames (int32 InNumFrames)
 
float GetAudioFrameAtFractionalIndex (float InIndex, TArray< SampleType > &OutFrame) const
 
float GetAudioFrameAtPhase (float InPhase, TArray< SampleType > &OutFrame) const
 
float GetAudioFrameAtTime (float InTimeSec, TArray< SampleType > &OutFrame) const
 

Friends

template<class >
class TSampleBuffer
 

Constructor & Destructor Documentation

◆ TSampleBuffer() [1/5]

template<class SampleType = DefaultUSoundWaveSampleType>
Audio::TSampleBuffer< SampleType >::TSampleBuffer ( )
inline

◆ TSampleBuffer() [2/5]

template<class SampleType = DefaultUSoundWaveSampleType>
Audio::TSampleBuffer< SampleType >::TSampleBuffer ( const TSampleBuffer< SampleType > &  Other)
inline

◆ TSampleBuffer() [3/5]

template<class SampleType = DefaultUSoundWaveSampleType>
Audio::TSampleBuffer< SampleType >::TSampleBuffer ( const FAlignedFloatBuffer InData,
int32  InNumChannels,
int32  InSampleRate 
)
inline

◆ TSampleBuffer() [4/5]

template<class SampleType = DefaultUSoundWaveSampleType>
Audio::TSampleBuffer< SampleType >::TSampleBuffer ( const float InBufferPtr,
int32  InNumSamples,
int32  InNumChannels,
int32  InSampleRate 
)
inline

◆ TSampleBuffer() [5/5]

template<class SampleType = DefaultUSoundWaveSampleType>
Audio::TSampleBuffer< SampleType >::TSampleBuffer ( const int16 InBufferPtr,
int32  InNumSamples,
int32  InNumChannels,
int32  InSampleRate 
)
inline

◆ ~TSampleBuffer()

template<class SampleType = DefaultUSoundWaveSampleType>
Audio::TSampleBuffer< SampleType >::~TSampleBuffer ( )
inline

Member Function Documentation

◆ Append() [1/2]

template<class SampleType = DefaultUSoundWaveSampleType>
template<class OtherSampleType >
void Audio::TSampleBuffer< SampleType >::Append ( const OtherSampleType InputBuffer,
int32  InNumSamples 
)
inline

◆ Append() [2/2]

template<class SampleType = DefaultUSoundWaveSampleType>
template<class OtherSampleType >
void Audio::TSampleBuffer< SampleType >::Append ( const OtherSampleType InputBuffer,
int32  InNumSamples,
int32  InNumChannels,
int32  InSampleRate 
)
inline

◆ Clamp()

template<class SampleType = DefaultUSoundWaveSampleType>
void Audio::TSampleBuffer< SampleType >::Clamp ( float  Ceiling = 1.0f)
inline

◆ CopyFrom()

template<class SampleType = DefaultUSoundWaveSampleType>
void Audio::TSampleBuffer< SampleType >::CopyFrom ( const TArray< SampleType > &  InArray,
int32  InNumChannels,
int32  InSampleRate 
)
inline

◆ GetArrayView() [1/2]

template<class SampleType = DefaultUSoundWaveSampleType>
TArrayView< SampleType > Audio::TSampleBuffer< SampleType >::GetArrayView ( )
inline

◆ GetArrayView() [2/2]

template<class SampleType = DefaultUSoundWaveSampleType>
TArrayView< const SampleType > Audio::TSampleBuffer< SampleType >::GetArrayView ( ) const
inline

◆ GetAudioFrameAtFractionalIndex()

template<class SampleType = DefaultUSoundWaveSampleType>
float Audio::TSampleBuffer< SampleType >::GetAudioFrameAtFractionalIndex ( float  InIndex,
TArray< SampleType > &  OutFrame 
) const
inline

◆ GetAudioFrameAtPhase()

template<class SampleType = DefaultUSoundWaveSampleType>
float Audio::TSampleBuffer< SampleType >::GetAudioFrameAtPhase ( float  InPhase,
TArray< SampleType > &  OutFrame 
) const
inline

◆ GetAudioFrameAtTime()

template<class SampleType = DefaultUSoundWaveSampleType>
float Audio::TSampleBuffer< SampleType >::GetAudioFrameAtTime ( float  InTimeSec,
TArray< SampleType > &  OutFrame 
) const
inline

◆ GetData()

template<class SampleType = DefaultUSoundWaveSampleType>
const SampleType * Audio::TSampleBuffer< SampleType >::GetData ( ) const
inline

◆ GetNumChannels()

template<class SampleType = DefaultUSoundWaveSampleType>
int32 Audio::TSampleBuffer< SampleType >::GetNumChannels ( ) const
inline

◆ GetNumFrames()

template<class SampleType = DefaultUSoundWaveSampleType>
int32 Audio::TSampleBuffer< SampleType >::GetNumFrames ( ) const
inline

◆ GetNumSamples()

template<class SampleType = DefaultUSoundWaveSampleType>
int32 Audio::TSampleBuffer< SampleType >::GetNumSamples ( ) const
inline

◆ GetSampleDuration()

template<class SampleType = DefaultUSoundWaveSampleType>
float Audio::TSampleBuffer< SampleType >::GetSampleDuration ( ) const
inline

◆ GetSampleRate()

template<class SampleType = DefaultUSoundWaveSampleType>
int32 Audio::TSampleBuffer< SampleType >::GetSampleRate ( ) const
inline

◆ MixBufferToChannels()

template<class SampleType = DefaultUSoundWaveSampleType>
void Audio::TSampleBuffer< SampleType >::MixBufferToChannels ( int32  InNumChannels)
inline

◆ operator=() [1/2]

template<class SampleType = DefaultUSoundWaveSampleType>
TSampleBuffer & Audio::TSampleBuffer< SampleType >::operator= ( const TSampleBuffer< SampleType > &  Other)
inline

◆ operator=() [2/2]

template<class SampleType = DefaultUSoundWaveSampleType>
template<class OtherSampleType >
TSampleBuffer & Audio::TSampleBuffer< SampleType >::operator= ( const TSampleBuffer< OtherSampleType > &  Other)
inline

◆ Reset()

template<class SampleType = DefaultUSoundWaveSampleType>
void Audio::TSampleBuffer< SampleType >::Reset ( )
inline

◆ SetNumFrames()

template<class SampleType = DefaultUSoundWaveSampleType>
void Audio::TSampleBuffer< SampleType >::SetNumFrames ( int32  InNumFrames)
inline

◆ ZeroPad()

template<class SampleType = DefaultUSoundWaveSampleType>
void Audio::TSampleBuffer< SampleType >::ZeroPad ( int32  NumFramesToAppend = 0)
inline

Appends zeroes to the end of this buffer. If called with no arguments or NumFramesToAppend = 0, this will ZeroPad

Friends And Related Symbol Documentation

◆ TSampleBuffer

template<class SampleType = DefaultUSoundWaveSampleType>
template<class >
friend class TSampleBuffer
friend

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