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 > ISoundfieldEndpointFactory

Light Theme

Dark Theme

ISoundfieldEndpointFactory

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

Windows

MacOS

Linux

Inheritance Hierarchy

IModularFeature

ISoundfieldFactory

ISoundfieldEndpointFactory

References

Module	AudioExtensions
Header	/Engine/Source/Runtime/AudioExtensions/Public/ISoundfieldEndpoint.h
Include	#include "ISoundfieldEndpoint.h"

Syntax

class ISoundfieldEndpointFactory : public ISoundfieldFactory

Remarks

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.

Destructors

	Name	Description
	~ISoundfieldEndpointFactory()	Virtual destructor

Functions

	Name	Description
TUniquePtr< ...	CreateNewEndpointInstance ( const FAudioPluginInitializationPar..., const ISoundfieldEndpointSettingsPr... )	REQUIRED OVERRIDES: These overrides are required from ISoundfieldFactory: ISoundfieldFactory::CreateNewEncoderStream ISoundfieldFactory::CreateNewTranscoderStream ISoundfieldFactory::CreateNewMixerStream ISoundfieldFactory::CreateEmptyPacket ISoundfieldFactory::CanTranscodeFromSoundfieldFormat ISoundfieldFactory::GetCustomEncodingSettingsClass ISoundfieldFactory::GetDefaultEncodingSettingsCalled for every new endpoint submix created with this factory's endpoint type.
FName	DefaultSoundfieldEndpointName()	This is the default name used when a user creates a soundfield endpoint submix.
ISoundfieldE...	Get ( const FName& InName )	Get a registered endpoint factory by name.
TArray< FNam...	GetAllSoundfieldEndpointTypes()
UClass *	GetCustomEndpointSettingsClass()	Should return the StaticClass of this factory's implementation of USoundfieldEndpointSettingsBase.
USoundfieldE...	GetDefaultEndpointSettings()	Return the settings an endpoint should use if a soundfield endpoint submix did not have their settings specified.
FName	GetEndpointTypeName()	Get the name for the endpoint type that this factory produces.
FName	GetModularFeatureName()	This is the FName used to register Soundfield Endpoint factories with the modular feature system.
void	RegisterEndpointType ( ISoundfieldEndpointFactory* In... )	This needs to be called to make a soundfield format usable by the engine.
void	UnregisterEndpointType ( ISoundfieldEndpointFactory* In... )	This needs to be called it an implementation of ISoundfieldFactory is about to be destroyed.

Overridden from ISoundfieldFactory

	Name	Description
bool	CanTranscodeToSoundfieldFormat ( FName DestinationFormat, const ISoundfieldEncodingSettingsPr... )
TUniquePtr< ...	CreateDecoderStream ( const FAudioPluginInitializationPar..., const ISoundfieldEncodingSettingsPr... )	This function is not necessary to override, since audio sent to an endpoint does not need to be decoded to interleaved audio buffers.
FName	GetSoundfieldFormatName()	Get soundfield format name
bool	IsEndpointFormat()	This is overridden to return true for soundfield formats that are only used for sending audio externally.

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

Take our survey

Dismiss