unreal.MetaSoundTemplateWidgetInterface

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

Bases: Interface

MetaSound Template Widget Interface

C++ Source:

  • Plugin: Metasound

  • Module: MetasoundEditor

  • File: MetasoundTemplateWidgetInterface.h

is_supported_configuration(config_name: Name, builder: MetaSoundBuilderBase) → bool

deprecated: ‘is_supported_configuration’ was renamed to ‘is_supported_template’.

is_supported_template(config_name, builder) → bool

Returns whether or not the widget supports the given template. Called when initializing the MetaSound Editor to determine if an implemented template supports the given widget.

Parameters:
Returns:

out_is_supported (bool):

Return type:

bool

on_audition_state_changed(audio_component, is_auditioning) → None

Called when the MetaSound starts and stops auditioning. Provides a reference to the audio component when auditioning starts, and returns nullptr when auditioning stops.

Parameters:
on_builder_set(builder) → None

Called when the builder is initialized (prior to PreConstruct).

Parameters:

builder (MetaSoundBuilderBase)

on_initializing_tab() → MetaSoundTemplateWidgetTabInfo

(Optional) Called when initializing a tab owning the given widget to allow implementation to provide basic tab display options and information.

Returns:

tab_info (MetaSoundTemplateWidgetTabInfo):

Return type:

MetaSoundTemplateWidgetTabInfo

on_initializing_view_model()

(Optional) If ViewModel class provided, automatically initializes and sets ViewModel of the given class for the given widget.

Returns:

class_ (type(Class)):

Return type:

type(Class)