Navigation
Unreal Engine C++ API Reference > Plugins > Synthesis > SynthComponents
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UActorComponent
- USceneComponent
- USynthComponent
- USynthComponentToneGenerator
References
| Module | Synthesis |
| Header | /Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Classes/SynthComponents/SynthComponentToneGenerator.h |
| Include | #include "SynthComponents/SynthComponentToneGenerator.h" |
Syntax
UCLASS&40;ClassGroup&61;Synth, Meta&61;&40;BlueprintSpawnableComponent&41;&41;
class USynthComponentToneGenerator : public USynthComponent
Variables
| Type | Name | Description | |
|---|---|---|---|
    |
float | AttenuationDbAtMaxRange | An attenuation, in decibels, to apply to the sound at max range. |
    |
FRuntimeFloatCurve | DistanceAttenuationCurve | A distance attenuation curve to use to attenuate the audio. |
    |
FVector2D | DistanceRange | A distance range over which to apply distance attenuation using the supplied curve. |
    |
float | Frequency | The frequency (in hz) of the tone generator. |
    |
float | Volume | The linear volume of the tone generator. |
Constructors
No constructors are accessible with public or protected access.
Destructors
No destructors are accessible with public or protected access.
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
void | SetFrequency
(
float InFrequency |
Sets the frequency of the tone generator. |
   |
void | SetVolume
(
float InVolume |
Sets the volume of the tone generator. |
Overridden from USynthComponent
| Type | Name | Description | |
|---|---|---|---|
  |
ISoundGeneratorPtr | CreateSoundGenerator
(
const FSoundGeneratorInitParams& InParams |
Implemented by the synth component to create a generator object instead of generating audio directly on the synth component. |
Overridden from UActorComponent
| Type | Name | Description | |
|---|---|---|---|
  |
void | TickComponent
(
float DeltaTime, |
Tick this component to get the current position of the component to pass to the attenuator. |