Navigation
API > API/Plugins > API/Plugins/MetasoundFrontend
Inheritance Hierarchy
- ILegacyParameterTransmitter
- IParameterTransmitter
- FParameterTransmitterBase
- FMetaSoundParameterTransmitter
References
| Module | MetasoundFrontend |
| Header | /Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundParameterTransmitter.h |
| Include | #include "MetasoundParameterTransmitter.h" |
Syntax
class FMetaSoundParameterTransmitter : public Audio::FParameterTransmitterBase
Remarks
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.
Constructors
| Type | Name | Description | |
|---|---|---|---|
FMetaSoundParameterTransmitter
(
FMetaSoundParameterTransmitter::FInitParams&& InInitParams |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddAvailableParameter
(
FName InName |
||
| FSendAddress | CreateSendAddressFromEnvironment
(
const FMetasoundEnvironment& InEnvironment, |
Creates a unique send address using the given MetaSound environment. | |
| FSendAddress | CreateSendAddressFromInstanceID
(
uint64 InInstanceID, |
Creates a unique send address using the given InstanceID. | |
| void | RemoveAvailableParameter
(
FName InName |
||
| bool | SetParameterWithLiteral
(
FName InParameterName, |
Set a parameter using a literal. |
Overridden from IParameterTransmitter
| Type | Name | Description | |
|---|---|---|---|
| bool | Reset () |
||
| bool | SetParameters
(
TArray< FAudioParameter >&& InParameters |
Sets parameters using array of AudioParameter structs |
Classes
| Type | Name | Description | |
|---|---|---|---|
| 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. |