Navigation
API > API/Runtime > API/Runtime/AudioExtensions
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.
| Name | IAudioEndpointFactory |
| Type | class |
| Header File | /Engine/Source/Runtime/AudioExtensions/Public/IAudioEndpoint.h |
| Include Path | #include "IAudioEndpoint.h" |
Syntax
class IAudioEndpointFactory : public IModularFeature
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IAudioEndpointFactory() |
Virtual destructor | IAudioEndpoint.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsImplemented | bool | IAudioEndpoint.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TUniquePtr< IAudioEndpoint > CreateNewEndpointInstance
(
const FAudioPluginInitializationParams& InitInfo, |
Called for every new endpoint submix created with this factory's endpoint type. | IAudioEndpoint.h | |
virtual UClass * GetCustomSettingsClass() |
Should return the StaticClass of this factory's implementation of UAudioEndpointSettingsBase. | IAudioEndpoint.h | |
virtual const UAudioEndpointSettingsBase * GetDefaultSettings() |
Return the settings an endpoint should use | IAudioEndpoint.h | |
virtual FName GetEndpointTypeName() |
Get the name for the endpoint type that this factory produces. | IAudioEndpoint.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IAudioEndpointFactory * Get
(
const FName& InName |
Get a registered endpoint factory by name. | IAudioEndpoint.h | |
| IAudioEndpoint.h | |||
static IAudioEndpointFactory * GetDummyFactory() |
IAudioEndpoint.h | ||
static FName GetModularFeatureName () |
This is used when calling IModularFeatures::Get().RegisterModularFeature for IAudioEndpointFactory implementations. | IAudioEndpoint.h | |
static FName GetTypeNameForDefaultEndpoint() |
This is a special cased name for endpoint submixes that render directly to the default audio device in Audio::FMixerDevice::OnProcessAudioStream. | IAudioEndpoint.h | |
static void RegisterEndpointType
(
IAudioEndpointFactory* InFactory |
This needs to be called to make a soundfield format usable by the engine. | IAudioEndpoint.h | |
static void UnregisterEndpointType
(
IAudioEndpointFactory* InFactory |
This needs to be called it an implementation of ISoundfieldFactory is about to be destroyed. | IAudioEndpoint.h |