USynthComponentToneGenerator

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Synthesis

Header

/Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Classes/SynthComponents/SynthComponentToneGenerator.h

Include

#include "SynthComponents/SynthComponentToneGenerator.h"

Syntax

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

Variables

Name Description

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

float

 

AttenuationDbAtMaxRange

An attenuation, in decibels, to apply to the sound at max range.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FRuntimeFloatCu...

 

DistanceAttenuationCurve

A distance attenuation curve to use to attenuate the audio.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FVector2D

 

DistanceRange

A distance range overwhich to apply distance attenuation using the supplied curve.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

float

 

Frequency

The frequency (in hz) of the tone generator.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

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

Name Description

Public function UFunction BlueprintCallable, Category

void

 

SetFrequency

(
    float InFrequency
)

Sets the frequency of the tone generator.

Public function UFunction BlueprintCallable, Category

void

 

SetVolume

(
    float InVolume
)

Sets the volume of the tone generator.

Overridden from USynthComponent

Name Description

Public function Virtual

ISoundGenera...

 

CreateSoundGenerator

(
    const FSoundGeneratorInitParams& I...
)

Implemented by the synth component to create a generator object instead of generating audio directly on the synth component.

Overridden from UActorComponent

Name Description

Public function Virtual

void

 

TickComponent

(
    float DeltaTime,
    enum ELevelTick TickType,
    FActorComponentTickFunction* T...
)

Tick this component to get the current position of the component to pass to the attenuator.