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

Light Theme

Dark Theme

ISoundfieldFactory

Windows

MacOS

Linux

Inheritance Hierarchy

IModularFeature

ISoundfieldFactory

	FAmbisonicsSoundfieldFormat
	FOculusAmbisonicsFactory
	ISoundfieldEndpointFactory

References

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

Syntax

class ISoundfieldFactory : public IModularFeature

Destructors

	Name	Description
	~ISoundfieldFactory()	Virtual destructor

Functions

	Name	Description
bool	CanTranscodeFromSoundfieldFormat ( FName SourceFormat, const ISoundfieldEncodingSettingsPr... )	Override this function to decide whether this soundfield format can read and convert from a source format.
bool	CanTranscodeToSoundfieldFormat ( FName DestinationFormat, const ISoundfieldEncodingSettingsPr... )
TUniquePtr< ...	CreateDecoderStream ( const FAudioPluginInitializationPar..., const ISoundfieldEncodingSettingsPr... )
TUniquePtr< ...	CreateEmptyPacket()
TUniquePtr< ...	CreateEncoderStream ( const FAudioPluginInitializationPar..., const ISoundfieldEncodingSettingsPr... )	Called when a stream is opened.
TUniquePtr< ...	CreateMixerStream ( const ISoundfieldEncodingSettingsPr... )
TUniquePtr< ...	CreateTranscoderStream ( const FName SourceFormat, const ISoundfieldEncodingSettingsPr..., const FName DestinationFormat, const ISoundfieldEncodingSettingsPr..., const FAudioPluginInitializationPar... )	Transcoder streams are fed a soundfield audio packet with either a different format entirely, or the same format and different settings.
ISoundfieldF...	Get ( const FName& InName )	Get a registered soundfield format factory by name.
TArray< FNam...	GetAvailableSoundfieldFormats()
UClass *	GetCustomEncodingSettingsClass()	Should return the StaticClass of your implementation of USoundfieldEncodingSettingsBase.
const USound...	GetDefaultEncodingSettings()
FName	GetFormatNameForInheritedEncoding()	When a submix has this format name, it derives its format from the submix it sends audio to.
FName	GetFormatNameForNoEncoding()	When a submix has this format name, it is using interleaved, floating point audio with no metadata.
FName	GetModularFeatureName()	This is the FName used to register Soundfield Format factories with the modular feature system.
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.
bool	IsTranscodeRequiredBetweenSettings ( const ISoundfieldEncodingSettingsPr..., const ISoundfieldEncodingSettingsPr... )	Override this function to determine whether an incoming ISoundfieldPacket would need to be explicitly operated on between two submixes with the same format, but potentially different encoding settings.
void	RegisterSoundfieldFormat ( ISoundfieldFactory* InFactory )	This needs to be called to make a soundfield format usable by the engine.
bool	ShouldEncodeAllStreamsIndependently ( const ISoundfieldEncodingSettingsPr... )	If this is overridden to true, we will set up a separate encoding stream for every submix plugged into this soundfield submix.
void	UnregisterSoundfieldFormat ( ISoundfieldFactory* InFactory )	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