UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
USoundSubmix Class Reference

#include <SoundSubmix.h>

+ Inheritance diagram for USoundSubmix:

Public Member Functions

 UPROPERTY (EditAnywhere, BlueprintSetter=SetOutputVolumeModulation, Category=SubmixLevel, meta=(DisplayName="Output Volume (dB)", AudioParam="Volume", AudioParamClass="SoundModulationParameterVolume", ClampMin="-96.0", ClampMax="0.0", UIMin="-96.0", UIMax="0.0")) FSoundModulationDestinationSettings OutputVolumeModulation
 
 UPROPERTY (EditAnywhere, BlueprintSetter=SetWetVolumeModulation, Category=SubmixLevel, meta=(DisplayName="Wet Level (dB)", AudioParam="Volume", AudioParamClass="SoundModulationParameterVolume", ClampMin="-96.0", ClampMax="0.0", UIMin="-96.0", UIMax="0.0")) FSoundModulationDestinationSettings WetLevelModulation
 
 UPROPERTY (EditAnywhere, BlueprintSetter=SetDryVolumeModulation, Category=SubmixLevel, meta=(DisplayName="Dry Level (dB)", AudioParam="Volume", AudioParamClass="SoundModulationParameterVolume", ClampMin="-96.0", ClampMax="0.0", UIMin="-96.0", UIMax="0.0")) FSoundModulationDestinationSettings DryLevelModulation
 
ENGINE_API void StartRecordingOutput (const UObject *WorldContextObject, float ExpectedDuration)
 
ENGINE_API void StartRecordingOutput (FAudioDevice *InDevice, float ExpectedDuration)
 
ENGINE_API void StopRecordingOutput (const UObject *WorldContextObject, EAudioRecordingExportType ExportType, const FString &Name, FString Path, USoundWave *ExistingSoundWaveToOverwrite=nullptr)
 
ENGINE_API void StopRecordingOutput (FAudioDevice *InDevice, EAudioRecordingExportType ExportType, const FString &Name, FString Path, USoundWave *ExistingSoundWaveToOverwrite=nullptr)
 
ENGINE_API void StartEnvelopeFollowing (const UObject *WorldContextObject)
 
ENGINE_API void StartEnvelopeFollowing (FAudioDevice *InDevice)
 
ENGINE_API void StopEnvelopeFollowing (const UObject *WorldContextObject)
 
ENGINE_API void StopEnvelopeFollowing (FAudioDevice *InDevice)
 
ENGINE_API void AddEnvelopeFollowerDelegate (const UObject *WorldContextObject, const FOnSubmixEnvelopeBP &OnSubmixEnvelopeBP)
 
ENGINE_API void RemoveEnvelopeFollowerDelegate (const UObject *WorldContextObject, const FOnSubmixEnvelopeBP &OnSubmixEnvelopeBP)
 
ENGINE_API void AddSpectralAnalysisDelegate (const UObject *WorldContextObject, const TArray< FSoundSubmixSpectralAnalysisBandSettings > &InBandSettings, const FOnSubmixSpectralAnalysisBP &OnSubmixSpectralAnalysisBP, float UpdateRate=10.f, float DecibelNoiseFloor=-40.f, bool bDoNormalize=true, bool bDoAutoRange=false, float AutoRangeAttackTime=0.1f, float AutoRangeReleaseTime=60.f)
 
ENGINE_API void RemoveSpectralAnalysisDelegate (const UObject *WorldContextObject, const FOnSubmixSpectralAnalysisBP &OnSubmixSpectralAnalysisBP)
 
ENGINE_API void StartSpectralAnalysis (const UObject *WorldContextObject, EFFTSize FFTSize=EFFTSize::DefaultSize, EFFTPeakInterpolationMethod InterpolationMethod=EFFTPeakInterpolationMethod::Linear, EFFTWindowType WindowType=EFFTWindowType::Hann, float HopSize=0, EAudioSpectrumType SpectrumType=EAudioSpectrumType::MagnitudeSpectrum)
 
ENGINE_API void StartSpectralAnalysis (FAudioDevice *InDevice, EFFTSize FFTSize=EFFTSize::DefaultSize, EFFTPeakInterpolationMethod InterpolationMethod=EFFTPeakInterpolationMethod::Linear, EFFTWindowType WindowType=EFFTWindowType::Hann, float HopSize=0, EAudioSpectrumType SpectrumType=EAudioSpectrumType::MagnitudeSpectrum)
 
ENGINE_API void StopSpectralAnalysis (const UObject *WorldContextObject)
 
