Navigation
API > API/Plugins > API/Plugins/MetasoundFrontend
Interface for frontend search engine. A frontend search engine provides a simple interface for common frontend queries. It also serves as an opportunity to cache queries to reduce CPU load.
| Name | ISearchEngine |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundFrontendSearchEngine.h |
| Include Path | #include "MetasoundFrontendSearchEngine.h" |
Syntax
class ISearchEngine
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ISearchEngine() |
MetasoundFrontendSearchEngine.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ISearchEngine() |
MetasoundFrontendSearchEngine.h |
Enums
Public
| Name | Remarks |
|---|---|
| EResultVersion | |
| ESortByVersion |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TArray< FMetaSoundClassInfo > FindAllClasses
(
EResultVersion Options, |
Find all class infos including those not registered but available via the asset manager for selection. | MetasoundFrontendSearchEngine.h | |
TArray< FMetasoundFrontendVersion > FindAllInterfaceVersions
(
bool bInIncludeAllVersions |
Returns array with all registered interface versions. | MetasoundFrontendSearchEngine.h | |
TArray< FMetasoundFrontendVersion > FindAllRegisteredInterfacesWithName
(
FName InInterfaceName |
Finds all registered interfaces with the given name. | MetasoundFrontendSearchEngine.h | |
TArray< FMetasoundFrontendClass > FindClassesWithName
(
const FMetasoundFrontendClassName& InName, |
Find all classes with the given ClassName. (Optional) Sort matches based on version. | MetasoundFrontendSearchEngine.h | |
TArray< FMetaSoundClassInfo > FindClassesWithName
(
const FMetasoundFrontendClassName& InName, |
Find all class info with the given ClassName. (Optional) Sort matches based on version. | MetasoundFrontendSearchEngine.h | |
bool FindClassWithHighestVersion
(
const FMetasoundFrontendClassName& InName, |
Find the highest version of class info with the given ClassName. | MetasoundFrontendSearchEngine.h | |
bool FindHighestInterfaceVersion
(
FName InInterfaceName, |
Finds the registered interface version with the highest version of the given name. | MetasoundFrontendSearchEngine.h | |
bool FindInterfaceWithHighestVersion
(
FName InInterfaceName, |
Finds the registered interface with the highest version of the given name. | MetasoundFrontendSearchEngine.h | |
bool FindRegisteredClass
(
const FMetasoundFrontendClassName& InName, |
Find the class info with the given ClassName & Major Version. | MetasoundFrontendSearchEngine.h | |
TArray< FMetasoundFrontendVersion > FindUClassDefaultInterfaceVersions
(
const FTopLevelAssetPath& InUClassPath |
Returns all interfaces that are to be added to a given document when it is initialized on an object with the given class | MetasoundFrontendSearchEngine.h | |
void Prime() |
Updates internal state to speed up queries. | MetasoundFrontendSearchEngine.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TArray< FMetasoundFrontendClass > FindAllClasses
(
bool bInIncludeAllVersions |
MetasoundFrontendSearchEngine.h | ||
virtual TArray< FMetasoundFrontendInterface > FindAllInterfaces
(
bool bInIncludeAllVersions |
MetasoundFrontendSearchEngine.h | ||
virtual bool FindClassWithHighestMinorVersion
(
const FMetasoundFrontendClassName& InName, |
MetasoundFrontendSearchEngine.h | ||
virtual bool FindClassWithHighestVersion
(
const FMetasoundFrontendClassName& InName, |
(To be deprecated) Find the highest version of a class with the given ClassName. | MetasoundFrontendSearchEngine.h |
Protected
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static ISearchEngine & Get() |
Return an instance of a search engine. | MetasoundFrontendSearchEngine.h |