Navigation
API > API/Plugins > API/Plugins/MetasoundEngine
| Name | FDocumentBuilderRegistry |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Metasound/Source/MetasoundEngine/Public/MetasoundDocumentBuilderRegistry.h |
| Include Path | #include "MetasoundDocumentBuilderRegistry.h" |
Syntax
class FDocumentBuilderRegistry : public Metasound::Frontend::IDocumentBuilderRegistry
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDocumentBuilderRegistry() |
MetasoundDocumentBuilderRegistry.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FDocumentBuilderRegistry() |
MetasoundDocumentBuilderRegistry.h |
Enums
Public
| Name | Remarks |
|---|---|
| ELogEvent |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Builders | TMultiMap< FMetasoundFrontendClassName, TWeakObjectPtr< UMetaSoundBuilderBase > > | MetasoundDocumentBuilderRegistry.h | ||
| BuildersCriticalSection | FCriticalSection | Critical section primarily for allowing builder collection mutation during async loading of MetaSound assets. | MetasoundDocumentBuilderRegistry.h | |
| EventLogVerbosity | TSortedMap< ELogEvent, ELogVerbosity::Type > | MetasoundDocumentBuilderRegistry.h | ||
| OnResolveAuditionPage | FOnResolveEditorPage | MetasoundDocumentBuilderRegistry.h | ||
| OnResolveProjectPage | FOnResolvePage | MetasoundDocumentBuilderRegistry.h | ||
| TargetPageResolveScratch | TArray< FGuid > | Reuseable scratch array of pages to resolve, which is used to optimize/reduce number of allocations required when resolving document. | MetasoundDocumentBuilderRegistry.h | |
| TargetPageResolveScratchCritSec | FCriticalSection | MetasoundDocumentBuilderRegistry.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
BuilderClass & CreateTransientBuilder
(
FName BuilderName |
MetasoundDocumentBuilderRegistry.h | ||
UMetaSoundBuilderBase * FindBuilderObject
(
TScriptInterface< const IMetaSoundDocumentInterface > MetaSound |
Returns the builder object associated with the given MetaSound asset if one is registered and active. | MetasoundDocumentBuilderRegistry.h | |
UMetaSoundBuilderBase * FindBuilderObject
(
const FMetasoundFrontendClassName& InClassName, |
Returns the builder object associated with the given ClassName if one is registered and active. | MetasoundDocumentBuilderRegistry.h | |
TArray< UMetaSoundBuilderBase * > FindBuilderObjects
(
const FMetasoundFrontendClassName& InClassName |
Returns all builder objects registered and active associated with the given ClassName. | MetasoundDocumentBuilderRegistry.h | |
BuilderClass & FindOrBeginBuilding
(
UObject& InMetaSoundObject, |
Find or begin building a MetaSound asset. | MetasoundDocumentBuilderRegistry.h | |
FOnResolveEditorPage & GetOnResolveAuditionPageDelegate() |
MetasoundDocumentBuilderRegistry.h | ||
FOnResolvePage & GetOnResolveProjectPageOverrideDelegate() |
MetasoundDocumentBuilderRegistry.h | ||
void SetEventLogVerbosity
(
ELogEvent Event, |
MetasoundDocumentBuilderRegistry.h |
Overridden from IDocumentBuilderRegistry
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CookPages
(
FName PlatformName, |
Frontend::IDocumentBuilderRegistry Implementation. | MetasoundDocumentBuilderRegistry.h | |
virtual FMetaSoundFrontendDocumentBuilder * FindBuilder
(
const FMetasoundFrontendClassName& InClassName, |
MetasoundDocumentBuilderRegistry.h | ||
virtual FMetaSoundFrontendDocumentBuilder * FindBuilder
(
TScriptInterface< IMetaSoundDocumentInterface > MetaSound |
MetasoundDocumentBuilderRegistry.h | ||
virtual FMetaSoundFrontendDocumentBuilder & FindOrBeginBuilding
(
TScriptInterface< IMetaSoundDocumentInterface > MetaSound |
MetasoundDocumentBuilderRegistry.h | ||
virtual FMetaSoundFrontendDocumentBuilder * FindOutermostBuilder
(
const UObject& InSubObject |
MetasoundDocumentBuilderRegistry.h | ||
virtual bool FinishBuilding
(
const FMetasoundFrontendClassName& InClassName, |
MetasoundDocumentBuilderRegistry.h | ||
virtual bool FinishBuilding
(
const FMetasoundFrontendClassName& InClassName, |
MetasoundDocumentBuilderRegistry.h | ||
virtual bool ReloadBuilder
(
const FMetasoundFrontendClassName& InClassName |
MetasoundDocumentBuilderRegistry.h | ||
virtual FGuid ResolveTargetPageID
(
const FMetasoundFrontendGraphClass& InGraphClass |
Given the provided document and its respective pages, returns the PageID to be used for runtime IGraph and proxy generation. | MetasoundDocumentBuilderRegistry.h | |
virtual FGuid ResolveTargetPageID
(
const TArray< FMetasoundFrontendClassInputDefault >& Defaults |
MetasoundDocumentBuilderRegistry.h | ||
virtual FGuid ResolveTargetPageID
(
const FMetasoundFrontendClassInput& InClassInput |
MetasoundDocumentBuilderRegistry.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FDocumentBuilderRegistry & GetChecked() |
MetasoundDocumentBuilderRegistry.h |