unreal.SoundSubmixSendInfo

class unreal.SoundSubmixSendInfo(send_level_control_method: SendLevelControlMethod = Ellipsis, sound_submix: SoundSubmixBase = Ellipsis, send_level: float = 0.0, disable_manual_send_clamp: bool = False, min_send_level: float = 0.0, max_send_level: float = 0.0, min_send_distance: float = 0.0, max_send_distance: float = 0.0, custom_send_level_curve: RuntimeFloatCurve = [], send_stage: SubmixSendStage = Ellipsis)

Bases: SoundSubmixSendInfoBase

Sound Submix Send Info

C++ Source:

  • Module: Engine

  • File: SoundSubmixSend.h

Editor Properties: (see get_editor_property/set_editor_property)

  • custom_send_level_curve (RuntimeFloatCurve): [Read-Write] The custom send curve to use for distance-based send level. (0.0-1.0 on the curve’s X-axis maps to Min/Max Send Distance)

  • disable_manual_send_clamp (bool): [Read-Write] Whether to disable the internal 0-1 clamp for Manual Send Level control

  • max_send_distance (float): [Read-Write] The distance at which to stop mapping between Min/Max Send Level Distances GREATER than this will result in a clamped Max Send Level

  • max_send_level (float): [Read-Write] The amount to send to the Submix when sound is located at a distance greater than or equal to value specified in the Max Send Distance

  • min_send_distance (float): [Read-Write] The distance at which to start mapping between to Min/Max Send Level Distances LESS than this will result in a clamped Min Send Level

  • min_send_level (float): [Read-Write] The amount to send to the Submix when sound is located at a distance less than or equal to value specified in the Min Send Distance

  • send_level (float): [Read-Write] Manually set the amount of audio to send

  • send_level_control_method (SendLevelControlMethod): [Read-Write] Manual: Use Send Level only Linear: Interpolate between Min and Max Send Levels based on listener distance (between Min/Max Send Distance) Custom Curve: Use the float curve to map Send Level to distance (0.0-1.0 on curve maps to Min/Max Send Distance)

  • send_stage (SubmixSendStage): [Read-Write] Defines at what mix stage the send should happen.

  • sound_submix (SoundSubmixBase): [Read-Write] The Submix to send the audio to

property send_stage: SubmixSendStage

[Read-Write] Defines at what mix stage the send should happen.

Type:

(SubmixSendStage)