unreal.SoundSubmixSendInfo

class unreal.SoundSubmixSendInfo(send_level_control_method=SendLevelControlMethod.MANUAL, send_stage=SubmixSendStage.POST_DISTANCE_ATTENUATION, sound_submix=None, send_level=0.0, disable_manual_send_clamp=False, min_send_level=0.0, max_send_level=1.0, min_send_distance=100.0, max_send_distance=1000.0, custom_send_level_curve=[])

Bases: unreal.StructBase

Class used to send audio to submixes from USoundBase

C++ Source:

  • Module: Engine

  • File: SoundSubmixSend.h

Editor Properties: (see get_editor_property/set_editor_property)

  • custom_send_level_curve (RuntimeFloatCurve): [Read-Write] Custom Send Level Curve: The custom reverb send curve to use for distance-based send level.

  • disable_manual_send_clamp (bool): [Read-Write] Disable Manual Send Clamp: Whether to disable the 0-1 clamp for manual SendLevel control

  • max_send_distance (float): [Read-Write] Max Send Distance: The max distance to send to the master

  • max_send_level (float): [Read-Write] Max Send Level: The amount to send to master when sound is located at a distance equal to value specified in the max send distance.

  • min_send_distance (float): [Read-Write] Min Send Distance: The min distance to send to the master

  • min_send_level (float): [Read-Write] Min Send Level: The amount to send to master when sound is located at a distance equal to value specified in the min send distance.

  • send_level (float): [Read-Write] Send Level: The amount of audio to send

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

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

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

property custom_send_level_curve

[Read-Write] Custom Send Level Curve: The custom reverb send curve to use for distance-based send level.

Type

(RuntimeFloatCurve)

property disable_manual_send_clamp

[Read-Write] Disable Manual Send Clamp: Whether to disable the 0-1 clamp for manual SendLevel control

Type

(bool)

property max_send_distance

[Read-Write] Max Send Distance: The max distance to send to the master

Type

(float)

property max_send_level

[Read-Write] Max Send Level: The amount to send to master when sound is located at a distance equal to value specified in the max send distance.

Type

(float)

property min_send_distance

[Read-Write] Min Send Distance: The min distance to send to the master

Type

(float)

property min_send_level

[Read-Write] Min Send Level: The amount to send to master when sound is located at a distance equal to value specified in the min send distance.

Type

(float)

property send_level

[Read-Write] Send Level: The amount of audio to send

Type

(float)

property send_level_control_method

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

Type

(SendLevelControlMethod)

property send_stage

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

Type

(SubmixSendStage)

property sound_submix

[Read-Write] Sound Submix: The submix to send the audio to

Type

(SoundSubmixBase)