Navigation
API > API/Plugins > API/Plugins/MetasoundFrontend
FMetasoundAssetBase is a mix-in subclass for UObjects which utilize MetaSound objects. As MetaSounds can now be generated dynamically via the Builder API, the name does not accurately reflect this classes current implementation. While it currently has some support for asset, editor graph & document accessors (actively being deprecated), its primary use is to support all access to runtime-specific, MetaSound features and associated data, such as proxy generation and runtime node class registration. For forward support of the MetaSound document model and supported accessors, see 'IMetaSoundDocumentInterface'.
| Name | FMetasoundAssetBase |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundAssetBase.h |
| Include Path | #include "MetasoundAssetBase.h" |
Syntax
class FMetasoundAssetBase : public IAudioProxyDataFactory
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMetasoundAssetBase() |
MetasoundAssetBase.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FMetasoundAssetBase() |
MetasoundAssetBase.h |
Structs
| Name | Remarks |
|---|---|
| FSendInfoAndVertexName |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FileExtension | const FString | MetasoundAssetBase.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bVersionedOnLoad | bool | MetasoundAssetBase.h | ||
| GraphRegistryKey | Metasound::Frontend::FGraphRegistryKey | MetasoundAssetBase.h | ||
| Proxy | FMetasoundAssetProxyPtr | MetasoundAssetBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AddingReferenceCausesLoop
(
const FMetasoundAssetBase& InMetaSound |
MetasoundAssetBase.h | ||
void CacheRegistryMetadata() |
MetasoundAssetBase.h | ||
void ClearVersionedOnLoad() |
MetasoundAssetBase.h | ||
const TSet< FSoftObjectPath > & GetAsyncReferencedAssetClassPaths() |
Return all dependent asset paths to load asynchronously. | MetasoundAssetBase.h | |
virtual const FMetasoundFrontendDocument & GetConstDocumentChecked() |
MetasoundAssetBase.h | ||
const FMetasoundFrontendDocumentModifyContext & GetConstModifyContext() |
MetasoundAssetBase.h | ||
| MetasoundAssetBase.h | |||
| Soft deprecated. | MetasoundAssetBase.h | ||
Metasound::Frontend::FDocumentHandle GetDocumentHandle () |
Soft Deprecated in favor of DocumentBuilder API. Returns handle for the root metasound graph of this asset. | MetasoundAssetBase.h | |
Metasound::Frontend::FConstDocumentHandle GetDocumentHandle () |
MetasoundAssetBase.h | ||
UEdGraph * GetGraph () |
Returns the graph associated with this Metasound. | MetasoundAssetBase.h | |
UEdGraph & GetGraphChecked() |
MetasoundAssetBase.h | ||
const Metasound::Frontend::FGraphRegistryKey & GetGraphRegistryKey() |
MetasoundAssetBase.h | ||
FMetasoundFrontendDocumentModifyContext & GetModifyContext() |
MetasoundAssetBase.h | ||
UObject * GetOwningAsset () |
Returns the owning asset responsible for transactions applied to MetaSound. | MetasoundAssetBase.h | |
const UObject * GetOwningAsset () |
Returns the owning asset responsible for transactions applied to MetaSound. | MetasoundAssetBase.h | |
FString GetOwningAssetName() |
MetasoundAssetBase.h | ||
const TSet< FString > & GetReferencedAssetClassKeys() |
Returns all the class keys of this asset's referenced assets. | MetasoundAssetBase.h | |
TArray< FMetasoundAssetBase * > GetReferencedAssets() |
Returns set of class references set call to serialize in the editor Used at runtime load register referenced classes. | MetasoundAssetBase.h | |
Metasound::Frontend::FConstGraphHandle GetRootGraphHandle () |
MetasoundAssetBase.h | ||
Metasound::Frontend::FGraphHandle GetRootGraphHandle () |
Soft Deprecated in favor of DocumentBuilder API. Returns handle for the root metasound graph of this asset. | MetasoundAssetBase.h | |
bool GetVersionedOnLoad() |
MetasoundAssetBase.h | ||
bool ImportFromJSON
(
const FString& InJSON |
Imports data from a JSON string directly. | MetasoundAssetBase.h | |
bool ImportFromJSONAsset
(
const FString& InAbsolutePath |
Imports the asset from a JSON file at provided path. | MetasoundAssetBase.h | |
bool IsInterfaceDeclared
(
const FMetasoundFrontendVersion& InVersion |
Returns whether an interface with the given version is declared by the given asset's document. | MetasoundAssetBase.h | |
bool IsReferencedAsset
(
const FMetasoundAssetBase& InAssetToCheck |
MetasoundAssetBase.h | ||
bool IsRegistered() |
MetasoundAssetBase.h | ||
bool MarkMetasoundDocumentDirty() |
Calls the outermost package and marks it dirty. | MetasoundAssetBase.h | |
void MigrateEditorGraph
(
FMetaSoundFrontendDocumentBuilder& OutBuilder |
MetasoundAssetBase.h | ||
void OnAsyncReferencedAssetsLoaded
(
const TArray< FMetasoundAssetBase* >& InAsyncReferences |
Called when async assets have finished loading. | MetasoundAssetBase.h | |
void RebuildReferencedAssetClasses() |
Rebuild dependent asset classes. | MetasoundAssetBase.h | |
void SetGraph
(
UEdGraph* InGraph |
Sets the graph associated with this Metasound. | MetasoundAssetBase.h | |
virtual void SetRegistryAssetClassInfo
(
const Metasound::Frontend::FNodeClassInfo& InClassInfo |
MetasoundAssetBase.h | ||
void SetVersionedOnLoad() |
MetasoundAssetBase.h | ||
void UnregisterGraphWithFrontend() |
Unregisters the root graph of the given asset with the MetaSound Frontend. | MetasoundAssetBase.h | |
void UpdateAndRegisterForExecution () |
MetasoundAssetBase.h | ||
virtual void UpdateAndRegisterForExecution
(
const Metasound::Frontend::FMetaSoundAssetRegistrationOptions& InRegistrationOptions |
Registers the root graph of the given asset with the MetaSound Frontend. | MetasoundAssetBase.h | |
void UpdateAndRegisterForSerialization
(
FName CookPlatformName |
Updates and registers this and referenced MetaSound document objects with the NodeClass Registry. | MetasoundAssetBase.h | |
void UpdateAndRegisterForSerialization
(
const Metasound::Frontend::FMetaSoundAssetCookOptions& InCookOptions |
Updates and registers this and referenced MetaSound document objects with the NodeClass Registry. | MetasoundAssetBase.h | |
bool VersionAsset
(
FMetaSoundFrontendDocumentBuilder& Builder |
MetasoundAssetBase.h |
Overridden from IAudioProxyDataFactory
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedPtr< Audio::IProxyData > CreateProxyData
(
const Audio::FProxyDataInitParams& InitParams |
MetasoundAssetBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FText GetDisplayName
(
FString&& InTypeName |
MetasoundAssetBase.h | ||
is particularly problematic as in so the builder s caches are reset which can cause major editor performance virtual regressions Metasound::Frontend::FDocumentAccessPtr GetDocumentAccessPtr() |
MetasoundAssetBase.h | ||
Metasound::Frontend::FConstDocumentAccessPtr GetDocumentConstAccessPtr() |
Returns an access pointer to the document. | MetasoundAssetBase.h | |
void OnNotifyBeginDestroy() |
MetasoundAssetBase.h | ||
void RegisterAssetDependencies
(
const Metasound::Frontend::FMetaSoundAssetRegistrationOptions& InRegistrationOptions |
Ensures all referenced graph classes are registered (or re-registers depending on options). | MetasoundAssetBase.h | |
virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS void SetReferencedAssetClasses
(
TSet< Metasound::Frontend::IMetaSoundAssetManager::FAssetInfo >&& InAssetClasses |
MetasoundAssetBase.h | ||
void SetReferencedAssets
(
TSet< Metasound::Frontend::IMetaSoundAssetManager::FAssetRef >&& InAssetRefs |
MetasoundAssetBase.h |