USoundfieldEndpointSubmix

Sound Submix class meant for sending soundfield-encoded audio to an external endpoint, such as a hardware binaural renderer that supports 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 USoundfieldEndpointSubmix : public USoundSubmixBase

Remarks

Sound Submix class meant for sending soundfield-encoded audio to an external endpoint, such as a hardware binaural renderer that supports ambisonics.

Variables

Name Description

Public variable

TObjectPtr< USo...

 

EncodingSettings

Public variable

TSubclassOf< US...

 

EncodingSettingsClass

Public variable

TObjectPtr< USo...

 

EndpointSettings

Public variable

TSubclassOf< UA...

 

EndpointSettingsClass

Public variable

TArray< TObject...

 

SoundfieldEffectChain

Public variable

FName

 

SoundfieldEndpointType

Currently used format.

Constructors

Name Description

Public function

USoundfieldEndpointSubmix

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

const USound...

 

GetEncodingSettings()

Public function Const

const USound...

 

GetEndpointSettings()

Public function Const

ISoundfieldE...

 

GetSoundfieldEndpointForSubmix()

Public function Const

TArray< USou...

 

GetSoundfieldProcessors()

Public function Const

bool

 

RecurseCheckChild

(
    const USoundSubmix* ChildSound...
)

Public function

void

 

SanitizeLinks()

This function goes through every child submix and the parent submix to ensure that they have a compatible format.

Overridden from UObject

Name Description

Protected function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally