UTimeSynthComponent

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

TimeSynth

Header

/Engine/Plugins/Runtime/TimeSynth/Source/TimeSynth/Classes/TimeSynthComponent.h

Include

#include "TimeSynthComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ClassGroup=Synth, Meta=(BlueprintSpawnableComponent))
class UTimeSynthComponent : public USynthComponent

Variables

Name Description

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

uint8: 1

 

bEnableSpectralAnalysis

Whether or not we are enabling spectrum analysis on the synth component. Enabling will result in FFT analysis being run.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

uint8: 1

 

bIsEnvelopeFollowerEnabled

Whether or not the filter is enabled.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

uint8: 1

 

bIsFilterAEnabled

Whether or not the filter A is enabled.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

uint8: 1

 

bIsFilterBEnabled

Whether or not the filter B is enabled.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

FTimeSynthEnvel...

 

EnvelopeFollowerSettings

The envelope follower settings to use.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

ETimeSynthFFTSi...

 

FFTSize

What FFT bin-size to use. Smaller makes it more time-reactive but less accurate in frequency space.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

FTimeSynthFilte...

 

FilterASettings

The filter settings to use for filter A.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

FTimeSynthFilte...

 

FilterBSettings

The filter settings to use for filter B.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

TArray< float >

 

FrequenciesToAnalyze

What frequencies to report magnitudes for during spectrum analysis.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

int32

 

MaxPoolSize

Set the Max Pool Size.

Public variable UProperty Category BlueprintAssignable

FOnTimeSynthPla...

 

OnPlaybackTime

Delegate to get continuous playback time in seconds.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FTimeSynthQuant...

 

QuantizationSettings

The default quantizations settings.

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, Meta

void

 

AddQuantizationEventDelegate

(
    ETimeSynthEventQuantization Quantiz...,
    const FOnQuantizationEventBP& OnQu...
)

Register an event to respond to a specific quantization event.

Public function Const UFunction BlueprintCallable, Category

int32

 

GetBPM()

Returns the current BPM of the time synth.

Public function Const UFunction BlueprintCallable, Category

float

 

GetEnvelopeFollowerValue()

Returns the current envelope follower value. Call at whatever rate desired.

Public function Const UFunction BlueprintCallable, Category

int32

 

GetMaxActiveClipLimit()

Public function Const UFunction BlueprintCallable, Category

TArray< FTim...

 

GetSpectralData()

Returns the spectral data if spectrum analysis is enabled.

Public function UFunction BlueprintCallable, Category, Meta

bool

 

HasActiveClips()

Check to see if clips are actively generating sound on the TimeSynth.

Public function UFunction BlueprintCallable, Category

FTimeSynthCl...

 

PlayClip

(
    UTimeSynthClip* InClip,
    UTimeSynthVolumeGroup* InVolum...
)

Plays the given clip using the global quantization setting.

Public function UFunction BlueprintCallable, Category

void

 

ResetSeed()

Resets the internal seed to it's current seed (allows repeating same random choices)

Public function UFunction BlueprintCallable, Category

void

 

SetBPM

(
    const float BeatsPerMinute
)

Sets just the BPM of the time synth on the next bar event.

Public function UFunction BlueprintCallable, Category, Meta

void

 

SetEnvelopeFollowerEnabled

(
    bool bInIsEnabled
)

Enables or disables the envelope follower.

Public function UFunction BlueprintCallable, Category, Meta

void

 

SetEnvelopeFollowerSettings

(
    const FTimeSynthEnvelopeFollowerSet...
)

Set the envelope follower settings.

Public function UFunction BlueprintCallable, Category, Meta

void

 

SetFFTSize

(
    ETimeSynthFFTSize InFFTSize
)

Sets the desired FFT Size for the spectrum analyzer.

Public function UFunction BlueprintCallable, Category, Meta

void

 

SetFilterEnabled

(
    ETimeSynthFilter Filter,
    bool bIsEnabled
)

Enables or disables the filter.

Public function UFunction BlueprintCallable, Category, Meta

void

 

SetFilterSettings

(
    ETimeSynthFilter Filter,
    const FTimeSynthFilterSettings& In...
)

Set the filter settings for the filter at the particular index.

Public function UFunction BlueprintCallable, Category

void

 

SetQuantizationSettings

(
    const FTimeSynthQuantizationSetting...
)

Sets the quantization settings on the time synth.

Public function UFunction BlueprintCallable, Category

void

 

SetSeed

(
    int32 InSeed
)

Sets the seed of the internal random stream so choices can be repeated or controlled.

Public function UFunction BlueprintCallable, Category

void

 

SetVolumeGroup

(
    UTimeSynthVolumeGroup* InVolum...,
    float VolumeDb,
    float FadeTimeSec
)

Sets the volume (in dB) of the given volume group over the supplied FadeTime.

Public function UFunction BlueprintCallable, Category

void

 

StopClip

(
    FTimeSynthClipHandle InClipHandle,
    ETimeSynthEventClipQuantization Eve...
)

Stops the clip on the desired quantization boundary with given fade time. Uses clip's fade time.

Public function UFunction BlueprintCallable, Category

void

 

StopClipWithFadeOverride

(
    FTimeSynthClipHandle InClipHandle,
    ETimeSynthEventClipQuantization Eve...,
    const FTimeSynthTimeDef& FadeTime
)

Stops the clip on the desired quantization boundary with given fade time. Overrides the clip's fade time.

Public function UFunction BlueprintCallable, Category

void

 

StopSoundsOnVolumeGroup

(
    UTimeSynthVolumeGroup* InVolum...,
    ETimeSynthEventClipQuantization Eve...
)

Stops clips playing on given volume group. Clips use their fade time.

Public function UFunction BlueprintCallable, Category

void

 

StopSoundsOnVolumeGroupWithFadeOverride

(
    UTimeSynthVolumeGroup* InVolum...,
    ETimeSynthEventClipQuantization Eve...,
    const FTimeSynthTimeDef& FadeTime
)

Stops clips playing on given volume group with the given fade time override.

Typedefs

Name

Description

VolumeGroupUniqueId

Defines type for a volume group ID.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss