1. Epic GamesDeveloper
  3. USynthComponent

USynthComponent

Unreal Engine C++ API Reference > Runtime > AudioMixer > Components

Inheritance Hierarchy

References

   
Module AudioMixer
Header /Engine/Source/Runtime/AudioMixer/Public/Components/SynthComponent.h
Include #include "Components/SynthComponent.h"

Syntax

class USynthComponent : public USceneComponent

Variables

  Type Name Description
Public variable FSoundAttenuationSettings AttenuationOverrides If bOverrideSettings is true, the attenuation properties to use for sounds generated by this component
Public variable TObjectPtr< class USoundAttenuation > 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 bAlwaysPlay Whether to artificially prioritize the component to play
Public variable uint8: 1 bAutoDestroy Auto destroy this component on completion
Public variable uint32: 1 bEnableBaseSubmix If enabled, sound will route to the Master Submix by default or to the Base Submix if defined.
Public variable uint32: 1 bEnableBusSends Whether or not to enable sending this audio's output to buses.
Public variable uint32: 1 bEnableSubmixSends Whether or not to enable Submix Sends other than the Base Submix.
Public variable uint8: 1 bIsPreviewSound Whether or not this synth is playing as a preview sound
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 TArray< FSoundSourceBusSendInfo > BusSends This sound will send its audio output to this list of buses if there are bus instances playing after source effects are processed.
Public variable TSet< TObjectPtr< USoundConcurrency > > ConcurrencySet What sound concurrency to use for sounds generated by this audio component
Public variable int32 EnvelopeFollowerAttackTime The attack time in milliseconds for the envelope follower.
Public variable int32 EnvelopeFollowerReleaseTime The release time in milliseconds for the envelope follower.
Public variable FSoundModulationDefaultRoutingSettings ModulationRouting  
Protected variable int32 NumChannels Can be set by the derived class, defaults to 2.
Public variable FOnSynthEnvelopeValue OnAudioEnvelopeValue  
Public variable FOnSynthEnvelopeValueNative OnAudioEnvelopeValueNative Shadow delegate for non UObject subscribers
Public variable TArray< FSoundSourceBusSendInfo > PreEffectBusSends This sound will send its audio output to this list of buses if there are bus instances playing before source effects are processed.
Protected variable int32 PreferredBufferLength Can be set by the derived class- sets the preferred callback size for the synth component.
Public variable TObjectPtr< USoundClass > SoundClass Sound class this sound belongs to
Public variable TObjectPtr< USoundSubmixBase > SoundSubmix Submix this sound belongs to
Public variable TArray< FSoundSubmixSendInfo > SoundSubmixSends An array of submix sends. Audio from this sound will send a portion of its audio to these effects.
Public variable TObjectPtr< USoundEffectSourcePresetChain > SourceEffectChain The source effect chain to use for this sound.

Constructors

  Type Name Description
Public function  

USynthComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

AddAudioBufferListener ( IAudioBufferListener* InAudioBufferListener
)

 Adds and removes audio buffer listener.
Public function Const void

AdjustVolume ( float AdjustVolumeDuration,
float AdjustVolumeLevel,
const EAudioFaderCurve FadeCurve
)

 This function allows designers to trigger an adjustment to the sound instance’s playback Volume with options for smoothly applying a curve over time.
Public function void Creates the audio component if it hasn't already been created yet.
Protected function Virtual ISoundGeneratorPtr Implemented by the synth component to create a generator object instead of generating audio directly on the synth component.
Public function Const void

FadeIn ( float FadeInDuration,
float FadeVolumeLevel,
float StartTime,
const EAudioFaderCurve FadeCurve
)

 This function allows designers to call Play on an Audio Component instance while applying a volume curve over time.
Public function Const void

FadeOut ( float FadeOutDuration,
float FadeVolumeLevel,
const EAudioFaderCurve FadeCurve
)

 This function allows designers to call a delayed Stop on an Audio Component instance while applying a volume curve over time.