ENGINE_API void StopSpectralAnalysis (FAudioDevice *InDevice)
 
 UFUNCTION (BlueprintCallable, Category="Audio", meta=(WorldContext="WorldContextObject", DisplayName="SetSubmixOutputVolume (linear gain)")) ENGINE_API void SetSubmixOutputVolume(const UObject *WorldContextObject
 
 UFUNCTION (BlueprintCallable, Category="Audio", meta=(WorldContext="WorldContextObject", DisplayName="SetSubmixWetLevel (linear gain)")) ENGINE_API void SetSubmixWetLevel(const UObject *WorldContextObject
 
 UFUNCTION (BlueprintCallable, Category="Audio", meta=(WorldContext="WorldContextObject", DisplayName="SetSubmixDryLevel (linear gain)")) ENGINE_API void SetSubmixDryLevel(const UObject *WorldContextObject
 
- Public Member Functions inherited from USoundSubmixWithParentBase
ENGINE_API TObjectPtr< USoundSubmixBaseGetParent (Audio::FDeviceId InDeviceId) const
 
ENGINE_API void SetParentSubmix (USoundSubmixBase *InParentSubmix, bool bModifyAssets=true)
 
virtual ENGINE_API bool DynamicConnect (const UObject *WorldContextObject, USoundSubmixBase *Parent) override
 
ENGINE_API bool DynamicConnect (FAudioDeviceHandle Handle, USoundSubmixBase *Parent)
 
virtual ENGINE_API bool DynamicDisconnect (const UObject *WorldContextObject) override
 
ENGINE_API bool DynamicDisconnect (FAudioDeviceHandle Handle)
 
virtual ENGINE_API bool IsDynamic (const bool bIncludeAncestors) const override
 
virtual ENGINE_API USoundSubmixBaseFindDynamicAncestor () override
 
- Public Member Functions inherited from USoundSubmixBase
virtual bool DynamicConnect (const UObject *WorldContextObject, UPARAM(DisplayName="Parent") USoundSubmixBase *InParent)
 
- Public Member Functions inherited from UObject
COREUOBJECT_API UObject ()
 
COREUOBJECT_API UObject (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UObject (EStaticConstructor, EObjectFlags InFlags)
 
COREUOBJECT_API UObject (FVTableHelper &Helper)
 
COREUOBJECT_API UObjectCreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
 
template<class TReturnType >
TReturnTypeCreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
COREUOBJECT_API void GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
 
COREUOBJECT_API UObjectGetDefaultSubobjectByName (FName ToFind)
 
virtual COREUOBJECT_API void PostInitProperties ()
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual void PostCDOContruct ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PreSave (FObjectPreSaveContext SaveContext)
 
virtual COREUOBJECT_API void CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
 
UE_FORCEINLINE_HINT bool Modify (bool bAlwaysMarkDirty=true)
 
UE_FORCEINLINE_HINT bool IsCapturingAsRootObjectForTransaction () const
 
virtual bool ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
 
virtual bool IsReadyForAsyncPostLoad () const
 
virtual COREUOBJECT_API void PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
virtual bool IsReadyForFinishDestroy ()
 
virtual COREUOBJECT_API void FinishDestroy ()
 
virtual COREUOBJECT_API void Serialize (FStructuredArchive::FRecord Record)
 
virtual void ShutdownAfterError ()
 
virtual void PostInterpChange (FProperty *PropertyThatChanged)
 
virtual COREUOBJECT_API void PostRename (UObject *OldOuter, const FName OldName)
 
virtual void PreDuplicate (FObjectDuplicationParameters &DupParams)
 
virtual void PostDuplicate (bool bDuplicateForPIE)
 
virtual void PostDuplicate (EDuplicateMode::Type DuplicateMode)
 
virtual COREUOBJECT_API bool NeedsLoadForClient () const
 
virtual COREUOBJECT_API bool NeedsLoadForServer () const
 
virtual COREUOBJECT_API bool NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
 
virtual bool NeedsLoadForEditorGame () const
 
virtual bool IsEditorOnly () const
 
virtual bool HasNonEditorOnlyReferences () const
 
virtual bool IsPostLoadThreadSafe () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps)
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void ExportCustomProperties (FOutputDevice &Out, uint32 Indent)
 
virtual void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn)
 
virtual void PostEditImport ()
 
virtual void PostReloadConfig (class FProperty *PropertyThatWasLoaded)
 
virtual COREUOBJECT_API bool Rename (const TCHAR *NewName=nullptr, UObject *NewOuter=nullptr, ERenameFlags Flags=REN_None)
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
virtual COREUOBJECT_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetData &Out) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
 
virtual COREUOBJECT_API bool IsAsset () const
 
virtual COREUOBJECT_API FPrimaryAssetId GetPrimaryAssetId () const
 
virtual COREUOBJECT_API bool IsLocalizedResource () const
 
virtual COREUOBJECT_API bool IsSafeForRootSet () const
 
virtual COREUOBJECT_API void TagSubobjects (EObjectFlags NewFlags)
 
virtual COREUOBJECT_API void GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const
 
virtual COREUOBJECT_API void GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
 
virtual COREUOBJECT_API void RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags)
 
virtual COREUOBJECT_API bool IsNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsFullNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsSupportedForNetworking () const
 
virtual void GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
 
virtual COREUOBJECT_API void PreNetReceive ()
 
virtual COREUOBJECT_API void PostNetReceive ()
 
virtual void PostRepNotifies ()
 
virtual COREUOBJECT_API void PreDestroyFromReplication ()
 
COREUOBJECT_API bool IsSelected () const
 
COREUOBJECT_API void SerializeScriptProperties (FArchive &Ar) const
 
COREUOBJECT_API void SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
 
COREUOBJECT_API void ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
 
COREUOBJECT_API FString GetDetailedInfo () const
 
COREUOBJECT_API bool ConditionalBeginDestroy ()
 
COREUOBJECT_API bool ConditionalFinishDestroy ()
 
COREUOBJECT_API void ConditionalPostLoad ()
 
COREUOBJECT_API void ConditionalPreload ()
 
COREUOBJECT_API void ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
 
bool IsBasedOnArchetype (const UObject *const SomeObject) const
 
COREUOBJECT_API UFunctionFindFunction (FName InName) const
 
COREUOBJECT_API UFunctionFindFunctionChecked (FName InName) const
 
virtual COREUOBJECT_API void BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
 
COREUOBJECT_API void CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
 
