IAudioEndpointFactory

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IModularFeature

IAudioEndpointFactory

References

Module

AudioExtensions

Header

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

Include

#include "IAudioEndpoint.h"

Syntax

class IAudioEndpointFactory : public IModularFeature

Remarks

This factory is used to expose 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.

Variables

Name Description

Public variable

bool

 

bIsImplemented

Destructors

Name Description

Public function Virtual

~IAudioEndpointFactory()

Virtual destructor

Functions

Name Description

Public function Virtual

TUniquePtr< ...

 

CreateNewEndpointInstance

(
    const FAudioPluginInitializationPar...,
    const IAudioEndpointSettingsProxy&...
)

Called for every new endpoint submix created with this factory's endpoint type.

Public function Static

IAudioEndpoi...

 

Get

(
    const FName& InName
)

Get a registered endpoint factory by name.

Public function Static

TArray< FNam...

 

GetAvailableEndpointTypes()

Public function Virtual Const

UClass *

 

GetCustomSettingsClass()

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

Public function Virtual Const

const UAudio...

 

GetDefaultSettings()

Return the settings an endpoint should use

Public function Static

IAudioEndpoi...

 

GetDummyFactory()

Public function Virtual

FName

 

GetEndpointTypeName()

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

Public function Static

FName

 

GetModularFeatureName()

This is used when calling IModularFeatures::Get().RegisterModularFeature for IAudioEndpointFactory implementations.

Public function Static

FName

 

GetTypeNameForDefaultEndpoint()

This is a special cased name for endpoint submixes that render directly to the default audio device in Audio::FMixerDevice::OnProcessAudioStream.

Public function Static

void

 

RegisterEndpointType

(
    IAudioEndpointFactory* InFacto...
)

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

Public function Static

void

 

UnregisterEndpointType

(
    IAudioEndpointFactory* InFacto...
)

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