USoundfieldSubmix

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

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

Public variable

TObjectPtr< USo...

 

EncodingSettings

Which encoding settings to use the sound field.

Public variable

TSubclassOf< US...

 

EncodingSettingsClass

Public variable

TArray< TObject...

 

SoundfieldEffectChain

Soundfield effect chain to use for the sound field.

Public variable

FName

 

SoundfieldEncodingFormat

Currently used format.

Constructors

Name Description

Public function

USoundfieldSubmix

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

const USound...

 

GetEncodingSettings()

Traverses parent submixes until we find a submix that specifies encoding settings.

Public function Const

const USound...

 

GetSoundfieldEncodingSettings()

Public function Const

ISoundfieldF...

 

GetSoundfieldFactoryForSubmix()

Public function Const

TArray< USou...

 

GetSoundfieldProcessors()

Public function Const

FName

 

GetSubmixFormat()

Traverses parent submixes until we find a submix that doesn't inherit it's soundfield format.

Public function

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

Protected function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally