Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Sound
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- USoundSubmixBase
- 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 USoundSubmixWithParentBase : public USoundSubmixBase
Remarks
This submix class can be derived from for submixes that output to a parent submix.
Variables
| Type | Name | Description | |
|---|---|---|---|
    |
uint8: 1 | bIsDynamic | Is Submix Dynamic. (i.e. allows connect/disconnect at runtime.) |
   |
TMap< uint32, TObjectPtr< USoundSubmixBase > > | DynamicParentSubmix | |
     |
TObjectPtr< USoundSubmixBase > | ParentSubmix |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
USoundSubmixWithParentBase
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
bool | DynamicConnect
(
const UObject* WorldContextObject, |
|
 |
bool | DynamicConnect
(
FAudioDeviceHandle Handle, |
|
 |
bool | DynamicDisconnect
(
FAudioDeviceHandle Handle |
|
  |
const USoundSubmixBase * | Const version. | |
  |
TObjectPtr< USoundSubmixBase > | GetParent
(
Audio::FDeviceId InDeviceId |
Holds the dynamic (not serialized) parent for this Submix. Overrides the serialized one. |
 |
void | SetParentSubmix
(
USoundSubmixBase* InParentSubmix, |
Set the parent submix of this SoundSubmix, removing it as a child from its previous owner |
Overridden from USoundSubmixBase
| Type | Name | Description | |
|---|---|---|---|
  |
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 | PostDuplicate
(
EDuplicateMode::Type DuplicateMode |
|
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |