Language:
Discover
By Skill Level
By Category

USynthComponent

Choose your OS:

Inheritance Hierarchy

Syntax

class USynthComponent : public USceneComponent

Variables

Name Description

Public variable

FSoundAttenuati ...

 

AttenuationOverrides

If bOverrideSettings is true, the attenuation properties to use for sounds generated by this component

Public variable

USoundAttenuati ...

 

AttenuationSettings

If bOverrideSettings is false, the asset to use to determine attenuation properties for sounds generated by this component

Public variable

uint8 : 1

 

bAllowSpatialization

Is this audio component allowed to be spatialized?

Public variable

uint8 : 1

 

bAutoDestroy

Auto destroy this component on completion

Public variable

uint8 : 1

 

bIsUISound

Whether or not this sound plays when the game is paused in the UI

Public variable

uint8 : 1

 

bOverrideAttenuation

Should the Attenuation Settings asset be used (false) or should the properties set directly on the component be used for attenuation properties

Public variable

uint8 : 1

 

bStopWhenOwnerDestroyed

Stop sound when owner is destroyed

Public variable

USoundConcurren ...

 

ConcurrencySettings

What sound concurrency to use for sounds generated by this audio component

Protected variable

int32

 

NumChannels

Can be set by the derived class, defaults to 2.

Public variable

USoundClass ...

 

SoundClass

Sound class this sound belongs to

Public variable

USoundSubmix &#...

 

SoundSubmix

Submix this sound belongs to

Public variable

TArray < FSoundS ...

 

SoundSubmixSends

An array of submix sends. Audio from this sound will send a portion of its audio to these effects.

Public variable

USoundEffectSou ...

 

SourceEffectChain

The source effect chain to use for this sound.

Constructors

Name Description

Public function

USynthComponent

(
    const FObjectInitializer & ObjectIn...
)

Functions

Name Description

Public function

UAudioCompon ...

 

GetAudioComponent()

Retrieves this synth component's audio component.

Protected function

FAudioDevice ...

 

GetAudioDevice()

Gets the audio device associated with this synth component.

Protected function Virtual

void

 

Init

(
    const int32 SampleRate
)

Called when synth is created.

Public function

void

 

Initialize()

Call if creating this synth component not via an actor component in BP, but in code or some other location.

Public function

bool

 

IsPlaying()

Returns true if this component is currently playing.

Protected function Virtual

void

 

OnGenerateAudio

(
    float* OutAudio,
    int32 NumSamples
)

Called when more audio is needed to be generated.

Protected function

void

 

OnGeneratePCMAudio

(
    float* GeneratedPCMData,
    int32 NumSamples
)

Called by procedural sound wave.

Protected function Virtual

void

 

OnStart()

Called when synth is about to start playing.

Protected function Virtual

void

 

OnStop()

Called when synth is about to stop playing.

Public function

void

 

SetSubmixSend

(
    USoundSubmix * Submix,
    float SendLevel
)

Sets how much audio the sound should send to the given submix.

Public function

void

 

Start()

WITH_EDITOR.

Public function

void

 

Stop()

Stops the synth generating audio.

Protected function

void

 

SynthCommand

(
    TFunction < void()> Command
)

Method to execute parameter changes on game thread in audio render thread.

Overridden from UActorComponent

Name Description

Public function Virtual

void

 

Activate

(
    bool bReset
)

Activates the SceneComponent

Public function Virtual

void

 

Deactivate()

Deactivates the SceneComponent.

Public function Virtual

bool

 

IsReadyForOwnerToAutoDestroy()

Overridable check for a component to indicate to its Owner that it should prevent the Actor from auto destroying when finished

Public function Virtual

void

 

OnRegister()

WITH_EDITOR.

Public function Virtual

void

 

OnUnregister()

Called when a component is unregistered.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent & PropertyCha...
)

Called when a property on this object has been modified externally

Enums

Name

Description

Private enum

ESynthEvent

References

Module

AudioMixer

Header

Runtime/AudioMixer/Public/Components/SynthComponent.h