Public function UAudioComponent * Retrieves this synth component's audio component.
Protected function Const FAudioDevice * Gets the audio device associated with this synth component.
Public function TSet< USoundModulatorBase * >

GetModulators ( const EModulationDestination Destination
)

 Gets the set of currently active modulators for a given Modulation Destination.
Public function Virtual USoundClass *  
Protected function Virtual bool

Init ( int32& SampleRate
)

 Called when synth is created.
Public function void

Initialize ( int32 SampleRateOverride
)

 Call if creating this synth component not via an actor component in BP, but in code or some other location.
Public function Const bool Returns true if this component is currently playing.
Public function void

OnAudioComponentEnvelopeValue ( const UAudioComponent* AudioComponent,
const USoundWave* SoundWave,
const float EnvelopeValue
)

  
Protected function Virtual void Called when the synth component begins generating audio in render thread.
Protected function Virtual void Called when the synth has finished generating audio on the render thread.
Protected function Virtual int32

OnGenerateAudio ( float* OutAudio,
int32 NumSamples
)

 Called when more audio is needed to be generated This method of generating audio is soon to be deprecated.
Protected function int32

OnGeneratePCMAudio ( float* GeneratedPCMData,
int32 NumSamples
)

 Called by procedural sound wave Returns the number of samples actually generated
Public function void

RemoveAudioBufferListener ( IAudioBufferListener* InAudioBufferListener
)

  
Public function void

SetAudioBusSendPostEffect ( UAudioBus* AudioBus,
float AudioBusSendLevel
)

 Sets how much audio the sound should send to the given AudioBus (post effect).
Public function void

SetAudioBusSendPreEffect ( UAudioBus* AudioBus,
float AudioBusSendLevel
)

 Sets how much audio the sound should send to the given AudioBus (pre effect).
Public function void

SetLowPassFilterEnabled ( bool InLowPassFilterEnabled
)

 Sets whether or not the low pass filter is enabled on the audio component.
Public function Virtual void

SetLowPassFilterFrequency ( float InLowPassFilterFrequency
)

 Sets lowpass filter frequency of the audio component.
Public function void

SetModulationRouting ( const TSet< USoundModulatorBase* >& Modulators,
const EModulationDestination Destination,
const EModulationRouting RoutingMethod
)

 Sets the routing for one of the given Synth component's Modulation Destinations.
Public function void

SetOutputToBusOnly ( bool bInOutputToBusOnly
)

 Sets whether or not the synth component outputs its audio to any source or audio buses.
Public function void

SetSourceBusSendPostEffect ( USoundSourceBus* SoundSourceBus,
float SourceBusSendLevel
)

 Sets how much audio the sound should send to the given SourceBus (post effect).
Public function void

SetSourceBusSendPreEffect ( USoundSourceBus* SoundSourceBus,
float SourceBusSendLevel
)

 Sets how much audio the sound should send to the given SourceBus (pre effect).
Public function void

SetSubmixSend ( USoundSubmixBase* Submix,
float SendLevel
)

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

SetVolumeMultiplier ( float VolumeMultiplier
)

 Set a new volume multiplier
Public function void

Start ()

 Starts the synth generating audio.
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

  Type Name Description
Public function Virtual void

Activate ( bool bReset
)

 Activates the SceneComponent, should be overridden by native child classes.
Public function Virtual void Deactivates the SceneComponent.
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Ends gameplay for this component.
Public function Virtual Const bool 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 Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void Called when a component is unregistered.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

  Type Name Description
Public variable uint32: 1 bOutputToBusOnly_DEPRECATED Whether or not to only send this audio's output to a bus.
Public variable TObjectPtr< USoundConcurrency > ConcurrencySettings_DEPRECATED What sound concurrency to use for sounds generated by this audio component

Deprecated Functions

  Type Name Description
Protected function Virtual void

OnStart ()

 Use OnBeginGenerate to get a callback before audio is generating on the audio render thread
Protected function Virtual void

OnStop ()

 Use OnEndGenerate to get a callback when audio stops generating on the audio render thread

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page