COREUOBJECT_API bool CheckDefaultSubobjects (bool bForceCheck=false) const
 
COREUOBJECT_API void SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
 
COREUOBJECT_API void SaveConfig (const FSaveConfigContext &Context)
 
COREUOBJECT_API void UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
 
COREUOBJECT_API bool TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
 
COREUOBJECT_API void UpdateGlobalUserConfigFile ()
 
COREUOBJECT_API void UpdateProjectUserConfigFile ()
 
COREUOBJECT_API void UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
 
COREUOBJECT_API FString GetDefaultConfigFilename () const
 
COREUOBJECT_API FString GetGlobalUserConfigFilename () const
 
COREUOBJECT_API FString GetProjectUserConfigFilename () const
 
virtual const TCHARGetConfigOverridePlatform () const
 
virtual void OverrideConfigSection (FString &SectionName)
 
virtual void OverridePerObjectConfigSection (FString &SectionName)
 
COREUOBJECT_API void LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
 
COREUOBJECT_API void ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
 
COREUOBJECT_API void ParseParms (const TCHAR *Parms)
 
COREUOBJECT_API void OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
 
COREUOBJECT_API void RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
 
COREUOBJECT_API void SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
 
COREUOBJECT_API UObjectGetArchetype () const
 
COREUOBJECT_API void GetArchetypeInstances (TArray< UObject * > &Instances)
 
COREUOBJECT_API void InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
 
template<class T >
bool Implements () const
 
virtual COREUOBJECT_API void ProcessEvent (UFunction *Function, void *Parms)
 
virtual int32 GetFunctionCallspace (UFunction *Function, FFrame *Stack)
 
virtual bool CallRemoteFunction (UFunction *Function, void *Parms, struct FOutParmRec *OutParms, FFrame *Stack)
 
COREUOBJECT_API bool CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
 
COREUOBJECT_API void CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
 DECLARE_FUNCTION (ProcessInternal)
 
virtual bool ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
 
COREUOBJECT_API void SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
virtual UClassRegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
 
COREUOBJECT_API bool IsInBlueprint () const
 
COREUOBJECT_API void DestroyNonNativeProperties ()
 
virtual void MarkAsEditorOnlySubobject ()
 
COREUOBJECT_API void AbortInsideMemberFunction () const
 
 DECLARE_FUNCTION (execUndefined)
 
 DECLARE_FUNCTION (execLocalVariable)
 
 DECLARE_FUNCTION (execInstanceVariable)
 
 DECLARE_FUNCTION (execDefaultVariable)
 
 DECLARE_FUNCTION (execLocalOutVariable)
 
 DECLARE_FUNCTION (execInterfaceVariable)
 
 DECLARE_FUNCTION (execClassSparseDataVariable)
 
 DECLARE_FUNCTION (execInterfaceContext)
 
 DECLARE_FUNCTION (execArrayElement)
 
 DECLARE_FUNCTION (execBoolVariable)
 
 DECLARE_FUNCTION (execClassDefaultVariable)
 
 DECLARE_FUNCTION (execEndFunctionParms)
 
 DECLARE_FUNCTION (execNothing)
 
 DECLARE_FUNCTION (execNothingInt32)
 
 DECLARE_FUNCTION (execNothingOp4a)
 
 DECLARE_FUNCTION (execBreakpoint)
 
 DECLARE_FUNCTION (execTracepoint)
 
 DECLARE_FUNCTION (execWireTracepoint)
 
 DECLARE_FUNCTION (execInstrumentation)
 
 DECLARE_FUNCTION (execEndOfScript)
 
 DECLARE_FUNCTION (execReturnNothing)
 
 DECLARE_FUNCTION (execEmptyParmValue)
 
 DECLARE_FUNCTION (execJump)
 
 DECLARE_FUNCTION (execJumpIfNot)
 
 DECLARE_FUNCTION (execAssert)
 
 DECLARE_FUNCTION (execPushExecutionFlow)
 
 DECLARE_FUNCTION (execPopExecutionFlow)
 
 DECLARE_FUNCTION (execComputedJump)
 
 DECLARE_FUNCTION (execPopExecutionFlowIfNot)
 
 DECLARE_FUNCTION (execLet)
 
 DECLARE_FUNCTION (execLetObj)
 
 DECLARE_FUNCTION (execLetWeakObjPtr)
 
 DECLARE_FUNCTION (execLetBool)
 
 DECLARE_FUNCTION (execLetDelegate)
 
 DECLARE_FUNCTION (execLetMulticastDelegate)
 
 DECLARE_FUNCTION (execAddMulticastDelegate)
 
 DECLARE_FUNCTION (execClearMulticastDelegate)
 
 DECLARE_FUNCTION (execEatReturnValue)
 
 DECLARE_FUNCTION (execRemoveMulticastDelegate)
 
 DECLARE_FUNCTION (execSelf)
 
 DECLARE_FUNCTION (execContext)
 
 DECLARE_FUNCTION (execContext_FailSilent)
 
 DECLARE_FUNCTION (execStructMemberContext)
 
 DECLARE_FUNCTION (execVirtualFunction)
 
 DECLARE_FUNCTION (execFinalFunction)
 
 DECLARE_FUNCTION (execLocalVirtualFunction)
 
 DECLARE_FUNCTION (execLocalFinalFunction)
 
 DECLARE_FUNCTION (execStructCmpEq)
 
 DECLARE_FUNCTION (execStructCmpNe)
 
 DECLARE_FUNCTION (execStructMember)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execNotEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execIntConst)
 
 DECLARE_FUNCTION (execInt64Const)
 
 DECLARE_FUNCTION (execUInt64Const)
 
 DECLARE_FUNCTION (execSkipOffsetConst)
 
 DECLARE_FUNCTION (execFloatConst)
 
 DECLARE_FUNCTION (execDoubleConst)
 
 DECLARE_FUNCTION (execStringConst)
 
 DECLARE_FUNCTION (execUnicodeStringConst)
 
 DECLARE_FUNCTION (execTextConst)
 
 DECLARE_FUNCTION (execPropertyConst)
 
 DECLARE_FUNCTION (execObjectConst)
 
 DECLARE_FUNCTION (execSoftObjectConst)
 
 DECLARE_FUNCTION (execFieldPathConst)
 
 DECLARE_FUNCTION (execInstanceDelegate)
 
 DECLARE_FUNCTION (execNameConst)
 
 DECLARE_FUNCTION (execByteConst)
 
 DECLARE_FUNCTION (execIntZero)
 
 DECLARE_FUNCTION (execIntOne)
 
 DECLARE_FUNCTION (execTrue)
 
 DECLARE_FUNCTION (execFalse)
 
 DECLARE_FUNCTION (execNoObject)
 
 DECLARE_FUNCTION (execNullInterface)
 
 DECLARE_FUNCTION (execIntConstByte)
 
 DECLARE_FUNCTION (execRotationConst)
 
 DECLARE_FUNCTION (execVectorConst)
 
 DECLARE_FUNCTION (execVector3fConst)
 
 DECLARE_FUNCTION (execTransformConst)
 
 DECLARE_FUNCTION (execStructConst)
 
 DECLARE_FUNCTION (execSetArray)
 
 DECLARE_FUNCTION (execSetSet)
 
 DECLARE_FUNCTION (execSetMap)
 
 DECLARE_FUNCTION (execArrayConst)
 
 DECLARE_FUNCTION (execSetConst)
 
 DECLARE_FUNCTION (execMapConst)
 
 DECLARE_FUNCTION (execBitFieldConst)
 
 DECLARE_FUNCTION (execNew)
 
 DECLARE_FUNCTION (execClassContext)
 
 DECLARE_FUNCTION (execNativeParm)
 
 DECLARE_FUNCTION (execCast)
 
 DECLARE_FUNCTION (execDynamicCast)
 
 DECLARE_FUNCTION (execMetaCast)
 
 DECLARE_FUNCTION (execInterfaceCast)
 
 DECLARE_FUNCTION (execDoubleToFloatCast)
 
 DECLARE_FUNCTION (execFloatToDoubleCast)
 
 DECLARE_FUNCTION (execObjectToBool)
 
 DECLARE_FUNCTION (execInterfaceToBool)
 
 DECLARE_FUNCTION (execObjectToInterface)
 
 DECLARE_FUNCTION (execInterfaceToInterface)
 
 DECLARE_FUNCTION (execInterfaceToObject)
 
 DECLARE_FUNCTION (execGetDynArrayElement)
 
 DECLARE_FUNCTION (execSetDynArrayElement)
 
 DECLARE_FUNCTION (execGetDynArrayLength)
 
 DECLARE_FUNCTION (execSetDynArrayLength)
 
 DECLARE_FUNCTION (execDynArrayInsert)
 
 DECLARE_FUNCTION (execDynArrayRemove)
 
 DECLARE_FUNCTION (execDynArrayFind)
 
 DECLARE_FUNCTION (execDynArrayFindStruct)
 
 DECLARE_FUNCTION (execDynArrayAdd)
 
 DECLARE_FUNCTION (execDynArrayAddItem)
 
 DECLARE_FUNCTION (execDynArrayInsertItem)
 
 DECLARE_FUNCTION (execDynArrayRemoveItem)
 
 DECLARE_FUNCTION (execDynArraySort)
 
 DECLARE_FUNCTION (execBindDelegate)
 
 DECLARE_FUNCTION (execCallMulticastDelegate)
 
 DECLARE_FUNCTION (execLetValueOnPersistentFrame)
 
 DECLARE_FUNCTION (execCallMathFunction)
 
 DECLARE_FUNCTION (execSwitchValue)
 
 DECLARE_FUNCTION (execArrayGetByRef)
 
 DECLARE_FUNCTION (execAutoRtfmTransact)
 
 DECLARE_FUNCTION (execAutoRtfmStopTransact)
 
 DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
 
void ExecuteUbergraph (int32 EntryPoint)
 
virtual void ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
 
virtual uint64 GetNetPushIdDynamic () const
 
- Public Member Functions inherited from UObjectBaseUtility
 UObjectBaseUtility ()
 
 UObjectBaseUtility (EObjectFlags InFlags)
 
void SetFlags (EObjectFlags NewFlags)
 
void ClearFlags (EObjectFlags FlagsToClear)
 
bool HasAnyFlags (EObjectFlags FlagsToCheck) const
 
bool HasAllFlags (EObjectFlags FlagsToCheck) const
 
UE_FORCEINLINE_HINT EObjectFlags GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
 
UE_FORCEINLINE_HINT void Mark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT void UnMark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAnyMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAllMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT EObjectMark GetAllMarks () const
 
void MarkAsGarbage ()
 
void ClearGarbage ()
 
UE_FORCEINLINE_HINT void AddToRoot ()
 
UE_FORCEINLINE_HINT void RemoveFromRoot ()
 
UE_FORCEINLINE_HINT bool IsRooted () const
 
UE_FORCEINLINE_HINT int32 GetRefCount () const
 
bool ThisThreadAtomicallyClearedRFUnreachable ()
 
UE_FORCEINLINE_HINT bool IsUnreachable () const
 
UE_FORCEINLINE_HINT bool IsNative () const
 
void SetInternalFlags (EInternalObjectFlags FlagsToSet) const
 
UE_FORCEINLINE_HINT EInternalObjectFlags GetInternalFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
 
void ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
bool AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
COREUOBJECT_API FString GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API FString GetPathName (const UObject *StopOuter=NULL) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FString &ResultString) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
 
virtual bool CanBeClusterRoot () const
 
virtual COREUOBJECT_API bool CanBeInCluster () const
 
virtual COREUOBJECT_API void CreateCluster ()
 
virtual void OnClusterMarkedAsPendingKill ()
 
COREUOBJECT_API void AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
 
COREUOBJECT_API FString GetFullGroupName (bool bStartWithOuter) const
 
UE_FORCEINLINE_HINT FString GetName () const
 
UE_FORCEINLINE_HINT void GetName (FString &ResultString) const
 
UE_FORCEINLINE_HINT void AppendName (FString &ResultString) const
 
COREUOBJECT_API bool IsPackageExternal () const
 
COREUOBJECT_API void DetachExternalPackage ()
 
COREUOBJECT_API void ReattachExternalPackage ()
 
COREUOBJECT_API UObjectGetOutermostObject () const
 
COREUOBJECT_API UPackageGetPackage () const
 
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath GetVersePath () const
 
COREUOBJECT_API UPackageGetOutermost () const
 
COREUOBJECT_API bool MarkPackageDirty () const
 
COREUOBJECT_API bool IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
 
COREUOBJECT_API UObjectGetTypedOuter (UClass *Target) const
 
template<typename T >
T * GetTypedOuter () const
 
template<typename InterfaceClassType >
InterfaceClassTypeGetImplementingOuter () const
 
COREUOBJECT_API UObjectBaseUtilityGetImplementingOuterObject (const UClass *InInterfaceClass) const
 
