UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Audio::FSampleBufferReader Class Reference

#include <SampleBufferReader.h>

Public Member Functions

SIGNALPROCESSING_API FSampleBufferReader ()
 
SIGNALPROCESSING_API ~FSampleBufferReader ()
 
SIGNALPROCESSING_API void Init (const int32 InSampleRate)
 
SIGNALPROCESSING_API void SetBuffer (const int16 *InBufferPtr, const int32 InNumBufferSamples, const int32 InNumChannels, const int32 InBufferSampleRate)
 
SIGNALPROCESSING_API void SeekTime (const float InTimeSec, const ESeekType::Type InSeekType=ESeekType::FromBeginning, const bool bWrap=true)
 
SIGNALPROCESSING_API void SetPitch (const float InPitch, const float InterpolationTimeSec=0.0f)
 
SIGNALPROCESSING_API void SetScrubMode (const bool bInIsScrubMode)
 
SIGNALPROCESSING_API void SetScrubTimeWidth (const float InScrubTimeWidthSec)
 
int32 GetNumChannels () const
 
int32 GetNumFrames () const
 
float GetPlaybackProgress () const
 
SIGNALPROCESSING_API bool Generate (float *OutAudioBuffer, const int32 NumFrames, const int32 OutChannels, const bool bWrap=false)
 
bool HasBuffer () const
 
SIGNALPROCESSING_API void ClearBuffer ()
 

Protected Member Functions

SIGNALPROCESSING_API float GetSampleValueForChannel (const int32 Channel)
 
SIGNALPROCESSING_API void UpdateScrubMinAndMax ()
 
SIGNALPROCESSING_API void UpdateSeekFrame ()
 
SIGNALPROCESSING_API float GetSampleValue (const int16 *InBuffer, const int32 SampleIndex)
 

Protected Attributes

const int16 * BufferPtr
 
int32 BufferNumSamples
 
int32 BufferNumFrames
 
int32 BufferSampleRate
 
int32 BufferNumChannels
 
int32 FadeFrames
 
float FadeValue
 
float FadeIncrement
 
float DeviceSampleRate
 
float BasePitch
 
float PitchScale
 
Audio::FLinearEase Pitch
 
int32 CurrentFrameIndex
 
int32 NextFrameIndex
 
double AlphaLerp
 
double CurrentBufferFrameIndexInterpolated
 
float PlaybackProgress
 
double ScrubAnchorFrame
 
double ScrubMinFrame
 
double ScrubMaxFrame
 
double ScrubWidthFrames
 
float CurrentSeekTime
 
float CurrentScrubWidthSec
 
ESeekType::Type CurrentSeekType
 
bool bWrap
 
bool bIsScrubMode
 
bool bIsFinished
 

Constructor & Destructor Documentation

◆ FSampleBufferReader()

Audio::FSampleBufferReader::FSampleBufferReader ( )

◆ ~FSampleBufferReader()

Audio::FSampleBufferReader::~FSampleBufferReader ( )

Member Function Documentation

◆ ClearBuffer()

void Audio::FSampleBufferReader::ClearBuffer ( )

◆ Generate()

bool Audio::FSampleBufferReader::Generate ( float *  OutAudioBuffer,
const int32  NumFrames,
const int32  OutChannels,
const bool  bWrap = false 
)

◆ GetNumChannels()

int32 Audio::FSampleBufferReader::GetNumChannels ( ) const
inline

◆ GetNumFrames()

int32 Audio::FSampleBufferReader::GetNumFrames ( ) const
inline

◆ GetPlaybackProgress()

float Audio::FSampleBufferReader::GetPlaybackProgress ( ) const
inline

◆ GetSampleValue()

float Audio::FSampleBufferReader::GetSampleValue ( const int16 *  InBuffer,
const int32  SampleIndex 
)
protected

◆ GetSampleValueForChannel()

float Audio::FSampleBufferReader::GetSampleValueForChannel ( const int32  Channel)
protected

◆ HasBuffer()

bool Audio::FSampleBufferReader::HasBuffer ( ) const
inline

