UResonanceAudioSpatializationSourceSettings

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

ResonanceAudio

Header

/Engine/Plugins/Runtime/ResonanceAudio/Source/ResonanceAudio/Public/ResonanceAudioSpatializationSourceSettings.h

Include

#include "ResonanceAudioSpatializationSourceSettings.h"

Syntax

UCLASS()
class UResonanceAudioSpatializationSourceSettings : public USpatializationPluginSourceSettingsBase

Remarks

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

Variables

Name Description

Public variable UProperty Category, EditAnywhere

bool

 

bToggleVisualization

Whether to visualize directivity pattern in the viewport.

Public variable UProperty Category, EditAnywhere, Meta GlobalConfig

float

 

MaxDistance

Maximum distance to apply the chosen attenuation method ((default = 50000.0 cm)

Public variable UProperty Category, EditAnywhere, Meta GlobalConfig

float

 

MinDistance

Minimum distance to apply the chosen attenuation method (default = 100.0 cm)

Public variable UProperty Category, EditAnywhere, Meta GlobalConfig

float

 

Pattern

Directivity pattern: 0.0 (omnidirectional), 0.5 (cardioid), 1.0 (figure-of-8)

Public variable UProperty Category, EditAnywhere GlobalConfig

ERaDistanceRoll...

 

Rolloff

Roll-off model to use for sound source distance attenuation. Select 'None' (default) to use Unreal attenuation settings.

Public variable UProperty Category, EditAnywhere, Meta

float

 

Scale

Scale (for directivity pattern visualization only).

Public variable UProperty Category, EditAnywhere, Meta GlobalConfig

float

 

Sharpness

Sharpness of the directivity pattern. Higher values result in a narrower sound emission beam.

Public variable UProperty Category, EditAnywhere GlobalConfig

ERaSpatializati...

 

SpatializationMethod

Spatialization method to use for sound object(s).

Public variable UProperty Category, EditAnywhere, Meta GlobalConfig

float

 

Spread

Spread (width) of the sound source (in degrees).

Constructors

Functions

Name Description

Public function

bool

 

DoesAudioComponentReferenceThis

(
    UAudioComponent* InAudioCompon...
)

See if Audio Component references this settings instance:

Public function UFunction BlueprintCallable, Category

void

 

SetSoundSourceDirectivity

(
    float InPattern,
    float InSharpness
)

Sets the sound source directivity, applies, and updates.

Public function UFunction BlueprintCallable, Category

void

 

SetSoundSourceSpread

(
    float InSpread
)

Sets the sound source spread (width), applies, and updates.

Overridden from UObject

Name Description

Public function Virtual Const

bool

 

CanEditChange

(
    const FProperty* InProperty
)

Called by the editor to query whether a property of this object is allowed to be modified.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally