Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

USoundfieldSubmix

Sound Submix class meant for use with soundfield formats, such as Ambisonics.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USoundSubmixBase

USoundSubmixWithParentBase

USoundfieldSubmix

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Sound/SoundSubmix.h
Include	#include "Sound/SoundSubmix.h"

Syntax

class USoundfieldSubmix : public USoundSubmixWithParentBase

Remarks

Sound Submix class meant for use with soundfield formats, such as Ambisonics.

Variables

	Name	Description
USoundfieldEnco...	EncodingSettings	TODO: Make this editable only if SoundfieldEncodingFormat is non-default, and filter classes based on ISoundfieldFactory::GetCustomSettingsClass().
TSubclassOf< US...	EncodingSettingsClass
TArray< USoundf...	SoundfieldEffectChain	TODO: make this editable only if SoundfieldEncodingFormat is non-default and filter classes based on USoundfieldProcessorBase::SupportsFormat.
FName	SoundfieldEncodingFormat	Currently used format.

Constructors

	Name	Description
	USoundfieldSubmix ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
const USound...	GetEncodingSettings()	Traverses parent submixes until we find a submix that specifies encoding settings.
const USound...	GetSoundfieldEncodingSettings()
ISoundfieldF...	GetSoundfieldFactoryForSubmix()
TArray< USou...	GetSoundfieldProcessors()
FName	GetSubmixFormat()	Traverses parent submixes until we find a submix that doesn't inherit it's soundfield format.
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.

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss