UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | List of all members
Audio::IConvertDeinterleave Struct Referenceabstract

#include <ConvertDeinterleave.h>

+ Inheritance diagram for Audio::IConvertDeinterleave:

Public Member Functions

virtual ~IConvertDeinterleave ()=default
 
virtual void ProcessAudio (TArrayView< const float > InSamples, FMultichannelBuffer &OutSamples) const =0
 

Static Public Member Functions

static SIGNALPROCESSING_API TUniquePtr< IConvertDeinterleave > Create (const FConvertDeinterleaveParams &InParams)
 

Detailed Description

IConvertDeinterleave is an interface for transforming multichannel interleaved audio samples into multichannel deinterleaved samples. The channel count of the input and output audio may differ.

The deinterleaving and channel format conversion operations are combined into this single object as both operations are often required for any given source audio.

Constructor & Destructor Documentation

◆ ~IConvertDeinterleave()

virtual Audio::IConvertDeinterleave::~IConvertDeinterleave ( )
virtualdefault

Member Function Documentation

◆ Create()

TUniquePtr< IConvertDeinterleave > Audio::IConvertDeinterleave::Create ( const FConvertDeinterleaveParams &  InParams)
static

Create an IConvertDeinterleave object for a given number of input and output channels.

Parameters
InNumInputChannels- Number of input channels in incoming audio.
InNumOutputChannels- Number of output channels in outgoing audio.
Returns
A valid TUniquePtr<> on success, an invalid TUniquePtr<> on failure.

◆ ProcessAudio()

virtual void Audio::IConvertDeinterleave::ProcessAudio ( TArrayView< const float >  InSamples,
FMultichannelBuffer &  OutSamples 
) const
pure virtual

Deinterleave and convert the channel format of the input audio.

Parameters
InSamples- ArrayView of interleaved input samples. The number of samples must be evenly divisible by the number of input channels.
OutSamples- A multichannel buffer of samples generated by deinterleaving the input samples and possibly upmixing or downmixing them to the target channel count.

Implemented in Audio::ConvertDeinterleavePrivate::TConvertDeinterleave< 1, 1 >, Audio::ConvertDeinterleavePrivate::TConvertDeinterleave< NumInputChannels, NumOutputChannels >, and Audio::ConvertDeinterleavePrivate::TConvertDeinterleave< 1, NumOutputChannels >.

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