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 > Plugins > ResonanceAudio > UResonanceAudioSpatializationSourceSettings

Light Theme

Dark Theme

UResonanceAudioSpatializationSourceSettings

Copyright (C) Google Inc. 2017. All rights reserved.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USpatializationPluginSourceSettingsBase

UResonanceAudioSpatializationSourceSettings

References

Module	ResonanceAudio
Header	/Engine/Plugins/Runtime/ResonanceAudio/Source/ResonanceAudio/Public/ResonanceAudioSpatializationSourceSettings.h
Include	#include "ResonanceAudioSpatializationSourceSettings.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UResonanceAudioSpatializationSourceSettings : public USpatializationPluginSourceSettingsBase

Remarks

Variables

	Name	Description
bool	bToggleVisualization	Whether to visualize directivity pattern in the viewport.
float	MaxDistance	Maximum distance to apply the chosen attenuation method ((default = 50000.0 cm)
float	MinDistance	Minimum distance to apply the chosen attenuation method (default = 100.0 cm)
float	Pattern	Directivity pattern: 0.0 (omnidirectional), 0.5 (cardioid), 1.0 (figure-of-8)
ERaDistanceRoll...	Rolloff	Roll-off model to use for sound source distance attenuation. Select 'None' (default) to use Unreal attenuation settings.
float	Scale	Scale (for directivity pattern visualization only).
float	Sharpness	Sharpness of the directivity pattern. Higher values result in a narrower sound emission beam.
ERaSpatializati...	SpatializationMethod	Spatialization method to use for sound object(s).
float	Spread	Spread (width) of the sound source (in degrees).

Constructors

	Name	Description
	UResonanceAudioSpatializationSourceSettings()

Functions

	Name	Description
bool	DoesAudioComponentReferenceThis ( UAudioComponent* InAudioCompon... )	See if Audio Component references this settings instance:
void	SetSoundSourceDirectivity ( float InPattern, float InSharpness )	Sets the sound source directivity, applies, and updates.
void	SetSoundSourceSpread ( float InSpread )	Sets the sound source spread (width), applies, and updates.

Overridden from UObject

		Name	Description
	bool	CanEditChange ( const FProperty* InProperty )	Called by the editor to query whether a property of this object is allowed to be modified.
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally

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

Take our survey

Dismiss