Navigation
API > API/Plugins > API/Plugins/MetasoundStandardNodes
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.
| Name | FMultichannelAudioFormat |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Metasound/Source/MetasoundStandardNodes/Public/MetasoundAudioFormats.h |
| Include Path | #include "MetasoundAudioFormats.h" |
Syntax
class FMultichannelAudioFormat : public Metasound::IAudioDataType
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| MetasoundAudioFormats.h | |||
FMultichannelAudioFormat
(
TArrayView< const FAudioBufferWriteRef > InWriteRefs |
FMultichannelAudioFormat Constructor. | MetasoundAudioFormats.h | |
FMultichannelAudioFormat
(
const FMultichannelAudioFormat& InOther |
Enable the copy constructor. | MetasoundAudioFormats.h | |
FMultichannelAudioFormat
(
TArrayView< const FAudioBufferReadRef > InReadRefs |
Construct a FMultichannelAudioFormat with an array of readable buffers. | MetasoundAudioFormats.h | |
FMultichannelAudioFormat
(
int32 InNumFrames, |
FMultichannelAudioFormat Constructor. | MetasoundAudioFormats.h | |
FMultichannelAudioFormat
(
const FOperatorSettings& InSettings, |
FMultichannelAudioFormat Constructor used by the metasound frontend. | MetasoundAudioFormats.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| NumChannels | int32 | MetasoundAudioFormats.h | ||
| ReadableBuffers | TArrayView< const FAudioBufferReadRef > | MetasoundAudioFormats.h | ||
| ReadableBufferStorage | TArray< FAudioBufferReadRef > | MetasoundAudioFormats.h | ||
| WritableBuffers | TArrayView< const FAudioBufferWriteRef > | MetasoundAudioFormats.h | ||
| WritableBufferStorage | TArray< FAudioBufferWriteRef > | MetasoundAudioFormats.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const TArrayView< const FAudioBufferReadRef > GetBuffers () |
Return an array view of the readable buffer references. | MetasoundAudioFormats.h | |
const TArrayView< const FAudioBufferWriteRef > GetBuffers () |
Return an array view of the writable buffer references. | MetasoundAudioFormats.h | |
int32 GetMaxNumChannels () |
Return the maximum number of channels. | MetasoundAudioFormats.h | |
int32 GetNumChannels() |
Disable move operator so channel count does not change FMultichannelAudioFormat& operator=(FMultichannelAudioFormat&& Other) = delete; Return the number of audio channels. | MetasoundAudioFormats.h | |
const TArray< FAudioBufferReadRef > & GetStorage () |
Return an array of the readable buffer reference storage. | MetasoundAudioFormats.h | |
const TArray< FAudioBufferWriteRef > & GetStorage () |
Return an array of the writable buffer reference storage. | MetasoundAudioFormats.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMultichannelAudioFormat & operator=
(
const FMultichannelAudioFormat& Other |
Disable equal operator so channel count does not change. | MetasoundAudioFormats.h |