Navigation
Unreal Engine C++ API Reference > Plugins > ResonanceAudio
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&40;&41;
class UResonanceAudioSpatializationSourceSettings : public USpatializationPluginSourceSettingsBase
Remarks
Copyright (C) Google Inc. 2017. All rights reserved.
Variables
| Type | 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) |
    |
ERaDistanceRolloffModel | 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. |
    |
ERaSpatializationMethod | SpatializationMethod | Spatialization method to use for sound object(s). NOTE: Has no effect if 'Stereo Panning' global quality mode is selected for the project. |
    |
float | Spread | 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. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
bool | DoesAudioComponentReferenceThis
(
UAudioComponent* InAudioComponent |
See if Audio Component references this settings instance: |
   |
void | SetSoundSourceDirectivity
(
float InPattern, |
Sets the sound source directivity, applies, and updates. |
   |
void | SetSoundSourceSpread
(
float InSpread |
Sets the sound source spread (width), applies, and updates. |
Overridden from UObject
| Type | 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& PropertyChangedEvent |
Called when a property on this object has been modified externally |