◆ Init()

void Audio::FSampleBufferReader::Init ( const int32  InSampleRate)

◆ SeekTime()

void Audio::FSampleBufferReader::SeekTime ( const float  InTimeSec,
const ESeekType::Type  InSeekType = ESeekType::FromBeginning,
const bool  bWrap = true 
)

◆ SetBuffer()

void Audio::FSampleBufferReader::SetBuffer ( const int16 *  InBufferPtr,
const int32  InNumBufferSamples,
const int32  InNumChannels,
const int32  InBufferSampleRate 
)

◆ SetPitch()

void Audio::FSampleBufferReader::SetPitch ( const float  InPitch,
const float  InterpolationTimeSec = 0.0f 
)

◆ SetScrubMode()

void Audio::FSampleBufferReader::SetScrubMode ( const bool  bInIsScrubMode)

◆ SetScrubTimeWidth()

void Audio::FSampleBufferReader::SetScrubTimeWidth ( const float  InScrubTimeWidthSec)

◆ UpdateScrubMinAndMax()

void Audio::FSampleBufferReader::UpdateScrubMinAndMax ( )
protected

◆ UpdateSeekFrame()

void Audio::FSampleBufferReader::UpdateSeekFrame ( )
protected

Member Data Documentation

◆ AlphaLerp

double Audio::FSampleBufferReader::AlphaLerp
protected

◆ BasePitch

float Audio::FSampleBufferReader::BasePitch
protected

◆ bIsFinished

bool Audio::FSampleBufferReader::bIsFinished
protected

◆ bIsScrubMode

bool Audio::FSampleBufferReader::bIsScrubMode
protected

◆ BufferNumChannels

int32 Audio::FSampleBufferReader::BufferNumChannels
protected

◆ BufferNumFrames

int32 Audio::FSampleBufferReader::BufferNumFrames
protected

◆ BufferNumSamples

int32 Audio::FSampleBufferReader::BufferNumSamples
protected

◆ BufferPtr

const int16* Audio::FSampleBufferReader::BufferPtr
protected

◆ BufferSampleRate

int32 Audio::FSampleBufferReader::BufferSampleRate
protected

◆ bWrap

bool Audio::FSampleBufferReader::bWrap
protected

◆ CurrentBufferFrameIndexInterpolated

double Audio::FSampleBufferReader::CurrentBufferFrameIndexInterpolated
protected

◆ CurrentFrameIndex

int32 Audio::FSampleBufferReader::CurrentFrameIndex
protected

◆ CurrentScrubWidthSec

float Audio::FSampleBufferReader::CurrentScrubWidthSec
protected

◆ CurrentSeekTime

float Audio::FSampleBufferReader::CurrentSeekTime
protected

◆ CurrentSeekType

ESeekType::Type Audio::FSampleBufferReader::CurrentSeekType
protected

◆ DeviceSampleRate

float Audio::FSampleBufferReader::DeviceSampleRate
protected

◆ FadeFrames

int32 Audio::FSampleBufferReader::FadeFrames
protected

◆ FadeIncrement

float Audio::FSampleBufferReader::FadeIncrement
protected

◆ FadeValue

float Audio::FSampleBufferReader::FadeValue
protected

◆ NextFrameIndex

int32 Audio::FSampleBufferReader::NextFrameIndex
protected

◆ Pitch

Audio::FLinearEase Audio::FSampleBufferReader::Pitch
protected

◆ PitchScale

float Audio::FSampleBufferReader::PitchScale
protected

◆ PlaybackProgress

float Audio::FSampleBufferReader::PlaybackProgress
protected

◆ ScrubAnchorFrame

double Audio::FSampleBufferReader::ScrubAnchorFrame
protected

◆ ScrubMaxFrame

double Audio::FSampleBufferReader::ScrubMaxFrame
protected

◆ ScrubMinFrame

double Audio::FSampleBufferReader::ScrubMinFrame
protected

◆ ScrubWidthFrames

double Audio::FSampleBufferReader::ScrubWidthFrames
protected
The documentation for this class was generated from the following files: