Navigation
API > API/Runtime > API/Runtime/Engine
| Name | USoundSubmixBase |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Sound/SoundSubmix.h |
| Include Path | #include "Sound/SoundSubmix.h" |
Syntax
UCLASS (Config=Engine, Abstract, HideCategories=Object, EditInlineNew, BlueprintType, MinimalAPI)
class USoundSubmixBase : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USoundSubmixBase
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
USoundSubmixBase
(
const FObjectInitializer& ObjectInitializer |
Sound/SoundSubmix.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| BackupChildSubmixes | TArray< TObjectPtr< USoundSubmixBase > > | Sound/SoundSubmix.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AutoDisableTime | float | The minimum amount of time to wait before automatically disabling a submix if it is silent. Will immediately re-enable if source audio is sent to it. | Sound/SoundSubmix.h |
|
| bAutoDisable | bool | Auto-manage enabling and disabling the submix as a CPU optimization. It will be disabled if the submix and all child submixes are silent. It will re-enable if a sound is sent to the submix or a child submix is audible. | Sound/SoundSubmix.h |
|
| ChildSubmixes | TArray< TObjectPtr< USoundSubmixBase > > | Child submixes to this sound mix. | Sound/SoundSubmix.h |
|
| DynamicChildSubmixes | TMap< uint32, FDynamicChildSubmix > | Dynamic Child submixes (Map of AudioDevice -> [Submix] ) | Sound/SoundSubmix.h |
|
| SoundSubmixGraph | TObjectPtr< UEdGraph > | EdGraph based representation of the SoundSubmix | Sound/SoundSubmix.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool DynamicConnect
(
const UObject* WorldContextObject, |
Dynamically Connects to a parent submix. | Sound/SoundSubmix.h |
|
virtual bool DynamicDisconnect
(
const UObject* WorldContextObject |
Dynamically Disconnect from a parent. | Sound/SoundSubmix.h |
|
virtual USoundSubmixBase * FindDynamicAncestor() |
Searching upwards from this Submix to the root looking for the first Submix marked Dynamic If this Submix is Dynamic this will be returned. | Sound/SoundSubmix.h |
|
virtual bool IsDynamic
(
const bool bIncludeAncestors |
If this Submix is (or any of its parents are marked dynamic). | Sound/SoundSubmix.h |
Protected
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
Sound/SoundSubmix.h | ||
virtual FString GetDesc() |
Sound/SoundSubmix.h | ||
virtual void PostDuplicate
(
EDuplicateMode::Type DuplicateMode |
Sound/SoundSubmix.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Sound/SoundSubmix.h | ||
virtual void PostLoad() |
Sound/SoundSubmix.h | ||
virtual void PreEditChange
(
FProperty* PropertyAboutToChange |
Sound/SoundSubmix.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void AddReferencedObjects
(
UObject* InThis, |
Sound Submix Editor functionality. | Sound/SoundSubmix.h |