Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FBaseChannelFormatConverter

[FBaseChannelFormatConverter](API\Runtime\SignalProcessing\DSP\FBaseChannelFormatConverter) implements channel conversion using a simple mixing matrix.

Windows

MacOS

Linux

Inheritance Hierarchy

IChannelFormatConverter

FBaseChannelFormatConverter

References

Module	SignalProcessing
Header	/Engine/Source/Runtime/SignalProcessing/Public/DSP/AudioChannelFormatConverter.h
Include	#include "DSP/AudioChannelFormatConverter.h"

Syntax

class FBaseChannelFormatConverter : public Audio::IChannelFormatConverter

Remarks

FBaseChannelFormatConverter implements channel conversion using a simple mixing matrix.

Constructors

	Name	Description
	FBaseChannelFormatConverter ( const FInputFormat& InInputFormat, const FOutputFormat& InOutputForma..., TArrayView< const FChannelMixEntry ..., int32 InNumFramesPerCall )

Destructors

	Name	Description
	~FBaseChannelFormatConverter()

Functions

	Name	Description
TUniquePtr< ...	CreateBaseFormatConverter ( const FInputFormat& InInputFormat, const FOutputFormat& InOutputForma..., TArrayView< const FChannelMixEntry ..., int32 InNumFramesPerCall )	Create a FBaseChannelFormatConverter
float	GetTargetMixGain ( int32 InInputChannelIndex, int32 InOutputChannelIndex )	Returns the scalar gain used to mix the input channel index into the output channel index.
float	GetTargetOutputGain()	Returns the scalar gain applied to the output audio.
void	SetMixGain ( const FChannelMixEntry& InEntry, bool bFadeToGain )	Sets the gain scalar to apply to a specific input/output channel pair.
void	SetMixGain ( int32 InInputChannelIndex, int32 InOutputChannelIndex, float InGain, bool bFadeToGain )	Sets the gain scalar to apply to a specific input/output channel pair.
void	SetOutputGain ( float InOutputGain, bool bFadeToGain )	Sets the output gain scalar to apply to all output audio.

Overridden from IChannelFormatConverter

	Name	Description
const FInput...	GetInputFormat()	Return the input format handled by this converter.
const FOutpu...	GetOutputFormat()	Return the output format handled by this converter.
void	ProcessAudio ( const TArray< AlignedFloatBuffer > ..., TArray< AlignedFloatBuffer >& OutO... )	Converter the audio format from the FInputFormat to the FOutputFormat.

Classes

	Name	Description
	FChannelMixEntry	FChannelMixEntry denotes how an input channel should be mixed into an output channel.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss