FMultichannelAudioFormat | Unreal Engine 5.1 Documentation

Inheritance Hierarchy


Module	MetasoundStandardNodes
Header	/Engine/Plugins/Runtime/Metasound/Source/MetasoundStandardNodes/Public/MetasoundAudioFormats.h
Include	#include "MetasoundAudioFormats.h"

class FMultichannelAudioFormat : public Metasound::IAudioDataType

FMultichannelAudioFormat represents deinterleaved multichannel audio which supports a constant number of channels for the lifetime of the object.

The audio buffers in FMultichannelAudioFormat are shared data references which can be accessed outside of the FMultichannelAudioFormat. All audio buffers within a FMultichannelAudioFormat object must contain the same number of audio frames.

	Type	Name	Description
		FMultichannelAudioFormat ()
		FMultichannelAudioFormat ( TArrayView< const FAudioBufferWriteRef > InWriteRefs )	FMultichannelAudioFormat Constructor.
		FMultichannelAudioFormat ( const FMultichannelAudioFormat& InOther )	Enable the copy constructor.
		FMultichannelAudioFormat ( int32 InNumFrames, int32 InNumChannels )	FMultichannelAudioFormat Constructor.
		FMultichannelAudioFormat ( const FOperatorSettings& InSettings, int32 InNumChannels )	FMultichannelAudioFormat Constructor used by the metasound frontend.

Type	Name	Description
const TArrayView< const FAudioBufferReadRef >	GetBuffers ()	Return an array view of the readable buffer references.
const TArrayView< const FAudioBufferWriteRef >	GetBuffers ()	Return an array view of the writable buffer references.
int32	GetMaxNumChannels ()	Return the maximum number of channels.
int32	GetNumChannels ()	Disable move operator so channel count does not change FMultichannelAudioFormat& operator=(FMultichannelAudioFormat&& Other) = delete; Return the number of audio channels.
const TArray< FAudioBufferReadRef > &	GetStorage ()	Return an array of the readable buffer reference storage.
const TArray< FAudioBufferWriteRef > &	GetStorage ()	Return an array of the writable buffer reference storage.