unreal.SoundModulationParameterSettings

class unreal.SoundModulationParameterSettings(value_normalized=1.0)

Bases: unreal.StructBase

Sound Modulation Parameter Settings

C++ Source:

  • Plugin: AudioModulation

  • Module: AudioModulation

  • File: SoundModulationParameter.h

Editor Properties: (see get_editor_property/set_editor_property)

  • unit_display_name (Text): [Read-Write] Unit Display Name: (Optional) Text name of parameter’s unit

  • value_normalized (float): [Read-Write] Value Normalized: Normalized, unitless default value of modulator. To ensure bypass functionality of mixing, patching, and modulating functions as anticipated, value should be selected such that GetMixFunction (see USoundModulationParameter) reduces to an identity function (i.e. function acts as a “pass-through” for all values in the range [0.0, 1.0]). If GetMixFunction performs the mathematical operation f(x1, x2), then the default ValueNormalized should result in f(x1, d) = x1 where d is ValueNormalized.

  • value_unit (float): [Read-Write] Value Unit: Default value of modulator in units (editor only)

property value_normalized

[Read-Only] Value Normalized: Normalized, unitless default value of modulator. To ensure bypass functionality of mixing, patching, and modulating functions as anticipated, value should be selected such that GetMixFunction (see USoundModulationParameter) reduces to an identity function (i.e. function acts as a “pass-through” for all values in the range [0.0, 1.0]). If GetMixFunction performs the mathematical operation f(x1, x2), then the default ValueNormalized should result in f(x1, d) = x1 where d is ValueNormalized.

Type

(float)