ISoundfieldEndpointFactory

This factory is used to expose Soundfield Endpoint types to the editor.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IModularFeature

ISoundfieldFactory

ISoundfieldEndpointFactory

References

Module

AudioExtensions

Header

/Engine/Source/Runtime/AudioExtensions/Public/ISoundfieldEndpoint.h

Include

#include "ISoundfieldEndpoint.h"

Syntax

class ISoundfieldEndpointFactory : public ISoundfieldFactory

Remarks

This factory is used to expose Soundfield Endpoint types to the editor. Once a factory is constructed and RegisterEndpointType is called, it will be exposed as a type of endpoint That a submix in the submix graph could be constructed with. Also

that an implementation of ISoundfieldDecoder is not necessary for soundfield formats that are only used for soundfield endpoints.

Destructors

Name Description

Public function Virtual

~ISoundfieldEndpointFactory()

Virtual destructor

Functions

Name Description

Public function

TUniquePtr< ...

 

CreateNewEndpointInstance

(
    const FAudioPluginInitializationPar...,
    const ISoundfieldEndpointSettingsPr...
)

REQUIRED OVERRIDES: These overrides are required from ISoundfieldFactory: ISoundfieldFactory::CreateNewEncoderStream ISoundfieldFactory::CreateNewTranscoderStream ISoundfieldFactory::CreateNewMixerStream ISoundfieldFactory::CreateEmptyPacketISoundfieldFactory::CanTranscodeFromSoundfieldFormatISoundfieldFactory::GetCustomEncodingSettingsClass ISoundfieldFactory::GetDefaultEncodingSettingsCalled for every new endpoint submix created with this factory's endpoint type.

Public function Static

FName

 

DefaultSoundfieldEndpointName()

This is the default name used when a user creates a soundfield endpoint submix.

Public function Static

ISoundfieldE...

 

Get

(
    const FName& InName
)

Get a registered endpoint factory by name.

Public function Static

TArray< FNam...

 

GetAllSoundfieldEndpointTypes()

Public function Virtual Const

UClass *

 

GetCustomEndpointSettingsClass()

Should return the StaticClass of this factory's implementation of USoundfieldEndpointSettingsBase.

Public function

USoundfieldE...

 

GetDefaultEndpointSettings()

Return the settings an endpoint should use if a soundfield endpoint submix did not have their settings specified.

Public function

FName

 

GetEndpointTypeName()

Get the name for the endpoint type that this factory produces.

Public function Static

FName

 

GetModularFeatureName()

This is the FName used to register Soundfield Endpoint factories with the modular feature system.

Public function Static

void

 

RegisterEndpointType

(
    ISoundfieldEndpointFactory* In...
)

This needs to be called to make a soundfield format usable by the engine.

Public function Static

void

 

UnregisterEndpointType

(
    ISoundfieldEndpointFactory* In...
)

This needs to be called it an implementation of ISoundfieldFactory is about to be destroyed.

Overridden from ISoundfieldFactory

Name Description

Public function Virtual

bool

 

CanTranscodeToSoundfieldFormat

(
    FName DestinationFormat,
    const ISoundfieldEncodingSettingsPr...
)

Public function Virtual

TUniquePtr< ...

 

CreateDecoderStream

(
    const FAudioPluginInitializationPar...,
    const ISoundfieldEncodingSettingsPr...
)

This function is not necessary to override, since audio sent to an endpoint does not need to be decoded to interleaved audio buffers.

Public function Virtual

FName

 

GetSoundfieldFormatName()

Get soundfield format name

Public function Virtual

bool

 

IsEndpointFormat()

This is overridden to return true for soundfield formats that are only used for sending audio externally.