Navigation
API > API/Runtime > API/Runtime/SignalProcessing
FBaseChannelFormatConverter implements channel conversion using a simple mixing matrix.
| Name | FBaseChannelFormatConverter |
| Type | class |
| Header File | /Engine/Source/Runtime/SignalProcessing/Public/DSP/AudioChannelFormatConverter.h |
| Include Path | #include "DSP/AudioChannelFormatConverter.h" |
Syntax
class FBaseChannelFormatConverter : public Audio::IChannelFormatConverter
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FBaseChannelFormatConverter
(
const FInputFormat& InInputFormat, |
DSP/AudioChannelFormatConverter.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FBaseChannelFormatConverter() |
DSP/AudioChannelFormatConverter.h |
Structs
| Name | Remarks |
|---|---|
| FChannelMixEntry | FChannelMixEntry denotes how an input channel should be mixed into an output channel. |
| FChannelMixKey | Channel mix key is used to lookup entries from a TSortedMap. |
| FChannelMixState | Channel mix entry holds current and next gain levels for a mix entry. |
| FOutputGainState | Output gain state holds current and next gain levels. |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ChannelMixStates | TSortedMap< FChannelMixKey, FChannelMixState > | DSP/AudioChannelFormatConverter.h | ||
| InputFormat | FInputFormat | The input audio format. | DSP/AudioChannelFormatConverter.h | |
| NumFramesPerCall | int32 | DSP/AudioChannelFormatConverter.h | ||
| OutputFormat | FOutputFormat | The output audio format. | DSP/AudioChannelFormatConverter.h | |
| OutputGainState | FOutputGainState | Gain states. | DSP/AudioChannelFormatConverter.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GetTargetMixGain
(
int32 InInputChannelIndex, |
Returns the scalar gain used to mix the input channel index into the output channel index. | DSP/AudioChannelFormatConverter.h | |
float GetTargetOutputGain () |
Returns the scalar gain applied to the output audio. | DSP/AudioChannelFormatConverter.h | |
void SetMixGain
(
const FChannelMixEntry& InEntry, |
Sets the gain scalar to apply to a specific input/output channel pair. | DSP/AudioChannelFormatConverter.h | |
void SetMixGain
(
int32 InInputChannelIndex, |
Sets the gain scalar to apply to a specific input/output channel pair. | DSP/AudioChannelFormatConverter.h | |
void SetOutputGain
(
float InOutputGain, |
Sets the output gain scalar to apply to all output audio. | DSP/AudioChannelFormatConverter.h |
Overridden from IChannelFormatConverter
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FInputFormat & GetInputFormat() |
Return the input format handled by this converter. | DSP/AudioChannelFormatConverter.h | |
virtual const FOutputFormat & GetOutputFormat() |
Return the output format handled by this converter. | DSP/AudioChannelFormatConverter.h | |
virtual void ProcessAudio
(
const TArray< FAlignedFloatBuffer >& InInputBuffers, |
Converter the audio format from the FInputFormat to the FOutputFormat. | DSP/AudioChannelFormatConverter.h |
Protected
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TUniquePtr< FBaseChannelFormatConverter > CreateBaseFormatConverter
(
const FInputFormat& InInputFormat, |
Create a FBaseChannelFormatConverter | DSP/AudioChannelFormatConverter.h |