unreal.SoundModulationOutputTransform

class unreal.SoundModulationOutputTransform(input_min=0.0, input_max=1.0, curve=SoundModulatorOutputCurve.LINEAR, scalar=2.5, curve_shared=None, output_min=0.0, output_max=1.0)

Bases: unreal.StructBase

Sound Modulation Output Transform

C++ Source:

  • Plugin: AudioModulation
  • Module: AudioModulation
  • File: SoundModulationTransform.h

Editor Properties: (see get_editor_property/set_editor_property)

  • curve (SoundModulatorOutputCurve): [Read-Write] The curve to apply when transforming the output.
  • curve_shared (CurveFloat): [Read-Write] Asset curve reference to apply if output curve type is set to ‘Shared.’
  • input_max (float): [Read-Write] Maximum value to clamp the input to.
  • input_min (float): [Read-Write] Minimum value to clamp the input to.
  • output_max (float): [Read-Write] Maximum value to clamp output to.
  • output_min (float): [Read-Write] Minimum value to clamp output to.
  • scalar (float): [Read-Write] When curve set to log, exponential or exponential inverse, value is factor ‘b’ in following equations with output ‘y’ and input ‘x’: Exponential: y = x * 10^-b(1-x) Exponential (Inverse): y = ((x - 1) * 10^(-bx)) + 1 Logarithmic: y = b * log(x) + 1
curve

(SoundModulatorOutputCurve) – [Read-Write] The curve to apply when transforming the output.

curve_shared

(CurveFloat) – [Read-Write] Asset curve reference to apply if output curve type is set to ‘Shared.’

input_max

(float) – [Read-Write] Maximum value to clamp the input to.

input_min

(float) – [Read-Write] Minimum value to clamp the input to.

output_max

(float) – [Read-Write] Maximum value to clamp output to.

output_min

(float) – [Read-Write] Minimum value to clamp output to.

scalar

**(float)* – [Read-Write] When curve set to log, exponential or exponential inverse, value is factor ‘b’ in following equations with output ‘y’ and input ‘x’* – Exponential: y = x * 10^-b(1-x) Exponential (Inverse): y = ((x - 1) * 10^(-bx)) + 1 Logarithmic: y = b * log(x) + 1