IAudioEndpointFactory | Unreal Engine 5.2 Documentation

API > API/Runtime > API/Runtime/AudioExtensions

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

	Type	Name	Description
	bool	bIsImplemented

Destructors

	Type	Name	Description
		~IAudioEndpointFactory ()	Virtual destructor

Functions

Type	Name	Description
TUniquePtr< IAudioEndpoint >	CreateNewEndpointInstance ( const FAudioPluginInitializationParams& InitInfo, const IAudioEndpointSettingsProxy& InitialSettings )	Called for every new endpoint submix created with this factory's endpoint type.
IAudioEndpointFactory *	Get ( const FName& InName )	Get a registered endpoint factory by name.
TArray< FName >	GetAvailableEndpointTypes ()
UClass *	GetCustomSettingsClass ()	Should return the StaticClass of this factory's implementation of UAudioEndpointSettingsBase.
const UAudioEndpointSettingsBase *	GetDefaultSettings ()	Return the settings an endpoint should use
IAudioEndpointFactory *	GetDummyFactory ()
FName	GetEndpointTypeName ()	Get the name for the endpoint type that this factory produces.
FName	GetModularFeatureName ()	This is used when calling IModularFeatures::Get().RegisterModularFeature for IAudioEndpointFactory implementations.
FName	GetTypeNameForDefaultEndpoint ()	This is a special cased name for endpoint submixes that render directly to the default audio device in Audio::FMixerDevice::OnProcessAudioStream.
void	RegisterEndpointType ( IAudioEndpointFactory* InFactory )	This needs to be called to make a soundfield format usable by the engine.
void	UnregisterEndpointType ( IAudioEndpointFactory* InFactory )	This needs to be called it an implementation of ISoundfieldFactory is about to be destroyed.

Navigation