Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > AudioExtensions > IAudioEndpointFactory

Light Theme

Dark Theme

IAudioEndpointFactory

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

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.

Destructors

	Name	Description
	~IAudioEndpointFactory()	Virtual destructor

Functions

	Name	Description
TUniquePtr< ...	CreateNewEndpointInstance ( const FAudioPluginInitializationPar..., const IAudioEndpointSettingsProxy&... )	Called for every new endpoint submix created with this factory's endpoint type.
IAudioEndpoi...	Get ( const FName& InName )	Get a registered endpoint factory by name.
TArray< FNam...	GetAvailableEndpointTypes()
UClass *	GetCustomSettingsClass()	Should return the StaticClass of this factory's implementation of UAudioEndpointSettingsBase.
const UAudio...	GetDefaultSettings()	Return the settings an endpoint should use if
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* InFacto... )	This needs to be called to make a soundfield format usable by the engine.
void	UnregisterEndpointType ( IAudioEndpointFactory* InFacto... )	This needs to be called it an implementation of ISoundfieldFactory is about to be destroyed.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss