IAudioEndpointFactory Class Reference

#include <IAudioEndpoint.h>

Inheritance diagram for IAudioEndpointFactory:

Public Member Functions
virtual	~IAudioEndpointFactory ()
virtual AUDIOEXTENSIONS_API FName	GetEndpointTypeName ()
virtual AUDIOEXTENSIONS_API TUniquePtr< IAudioEndpoint >	CreateNewEndpointInstance (const FAudioPluginInitializationParams &InitInfo, const IAudioEndpointSettingsProxy &InitialSettings)
virtual AUDIOEXTENSIONS_API UClass *	GetCustomSettingsClass () const
virtual AUDIOEXTENSIONS_API const UAudioEndpointSettingsBase *	GetDefaultSettings () const

Static Public Member Functions
static AUDIOEXTENSIONS_API FName	GetTypeNameForDefaultEndpoint ()
static AUDIOEXTENSIONS_API FName	GetModularFeatureName ()
static AUDIOEXTENSIONS_API void	RegisterEndpointType (IAudioEndpointFactory *InFactory)
static AUDIOEXTENSIONS_API void	UnregisterEndpointType (IAudioEndpointFactory *InFactory)
static AUDIOEXTENSIONS_API IAudioEndpointFactory *	Get (const FName &InName)
static AUDIOEXTENSIONS_API TArray< FName >	GetAvailableEndpointTypes ()
static AUDIOEXTENSIONS_API IAudioEndpointFactory *	GetDummyFactory ()

Public Attributes
bool	bIsImplemented = false

Detailed Description

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.

Constructor & Destructor Documentation

~IAudioEndpointFactory()

virtual IAudioEndpointFactory::~IAudioEndpointFactory ( )

inlinevirtual

Virtual destructor

Member Function Documentation

CreateNewEndpointInstance()

TUniquePtr< IAudioEndpoint > IAudioEndpointFactory::CreateNewEndpointInstance ( const FAudioPluginInitializationParams &  InitInfo, const IAudioEndpointSettingsProxy &  InitialSettings  )

virtual

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

Get()

IAudioEndpointFactory * IAudioEndpointFactory::Get ( const FName &  InName )

static

Get a registered endpoint factory by name.

GetAvailableEndpointTypes()

TArray< FName > IAudioEndpointFactory::GetAvailableEndpointTypes ( )

static

GetCustomSettingsClass()

UClass * IAudioEndpointFactory::GetCustomSettingsClass ( ) const

virtual

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

GetDefaultSettings()

const UAudioEndpointSettingsBase * IAudioEndpointFactory::GetDefaultSettings ( ) const

virtual

return the settings an endpoint should use

GetDummyFactory()

IAudioEndpointFactory * IAudioEndpointFactory::GetDummyFactory ( )

static

GetEndpointTypeName()

FName IAudioEndpointFactory::GetEndpointTypeName ( )

virtual

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

GetModularFeatureName()

FName IAudioEndpointFactory::GetModularFeatureName ( )

static

This is used when calling IModularFeatures::Get().RegisterModularFeature for IAudioEndpointFactory implementations. It's not needed if one uses RegisterEndpointType() to register IAudioEndpointFactory implementations.

GetTypeNameForDefaultEndpoint()

FName IAudioEndpointFactory::GetTypeNameForDefaultEndpoint ( )

static

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

RegisterEndpointType()

void IAudioEndpointFactory::RegisterEndpointType ( IAudioEndpointFactory *  InFactory )

static

This needs to be called to make a soundfield format usable by the engine. It can be called from a ISoundfieldFactory subclass' constructor

UnregisterEndpointType()

void IAudioEndpointFactory::UnregisterEndpointType ( IAudioEndpointFactory *  InFactory )

static

This needs to be called it an implementation of ISoundfieldFactory is about to be destroyed. It can be called from the destructor of an implementation of ISoundfieldFactory.

Member Data Documentation

bIsImplemented

bool IAudioEndpointFactory::bIsImplemented = false

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/AudioExtensions/Public/IAudioEndpoint.h
• Engine/Source/Runtime/AudioExtensions/Private/IAudioEndpoint.cpp