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 > Plugins > SoundFields > FAmbisonicsSoundfieldFormat

Light Theme

Dark Theme

FAmbisonicsSoundfieldFormat

This is the default format for Ambisonics in the Unreal Audio Engine.

Windows

MacOS

Linux

Inheritance Hierarchy

IModularFeature

ISoundfieldFactory

FAmbisonicsSoundfieldFormat

References

Module	SoundFields
Header	/Engine/Plugins/Runtime/SoundFields/Source/SoundFields/Public/SoundFields.h
Include	#include "SoundFields.h"

Syntax

class FAmbisonicsSoundfieldFormat : public ISoundfieldFactory

Remarks

This is the default format for Ambisonics in the Unreal Audio Engine.

Constructors

	Name	Description
	FAmbisonicsSoundfieldFormat()

Destructors

	Name	Description
	~FAmbisonicsSoundfieldFormat()	Dtor

Overridden from ISoundfieldFactory

	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.
UClass *	GetCustomEncodingSettingsClass()	Should return the StaticClass of your implementation of USoundfieldEncodingSettingsBase.
USoundfieldE...	GetDefaultEncodingSettings()
FName	GetSoundfieldFormatName()	Begin ISoundfieldFactory.
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.

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

Take our survey

Dismiss