TStaticChannelAudioFormat | Unreal Engine 5.2 Documentation

API > API/Plugins > API/Plugins/MetasoundStandardNodes

Inheritance Hierarchy

References


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

Syntax

template<int32 TNumChannels>  
class TStaticChannelAudioFormat : public Metasound::IAudioDataType

Remarks

A TStaticChannelAudioFormat represents deinterleaved multichannel audio where the number of channels is known at compile time. This is primarily useful to define such cases as Stereo, Mono, Qaud, 5.1, etc.

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.

Constructors

	Type	Name	Description
		TStaticChannelAudioFormat ( int32 InNumFrames )	TStaticChannelAudioFormat Constructor
		TStaticChannelAudioFormat ( const FOperatorSettings& InOperatorSettings )
		TStaticChannelAudioFormat ( const FAudioBufferWriteRef(&) InBuffers )	TStaticChannelAudioFormat constructor with an array of writable buffers.

Functions

Type	Name	Description
FAudioBufferReadRef	GetBuffer ()	Return an readable buffer reference for a specific channel.
FAudioBufferWriteRef	GetBuffer ()	Return an writable buffer reference for a specific channel.
const TArrayView< FAudioBufferReadRef >	GetBuffers ()	Return an array view of the readable buffer references.
const TArrayView< FAudioBufferWriteRef >	GetBuffers ()	Return an array view of the writable buffer references.
int32	GetMaxNumChannels ()	Return the maximum number of channels.
int32	GetNumChannels ()	Return the number of audio channels.
const TArray< FAudioBufferReadRef >	GetStorage ()	Return an array of the readable buffer references.
const TArray< FAudioBufferWriteRef >	GetStorage ()	Return an array of the writable buffer references.

Constants

Name	Description
NumChannels

Navigation