COREUOBJECT_API bool IsIn (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsIn (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInOuter (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsInPackage (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInA (const UClass *SomeBaseClass) const
 
COREUOBJECT_API bool RootPackageHasAnyFlags (uint32 CheckFlagMask) const
 
template<typename OtherClassType >
bool IsA (OtherClassType SomeBase) const
 
template<class T >
bool IsA () const
 
COREUOBJECT_API const UClassFindNearestCommonBaseClass (const UClass *TestClass) const
 
COREUOBJECT_API voidGetInterfaceAddress (UClass *InterfaceClass)
 
COREUOBJECT_API voidGetNativeInterfaceAddress (UClass *InterfaceClass)
 
const voidGetNativeInterfaceAddress (UClass *InterfaceClass) const
 
COREUOBJECT_API bool IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
 
COREUOBJECT_API bool IsDefaultSubobject () const
 
COREUOBJECT_API class FLinkerLoadGetLinker () const
 
COREUOBJECT_API int32 GetLinkerIndex () const
 
COREUOBJECT_API FPackageFileVersion GetLinkerUEVersion () const
 
int32 GetLinkerUE4Version () const
 
COREUOBJECT_API int32 GetLinkerLicenseeUEVersion () const
 
int32 GetLinkerLicenseeUE4Version () const
 
COREUOBJECT_API int32 GetLinkerCustomVersion (FGuid CustomVersionKey) const
 
UE_FORCEINLINE_HINT bool operator< (const UObjectBaseUtility &Other) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
- Public Member Functions inherited from UObjectBase
COREUOBJECT_API UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
 
virtual COREUOBJECT_API ~UObjectBase ()
 
COREUOBJECT_API bool IsValidLowLevel () const
 
COREUOBJECT_API bool IsValidLowLevelFast (bool bRecursive=true) const
 
FORCEINLINE uint32 GetUniqueID () const
 
FORCEINLINE UClassGetClass () const
 
FORCEINLINE UObjectGetOuter () const
 
FORCEINLINE FName GetFName () const
 
virtual COREUOBJECT_API FName GetFNameForStatID () const
 
COREUOBJECT_API UPackageGetExternalPackage () const
 
COREUOBJECT_API void SetExternalPackage (UPackage *InPackage)
 
COREUOBJECT_API UPackageGetExternalPackageInternal () const
 
COREUOBJECT_API void MarkAsReachable () const
 
COREUOBJECT_API void AddRef () const
 
COREUOBJECT_API void ReleaseRef () const
 
FORCEINLINE EObjectFlags GetFlags () const
 
FORCENOINLINE void AtomicallySetFlags (EObjectFlags FlagsToAdd)
 
FORCENOINLINE void AtomicallyClearFlags (EObjectFlags FlagsToClear)
 

Static Public Member Functions

static ENGINE_API FSoundSpectrumAnalyzerSettings GetSpectrumAnalyzerSettings (EFFTSize FFTSize, EFFTPeakInterpolationMethod InterpolationMethod, EFFTWindowType WindowType, float HopSize, EAudioSpectrumType SpectrumType)
 
static ENGINE_API FSoundSpectrumAnalyzerDelegateSettings GetSpectrumAnalysisDelegateSettings (const TArray< FSoundSubmixSpectralAnalysisBandSettings > &InBandSettings, float UpdateRate, float DecibelNoiseFloor, bool bDoNormalize, bool bDoAutoRange, float AutoRangeAttackTime, float AutoRangeReleaseTime)
 
- Static Public Member Functions inherited from UObject
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API bool CanCreateInCurrentContext (UObject *Template)
 
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
static COREUOBJECT_API const FNameSourceFileTagName ()
 
static COREUOBJECT_API UObjectGetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
 
- Static Public Member Functions inherited from UObjectBaseUtility
static bool IsGarbageEliminationEnabled ()
 
static bool IsPendingKillEnabled ()
 
static void SetGarbageEliminationEnabled (bool bEnabled)
 
static COREUOBJECT_API void ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
 
- Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString RemoveClassPrefix (const TCHAR *ClassName)
 
static void PrefetchClass (UObject *Object)
 
static void PrefetchOuter (UObject *Object)
 

Public Attributes

uint8 bMuteWhenBackgrounded: 1
 
TArray< TObjectPtr< USoundEffectSubmixPreset > > SubmixEffectChain
 
TObjectPtr< USoundfieldEncodingSettingsBaseAmbisonicsPluginSettings
 
int32 EnvelopeFollowerAttackTime
 
int32 EnvelopeFollowerReleaseTime
 
uint8 bSendToAudioLink: 1
 
TObjectPtr< UAudioLinkSettingsAbstractAudioLinkSettings
 
FOnSubmixRecordedFileDone OnSubmixRecordedFileDone
 
float InOutputVolume
 
float InWetLevel
 
float InDryLevel
 
- Public Attributes inherited from USoundSubmixWithParentBase
TObjectPtr< USoundSubmixBaseParentSubmix
 
TMap< uint32, TObjectPtr< USoundSubmixBase > > DynamicParentSubmix
 
- Public Attributes inherited from USoundSubmixBase
bool bAutoDisable = true
 
float AutoDisableTime = 0.01f
 
TArray< TObjectPtr< USoundSubmixBase > > ChildSubmixes
 
TMap< uint32, FDynamicChildSubmixDynamicChildSubmixes
 

Protected Member Functions

virtual ENGINE_API void Serialize (FArchive &Ar) override
 
virtual ENGINE_API void PostLoad () override
 
void SetOutputVolumeModulation (const FSoundModulationDestinationSettings &InVolMod)
 
void SetWetVolumeModulation (const FSoundModulationDestinationSettings &InVolMod)
 
void SetDryVolumeModulation (const FSoundModulationDestinationSettings &InVolMod)
 
void PushModulationChanges ()
 
- Protected Member Functions inherited from USoundSubmixWithParentBase
const USoundSubmixBaseFindDynamicAncestor () const
 
- Protected Member Functions inherited from USoundSubmixBase
virtual ENGINE_API FString GetDesc () override
 
virtual ENGINE_API void BeginDestroy () override
 
- Protected Member Functions inherited from UObject
virtual FString GetDetailedInfoInternal () const
 
COREUOBJECT_API bool CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
 
virtual COREUOBJECT_API bool CheckDefaultSubobjectsInternal () const
 
- Protected Member Functions inherited from UObjectBase
 UObjectBase ()
 
COREUOBJECT_API UObjectBase (EObjectFlags InFlags)
 
COREUOBJECT_API void LowLevelRename (FName NewName, UObject *NewOuter=NULL)
 
virtual void RegisterDependencies ()
 
COREUOBJECT_API void Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
 
COREUOBJECT_API void Register (const TCHAR *PackageName, const TCHAR *Name)
 
virtual COREUOBJECT_API void DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
 
FORCEINLINE void SetFlagsTo (EObjectFlags NewFlags)
 

Static Protected Member Functions

static FAudioDeviceGetAudioDeviceFrom (const UObject *WorldContextObject)
 

Protected Attributes

TUniquePtr< Audio::FAudioRecordingDataRecordingData
 
- Protected Attributes inherited from USoundSubmixWithParentBase
uint8 bIsDynamic: 1
 

Additional Inherited Members

- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 

Detailed Description

Sound Submix class meant for applying an effect to the downmixed sum of multiple audio sources.

Member Function Documentation

◆ AddEnvelopeFollowerDelegate()

void USoundSubmix::AddEnvelopeFollowerDelegate ( const UObject WorldContextObject,
const FOnSubmixEnvelopeBP OnSubmixEnvelopeBP 
)

Adds an envelope follower delegate to the submix when envelope following is enabled on this submix.

Parameters
OnSubmixEnvelopeBPEvent to fire when new envelope data is available.

◆ AddSpectralAnalysisDelegate()

void USoundSubmix::AddSpectralAnalysisDelegate ( const UObject WorldContextObject,
const TArray< FSoundSubmixSpectralAnalysisBandSettings > &  InBandSettings,
const FOnSubmixSpectralAnalysisBP OnSubmixSpectralAnalysisBP,
float  UpdateRate = 10.f,
float  DecibelNoiseFloor = -40.f,
bool  bDoNormalize = true,
bool  bDoAutoRange = false,
float  AutoRangeAttackTime = 0.1f,
float  AutoRangeReleaseTime = 60.f 
)

Adds a spectral analysis delegate to receive notifications when this submix has spectrum analysis enabled.

Parameters
InBandsettingsThe frequency bands to analyze and their envelope-following settings.
OnSubmixSpectralAnalysisBPEvent to fire when new spectral data is available.
UpdateRateHow often to retrieve the data from the spectral analyzer and broadcast the event. Max is 30 times per second.
InterpMethodMethod to used for band peak calculation.
SpectrumTypeMetric to use when returning spectrum values.
DecibelNoiseFloorDecibel Noise Floor to consider as silence when using a Decibel Spectrum Type.
bDoNormalizeIf true, output band values will be normalized between zero and one.
bDoAutoRangeIf true, output band values will have their ranges automatically adjusted to the minimum and maximum values in the audio. Output band values will be normalized between zero and one.
AutoRangeAttackTimeThe time (in seconds) it takes for the range to expand to 90% of a larger range.
AutoRangeReleaseTimeThe time (in seconds) it takes for the range to shrink to 90% of a smaller range.

◆ GetAudioDeviceFrom()

FAudioDevice * USoundSubmix::GetAudioDeviceFrom ( const UObject WorldContextObject)
staticprotected

Return the audio device that corresponds to the provided world context object.

◆ GetSpectrumAnalysisDelegateSettings()

FSoundSpectrumAnalyzerDelegateSettings USoundSubmix::GetSpectrumAnalysisDelegateSettings ( const TArray< FSoundSubmixSpectralAnalysisBandSettings > &  InBandSettings,
float  UpdateRate,
float  DecibelNoiseFloor,
bool  bDoNormalize,
bool  bDoAutoRange,
float  AutoRangeAttackTime,
float  AutoRangeReleaseTime 
)
static

◆ GetSpectrumAnalyzerSettings()

FSoundSpectrumAnalyzerSettings USoundSubmix::GetSpectrumAnalyzerSettings ( EFFTSize  FFTSize,
EFFTPeakInterpolationMethod  InterpolationMethod,
EFFTWindowType  WindowType,
float  HopSize,
EAudioSpectrumType  SpectrumType 
)
static

◆ PostLoad()

void USoundSubmix::PostLoad ( )
overrideprotectedvirtual

Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

Reimplemented from USoundSubmixBase.

◆ PushModulationChanges()

void USoundSubmix::PushModulationChanges ( )
protected

◆ RemoveEnvelopeFollowerDelegate()

void USoundSubmix::RemoveEnvelopeFollowerDelegate ( const UObject WorldContextObject,
const FOnSubmixEnvelopeBP OnSubmixEnvelopeBP 
)

Remove an envelope follower delegate.

Parameters
OnSubmixEnvelopeBPThe event delegate to remove.

◆ RemoveSpectralAnalysisDelegate()

void USoundSubmix::RemoveSpectralAnalysisDelegate ( const UObject WorldContextObject,
const FOnSubmixSpectralAnalysisBP OnSubmixSpectralAnalysisBP 
)

Remove a spectral analysis delegate.

Parameters
OnSubmixSpectralAnalysisBPThe event delegate to remove.

◆ Serialize()

void USoundSubmix::Serialize ( FArchive Ar)
overrideprotectedvirtual

Handles reading, writing, and reference collecting using FArchive. This implementation handles all FProperty serialization, but can be overridden for native variables.

Reimplemented from UObject.

◆ SetDryVolumeModulation()

void USoundSubmix::SetDryVolumeModulation ( const FSoundModulationDestinationSettings InVolMod)
protected

◆ SetOutputVolumeModulation()

void USoundSubmix::SetOutputVolumeModulation ( const FSoundModulationDestinationSettings InVolMod)
protected

◆ SetWetVolumeModulation()

void USoundSubmix::SetWetVolumeModulation ( const FSoundModulationDestinationSettings InVolMod)
protected

◆ StartEnvelopeFollowing() [1/2]

void USoundSubmix::StartEnvelopeFollowing ( const UObject WorldContextObject)

◆ StartEnvelopeFollowing() [2/2]

void USoundSubmix::StartEnvelopeFollowing ( FAudioDevice InDevice)

◆ StartRecordingOutput() [1/2]

void USoundSubmix::StartRecordingOutput ( const UObject WorldContextObject,
float  ExpectedDuration 
)

◆ StartRecordingOutput() [2/2]

void USoundSubmix::StartRecordingOutput ( FAudioDevice InDevice,
float  ExpectedDuration 
)

◆ StartSpectralAnalysis() [1/2]

void USoundSubmix::StartSpectralAnalysis ( const UObject WorldContextObject,
EFFTSize  FFTSize = EFFTSize::DefaultSize,
EFFTPeakInterpolationMethod  InterpolationMethod = EFFTPeakInterpolationMethod::Linear,
EFFTWindowType  WindowType = EFFTWindowType::Hann,
float  HopSize = 0,
EAudioSpectrumType  SpectrumType = EAudioSpectrumType::MagnitudeSpectrum 
)

Start spectrum analysis of the audio output.

◆ StartSpectralAnalysis() [2/2]

void USoundSubmix::StartSpectralAnalysis ( FAudioDevice InDevice,
EFFTSize  FFTSize = EFFTSize::DefaultSize,
EFFTPeakInterpolationMethod  InterpolationMethod = EFFTPeakInterpolationMethod::Linear,
EFFTWindowType  WindowType = EFFTWindowType::Hann,
float  HopSize = 0,
EAudioSpectrumType  SpectrumType = EAudioSpectrumType::MagnitudeSpectrum 
)

◆ StopEnvelopeFollowing() [1/2]

void USoundSubmix::StopEnvelopeFollowing ( const UObject WorldContextObject)

◆ StopEnvelopeFollowing() [2/2]

void USoundSubmix::StopEnvelopeFollowing ( FAudioDevice InDevice)

◆ StopRecordingOutput() [1/2]

void USoundSubmix::StopRecordingOutput ( const UObject WorldContextObject,
EAudioRecordingExportType  ExportType,
const FString &  Name,
FString  Path,
USoundWave ExistingSoundWaveToOverwrite = nullptr 
)

◆ StopRecordingOutput() [2/2]

void USoundSubmix::StopRecordingOutput ( FAudioDevice InDevice,
EAudioRecordingExportType  ExportType,
const FString &  Name,
FString  Path,
USoundWave ExistingSoundWaveToOverwrite = nullptr 
)

◆ StopSpectralAnalysis() [1/2]

void USoundSubmix::StopSpectralAnalysis ( const UObject WorldContextObject)

Stop spectrum analysis of the audio output.

◆ StopSpectralAnalysis() [2/2]

void USoundSubmix::StopSpectralAnalysis ( FAudioDevice InDevice)

◆ UFUNCTION() [1/3]

USoundSubmix::UFUNCTION ( BlueprintCallable  ,
Category  = "Audio",
meta  = (WorldContext = "WorldContextObject", DisplayName = "SetSubmixDryLevel (linear gain)") 
) const

Sets the output volume of the submix in linear gain. This dynamic level acts as a multiplier on the DryLevel property of this submix.

◆ UFUNCTION() [2/3]

USoundSubmix::UFUNCTION ( BlueprintCallable  ,
Category  = "Audio",
meta  = (WorldContext = "WorldContextObject", DisplayName = "SetSubmixOutputVolume (linear gain)") 
) const

Sets the output volume of the submix in linear gain. This dynamic volume acts as a multiplier on the OutputVolume property of this submix.

◆ UFUNCTION() [3/3]

USoundSubmix::UFUNCTION ( BlueprintCallable  ,
Category  = "Audio",
meta  = (WorldContext = "WorldContextObject", DisplayName = "SetSubmixWetLevel (linear gain)") 
) const

Sets the output volume of the submix in linear gain. This dynamic level acts as a multiplier on the WetLevel property of this submix.

◆ UPROPERTY() [1/3]

USoundSubmix::UPROPERTY ( EditAnywhere  ,
BlueprintSetter  = SetDryVolumeModulation,
Category  = SubmixLevel,
meta  = (DisplayName="Dry Level (dB)", AudioParam="Volume", AudioParamClass="SoundModulationParameterVolume", ClampMin="-96.0", ClampMax="0.0", UIMin="-96.0", UIMax="0.0") 
)

The dry level of the submix in Decibels. Applied before submix effects and analysis are performed.

◆ UPROPERTY() [2/3]

USoundSubmix::UPROPERTY ( EditAnywhere  ,
BlueprintSetter  = SetOutputVolumeModulation,
Category  = SubmixLevel,
meta  = (DisplayName="Output Volume (dB)", AudioParam="Volume", AudioParamClass="SoundModulationParameterVolume", ClampMin="-96.0", ClampMax="0.0", UIMin="-96.0", UIMax="0.0") 
)

The output volume of the submix in Decibels. Applied after submix effects and analysis are performed.

◆ UPROPERTY() [3/3]

USoundSubmix::UPROPERTY ( EditAnywhere  ,
BlueprintSetter  = SetWetVolumeModulation,
Category  = SubmixLevel,
meta  = (DisplayName="Wet Level (dB)", AudioParam="Volume", AudioParamClass="SoundModulationParameterVolume", ClampMin="-96.0", ClampMax="0.0", UIMin="-96.0", UIMax="0.0") 
)

The wet level of the submixin Decibels. Applied after submix effects and analysis are performed.

Member Data Documentation

◆ AmbisonicsPluginSettings

TObjectPtr<USoundfieldEncodingSettingsBase> USoundSubmix::AmbisonicsPluginSettings

Optional settings used by plugins which support ambisonics file playback.

◆ AudioLinkSettings

TObjectPtr<UAudioLinkSettingsAbstract> USoundSubmix::AudioLinkSettings

Optional Audio Link Settings Object

◆ bMuteWhenBackgrounded

uint8 USoundSubmix::bMuteWhenBackgrounded

Mute this submix when the application is muted or in the background. Used to prevent submix effect tails from continuing when tabbing out of application or if application is muted.

◆ bSendToAudioLink

uint8 USoundSubmix::bSendToAudioLink

Whether to send this Submix to AudioLink (when AudioLink is Enabled)

◆ EnvelopeFollowerAttackTime

int32 USoundSubmix::EnvelopeFollowerAttackTime

The attack time in milliseconds for the envelope follower. Delegate callbacks can be registered to get the envelope value of sounds played with this submix.

◆ EnvelopeFollowerReleaseTime

int32 USoundSubmix::EnvelopeFollowerReleaseTime

The release time in milliseconds for the envelope follower. Delegate callbacks can be registered to get the envelope value of sounds played with this submix.

◆ InDryLevel

float USoundSubmix::InDryLevel

◆ InOutputVolume

float USoundSubmix::InOutputVolume

◆ InWetLevel

float USoundSubmix::InWetLevel

◆ OnSubmixRecordedFileDone

FOnSubmixRecordedFileDone USoundSubmix::OnSubmixRecordedFileDone

◆ RecordingData

TUniquePtr<Audio::FAudioRecordingData> USoundSubmix::RecordingData
protected

◆ SubmixEffectChain

TArray<TObjectPtr<USoundEffectSubmixPreset> > USoundSubmix::SubmixEffectChain

The documentation for this class was generated from the following files: