Navigation
API > API/Runtime > API/Runtime/Engine
Sound Submix class meant for sending soundfield-encoded audio to an external endpoint, such as a hardware binaural renderer that supports ambisonics.
| Name | USoundfieldEndpointSubmix |
| 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 Endpoint"), MinimalAPI)
class USoundfieldEndpointSubmix : public USoundSubmixBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USoundSubmixBase → USoundfieldEndpointSubmix
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
USoundfieldEndpointSubmix
(
const FObjectInitializer& ObjectInitializer |
Sound/SoundSubmix.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| EncodingSettings | TObjectPtr< USoundfieldEncodingSettingsBase > | Sound/SoundSubmix.h |
|
|
| EncodingSettingsClass | TSubclassOf< USoundfieldEncodingSettingsBase > | Sound/SoundSubmix.h | ||
| EndpointSettings | TObjectPtr< USoundfieldEndpointSettingsBase > | Sound/SoundSubmix.h |
|
|
| EndpointSettingsClass | TSubclassOf< UAudioEndpointSettingsBase > | Sound/SoundSubmix.h | ||
| SoundfieldEffectChain | TArray< TObjectPtr< USoundfieldEffectBase > > | Sound/SoundSubmix.h |
|
|
| SoundfieldEndpointType | FName | Currently used format. | Sound/SoundSubmix.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const USoundfieldEncodingSettingsBase * GetEncodingSettings() |
Sound/SoundSubmix.h | ||
const USoundfieldEndpointSettingsBase * GetEndpointSettings() |
Sound/SoundSubmix.h | ||
ISoundfieldEndpointFactory * GetSoundfieldEndpointForSubmix() |
Sound/SoundSubmix.h | ||
TArray< USoundfieldEffectBase * > GetSoundfieldProcessors() |
Sound/SoundSubmix.h | ||
bool RecurseCheckChild
(
const USoundSubmix* ChildSoundSubmix |
Sound/SoundSubmix.h | ||
void SanitizeLinks() |
This function goes through every child submix and the parent submix to ensure that they have a compatible 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 |