Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > AudioMixer > Components > USynthComponent

Light Theme

Dark Theme

USynthComponent

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

USynthComponent

	UAudioCaptureComponent
	UGranularSynth
	UMediaSoundComponent
	UModularSynthComponent
	USynthComponentMonoWaveTable
	USynthComponentMoto
	USynthComponentToneGenerator
	USynthSamplePlayer
	UTimeSynthComponent
	UVoipListenerSynthComponent

References

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

Syntax

class USynthComponent : public USceneComponent

Variables

	Name	Description
FSoundAttenuati...	AttenuationOverrides	If bOverrideSettings is true, the attenuation properties to use for sounds generated by this component
USoundAttenuati...	AttenuationSettings	If bOverrideSettings is false, the asset to use to determine attenuation properties for sounds generated by this component
uint8: 1	bAllowSpatialization	Is this audio component allowed to be spatialized?
uint8: 1	bAlwaysPlay	Whether to artificially prioritize the component to play
uint8: 1	bAutoDestroy	Auto destroy this component on completion
uint32: 1	bEnableBaseSubmix	If enabled, sound will route to the Master Submix by default or to the Base Submix if defined.
uint32: 1	bEnableBusSends	Whether or not to enable sending this audio's output to buses.
uint32: 1	bEnableSubmixSends	Whether or not to enable Submix Sends other than the Base Submix.
uint8: 1	bIsPreviewSound	Whether or not this synth is playing as a preview sound
uint8: 1	bIsUISound	Whether or not this sound plays when the game is paused in the UI
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
uint8: 1	bStopWhenOwnerDestroyed	Stop sound when owner is destroyed
TArray< FSoundS...	BusSends	This sound will send its audio output to this list of buses if there are bus instances playing after source effects are processed.
TSet< USoundCon...	ConcurrencySet	What sound concurrency to use for sounds generated by this audio component
int32	EnvelopeFollowerAttackTime	The attack time in milliseconds for the envelope follower.
int32	EnvelopeFollowerReleaseTime	The release time in milliseconds for the envelope follower.
int32	NumChannels	Can be set by the derived class, defaults to 2.
FOnSynthEnvelop...	OnAudioEnvelopeValue
FOnSynthEnvelop...	OnAudioEnvelopeValueNative	Shadow delegate for non UObject subscribers
TArray< FSoundS...	PreEffectBusSends	This sound will send its audio output to this list of buses if there are bus instances playing before source effects are processed.
int32	PreferredBufferLength	Can be set by the derived class- sets the preferred callback size for the synth component.
USoundClass ...	SoundClass	Sound class this sound belongs to
USoundSubmixBas...	SoundSubmix	Submix this sound belongs to
TArray< FSoundS...	SoundSubmixSends	An array of submix sends. Audio from this sound will send a portion of its audio to these effects.
USoundEffectSou...	SourceEffectChain	The source effect chain to use for this sound.

Constructors

	Name	Description
	USynthComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AddAudioBufferListener ( IAudioBufferListener* InAudioB... )	Adds and removes audio buffer listener.
void	CreateAudioComponent()	Creates the audio component if it hasn't already been created yet.
ISoundGenera...	CreateSoundGenerator ( int32 InSampleRate, int32 InNumChannels )	Implemented by the synth component to create a generator object instead of generating audio directly on the synth component.
UAudioCompon...	GetAudioComponent()	Retrieves this synth component's audio component.
FAudioDevice...	GetAudioDevice()	Gets the audio device associated with this synth component.
bool	Init ( int32& SampleRate )	Called when synth is created.
void	Initialize ( int32 SampleRateOverride )	Call if creating this synth component not via an actor component in BP, but in code or some other location.
bool	IsPlaying()	Returns true if this component is currently playing.
void	OnAudioComponentEnvelopeValue ( const UAudioComponent* AudioCo..., const USoundWave* SoundWave, const float EnvelopeValue )
void	OnBeginGenerate()	Called when the synth component begins generating audio in render thread.
void	OnEndGenerate()	Called when the synth has finished generating audio on the render thread.
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.
int32	OnGeneratePCMAudio ( float* GeneratedPCMData, int32 NumSamples )	Called by procedural sound wave Returns the number of samples actually generated
void	RemoveAudioBufferListener ( IAudioBufferListener* InAudioB... )
void	SetLowPassFilterEnabled ( bool InLowPassFilterEnabled )	Sets whether or not the low pass filter is enabled on the audio component.
void	SetLowPassFilterFrequency ( float InLowPassFilterFrequency )	Sets lowpass filter frequency of the audio component.
void	SetOutputToBusOnly ( bool bInOutputToBusOnly )	Sets whether or not the synth component outputs its audio to any source or audio buses.
void	SetSubmixSend ( USoundSubmixBase* Submix, float SendLevel )	Sets how much audio the sound should send to the given submix.
void	SetVolumeMultiplier ( float VolumeMultiplier )	Set a new volume multiplier
void	Start()	Starts the synth generating audio.
void	Stop()	Stops the synth generating audio.
void	SynthCommand ( TFunction< void()> Command )	Method to execute parameter changes on game thread in audio render thread.

Overridden from UActorComponent

	Name	Description
void	Activate ( bool bReset )	Activates the SceneComponent, should be overridden by native child classes.
void	Deactivate()	Deactivates the SceneComponent.
bool	IsReadyForOwnerToAutoDestroy()	Overridable check for a component to indicate to its Owner that it should prevent the Actor from auto destroying when finished
void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
void	OnUnregister()	Called when a component is unregistered.

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

		Name	Description
	uint32: 1	bOutputToBusOnly_DEPRECATED	Whether or not to only send this audio's output to a bus.
	USoundConcurren...	ConcurrencySettings_DEPRECATED	What sound concurrency to use for sounds generated by this audio component

Deprecated Functions

		Name	Description
	void	OnStart()	Use OnBeginGenerate to get a callback before audio is generating on the audio render thread
	void	OnStop()	Use OnEndGenerate to get a callback when audio stops generating on the audio render thread

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss