UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::ISampleRateConverter Class Referenceabstract

#include <SampleRateConverter.h>

+ Inheritance diagram for Audio::ISampleRateConverter:

Public Member Functions

virtual ~ISampleRateConverter ()
 
virtual void Init (const float InSampleRateRatio, const int32 InNumChannels)=0
 
virtual void SetSampleRateRatio (const float InSampleRateRatio, const int32 NumInterpolationFrames=0)=0
 
virtual int32 ProcessFullbuffer (const int16 *InBuffer, const int32 InNumSamples, TArray< float > &OutBuffer)=0
 
virtual int32 ProcessFullbuffer (const float *InBuffer, const int32 InNumSamples, TArray< float > &OutBuffer)=0
 
virtual int32 ProcessChunk (const int16 *BufferChunk, const int32 NumInputSamples, const int32 RequestedFrames, TArray< float > &OutBuffer)=0
 
virtual int32 ProcessChunk (const float *BufferChunk, const int32 NumInputSamples, const int32 RequestedFrames, TArray< float > &OutBuffer)=0
 

Static Public Member Functions

static SIGNALPROCESSING_API ISampleRateConverterCreateSampleRateConverter ()
 

Constructor & Destructor Documentation

◆ ~ISampleRateConverter()

virtual Audio::ISampleRateConverter::~ISampleRateConverter ( )
inlinevirtual

Member Function Documentation

◆ CreateSampleRateConverter()

ISampleRateConverter * Audio::ISampleRateConverter::CreateSampleRateConverter ( )
static

◆ Init()

virtual void Audio::ISampleRateConverter::Init ( const float  InSampleRateRatio,
const int32  InNumChannels 
)
pure virtual

Implemented in Audio::FSampleRateConverter.

◆ ProcessChunk() [1/2]

virtual int32 Audio::ISampleRateConverter::ProcessChunk ( const float BufferChunk,
const int32  NumInputSamples,
const int32  RequestedFrames,
TArray< float > &  OutBuffer 
)
pure virtual

Implemented in Audio::FSampleRateConverter.

◆ ProcessChunk() [2/2]

virtual int32 Audio::ISampleRateConverter::ProcessChunk ( const int16 BufferChunk,
const int32  NumInputSamples,
const int32  RequestedFrames,
TArray< float > &  OutBuffer 
)
pure virtual

Process chunks of audio at a time. Saves state so can properly handle buffer boundaries. Use with Reset() to reset internal state before starting realtime SRC.

Parameters
BufferChunkInput audio buffer chunk
NumInputSamplesNumber of input samples.
RequestedFramesNumber of frames requested to process
OutBufferThe output buffer of converted audio.
Returns
Number of frames generated.

Implemented in Audio::FSampleRateConverter.

◆ ProcessFullbuffer() [1/2]

virtual int32 Audio::ISampleRateConverter::ProcessFullbuffer ( const float InBuffer,
const int32  InNumSamples,
TArray< float > &  OutBuffer 
)
pure virtual

Implemented in Audio::FSampleRateConverter.

◆ ProcessFullbuffer() [2/2]

virtual int32 Audio::ISampleRateConverter::ProcessFullbuffer ( const int16 InBuffer,
const int32  InNumSamples,
TArray< float > &  OutBuffer 
)
pure virtual

Given an input buffer, the output buffer is fully sample-rate converted.

Parameters
InBufferInput audio buffer
InNumSamplesNumber of input samples.
OutBufferThe output buffer of converted audio.
Returns
Number of frames generated.

Implemented in Audio::FSampleRateConverter.

◆ SetSampleRateRatio()

virtual void Audio::ISampleRateConverter::SetSampleRateRatio ( const float  InSampleRateRatio,
const int32  NumInterpolationFrames = 0 
)
pure virtual

Implemented in Audio::FSampleRateConverter.


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