Navigation
API > API/Plugins > API/Plugins/MetasoundEngine
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UMetaSoundPatch
References
| Module | MetasoundEngine |
| Header | /Engine/Plugins/Runtime/Metasound/Source/MetasoundEngine/Public/Metasound.h |
| Include | #include "Metasound.h" |
Syntax
UCLASS (HideCategories=object, BlueprintType, Meta=(DisplayName="MetaSound Patch"))
class UMetaSoundPatch :
public UObject ,
public FMetasoundAssetBase ,
public IMetaSoundDocumentInterface
Remarks
This asset type is used for Metasound assets that can only be used as nodes in other Metasound graphs. Because of this, they contain no required inputs or outputs.
Variables
| Type | Name | Description | |
|---|---|---|---|
   |
FGuid | AssetClassID | |
   |
bool | bIsPreset | |
   |
TObjectPtr< UMetasoundEditorGraphBase > | EditorGraph | |
   |
TObjectPtr< UMetasoundEditorGraphBase > | Graph | |
  |
TSet< FSoftObjectPath > | ReferenceAssetClassCache | |
  |
TSet< FString > | ReferencedAssetClassKeys | |
  |
TSet< TObjectPtr< UObject > > | ReferencedAssetClassObjects | |
   |
FString | RegistryInputTypes | |
   |
FString | RegistryOutputTypes | |
   |
int32 | RegistryVersionMajor | |
   |
int32 | RegistryVersionMinor | |
   |
FMetasoundFrontendDocument | RootMetaSoundDocument |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UMetaSoundPatch
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
FName | Returns document name (for editor purposes, and avoids making document public for edit while allowing editor to reference directly) |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | BeginDestroy () |
Called before destroying the object. |
   |
EDataValidationResult | IsDataValid
(
FDataValidationContext& Context |
Generic function to validate objects during changelist validations, etc. |
  |
void | PostDuplicate
(
EDuplicateMode::Type DuplicateMode |
|
  |
void | PostEditUndo () |
Called after applying a transaction to the object. |
  |
void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |
  |
void | PreDuplicate
(
FObjectDuplicationParameters& DupParams |
Called before duplication. |
  |
void | PreSave
(
FObjectPreSaveContext InSaveContext |
Presave function. |
  |
void | Handles reading, writing, and reference collecting using FArchive. |
Overridden from FMetasoundAssetBase
| Type | Name | Description | |
|---|---|---|---|
   |
const TSet< FSoftObjectPath > & | Return all dependent asset paths to load asynchronously. | |
   |
FText | Name to display in editors. | |
  |
Metasound::Frontend::FDocumentAccessPtr | Returns an access pointer to the document. | |
   |
Metasound::Frontend::FConstDocumentAccessPtr | Returns an access pointer to the document. | |
   |
UEdGraph * | GetGraph () |
Returns the graph associated with this Metasound. |
   |
UEdGraph & | ||
  |
UObject * | Returns the owning asset responsible for transactions applied to MetaSound. | |
   |
const UObject * | Returns the owning asset responsible for transactions applied to MetaSound. | |
   |
const TSet< FString > & | Returns all the class keys of this asset's referenced assets. | |
  |
TArray< FMetasoundAssetBase * > | Returns set of class references set call to serialize in the editor Used at runtime load register referenced classes. | |
  |
void | MigrateEditorGraph
(
FMetaSoundFrontendDocumentBuilder& OutBuilder |
|
  |
void | OnAsyncReferencedAssetsLoaded
(
const TArray< FMetasoundAssetBase* >& InAsyncReferences |
Called when async assets have finished loading. |
  |
void | SetGraph
(
UEdGraph* InGraph |
Sets the graph associated with this Metasound. |
  |
void | SetReferencedAssetClasses
(
TSet< Metasound::Frontend::IMetaSoundAssetManager::FAssetInfo >&& InAssetClasses |
|
  |
void | SetRegistryAssetClassInfo
(
const Metasound::Frontend::FNodeClassInfo& InClassInfo |
Sets Asset Registry Metadata associated with this MetaSound. |
Overridden from IMetaSoundDocumentInterface
| Type | Name | Description | |
|---|---|---|---|
  |
bool | Conforms UProperty data outside the Frontend Document Model to the document's data. | |
   |
FTopLevelAssetPath | ||
   |
const UClass & | Returns the parent class registered with the MetaSound UObject registry. | |
   |
const UClass & | Returns the builder class used to modify the given document. | |
   |
const FMetasoundFrontendDocument & | Returns read-only reference to the the MetaSoundFrontendDocument containing all MetaSound runtime & editor data. | |
   |
bool | Returns whether or not a document builder is currently active and can mutate the given interface's document. |