Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Sound
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- USoundSubmixBase
- UEndpointSubmix
- USoundfieldEndpointSubmix
- USoundSubmixWithParentBase
- USoundfieldSubmix
- USoundSubmix
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Classes/Sound/SoundSubmix.h |
| Include | #include "Sound/SoundSubmix.h" |
Syntax
UCLASS (Config=Engine, Abstract, HideCategories=Object, EditInlineNew, BlueprintType, MinimalAPI)
class USoundSubmixBase : public UObject
Variables
| Type | Name | Description | |
|---|---|---|---|
     |
float | AutoDisableTime | 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. |
     |
bool | bAutoDisable | 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. |
     |
TArray< TObjectPtr< USoundSubmixBase > > | ChildSubmixes | Child submixes to this sound mix. |
   |
TMap< uint32, FDynamicChildSubmix > | DynamicChildSubmixes | Dynamic Child submixes (Map of AudioDevice -> [Submix] ) |
 |
TObjectPtr< UEdGraph > | SoundSubmixGraph | EdGraph based representation of the SoundSubmix |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
USoundSubmixBase
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
void | AddReferencedObjects
(
UObject* InThis, |
Sound Submix Editor functionality. |
    |
bool | DynamicConnect
(
const UObject* WorldContextObject, |
Dynamically Connects to a parent submix. |
    |
bool | DynamicDisconnect
(
const UObject* WorldContextObject |
Dynamically Disconnect from a parent. |
    |
USoundSubmixBase * | Searching upwards from this Submix to the root looking for the first Submix marked Dynamic If this Submix is Dynamic this will be returned. | |
   |
bool | IsDynamic
(
const bool bIncludeAncestors |
If this Submix is (or any of its parents are marked dynamic). |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | BeginDestroy () |
Called before destroying the object. |
  |
FString | GetDesc () |
Return a one line description of an object for viewing in the thumbnail view of the generic browser |
  |
void | PostDuplicate
(
EDuplicateMode::Type DuplicateMode |
|
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |
  |
void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |
  |
void | PreEditChange
(
FProperty* PropertyAboutToChange |
This is called when a property is about to be modified externally |
Constants
| Name | Description |
|---|---|
| BackupChildSubmixes |