Navigation
API > API/Plugins > API/Plugins/ResonanceAudio
| Name | UResonanceAudioSpatializationSourceSettings |
| Type | class |
| Header File | /Engine/Plugins/Runtime/ResonanceAudio/Source/ResonanceAudio/Public/ResonanceAudioSpatializationSourceSettings.h |
| Include Path | #include "ResonanceAudioSpatializationSourceSettings.h" |
Syntax
UCLASS (MinimalAPI)
class UResonanceAudioSpatializationSourceSettings : public USpatializationPluginSourceSettingsBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USpatializationPluginSourceSettingsBase → UResonanceAudioSpatializationSourceSettings
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UResonanceAudioSpatializationSourceSettings() |
ResonanceAudioSpatializationSourceSettings.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bToggleVisualization | bool | Whether to visualize directivity pattern in the viewport. | ResonanceAudioSpatializationSourceSettings.h |
|
| MaxDistance | float | Maximum distance to apply the chosen attenuation method ((default = 50000.0 cm) | ResonanceAudioSpatializationSourceSettings.h |
|
| MinDistance | float | Minimum distance to apply the chosen attenuation method (default = 100.0 cm) | ResonanceAudioSpatializationSourceSettings.h |
|
| Pattern | float | Directivity pattern: 0.0 (omnidirectional), 0.5 (cardioid), 1.0 (figure-of-8) | ResonanceAudioSpatializationSourceSettings.h |
|
| Rolloff | ERaDistanceRolloffModel | Roll-off model to use for sound source distance attenuation. Select 'None' (default) to use Unreal attenuation settings. | ResonanceAudioSpatializationSourceSettings.h |
|
| Scale | float | Scale (for directivity pattern visualization only). | ResonanceAudioSpatializationSourceSettings.h |
|
| Sharpness | float | Sharpness of the directivity pattern. Higher values result in a narrower sound emission beam. | ResonanceAudioSpatializationSourceSettings.h |
|
| SpatializationMethod | ERaSpatializationMethod | Spatialization method to use for sound object(s). NOTE: Has no effect if 'Stereo Panning' global quality mode is selected for the project. | ResonanceAudioSpatializationSourceSettings.h |
|
| Spread | float | Spread (width) of the sound source (in degrees). Note: spread control is not available if 'Stereo Panning' global quality mode is enabled for the project and / or 'Stereo Panning' spatialization mode is enabled for the sound source. | ResonanceAudioSpatializationSourceSettings.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool DoesAudioComponentReferenceThis
(
UAudioComponent* InAudioComponent |
See if Audio Component references this settings instance: | ResonanceAudioSpatializationSourceSettings.h | |
void SetSoundSourceDirectivity
(
float InPattern, |
Sets the sound source directivity, applies, and updates. | ResonanceAudioSpatializationSourceSettings.h |
|
void SetSoundSourceSpread
(
float InSpread |
Sets the sound source spread (width), applies, and updates. | ResonanceAudioSpatializationSourceSettings.h |
|
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanEditChange
(
const FProperty* InProperty |
ResonanceAudioSpatializationSourceSettings.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
ResonanceAudioSpatializationSourceSettings.h |