Navigation
API > API/Plugins > API/Plugins/MetasoundFrontend
FMetaSoundParameterTransmitter provides a communication interface for sending values to a MetaSound instance. It relies on the send/receive transmission system to ferry data from the transmitter to the MetaSound instance. Data will be safely ushered across thread boundaries in scenarios where the instance transmitter and metasound instance live on different threads.
| Name | FMetaSoundParameterTransmitter |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundParameterTransmitter.h |
| Include Path | #include "MetasoundParameterTransmitter.h" |
Syntax
class FMetaSoundParameterTransmitter : public Audio::FParameterTransmitterBase
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| MetasoundParameterTransmitter.h | |||
FMetaSoundParameterTransmitter
(
FMetaSoundParameterTransmitter::FInitParams&& InInitParams |
MetasoundParameterTransmitter.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FMetaSoundParameterTransmitter() |
MetasoundParameterTransmitter.h |
Structs
| Name | Remarks |
|---|---|
| FInitParams | Initialization parameters for a FMetaSoundParameterTransmitter. |
| FParameter | |
| FSendInfo | FSendInfo describes the MetaSounds input parameters as well as the necessary information to route data to the instances inputs. |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AvailableParameterNames | TArray< FName > | MetasoundParameterTransmitter.h | ||
| DataChannel | TSharedPtr< TSpscQueue< FParameter > > | MetasoundParameterTransmitter.h | ||
| DebugMetaSoundName | FName | MetasoundParameterTransmitter.h | ||
| InstanceID | uint64 | MetasoundParameterTransmitter.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddAvailableParameter
(
FName InName |
MetasoundParameterTransmitter.h | ||
void RemoveAvailableParameter
(
FName InName |
MetasoundParameterTransmitter.h | ||
| Set a parameter using a literal. | MetasoundParameterTransmitter.h |
Overridden from IParameterTransmitter
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool SetParameters
(
TArray< FAudioParameter >&& InParameters |
Sets parameters using array of AudioParameter structs | MetasoundParameterTransmitter.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FSendAddress CreateSendAddressFromEnvironment
(
const FMetasoundEnvironment& InEnvironment, |
Creates a unique send address using the given MetaSound environment. | MetasoundParameterTransmitter.h | |
static FSendAddress CreateSendAddressFromInstanceID
(
uint64 InInstanceID, |
Creates a unique send address using the given InstanceID. | MetasoundParameterTransmitter.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMetaSoundParameterTransmitter & operator=
(
const FMetaSoundParameterTransmitter& |
MetasoundParameterTransmitter.h |