USynthComponentToneGenerator | Unreal Engine 5.7 Documentation


Name	USynthComponentToneGenerator
Type	class
Header File	/Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Classes/SynthComponents/SynthComponentToneGenerator.h
Include Path	#include "SynthComponents/SynthComponentToneGenerator.h"

Syntax

UCLASS (MinimalAPI, ClassGroup=Synth, Meta=(BlueprintSpawnableComponent))  
class USynthComponentToneGenerator : public USynthComponent

Name	Remarks	Include Path	Unreal Specifiers
USynthComponentToneGenerator ( const FObjectInitializer& ObjInitializer )		SynthComponents/SynthComponentToneGenerator.h

Name	Remarks	Include Path	Unreal Specifiers
virtual ~USynthComponentToneGenerator()		SynthComponents/SynthComponentToneGenerator.h

Name	Type	Remarks	Include Path	Unreal Specifiers
AttenuationDbAtMaxRange	float	An attenuation, in decibels, to apply to the sound at max range.	SynthComponents/SynthComponentToneGenerator.h	EditAnywhere BlueprintReadWrite Category=Attenuation
DistanceAttenuationCurve	FRuntimeFloatCurve	A distance attenuation curve to use to attenuate the audio.	SynthComponents/SynthComponentToneGenerator.h	EditAnywhere BlueprintReadWrite Category=Attenuation
DistanceRange	FVector2D	A distance range over which to apply distance attenuation using the supplied curve.	SynthComponents/SynthComponentToneGenerator.h	EditAnywhere BlueprintReadWrite Category=Attenuation
Frequency	float	The frequency (in hz) of the tone generator.	SynthComponents/SynthComponentToneGenerator.h	EditAnywhere BlueprintReadOnly Category="Tone Generator" Meta=(ClampMin="10.0", ClampMax="20000.0")
Volume	float	The linear volume of the tone generator.	SynthComponents/SynthComponentToneGenerator.h	EditAnywhere BlueprintReadOnly Category="Tone Generator" Meta=(ClampMin="0.0", ClampMax="1.0")

Name	Type	Remarks	Include Path	Unreal Specifiers
DistanceAttenuationSettings	Audio::FAudioBufferDistanceAttenuationSettings		SynthComponents/SynthComponentToneGenerator.h
ToneGenerator	ISoundGeneratorPtr		SynthComponents/SynthComponentToneGenerator.h

Name	Remarks	Include Path	Unreal Specifiers
virtual ISoundGeneratorPtr CreateSoundGenerator ( const FSoundGeneratorInitParams& InParams )		SynthComponents/SynthComponentToneGenerator.h
void SetFrequency ( float InFrequency )	Sets the frequency of the tone generator.	SynthComponents/SynthComponentToneGenerator.h	BlueprintCallable Category="Tone Generator"
void SetVolume ( float InVolume )	Sets the volume of the tone generator.	SynthComponents/SynthComponentToneGenerator.h	BlueprintCallable Category="Tone Generator"
virtual void TickComponent ( float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* ThisTickFunction )	Tick this component to get the current position of the component to pass to the attenuator.	SynthComponents/SynthComponentToneGenerator.h