FEncoderConfig Struct Reference

Structure that holds configuration for audio encoding. More...

#include <ST_AudioProcessingSettings.h>

Public Member Functions
	FEncoderConfig (const FAudioIOConfig &BaseConfig)
	Constructs an encoder configuration from a base audio I/O configuration.

Public Attributes
bool	bCanWriteToFile = false
	Whether or not the audio can be written to a file. @meta (SessionRestartRequired)
EST_AudioFileLocation	AudioFileLocation = EST_AudioFileLocation::ProjectPluginsDir
	Where the OutputFilePath Should start. @meta (SessionRestartRequired, EditCondition = "bCanWriteToFile")
FString	OutputFilePath = "ST_VJMaster/ExampleAudio/VJMaster_ExampleWrite.wav"
	Path to the output file where audio will be written, only if bCanWriteToFile is true. @meta (SessionRestartRequired, EditCondition = "bCanWriteToFile")
EST_EncodingFormat	EncodingFormat = EST_EncodingFormat::WAV
	The encoding format to be used for the audio output.
EST_SampleFormat	SampleFormat = EST_SampleFormat::F32
	The sample format for the audio data.
int32	Channels = 2
	The number of audio channels (e.g., 1 for mono, 2 for stereo). @meta (SessionRestartRequired)
int32	SampleRate = 24000
	The sample rate of the audio (e.g., 48000, 44100). @meta (SessionRestartRequired)
Public Attributes inherited from FAudioIOConfig
FString	DeviceName = "[System Default]"
	The name of the audio device. Defaults to "[System Default]" if not specified. @meta (SessionRestartRequired)
FFFTConfig	FFTConfig
	FFT configuration settings.

Detailed Description

Structure that holds configuration for audio encoding.

Constructor & Destructor Documentation

FEncoderConfig()

FEncoderConfig::FEncoderConfig ( const FAudioIOConfig & BaseConfig )

inline

Constructs an encoder configuration from a base audio I/O configuration.

Parameters

BaseConfig

The base audio configuration to copy.

Copies all fields from FAudioIOConfig into this FEncoderConfig.

Member Data Documentation

EncodingFormat

EST_EncodingFormat FEncoderConfig::EncodingFormat = EST_EncodingFormat::WAV

The encoding format to be used for the audio output.

See also

EST_EncodingFormat @meta (SessionRestartRequired)

SampleFormat

EST_SampleFormat FEncoderConfig::SampleFormat = EST_SampleFormat::F32

The sample format for the audio data.

See also

EST_SampleFormat @meta (SessionRestartRequired)

---

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

• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioProcessing/Public/Main/ST_AudioProcessingSettings.h