ISoundfieldEndpointFactory | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/AudioExtensions

This factory is used to expose Soundfield 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. Also note that an implementation of ISoundfieldDecoder is not necessary for soundfield formats that are only used for soundfield endpoints.


Name	ISoundfieldEndpointFactory
Type	class
Header File	/Engine/Source/Runtime/AudioExtensions/Public/ISoundfieldEndpoint.h
Include Path	#include "ISoundfieldEndpoint.h"

Syntax

class ISoundfieldEndpointFactory : public ISoundfieldFactory

Implements Interfaces

ISoundfieldFactory

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~ISoundfieldEndpointFactory()	Virtual destructor	ISoundfieldEndpoint.h

Functions

Public

Name	Remarks	Include Path
TUniquePtr< ISoundfieldEndpoint > CreateNewEndpointInstance ( const FAudioPluginInitializationParams& InitInfo, const ISoundfieldEndpointSettingsProxy& InitialSettings )	REQUIRED OVERRIDES: These overrides are required from ISoundfieldFactory: ISoundfieldFactory::CreateNewEncoderStream ISoundfieldFactory::CreateNewTranscoderStream ISoundfieldFactory::CreateNewMixerStream ISoundfieldFactory::CreateEmptyPacketISoundfieldFactory::CanTranscodeFromSoundfieldFormatISoundfieldFactory::GetCustomEncodingSettingsClassISoundfieldFactory::GetDefaultEncodingSettings Called for every new endpoint submix created with this factory's endpoint type.	ISoundfieldEndpoint.h
virtual UClass * GetCustomEndpointSettingsClass()	Should return the StaticClass of this factory's implementation of USoundfieldEndpointSettingsBase.	ISoundfieldEndpoint.h
USoundfieldEndpointSettingsBase * GetDefaultEndpointSettings()	Return the settings an endpoint should use if a soundfield endpoint submix did not have their settings specified.	ISoundfieldEndpoint.h
FName GetEndpointTypeName()	Get the name for the endpoint type that this factory produces.	ISoundfieldEndpoint.h

Overridden from ISoundfieldFactory

Name	Remarks	Include Path
virtual bool CanTranscodeToSoundfieldFormat ( FName DestinationFormat, const ISoundfieldEncodingSettingsProxy& DestinationEncodingSettings )		ISoundfieldEndpoint.h
virtual TUniquePtr< ISoundfieldDecoderStream > CreateDecoderStream ( const FAudioPluginInitializationParams& InitInfo, const ISoundfieldEncodingSettingsProxy& InitialSettings )	This function is not necessary to override, since audio sent to an endpoint does not need to be decoded to interleaved audio buffers.	ISoundfieldEndpoint.h
virtual FName GetSoundfieldFormatName()	Get soundfield format name	ISoundfieldEndpoint.h
virtual bool IsEndpointFormat ()	This is overridden to return true for soundfield formats that are only used for sending audio externally.	ISoundfieldEndpoint.h

Static

Name	Remarks	Include Path
static FName DefaultSoundfieldEndpointName ()	This is the default name used when a user creates a soundfield endpoint submix.	ISoundfieldEndpoint.h
static ISoundfieldEndpointFactory * Get ( const FName& InName )	Get a registered endpoint factory by name.	ISoundfieldEndpoint.h
static TArray< FName > GetAllSoundfieldEndpointTypes()		ISoundfieldEndpoint.h
static FName GetModularFeatureName()	This is the FName used to register Soundfield Endpoint factories with the modular feature system.	ISoundfieldEndpoint.h
static void RegisterEndpointType ( ISoundfieldEndpointFactory* InFactory )	This needs to be called to make a soundfield format usable by the engine.	ISoundfieldEndpoint.h
static void UnregisterEndpointType ( ISoundfieldEndpointFactory* InFactory )	This needs to be called it an implementation of ISoundfieldFactory is about to be destroyed.	ISoundfieldEndpoint.h

Navigation