Navigation
API > API/Runtime > API/Runtime/Engine
Sound Submix class meant for use with soundfield formats, such as Ambisonics.
| Name | USoundfieldSubmix |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Sound/SoundSubmix.h |
| Include Path | #include "Sound/SoundSubmix.h" |
Syntax
UCLASS (Config=Engine, HideCategories=Object, EditInlineNew, BlueprintType,
Meta=(DisplayName="Sound Submix Soundfield"), MinimalAPI)
class USoundfieldSubmix : public USoundSubmixWithParentBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USoundSubmixBase → USoundSubmixWithParentBase → USoundfieldSubmix
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
USoundfieldSubmix
(
const FObjectInitializer& ObjectInitializer |
Sound/SoundSubmix.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| EncodingSettings | TObjectPtr< USoundfieldEncodingSettingsBase > | Which encoding settings to use the sound field. | Sound/SoundSubmix.h |
|
| EncodingSettingsClass | TSubclassOf< USoundfieldEncodingSettingsBase > | Sound/SoundSubmix.h | ||
| SoundfieldEffectChain | TArray< TObjectPtr< USoundfieldEffectBase > > | Soundfield effect chain to use for the sound field. | Sound/SoundSubmix.h |
|
| SoundfieldEncodingFormat | FName | Currently used format. | Sound/SoundSubmix.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const USoundfieldEncodingSettingsBase * GetEncodingSettings() |
Traverses parent submixes until we find a submix that specifies encoding settings. | Sound/SoundSubmix.h | |
const USoundfieldEncodingSettingsBase * GetSoundfieldEncodingSettings() |
Sound/SoundSubmix.h | ||
ISoundfieldFactory * GetSoundfieldFactoryForSubmix() |
Sound/SoundSubmix.h | ||
TArray< USoundfieldEffectBase * > GetSoundfieldProcessors() |
Sound/SoundSubmix.h | ||
FName GetSubmixFormat() |
Traverses parent submixes until we find a submix that doesn't inherit its soundfield format. | Sound/SoundSubmix.h | |
void SanitizeLinks() |
This function goes through every child submix and the parent submix to ensure that they have a compatible format with this submix's format. | Sound/SoundSubmix.h |
Protected
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Sound/SoundSubmix.h | ||
virtual void PostLoad() |
Sound/SoundSubmix.h |