unreal.MetasoundFrontendLiteralBlueprintAccess

class unreal.MetasoundFrontendLiteralBlueprintAccess(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

Blueprint support for FMetasoundFrontendLiteral

C++ Source:

  • Plugin: Metasound

  • Module: MetasoundEngine

  • File: MetasoundFrontendLiteralBlueprintAccess.h

classmethod conv_meta_sound_literal_to_string(literal) str

Conv Meta Sound Literal to String

Parameters:

literal (MetasoundFrontendLiteral)

Return type:

str

classmethod create_bool_array_meta_sound_literal(value) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given boolean array.

Parameters:

value (Array[bool])

Return type:

MetasoundFrontendLiteral

classmethod create_bool_meta_sound_literal(value) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given boolean value.

Parameters:

value (bool)

Return type:

MetasoundFrontendLiteral

classmethod create_float_array_meta_sound_literal(value) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given float array.

Parameters:

value (Array[float])

Return type:

MetasoundFrontendLiteral

classmethod create_float_meta_sound_literal(value) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given float value.

Parameters:

value (float)

Return type:

MetasoundFrontendLiteral

classmethod create_int_array_meta_sound_literal(value) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given integer array.

Parameters:

value (Array[int32])

Return type:

MetasoundFrontendLiteral

classmethod create_int_meta_sound_literal(value) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given integer value.

Parameters:

value (int32)

Return type:

MetasoundFrontendLiteral

classmethod create_meta_sound_literal_from_audio_parameter(audio_parameter) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given audio parameter.

Parameters:

audio_parameter (AudioParameter)

Return type:

MetasoundFrontendLiteral

classmethod create_meta_sound_literal_from_boolean(boolean) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given boolean value.

Parameters:

boolean (bool)

Return type:

MetasoundFrontendLiteral

classmethod create_meta_sound_literal_from_boolean_array(boolean_array) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given boolean array.

Parameters:

boolean_array (Array[bool])

Return type:

MetasoundFrontendLiteral

classmethod create_meta_sound_literal_from_float(float) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given float value.

Parameters:

float (float)

Return type:

MetasoundFrontendLiteral

classmethod create_meta_sound_literal_from_float_array(float_array) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given float array.

Parameters:

float_array (Array[float])

Return type:

MetasoundFrontendLiteral

classmethod create_meta_sound_literal_from_integer(integer) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given integer value.

Parameters:

integer (int32)

Return type:

MetasoundFrontendLiteral

classmethod create_meta_sound_literal_from_integer_array(integer_array) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given integer array.

Parameters:

integer_array (Array[int32])

Return type:

MetasoundFrontendLiteral

classmethod create_meta_sound_literal_from_object(object) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given object.

Parameters:

object (Object)

Return type:

MetasoundFrontendLiteral

classmethod create_meta_sound_literal_from_object_array(object_array) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given object array.

Parameters:

object_array (Array[Object])

Return type:

MetasoundFrontendLiteral

classmethod create_meta_sound_literal_from_param(param) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given audio parameter.

Parameters:

param (AudioParameter)

Return type:

MetasoundFrontendLiteral

classmethod create_meta_sound_literal_from_string(string) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given string.

Parameters:

string (str)

Return type:

MetasoundFrontendLiteral

classmethod create_meta_sound_literal_from_string_array(string_array) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given string array.

Parameters:

string_array (Array[str])

Return type:

MetasoundFrontendLiteral

classmethod create_object_array_meta_sound_literal(value) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given object array.

Parameters:

value (Array[Object])

Return type:

MetasoundFrontendLiteral

classmethod create_object_meta_sound_literal(value) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given object.

Parameters:

value (Object)

Return type:

MetasoundFrontendLiteral

classmethod create_string_array_meta_sound_literal(value) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given string array.

Parameters:

value (Array[str])

Return type:

MetasoundFrontendLiteral

classmethod create_string_meta_sound_literal(value) MetasoundFrontendLiteral

Creates a MetaSound Literal using the given string.

Parameters:

value (str)

Return type:

MetasoundFrontendLiteral

classmethod equal_equal_meta_sound_literal(literal_a, literal_b) bool

Equal Equal Meta Sound Literal

Parameters:
Return type:

bool

classmethod get_bool_array_value_from_literal(literal) -> (Array[bool], out_result=MetaSoundBuilderResult)

Returns the value of the given MetaSound Literal as a bool array. Has separate execution outputs for success and failure.

Parameters:

literal (MetasoundFrontendLiteral)

Returns:

out_result (MetaSoundBuilderResult):

Return type:

MetaSoundBuilderResult

classmethod get_bool_value_from_literal(literal) MetaSoundBuilderResult or None

Returns the value of the given MetaSound Literal as a bool. Has separate execution outputs for success and failure.

Parameters:

literal (MetasoundFrontendLiteral)

Returns:

out_result (MetaSoundBuilderResult):

Return type:

MetaSoundBuilderResult or None

classmethod get_float_array_value_from_literal(literal) -> (Array[float], out_result=MetaSoundBuilderResult)

Returns the value of the given MetaSound Literal as a float array. Has separate execution outputs for success and failure.

Parameters:

literal (MetasoundFrontendLiteral)

Returns:

out_result (MetaSoundBuilderResult):

Return type:

MetaSoundBuilderResult

classmethod get_float_value_from_literal(literal) -> (float, out_result=MetaSoundBuilderResult)

Returns the value of the given MetaSound Literal as a float. Has separate execution outputs for success and failure.

Parameters:

literal (MetasoundFrontendLiteral)

Returns:

out_result (MetaSoundBuilderResult):

Return type:

MetaSoundBuilderResult

classmethod get_int_array_value_from_literal(literal) -> (Array[int32], out_result=MetaSoundBuilderResult)

Returns the value of the given MetaSound Literal as an integer array. Has separate execution outputs for success and failure.

Parameters:

literal (MetasoundFrontendLiteral)

Returns:

out_result (MetaSoundBuilderResult):

Return type:

MetaSoundBuilderResult

classmethod get_int_value_from_literal(literal) -> (int32, out_result=MetaSoundBuilderResult)

Returns the value of the given MetaSound Literal as an integer. Has separate execution outputs for success and failure.

Parameters:

literal (MetasoundFrontendLiteral)

Returns:

out_result (MetaSoundBuilderResult):

Return type:

MetaSoundBuilderResult

classmethod get_meta_sound_literal_as_bool(literal) bool

Returns the value of the given MetaSound Literal as a bool. Logs a warning if the value fails to be retrieved.

Parameters:

literal (MetasoundFrontendLiteral)

Return type:

bool

classmethod get_meta_sound_literal_as_bool_array(literal) Array[bool]

Returns the value of the given MetaSound Literal as a bool array. Logs a warning if the value fails to be retrieved.

Parameters:

literal (MetasoundFrontendLiteral)

Return type:

Array[bool]

classmethod get_meta_sound_literal_as_float(literal) float

Returns the value of the given MetaSound Literal as a float. Logs a warning if the value fails to be retrieved.

Parameters:

literal (MetasoundFrontendLiteral)

Return type:

float

classmethod get_meta_sound_literal_as_float_array(literal) Array[float]

Returns the value of the given MetaSound Literal as a float array. Logs a warning if the value fails to be retrieved.

Parameters:

literal (MetasoundFrontendLiteral)

Return type:

Array[float]

classmethod get_meta_sound_literal_as_integer(literal) int32

Returns the value of the given MetaSound Literal as an integer. Logs a warning if the value fails to be retrieved.

Parameters:

literal (MetasoundFrontendLiteral)

Return type:

int32

classmethod get_meta_sound_literal_as_integer_array(literal) Array[int32]

Returns the value of the given MetaSound Literal as an integer array. Logs a warning if the value fails to be retrieved.

Parameters:

literal (MetasoundFrontendLiteral)

Return type:

Array[int32]

classmethod get_meta_sound_literal_as_object(literal) Object

Returns the value of the given MetaSound Literal as an object. Logs a warning if the value fails to be retrieved.

Parameters:

literal (MetasoundFrontendLiteral)

Return type:

Object

classmethod get_meta_sound_literal_as_object_array(literal) Array[Object]

Returns the value of the given MetaSound Literal as an object array. Logs a warning if the value fails to be retrieved.

Parameters:

literal (MetasoundFrontendLiteral)

Return type:

Array[Object]

classmethod get_meta_sound_literal_as_string(literal) str

Returns the value of the given MetaSound Literal as a string. Logs a warning if the value fails to be retrieved.

Parameters:

literal (MetasoundFrontendLiteral)

Return type:

str

classmethod get_meta_sound_literal_as_string_array(literal) Array[str]

Returns the value of the given MetaSound Literal as a string array. Logs a warning if the value fails to be retrieved.

Parameters:

literal (MetasoundFrontendLiteral)

Return type:

Array[str]

classmethod get_object_array_value_from_literal(literal) -> (Array[Object], out_result=MetaSoundBuilderResult)

Returns the value of the given MetaSound Literal as an object array. Has separate execution outputs for success and failure.

Parameters:

literal (MetasoundFrontendLiteral)

Returns:

out_result (MetaSoundBuilderResult):

Return type:

MetaSoundBuilderResult

classmethod get_object_value_from_literal(literal) -> (Object, out_result=MetaSoundBuilderResult)

Returns the value of the given MetaSound Literal as an object. Has separate execution outputs for success and failure.

Parameters:

literal (MetasoundFrontendLiteral)

Returns:

out_result (MetaSoundBuilderResult):

Return type:

MetaSoundBuilderResult

classmethod get_string_array_value_from_literal(literal) -> (Array[str], out_result=MetaSoundBuilderResult)

Returns the value of the given MetaSound Literal as a string array. Has separate execution outputs for success and failure.

Parameters:

literal (MetasoundFrontendLiteral)

Returns:

out_result (MetaSoundBuilderResult):

Return type:

MetaSoundBuilderResult

classmethod get_string_value_from_literal(literal) -> (str, out_result=MetaSoundBuilderResult)

Returns the value of the given MetaSound Literal as a string. Has separate execution outputs for success and failure.

Parameters:

literal (MetasoundFrontendLiteral)

Returns:

out_result (MetaSoundBuilderResult):

Return type:

MetaSoundBuilderResult

classmethod get_type(literal) MetasoundFrontendLiteralType

Get Type

Parameters:

literal (MetasoundFrontendLiteral)

Return type:

MetasoundFrontendLiteralType