FSoundSubmixSendInfoBase

Common set of settings that are uses as submix sends.

API > API/Runtime > API/Runtime/Engine

Common set of settings that are uses as submix sends.

   
Name FSoundSubmixSendInfoBase
Type struct
Header File /Engine/Source/Runtime/Engine/Classes/Sound/SoundSubmixSend.h
Include Path #include "Sound/SoundSubmixSend.h"

Syntax

USTRUCT (BlueprintType )  
struct FSoundSubmixSendInfoBase

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
  Sound/SoundSubmixSend.h  
Implicit special members would touch the deprecated members and warn at the synthesis site (outside the field-decl pragma). Default them explicitly inside the pragma so synthesis sits in the suppressed region. Sound/SoundSubmixSend.h  
  Sound/SoundSubmixSend.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FSoundSubmixSendInfoBase()

   Sound/SoundSubmixSend.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bEnableHPFCutoff uint8   Sound/SoundSubmixSend.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="HPF/LPF"
  • Meta=(InlineEditConditionToggle)
bEnableLPFCutoff uint8   Sound/SoundSubmixSend.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="HPF/LPF"
  • Meta=(InlineEditConditionToggle)
CustomSendLevelCurve FRuntimeFloatCurve 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) Sound/SoundSubmixSend.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=SubmixSend
  • Meta=(EditCondition="SendLevelControlMethod == ESendLevelControlMethod::CustomCurve", EditConditionHides)
DisableManualSendClamp bool Whether to disable the internal 0-1 clamp for Constant Send Level control. Sound/SoundSubmixSend.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=SubmixSend
  • Meta=(DisplayName="Disable Send Level Clamp", EditCondition="SendLevelControlMethod == ESendLevelControlMethod::Manual", EditConditionHides)
HPFCutoff float   Sound/SoundSubmixSend.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="HPF/LPF"
  • Meta=(Units="Hz", Delta="0.1", ClampMin="20.0", ClampMax="20000.0", UIMin="20.0", UIMax="20000.0", EditCondition="bEnableHPFCutoff")
LPFCutoff float   Sound/SoundSubmixSend.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="HPF/LPF"
  • Meta=(Units="Hz", Delta="0.1", ClampMin="20.0", ClampMax="20000.0", UIMin="20.0", UIMax="20000.0", EditCondition="bEnableLPFCutoff")
MaxSendDistance float The distance at which to stop mapping between Send Level Min/Max Distances GREATER than this will result in a clamped Send Level Max Sound/SoundSubmixSend.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=SubmixSend
  • Meta=(DisplayName="Send Distance Max", EditCondition="SendLevelControlMethod != ESendLevelControlMethod::Manual", EditConditionHides)
MaxSendLevel float The amount to send to the Submix when sound is located at a distance greater than or equal to value specified in the Send Distance Max. Sound/SoundSubmixSend.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=SubmixSend
  • Meta=(DisplayName="Send Level Max", EditCondition="SendLevelControlMethod == ESendLevelControlMethod::Linear", EditConditionHides)
MinSendDistance float The distance at which to start mapping between to Send Level Min/Max Distances LESS than this will result in a clamped Send Level Min Sound/SoundSubmixSend.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=SubmixSend
  • Meta=(DisplayName="Send Distance Min", EditCondition="SendLevelControlMethod != ESendLevelControlMethod::Manual", EditConditionHides)
MinSendLevel float The amount to send to the Submix when sound is located at a distance less than or equal to value specified in the Send Distance Min. Sound/SoundSubmixSend.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=SubmixSend
  • Meta=(DisplayName="Send Level Min", EditCondition="SendLevelControlMethod == ESendLevelControlMethod::Linear", EditConditionHides)
SendLevel float Manually set the amount of audio to send. Sound/SoundSubmixSend.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=SubmixSend
  • Meta=(DisplayName="Send Level", EditCondition="SendLevelControlMethod == ESendLevelControlMethod::Manual", EditConditionHides)
SendLevelControlMethod ESendLevelControlMethod Changes the method we use to determine the send level - see enum value tooltips for more information. Sound/SoundSubmixSend.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=SubmixSend
SoundSubmix TObjectPtr< USoundSubmixBase > The Submix to send the audio to. Sound/SoundSubmixSend.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=SubmixSend

Functions

Public

Name Remarks Include Path Unreal Specifiers

void PostSerialize ( const FArchive& Ar
)

   Sound/SoundSubmixSend.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Sound/SoundSubmixSend.h  
  Sound/SoundSubmixSend.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
HPFCutoffFrequency_DEPRECATED TOptional< float >   Sound/SoundSubmixSend.h  
LPFCutoffFrequency_DEPRECATED TOptional< float > Legacy fields kept for tagged-load matching; migrated in PostSerialize. UHT strips _DEPRECATED from the EngineName. Sound/SoundSubmixSend.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page