VJ Master 1.0
Real-time audio analysis and visualisation.
Loading...
Searching...
No Matches
UST_AudioVisSettings Class Reference

Audio Visualisation Settings class used for managing audio visualisation parameters. More...

#include <ST_AudioVisSettings.h>

Static Public Member Functions

static const UST_AudioVisSettingsGetST_AudioVisSettings ()

Public Attributes

int32 Material_AudioIOs = 0
bool bBindAudioSceneToWorld = false
FFreqWaveformDisplay FreqWaveformDisplay
FAmpWaveformDisplay AmpWaveformDisplay
FPitchWaveformDisplay PitchWaveformDisplay
FVisAudioReactiveBoidsData VisAudioReactiveBoidsData
FVisNiagaraBeatDetection VisBeatDetection
FVisMPCData VisMPCData
FVisDMX VisDMX
FVisMIDIControlled VisMIDIControlled
FVisNiagaraFrequency VisNiagaraFrequency

Protected Member Functions

virtual FName GetCategoryName () const override

Detailed Description

Audio Visualisation Settings class used for managing audio visualisation parameters.

Audio Visualisation Settings class used for managing audio visualisation parameters. This class is derived from UDeveloperSettings and holds various settings related to audio visualisation.

Settings are loaded from a default config file and can be edited in the editor.

Member Function Documentation

◆ GetCategoryName()

virtual FName UST_AudioVisSettings::GetCategoryName ( ) const
inlineoverrideprotectedvirtual

Returns the category name for these settings in the editor.

Returns
The category name ("ShaderTech").

◆ GetST_AudioVisSettings()

const UST_AudioVisSettings * UST_AudioVisSettings::GetST_AudioVisSettings ( )
inlinestatic

Retrieves the default audio visualisation settings instance.

Returns
The default audio visualisation settings object.

Member Data Documentation

◆ AmpWaveformDisplay

FAmpWaveformDisplay UST_AudioVisSettings::AmpWaveformDisplay

Amplitude waveform display settings for visualisation.

◆ bBindAudioSceneToWorld

bool UST_AudioVisSettings::bBindAudioSceneToWorld = false

Bind audio scene to the world. If true, the the audio scene responsible for preparing data for material expressions will register/deregister IOs on world delegates. If false, you will manually have to tell the audio scene when to register/deregister IOs. Requires editor restart when changed. @meta (EditorRestartRequired)

◆ FreqWaveformDisplay

FFreqWaveformDisplay UST_AudioVisSettings::FreqWaveformDisplay

Frequency waveform display settings for visualisation.

◆ Material_AudioIOs

int32 UST_AudioVisSettings::Material_AudioIOs = 0

Specifies the audio input/output types associated with the material. This is a bitmask and will require editor restart when changed. @meta (EditorRestartRequired)

◆ PitchWaveformDisplay

FPitchWaveformDisplay UST_AudioVisSettings::PitchWaveformDisplay

Pitch waveform display settings for visualisation.

◆ VisAudioReactiveBoidsData

FVisAudioReactiveBoidsData UST_AudioVisSettings::VisAudioReactiveBoidsData

Data for audio-reactive boid visualisation.

◆ VisBeatDetection

FVisNiagaraBeatDetection UST_AudioVisSettings::VisBeatDetection

Beat detection settings for visualisation using Niagara.

◆ VisDMX

FVisDMX UST_AudioVisSettings::VisDMX

DMX settings for visualisation.

◆ VisMIDIControlled

FVisMIDIControlled UST_AudioVisSettings::VisMIDIControlled

MIDI control settings for visualisation.

◆ VisMPCData

FVisMPCData UST_AudioVisSettings::VisMPCData

Material parameter collection data for visualisation.

◆ VisNiagaraFrequency

FVisNiagaraFrequency UST_AudioVisSettings::VisNiagaraFrequency

Frequency data settings for Niagara visualisation.


The documentation for this class was generated from the following file:
  • H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Public/Main/ST_AudioVisSettings.h