1. Epic GamesDeveloper
  3. FBaseChannelFormatConverter

FBaseChannelFormatConverter

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

API > API/Runtime > API/Runtime/SignalProcessing > API/Runtime/SignalProcessing/DSP

Inheritance Hierarchy

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

  Type Name Description
Protected function  

FBaseChannelFormatConverter ( const FInputFormat& InInputFormat,
const FOutputFormat& InOutputFormat,
TArrayView< const FChannelMixEntry > InMixEntries,
int32 InNumFramesPerCall
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Static TUniquePtr< FBaseChannelFormatConverter >

CreateBaseFormatConverter ( const FInputFormat& InInputFormat,
const FOutputFormat& InOutputFormat,
TArrayView< const FChannelMixEntry > InMixEntries,
int32 InNumFramesPerCall
)

 Create a FBaseChannelFormatConverter
Public function Const float

GetTargetMixGain ( int32 InInputChannelIndex,
int32 InOutputChannelIndex
)

 Returns the scalar gain used to mix the input channel index into the output channel index.
Public function Const float Returns the scalar gain applied to the output audio.
Public function void

SetMixGain ( const FChannelMixEntry& InEntry,
bool bFadeToGain
)

 Sets the gain scalar to apply to a specific input/output channel pair.
Public function void

SetMixGain ( int32 InInputChannelIndex,
int32 InOutputChannelIndex,
float InGain,
bool bFadeToGain
)

 Sets the gain scalar to apply to a specific input/output channel pair.
Public function void

SetOutputGain ( float InOutputGain,
bool bFadeToGain
)

 Sets the output gain scalar to apply to all output audio.

Overridden from IChannelFormatConverter

  Type Name Description
Public function Virtual Const const FInputFormat & Return the input format handled by this converter.
Public function Virtual Const const FOutputFormat & Return the output format handled by this converter.
Public function Virtual void

ProcessAudio ( const TArray< FAlignedFloatBuffer >& InInputBuffers,
TArray< FAlignedFloatBuffer >& OutOutputBuffers
)

 Converter the audio format from the FInputFormat to the FOutputFormat.

Classes

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page