1. Epic GamesDeveloper
  3. UMetasoundParameterPack

UMetasoundParameterPack

Here is the [UObject](API\Runtime\CoreUObject\UObject) BlueprintType that can be used in c++ and blueprint code.

API > API/Plugins > API/Plugins/MetasoundFrontend

Here is the UObject BlueprintType that can be used in c++ and blueprint code. It holds a FMetasoundParamStorage instance and can pass it along to the audio system's SetObjectParameter function via an AudioProxy.

   
Name UMetasoundParameterPack
Type class
Header File /Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundParameterPack.h
Include Path #include "MetasoundParameterPack.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, Meta=(DisplayName="MetaSoundParameterPack"))  
class UMetasoundParameterPack :  
    public UObject ,  
    public IAudioProxyDataFactory

Inheritance Hierarchy

Implements Interfaces

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ParameterStorage FSharedMetasoundParameterStoragePtr   MetasoundParameterPack.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddArrayParameter ( const FName& Name,
const FName& InTypeName,
const T& InValue
)

   MetasoundParameterPack.h  

void AddBoolParameter ( FName Name,
bool InValue
)

   MetasoundParameterPack.h  

void AddFloatParameter ( FName Name,
float InValue
)

   MetasoundParameterPack.h  

void AddIntParameter ( FName Name,
int32 InValue
)

   MetasoundParameterPack.h  

void AddParameter ( const FName& Name,
const FName& InTypeName,
const T& InValue
)

   MetasoundParameterPack.h  

void AddStringParameter ( FName Name,
const FString& InValue
)

   MetasoundParameterPack.h  

void AddTriggerParameter ( FName Name,
bool InValue
)

   MetasoundParameterPack.h  

bool GetBool ( FName ParameterName,
ESetParamResult& Result
) const

   MetasoundParameterPack.h
  • BlueprintCallable
  • Category="MetaSoundParameterPack"
  • Meta=(ExpandEnumAsExecs="Result")

bool * GetBoolParameterPtr ( FName Name
) const

 YIKES! BEWARE: If the returned pointers are only valid until another parameter is added! MetasoundParameterPack.h  

FSharedMetasoundParameterStoragePtr GetCopyOfParameterStorage()

   MetasoundParameterPack.h  

float GetFloat ( FName ParameterName,
ESetParamResult& Result
) const

   MetasoundParameterPack.h
  • BlueprintCallable
  • Category="MetaSoundParameterPack"
  • Meta=(ExpandEnumAsExecs="Result")

float * GetFloatParameterPtr ( FName Name
) const

   MetasoundParameterPack.h  

int32 GetInt ( FName ParameterName,
ESetParamResult& Result
) const

   MetasoundParameterPack.h
  • BlueprintCallable
  • Category="MetaSoundParameterPack"
  • Meta=(ExpandEnumAsExecs="Result")

int32 * GetIntParameterPtr ( FName Name
) const

   MetasoundParameterPack.h  

T GetParameter ( const FName& Name,
const FName& InTypeName,
ESetParamResult& Result
) const

   MetasoundParameterPack.h  

void GetParameter ( const FName& Name,
const FName& InTypeName,
TArray< typename T::ElementType >& ResultArray,
ESetParamResult& Result
) const

   MetasoundParameterPack.h  

FSharedMetasoundParameterStoragePtr GetParameterStorage()

   MetasoundParameterPack.h  

FString GetString ( FName ParameterName,
ESetParamResult& Result
) const

   MetasoundParameterPack.h
  • BlueprintCallable
  • Category="MetaSoundParameterPack"
  • Meta=(ExpandEnumAsExecs="Result")

FString * GetStringParameterPtr ( FName Name
) const

   MetasoundParameterPack.h  

bool GetTrigger ( FName ParameterName,
ESetParamResult& Result
) const

   MetasoundParameterPack.h
  • BlueprintCallable
  • Category="MetaSoundParameterPack"
  • Meta=(ExpandEnumAsExecs="Result")

bool * GetTriggerParameterPtr ( FName Name
) const

   MetasoundParameterPack.h  

bool HasBool ( FName ParameterName
) const

   MetasoundParameterPack.h
  • BlueprintCallable
  • Category="MetaSoundParameterPack"
  • Meta=(ExpandEnumAsExecs=ReturnValue)

bool HasFloat ( FName ParameterName
) const

   MetasoundParameterPack.h
  • BlueprintCallable
  • Category="MetaSoundParameterPack"
  • Meta=(ExpandEnumAsExecs=ReturnValue)

bool HasInt ( FName ParameterName
) const

   MetasoundParameterPack.h
  • BlueprintCallable
  • Category="MetaSoundParameterPack"
  • Meta=(ExpandEnumAsExecs=ReturnValue)

bool HasParameter ( const FName& Name,
const FName& InTypeName
) const

   MetasoundParameterPack.h  

bool HasString ( FName ParameterName
) const

   MetasoundParameterPack.h
  • BlueprintCallable
  • Category="MetaSoundParameterPack"
  • Meta=(ExpandEnumAsExecs=ReturnValue)

bool HasTrigger ( FName ParameterName
) const

   MetasoundParameterPack.h
  • BlueprintCallable
  • Category="MetaSoundParameterPack"
  • Meta=(ExpandEnumAsExecs=ReturnValue)

ESetParamResult SetArrayParameter ( const FName& Name,
const FName& InTypeName,
const T& InValue,
bool OnlyIfExists
)

   MetasoundParameterPack.h  

ESetParamResult SetBool ( FName ParameterName,
bool InValue,
bool OnlyIfExists
)

   MetasoundParameterPack.h
  • BlueprintCallable
  • Category="MetaSoundParameterPack"
  • Meta=(ExpandEnumAsExecs=ReturnValue)

ESetParamResult SetFloat ( FName ParameterName,
float InValue,
bool OnlyIfExists
)

   MetasoundParameterPack.h
  • BlueprintCallable
  • Category="MetaSoundParameterPack"
  • Meta=(ExpandEnumAsExecs=ReturnValue)

ESetParamResult SetInt ( FName ParameterName,
int32 InValue,
bool OnlyIfExists
)

   MetasoundParameterPack.h
  • BlueprintCallable
  • Category="MetaSoundParameterPack"
  • Meta=(ExpandEnumAsExecs=ReturnValue)

ESetParamResult SetParameter ( const FName& Name,
const FName& InTypeName,
const T& InValue,
bool OnlyIfExists
)

   MetasoundParameterPack.h  

ESetParamResult SetString ( FName ParameterName,
const FString& InValue,
bool OnlyIfExists
)

   MetasoundParameterPack.h
  • BlueprintCallable
  • Category="MetaSoundParameterPack"
  • Meta=(ExpandEnumAsExecs=ReturnValue)

ESetParamResult SetTrigger ( FName ParameterName,
bool OnlyIfExists
)

   MetasoundParameterPack.h
  • BlueprintCallable
  • Category="MetaSoundParameterPack"
  • Meta=(ExpandEnumAsExecs=ReturnValue)

Overridden from IAudioProxyDataFactory

Name Remarks Include Path Unreal Specifiers

virtual TSharedPtr< Audio::IProxyData > CreateProxyData ( const Audio::FProxyDataInitParams& InitParams
)

   MetasoundParameterPack.h  

Static

Name Remarks Include Path Unreal Specifiers

static Metasound::FSendAddress CreateSendAddressFromEnvironment ( const Metasound::FMetasoundEnvironment& InEnvironment
)

 A couple of utilities for use by MetasoundAssetBase and MetasoundGenerator to set up the routing for parameter packs MetasoundParameterPack.h  

static FMetasoundFrontendClassInput GetClassInput()

   MetasoundParameterPack.h  

static UMetasoundParameterPack * MakeMetasoundParameterPack()

   MetasoundParameterPack.h
  • BlueprintCallable
  • Category="MetaSoundParameterPack"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page