Navigation
API > API/Plugins > API/Plugins/MetasoundFrontend
Represents the serialized version of variant literal types.
| Name | FMetasoundFrontendLiteral |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundFrontendLiteral.h |
| Include Path | #include "MetasoundFrontendLiteral.h" |
Syntax
USTRUCT (BlueprintType , Meta=(DisplayName="MetaSound Literal"))
struct FMetasoundFrontendLiteral
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMetasoundFrontendLiteral
(
const FAudioParameter& InParameter |
MetasoundFrontendLiteral.h | ||
| MetasoundFrontendLiteral.h |
Structs
| Name | Remarks |
|---|---|
| FDefault | |
| FDefaultArray |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AsBoolean | TArray< bool > | MetasoundFrontendLiteral.h | ||
| AsFloat | TArray< float > | MetasoundFrontendLiteral.h | ||
| AsInteger | TArray< int32 > | MetasoundFrontendLiteral.h | ||
| AsNumDefault | int32 | MetasoundFrontendLiteral.h | ||
| AsString | TArray< FString > | MetasoundFrontendLiteral.h | ||
| AsUObject | TArray< TObjectPtr< UObject > > | MetasoundFrontendLiteral.h | ||
| Type | EMetasoundFrontendLiteralType | The set type of this literal. | MetasoundFrontendLiteral.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Clear() |
Remove any stored data and set to an invalid state. | MetasoundFrontendLiteral.h | |
int32 GetArrayNum() |
Get the number of array elements if this literal is an array type, otherwise return 0. | MetasoundFrontendLiteral.h | |
EMetasoundFrontendLiteralType GetType() |
MetasoundFrontendLiteral.h | ||
bool IsArray() |
Returns true if the stored Type is an array type. | MetasoundFrontendLiteral.h | |
bool IsEqual
(
const FMetasoundFrontendLiteral& InOther |
Returns whether the other literal is value equivalent. | MetasoundFrontendLiteral.h | |
bool IsValid() |
Returns true if the literal is in a valid state (Type != EMetasoundFrontendLiteralType::Invalid) | MetasoundFrontendLiteral.h | |
void Set
(
float InValue |
MetasoundFrontendLiteral.h | ||
| MetasoundFrontendLiteral.h | |||
| MetasoundFrontendLiteral.h | |||
| MetasoundFrontendLiteral.h | |||
| MetasoundFrontendLiteral.h | |||
| MetasoundFrontendLiteral.h | |||
| MetasoundFrontendLiteral.h | |||
void Set
(
int32 InValue |
MetasoundFrontendLiteral.h | ||
| MetasoundFrontendLiteral.h | |||
void Set
(
bool InValue |
MetasoundFrontendLiteral.h | ||
void Set
(
const FDefaultArray& InValue |
MetasoundFrontendLiteral.h | ||
| MetasoundFrontendLiteral.h | |||
void SetFromLiteral
(
const Metasound::FLiteral& InLiteral |
MetasoundFrontendLiteral.h | ||
void SetType
(
EMetasoundFrontendLiteralType InType |
Sets the literal to the given type and value to default;. | MetasoundFrontendLiteral.h | |
Metasound::FLiteral ToLiteral
(
const FName& InMetaSoundDataType, |
Return a Metasound::FLiteral representation of this object. | MetasoundFrontendLiteral.h | |
Metasound::FLiteral ToLiteralNoProxy() |
Return a Metasound::FLiteral representation of this object, excluding UObject proxies. | MetasoundFrontendLiteral.h | |
FString ToString() |
Convert the value to a string for printing. | MetasoundFrontendLiteral.h | |
| MetasoundFrontendLiteral.h | |||
bool TryGet
(
float& OutValue |
MetasoundFrontendLiteral.h | ||
| MetasoundFrontendLiteral.h | |||
bool TryGet
(
int32& OutValue |
MetasoundFrontendLiteral.h | ||
| MetasoundFrontendLiteral.h | |||
bool TryGet
(
bool& OutValue |
MetasoundFrontendLiteral.h | ||
| MetasoundFrontendLiteral.h | |||
| MetasoundFrontendLiteral.h | |||
| MetasoundFrontendLiteral.h | |||
| MetasoundFrontendLiteral.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FMetasoundFrontendLiteral GetInvalid() |
MetasoundFrontendLiteral.h |