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

#include <AudioChannelFormatConverter.h>

+ Inheritance diagram for Audio::IChannelFormatConverter:

Classes

struct  FInputFormat
 
struct  FOutputFormat
 

Public Member Functions

virtual ~IChannelFormatConverter ()=default
 
virtual const FInputFormatGetInputFormat () const =0
 
virtual const FOutputFormatGetOutputFormat () const =0
 
virtual void ProcessAudio (const TArray< FAlignedFloatBuffer > &InInputBuffers, TArray< FAlignedFloatBuffer > &OutOutputBuffers)=0
 

Detailed Description

Inteface for Channel Format Converters which process deinterleaved audio.

Constructor & Destructor Documentation

◆ ~IChannelFormatConverter()

virtual Audio::IChannelFormatConverter::~IChannelFormatConverter ( )
virtualdefault

Member Function Documentation

◆ GetInputFormat()

virtual const FInputFormat & Audio::IChannelFormatConverter::GetInputFormat ( ) const
pure virtual

Return the input format handled by this converter.

Implemented in Audio::FBaseChannelFormatConverter.

◆ GetOutputFormat()

virtual const FOutputFormat & Audio::IChannelFormatConverter::GetOutputFormat ( ) const
pure virtual

Return the output format handled by this converter.

Implemented in Audio::FBaseChannelFormatConverter.

◆ ProcessAudio()

virtual void Audio::IChannelFormatConverter::ProcessAudio ( const TArray< FAlignedFloatBuffer > &  InInputBuffers,
TArray< FAlignedFloatBuffer > &  OutOutputBuffers 
)
pure virtual

Converter the audio format from the FInputFormat to the FOutputFormat.

The input buffer array must have the same number of channels as the FInputFormat return from GetInputFormat(). Each buffer within that array must have the same number of samples.

Parameters
InInputBuffers- An array of input audio buffers.
OutOutputBuffers- An array of buffers where output audio is stored.

Implemented in Audio::FBaseChannelFormatConverter.


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