code: bool DoesPackageExistOnDisk ( [FName](API\Runtime\Core\UObject\FName) PackageName, [FString](API\Runtime\Core\Containers\FString) * OutCorrectCasePackageName, [FString](API\Runtime\Core\Containers\FString) * OutExtension ) const


description: Writes out the state in textual form. Use arguments to control which segments to emit.

module: AssetRegistry

code: void DumpState ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Arguments, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutPages, int32 LinesPerPage ) const


description: Enumerate all the paths that are currently cached

code: void EnumerateAllCachedPaths ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool([FString](API\Runtime\Core\Containers\FString))> Callback ) const


description: Enumerate asset data for all assets in the registry. This method may be slow, use a filter if possible to avoid iterating over the entire registry.

code: bool EnumerateAllAssets ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) &)> Callback, bool bIncludeOnlyOnDiskAssets ) const


code: void EnumerateAllCachedPaths ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool([FName](API\Runtime\Core\UObject\FName))> Callback ) const


description: Event for when assets are renamed in the registry

code: DECLARE_TS_MULTICAST_DELEGATE_TwoParams ( FAssetRenamedEvent, const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) &, const [FString](API\Runtime\Core\Containers\FString) & )


description: Enumerate all PackageDatas in the AssetRegistry. The callback is called from within the AssetRegistry's lock, so it must not call arbitrary code that could call back into the AssetRegistry; doing so would deadlock.

code: void EnumerateAllPackages ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void([FName](API\Runtime\Core\UObject\FName) PackageName, const [FAssetPackageData](API\Runtime\CoreUObject\AssetRegistry\FAssetPackageData) &PackageData)> Callback ) const


description: Enumerate asset data for all assets that match the filter. Assets returned must satisfy every filter component if there is at least one element in the component's array. Assets will satisfy a component if they match any of the elements in it.

code: bool EnumerateAssets ( const [FARFilter](API\Runtime\CoreUObject\AssetRegistry\FARFilter) & Filter, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) &)> Callback, bool bSkipARFilteredAssets ) const


code: bool EnumerateAssets ( const [FARCompiledFilter](API\Runtime\CoreUObject\AssetRegistry\FARCompiledFilter) & Filter, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) &)> Callback, bool bSkipARFilteredAssets ) const


description: Enumerate the all paths that are currently cached below the passed-in base path

code: void EnumerateSubPaths ( const [FString](API\Runtime\Core\Containers\FString) & InBasePath, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool([FString](API\Runtime\Core\Containers\FString))> Callback, bool bInRecurse ) const


code: void EnumerateSubPaths ( const [FName](API\Runtime\Core\UObject\FName) InBasePath, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool([FName](API\Runtime\Core\UObject\FName))> Callback, bool bInRecurse ) const


code: FFileLoadProgressUpdateData &40; int32 InNumTotalAssets, int32 InNumAssetsProcessedByAssetRegistry, int32 InNumAssetsPendingDataLoad, bool InIsDiscoveringAssetFiles &41;


className: FFileLoadProgressUpdateData

description: Payload data for a file progress update

code: struct FFileLoadProgressUpdateData

bIsDiscoveringAssetFiles

type: bool


className: FFilesBlockedEvent

description: Event for when one or more files have been blocked from the registry

code: class FFilesBlockedEvent : public TBaseMulticastDelegate_OneParam< void, const TArray< FString > & >


code: FLoadPackageRegistryData &40; bool bInGetDependencies &41;


className: FLoadPackageRegistryData

code: struct FLoadPackageRegistryData

Data

type: TArray<FAssetD...

DataDependencies

type: TArray<FName>


className: FPathRemovedEvent

description: Event for when paths are removed from the registry

code: class FPathRemovedEvent : public TBaseMulticastDelegate_OneParam< void, const FString & >


code: static [IAssetRegistry](API\Runtime\AssetRegistry\AssetRegistry\IAssetRegistry) * Get()


description: Gets asset data for all assets in the registry. This method may be slow, use a filter if possible to avoid iterating over the entire registry.

code: bool GetAllAssets ( [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > & OutAssetData, bool bIncludeOnlyOnDiskAssets ) const


description: Gets a list of all paths that are currently cached

code: void GetAllCachedPaths ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutPathList ) const


description: Returns memory size of entire registry, optionally logging sizes

code: SIZE_T GetAllocatedSize ( bool bLogDetailed ) const


description: Returns true if the specified ClassName's ancestors could be found. If so, OutAncestorClassNames is a list of all its ancestors. This can be slow if temporary caching mode is not on

code: bool GetAncestorClassNames ( [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) ClassPathName, [TArray](API\Runtime\Core\Containers\TArray)< [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) > & OutAncestorClassNames ) const


description: Deprecated* Class names are now represented by path names. Please use a version of this function that usesFTopLevelAssetPath.

code: bool GetAncestorClassNames ( [FName](API\Runtime\Core\UObject\FName) ClassName, [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutAncestorClassNames ) const


description: Gets an ETA or percentage complete for an asset that is still in the process of being installed.

code: float GetAssetAvailabilityProgress ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & AssetData, [EAssetAvailabilityProgressReportingType::Type](API\Runtime\AssetRegistry\AssetRegistry\EAssetAvailabili-) ReportType ) const


code: bool GetAssetAvailabilityProgressTypeSupported ( [EAssetAvailabilityProgressReportingType::Type](API\Runtime\AssetRegistry\AssetRegistry\EAssetAvailabili-) ReportType ) const


description: Gets the current availability of an asset, primarily for streaming install purposes.

code: [EAssetAvailability::Type](API\Runtime\AssetRegistry\AssetRegistry\EAssetAvailability__Type) GetAssetAvailability ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & AssetData ) const


description:
Gets the asset data for the specified object path
the assets data;Will be invalid if object could not be found

code: [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) GetAssetByObjectPath ( const [FName](API\Runtime\Core\UObject\FName) ObjectPath, bool bIncludeOnlyOnDiskAssets ) const


code: [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) GetAssetByObjectPath ( const [FSoftObjectPath](API\Runtime\CoreUObject\UObject\FSoftObjectPath) & ObjectPath, bool bIncludeOnlyOnDiskAssets, bool bSkipARFilteredAssets ) const


description: Finds Package data for a package name. This data is only updated on save and can only be accessed for valid packages

code: [TOptional](API\Runtime\Core\IO\TOptional)< [FAssetPackageData](API\Runtime\CoreUObject\AssetRegistry\FAssetPackageData) > GetAssetPackageDataCopy ( [FName](API\Runtime\Core\UObject\FName) PackageName ) const


description: Deprecated* Receiving a pointer is not threadsafe. Use other functions onIAssetRegistryto access the same data, or contact Epic Core team to add the threadsafe functions you require..

code: const [FAssetRegistryState](API\Runtime\AssetRegistry\AssetRegistry\FAssetRegistryState) * GetAssetRegistryState() const


description: Gets asset data for all assets that match the filter. Assets returned must satisfy every filter component if there is at least one element in the component's array. Assets will satisfy a component if they match any of the elements in it.

code: bool GetAssets ( const [FARFilter](API\Runtime\CoreUObject\AssetRegistry\FARFilter) & Filter, [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > & OutAssetData, bool bSkipARFilteredAssets ) const


description: Gets asset data for all assets with the supplied class

code: bool GetAssetsByClass ( [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) ClassPathName, [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > & OutAssetData, bool bSearchSubClasses ) const


code: bool GetAssetsByClass ( [FName](API\Runtime\Core\UObject\FName) ClassPathName, [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > & OutAssetData, bool bSearchSubClasses ) const


description: Gets asset data for the assets in the package with the specified package name

code: bool GetAssetsByPackageName ( [FName](API\Runtime\Core\UObject\FName) PackageName, [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > & OutAssetData, bool bIncludeOnlyOnDiskAssets, bool bSkipARFilteredAssets ) const


description: Gets asset data for all assets in the supplied folder path

code: bool GetAssetsByPath ( [FName](API\Runtime\Core\UObject\FName) PackagePath, [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > & OutAssetData, bool bRecursive, bool bIncludeOnlyOnDiskAssets ) const


description: Gets asset data for all assets in any of the supplied folder paths

code: bool GetAssetsByPaths ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > PackagePaths, [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > & OutAssetData, bool bRecursive, bool bIncludeOnlyOnDiskAssets ) const


description: Gets asset data for all assets with the supplied tags and values

code: bool GetAssetsByTagValues ( const [TMultiMap](API\Runtime\Core\Containers\TMultiMap)< [FName](API\Runtime\Core\UObject\FName), [FString](API\Runtime\Core\Containers\FString) > & AssetTagsAndValues, [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > & OutAssetData ) const


description: Gets asset data for all assets with the supplied tags, regardless of their value

code: bool GetAssetsByTags ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & AssetTags, [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > & OutAssetData ) const


description: Deprecated* Receiving a reference is not threadsafe. Use GetCachedEmptyPackagesCopy instead.

code: const [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > & GetCachedEmptyPackages() const


description: Returns the set of empty package names fast iteration

code: [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > GetCachedEmptyPackagesCopy() const


code: static [IAssetRegistry](API\Runtime\AssetRegistry\AssetRegistry\IAssetRegistry) & GetChecked()


description: Gets a list of AssetIdentifiers or FAssetDependencies that are referenced by the supplied AssetIdentifier. (On disk references ONLY)

code: bool GetDependencies ( const [FAssetIdentifier](API\Runtime\CoreUObject\AssetRegistry\FAssetIdentifier) & AssetIdentifier, [TArray](API\Runtime\Core\Containers\TArray)< [FAssetIdentifier](API\Runtime\CoreUObject\AssetRegistry\FAssetIdentifier) > & OutDependencies, [UE::AssetRegistry::EDependencyCategory](API\Runtime\CoreUObject\Misc\UE__AssetRegistry__EDependencyCa-) Category, const [UE::AssetRegistry::FDependencyQuery](API\Runtime\CoreUObject\Misc\FDependencyQuery) & Flags ) const


code: bool GetDependencies ( const [FAssetIdentifier](API\Runtime\CoreUObject\AssetRegistry\FAssetIdentifier) & AssetIdentifier, [TArray](API\Runtime\Core\Containers\TArray)< [FAssetDependency](API\Runtime\AssetRegistry\AssetRegistry\FAssetDependency) > & OutDependencies, [UE::AssetRegistry::EDependencyCategory](API\Runtime\CoreUObject\Misc\UE__AssetRegistry__EDependencyCa-) Category, const [UE::AssetRegistry::FDependencyQuery](API\Runtime\CoreUObject\Misc\FDependencyQuery) & Flags ) const


description: Gets a list of PackageNames that are referenced by the supplied package. (On disk references ONLY)

code: bool GetDependencies ( [FName](API\Runtime\Core\UObject\FName) PackageName, [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutDependencies, [UE::AssetRegistry::EDependencyCategory](API\Runtime\CoreUObject\Misc\UE__AssetRegistry__EDependencyCa-) Category, const [UE::AssetRegistry::FDependencyQuery](API\Runtime\CoreUObject\Misc\FDependencyQuery) & Flags ) const


description: Returns the names of all classes derived by the supplied class names, excluding any classes matching the excluded class names. This can be slow if temporary caching mode is not on

code: void GetDerivedClassNames ( const [TArray](API\Runtime\Core\Containers\TArray)< [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) > & ClassNames, const [TSet](API\Runtime\Core\Containers\TSet)< [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) > & ExcludedClassNames, [TSet](API\Runtime\Core\Containers\TSet)< [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) > & OutDerivedClassNames ) const


description: Deprecated* Class names are now represented by path names. Please use a version of this function that usesFTopLevelAssetPath.

code: void GetDerivedClassNames ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & ClassNames, const [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > & ExcludedClassNames, [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > & OutDerivedClassNames ) const


description:
Returns the first LongPackageName found for the given PackageName. Issues a warning and returns the first (sorted lexically) if there is more than one. Call to check existence of a LongPackageName or find a package with a ShortPackageName.
The first LongPackageName of the matching package, or NAME_None if not found.

code: [FName](API\Runtime\Core\UObject\FName) GetFirstPackageByName ( FStringView PackageName ) const


description: Uses the asset registry to look for ObjectRedirectors. This will follow the chain of redirectors. It will return the original path if no redirectors are found

code: [FSoftObjectPath](API\Runtime\CoreUObject\UObject\FSoftObjectPath) GetRedirectedObjectPath ( const [FSoftObjectPath](API\Runtime\CoreUObject\UObject\FSoftObjectPath) & ObjectPath ) const


description: Gets the LongPackageName for all packages with the given PackageName. Call to check existence of a LongPackageName or find all packages with a ShortPackageName.

code: void GetPackagesByName ( FStringView PackageName, [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutPackageNames ) const


description: Deprecated* Asset path FNames have been deprecated, useFSoftObjectPathinstead.

code: [FName](API\Runtime\Core\UObject\FName) GetRedirectedObjectPath ( const [FName](API\Runtime\Core\UObject\FName) ObjectPath ) const


code: bool GetReferencers ( const [FAssetIdentifier](API\Runtime\CoreUObject\AssetRegistry\FAssetIdentifier) & AssetIdentifier, [TArray](API\Runtime\Core\Containers\TArray)< [FAssetDependency](API\Runtime\AssetRegistry\AssetRegistry\FAssetDependency) > & OutReferencers, [UE::AssetRegistry::EDependencyCategory](API\Runtime\CoreUObject\Misc\UE__AssetRegistry__EDependencyCa-) Category, const [UE::AssetRegistry::FDependencyQuery](API\Runtime\CoreUObject\Misc\FDependencyQuery) & Flags ) const


description: Gets a list of AssetIdentifiers or FAssetDependencies that reference the supplied AssetIdentifier. (On disk references ONLY)

code: bool GetReferencers ( const [FAssetIdentifier](API\Runtime\CoreUObject\AssetRegistry\FAssetIdentifier) & AssetIdentifier, [TArray](API\Runtime\Core\Containers\TArray)< [FAssetIdentifier](API\Runtime\CoreUObject\AssetRegistry\FAssetIdentifier) > & OutReferencers, [UE::AssetRegistry::EDependencyCategory](API\Runtime\CoreUObject\Misc\UE__AssetRegistry__EDependencyCa-) Category, const [UE::AssetRegistry::FDependencyQuery](API\Runtime\CoreUObject\Misc\FDependencyQuery) & Flags ) const


description: Gets a list of all paths that are currently cached below the passed-in base path

code: void GetSubPaths ( const [FString](API\Runtime\Core\Containers\FString) & InBasePath, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutPathList, bool bInRecurse ) const


description: Gets a list of all paths by name that are currently cached below the passed-in base path

code: void GetSubPaths ( const [FName](API\Runtime\Core\UObject\FName) & InBasePath, [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutPathList, bool bInRecurse ) const


description: Returns true if temporary caching mode enabled

code: bool GetTemporaryCachingMode() const


description: Gets paths for all Verse files in the supplied folder

code: bool GetVerseFilesByPath ( [FName](API\Runtime\Core\UObject\FName) PackagePath, [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutFilePaths, bool bRecursive ) const


description: Does the given path contain assets, optionally also testing sub-paths?

code: bool HasAssets ( const [FName](API\Runtime\Core\UObject\FName) PackagePath, const bool bRecursive ) const


description: Gets a list of PackageNames that reference the supplied package. (On disk references ONLY)

code: bool GetReferencers ( [FName](API\Runtime\Core\UObject\FName) PackageName, [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutReferencers, [UE::AssetRegistry::EDependencyCategory](API\Runtime\CoreUObject\Misc\UE__AssetRegistry__EDependencyCa-) Category, const [UE::AssetRegistry::FDependencyQuery](API\Runtime\CoreUObject\Misc\FDependencyQuery) & Flags ) const


description:
Returns whether the supplied folder contains any verse file
True if any verse file is found under the supplied folder

code: bool HasVerseFiles ( [FName](API\Runtime\Core\UObject\FName) PackagePath, bool bRecursive ) const


description: Fills in a AssetRegistryState with a copy of the data in the internal cache, overriding some

code: void InitializeTemporaryAssetRegistryState ( [FAssetRegistryState](API\Runtime\AssetRegistry\AssetRegistry\FAssetRegistryState) & OutState, const [FAssetRegistrySerializationOptions](API\Runtime\AssetRegistry\AssetRegistry\FAssetRegistrySerializationOptio-) & Options, bool bRefreshExisting, const [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > & RequiredPackages, const [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > & RemovePackages ) const


description: Fills inFAssetRegistrySerializationOptionsfrom ini, optionally using a target platform ini name

code: void InitializeSerializationOptions ( [FAssetRegistrySerializationOptions](API\Runtime\AssetRegistry\AssetRegistry\FAssetRegistrySerializationOptio-) & Options, const [FString](API\Runtime\Core\Containers\FString) & PlatformIniName, [UE::AssetRegistry::ESerializationTarget](API\Runtime\CoreUObject\Misc\UE__AssetRegistry__ESerializatio-) Target ) const


description: Tests to see whether the given asset would be excluded (fails) the given filter

code: bool IsAssetExcludedByFilter ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & AssetData, const [FARCompiledFilter](API\Runtime\CoreUObject\AssetRegistry\FARCompiledFilter) & Filter ) const


description: Tests to see whether the given asset would be included (passes) the given filter

code: bool IsAssetIncludedByFilter ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & AssetData, const [FARCompiledFilter](API\Runtime\CoreUObject\AssetRegistry\FARCompiledFilter) & Filter ) const


description: Returns true if the asset registry is currently loading files and does not yet know about all assets

code: bool IsLoadingAssets() const


description: Whether SearchAllAssets has been called, or was auto-called at startup. When async (editor or cooking), if SearchAllAssets has ever been called, any newly-mounted directory will be automatically searched.

code: bool IsSearchAllAssets() const


description:
Indicates if path should be beautified before presented to the user.
True if the path should be beautified

code: bool IsPathBeautificationNeeded ( const [FString](API\Runtime\Core\Containers\FString) & InAssetPath ) const


description: Whether searching is done async (and was started at startup), or synchronously and on-demand, requiring ScanPathsSynchronous or SearchAllAssets.

code: bool IsSearchAsync() const


description: Gets a list of paths to objects that are referenced by the supplied package. (On disk references ONLY)

code: virtual bool K2_GetDependencies ( [FName](API\Runtime\Core\UObject\FName) PackageName, const [FAssetRegistryDependencyOptions](API\Runtime\AssetRegistry\AssetRegistry\FAssetRegistryDependencyOptions) & DependencyOptions, [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutDependencies ) const


description:
Gets the asset data for the specified object path
the assets data;Will be invalid if object could not be found

code: virtual [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) K2_GetAssetByObjectPath ( const [FSoftObjectPath](API\Runtime\CoreUObject\UObject\FSoftObjectPath) & ObjectPath, bool bIncludeOnlyOnDiskAssets, bool bSkipARFilteredAssets ) const


description: Gets a list of packages that reference the supplied package. (On disk references ONLY)

code: virtual bool K2_GetReferencers ( [FName](API\Runtime\Core\UObject\FName) PackageName, const [FAssetRegistryDependencyOptions](API\Runtime\AssetRegistry\AssetRegistry\FAssetRegistryDependencyOptions) & ReferenceOptions, [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutReferencers ) const


description: Load FPackageRegistry data from the supplied package

code: void LoadPackageRegistryData ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [FLoadPackageRegistryData](API\Runtime\AssetRegistry\AssetRegistry\IAssetRegistry\FLoadPackageRegistryData) & InOutData ) const


description: LoadFAssetDatafrom the specified package filename

code: void LoadPackageRegistryData ( const [FString](API\Runtime\Core\Containers\FString) & PackageFilename, [FLoadPackageRegistryData](API\Runtime\AssetRegistry\AssetRegistry\IAssetRegistry\FLoadPackageRegistryData) & InOutData ) const


code: FAssetAddedEvent & OnAssetAdded()


code: FAssetRemovedEvent & OnAssetRemoved()


code: FAssetRenamedEvent & OnAssetRenamed()


description: Event for when assets are added to the registry to handle batches more efficiently

code: FAssetsEvent & OnAssetsAdded()


description: Event for when assets are updated in the registry

code: FAssetsEvent & OnAssetsUpdated()


description: Event for when assets are removed from the registry

code: FAssetsEvent & OnAssetsRemoved()


description: Event for when assets are updated on disk and have been refreshed in the assetregistry

code: FAssetsEvent & OnAssetsUpdatedOnDisk()


code: FAssetUpdatedEvent & OnAssetUpdated()


code: FFilesLoadedEvent & OnFilesLoaded()


code: FPathAddedEvent & OnPathAdded()


code: FVerseAddedEvent & OnVerseAdded()


code: FVerseRemovedEvent & OnVerseRemoved()


description: Informs the asset registry that an in-memory package has been deleted, and all associated assets should be removed

code: void PackageDeleted ( [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * DeletedPackage )


description: Queries whether the given path exists in the set of cached paths

code: bool PathExists ( const [FString](API\Runtime\Core\Containers\FString) & PathToTest ) const


code: bool PathExists ( const [FName](API\Runtime\Core\UObject\FName) PathToTest ) const


description: Hint the streaming installers to prioritize a specific asset for install.

code: void PrioritizeAssetInstall ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & AssetData ) const


description: If assets are currently being asynchronously scanned in the specified path, this will cause them to be scanned before other assets.

code: void PrioritizeSearchPath ( const [FString](API\Runtime\Core\Containers\FString) & PathToPrioritize )


description: Enumerate all pairs in State->TagToAssetDataMapAssetRegistry and call a callback on each pair. To avoid copies, the callback is called from within the ReadLock. DO NOT CALL AssetRegistry functions from the callback; doing so will create a deadlock.

code: void ReadLockEnumerateTagToAssetDatas ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void([FName](API\Runtime\Core\UObject\FName) TagName, const [TArray](API\Runtime\Core\Containers\TArray)< const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) * > &Assets)> Callback ) const


description: Attempts to remove the specified path to the set of cached paths. This will only succeed if there are no assets left in the specified path.

code: bool RemovePath ( const [FString](API\Runtime\Core\Containers\FString) & PathToRemove )


description: Trims items out of the asset data list that do not pass the supplied filter

code: void RunAssetsThroughFilter ( [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > & AssetDataList, const [FARFilter](API\Runtime\CoreUObject\AssetRegistry\FARFilter) & Filter ) const


description: Scan the specified individual files right now and populate the asset registry. If bForceRescan is true, the paths will be scanned again, even if they were previously scanned

code: void ScanFilesSynchronous ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFilePaths, bool bForceRescan )


description: Forces a rescan of specific filenames, call this when you need to refresh from disk

code: void ScanModifiedAssetFiles ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFilePaths )


description: Scan the supplied paths recursively right now and populate the asset registry. If bForceRescan is true, the paths will be scanned again, even if they were previously scanned

code: void ScanPathsSynchronous ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InPaths, bool bForceRescan, bool bIgnoreDenyListScanFilters )


description: Scan the supplied paths and files recursively right now and populate the asset registry.

code: void ScanSynchronous ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InPaths, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFilePaths, [UE::AssetRegistry::EScanFlags](API\Runtime\AssetRegistry\AssetRegistry\UE__AssetRegistry__EScanFlags) InScanFlags )


description: Look for all assets on disk (can be async or synchronous)

code: void SearchAllAssets ( bool bSynchronousSearch )


description: Serialize the registry to/from a file, skipping editor only data

code: void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: void Serialize ( [FStructuredArchive::FRecord](API\Runtime\Core\Serialization\FStructuredArchive\FRecord) Record )


description: Specifies a list of manager mappings, optionally recursing to dependencies. These mappings can then be queried later to see which assets "manage" other assets This function is only meant to be called by the AssetManager, calls from anywhere else will conflict and lose data

code: void SetManageReferences ( const [TMultiMap](API\Runtime\Core\Containers\TMultiMap)< [FAssetIdentifier](API\Runtime\CoreUObject\AssetRegistry\FAssetIdentifier), [FAssetIdentifier](API\Runtime\CoreUObject\AssetRegistry\FAssetIdentifier) > & ManagerMap, bool bClearExisting, [UE::AssetRegistry::EDependencyCategory](API\Runtime\CoreUObject\Misc\UE__AssetRegistry__EDependencyCa-) RecurseType, [TSet](API\Runtime\Core\Containers\TSet)< FDependsNode * > & ExistingManagedNodes, [ShouldSetManagerPredicate](API\Runtime\AssetRegistry\AssetRegistry\IAssetRegistry\ShouldSetManagerPredicate) ShouldSetManager )


description: Sets the PrimaryAssetId for a specific asset. This should only be called by the AssetManager, and is needed when the AssetManager is more up to date than the on disk Registry

code: bool SetPrimaryAssetIdForObjectPath ( const [FName](API\Runtime\Core\UObject\FName) ObjectPath, [FPrimaryAssetId](API\Runtime\CoreUObject\UObject\FPrimaryAssetId) PrimaryAssetId )


code: bool SetPrimaryAssetIdForObjectPath ( const [FSoftObjectPath](API\Runtime\CoreUObject\UObject\FSoftObjectPath) & ObjectPath, [FPrimaryAssetId](API\Runtime\CoreUObject\UObject\FPrimaryAssetId) PrimaryAssetId )


description: Mark that the temporary cached needs to be updated before being used again, because e.g. a new class was loaded. Does nothing if TemporaryCachingMode is not enabled


description: Enables or disable temporary search caching, when this is enabled scanning/searching is faster because we assume no objects are loaded between scans. Disabling frees any caches created

code: void SetTemporaryCachingMode ( bool bEnable )


className: ShouldSetManagerPredicate

description: Predicate called to decide whether to recurse into a reference when setting manager references


description: Tick the asset registry

code: void Tick ( float DeltaTime )


description:
Tries to get the asset data for the specified object path
Enum return code

code: [UE::AssetRegistry::EExists](API\Runtime\CoreUObject\Misc\UE__AssetRegistry__EExists) TryGetAssetByObjectPath ( const [FSoftObjectPath](API\Runtime\CoreUObject\UObject\FSoftObjectPath) & ObjectPath, [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & OutAssetData ) const


description:
Tries to get the pacakge data for a specified path
Enum return code

code: [UE::AssetRegistry::EExists](API\Runtime\CoreUObject\Misc\UE__AssetRegistry__EExists) TryGetAssetPackageData ( [FName](API\Runtime\Core\UObject\FName) PackageName, [FAssetPackageData](API\Runtime\CoreUObject\AssetRegistry\FAssetPackageData) & OutAssetPackageData ) const


description: Trims items out of the asset data list that pass the supplied filter

code: void UseFilterToExcludeAssets ( [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > & AssetDataList, const [FARFilter](API\Runtime\CoreUObject\AssetRegistry\FARFilter) & Filter ) const


code: void UseFilterToExcludeAssets ( [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > & AssetDataList, const [FARCompiledFilter](API\Runtime\CoreUObject\AssetRegistry\FARCompiledFilter) & CompiledFilter ) const


description: Wait for scan to be complete. If called during editor startup before OnPostEngineInit, and there are any assets that use classes in not-yet-loaded plugin modules, WaitForCompletion will return silently with those assets still ungathered.

code: void WaitForCompletion()


description: Wait for the scan of a specific package to be complete

code: void WaitForPackage ( const [FString](API\Runtime\Core\Containers\FString) & PackageName )


code: UAssetRegistry ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: IAssetRegistry

code: class IAssetRegistry


description: Creates asset data from aUObject.

code: static [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) CreateAssetData ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * InAsset, bool bAllowBlueprintClass )


className: UAssetRegistry

code: class UAssetRegistry : public [UInterface](API\Runtime\CoreUObject\UObject\UInterface)


description: Returns the first native class of the asset type that can be found. Normally this is just theFAssetData::GetClass(), however if the class is a blueprint generated class it may not be loaded. In which case GetAncestorClassNames will be used to find the first native super class. This can be slow if temporary caching mode is not on.

code: static [UClass](API\Runtime\CoreUObject\UObject\UClass) * FindAssetNativeClass ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & AssetData )


description: Finds references of the provided asset that are of the a class contained in the InMatchClasses set.

code: static void FindReferencersOfAssetOfClass ( const [FAssetIdentifier](API\Runtime\CoreUObject\AssetRegistry\FAssetIdentifier) & InAssetIdentifier, TConstArrayView< [UClass](API\Runtime\CoreUObject\UObject\UClass) * > InMatchClasses, [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > & OutAssetDatas )


code: static void FindReferencersOfAssetOfClass ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * AssetInstance, TConstArrayView< [UClass](API\Runtime\CoreUObject\UObject\UClass) * > InMatchClasses, [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > & OutAssetDatas )


code: FTemporaryCachingModeScope &40; bool InTempCachingMode &41;


className: FTemporaryCachingModeScope

description: Enable/disable asset registry caching mode for the duration of the scope

code: struct FTemporaryCachingModeScope


description: Returns the assetUObjectif it is loaded or loads the asset if it is unloaded then returns the result

code: static [UObject](API\Runtime\CoreUObject\UObject\UObject) * GetAsset ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & InAssetData )


code: static [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetClass ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & InAssetData )


description: Gets asset data for all blueprint assets that match the filter. ClassPaths in the filter specify the blueprint's parent class.

code: static void GetBlueprintAssets ( const [FARFilter](API\Runtime\CoreUObject\AssetRegistry\FARFilter) & InFilter, [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > & OutAssetData )


description: Returns the name for the asset in the form: Class'ObjectPath'

code: static [FString](API\Runtime\Core\Containers\FString) GetExportTextName ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & InAssetData )


description: Returns the full name for the asset in the form: Class ObjectPath

code: static [FString](API\Runtime\Core\Containers\FString) GetFullName ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & InAssetData )


description: Gets the value associated with the given tag as a string

code: static bool GetTagValue ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & InAssetData, const [FName](API\Runtime\Core\UObject\FName) & InTagName, [FString](API\Runtime\Core\Containers\FString) & OutTagValue )


description: Checks to see if the given asset data is a blueprint with a base class in the ClassNameSet. This checks the parent asset tag

code: static bool IsAssetDataBlueprintOfClassSet ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & AssetData, const [TSet](API\Runtime\Core\Containers\TSet)< [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) > & ClassNameSet )


description: Returns true if the asset is loaded

code: static bool IsAssetLoaded ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & InAssetData )


description: Returns true if this is the primary asset in a package, true for maps and assets but false for secondary objects like class redirectors

code: static bool IsUAsset ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & InAssetData )


description: Returns true if the this asset is a redirector.

code: static bool IsRedirector ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & InAssetData )


description: Checks to see if this AssetData refers to an asset or is NULL

code: static bool IsValid ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & InAssetData )


description: Populates the FARFilters tags and values map with the passed in tags and values

code: static [FARFilter](API\Runtime\CoreUObject\AssetRegistry\FARFilter) SetFilterTagsAndValues ( const [FARFilter](API\Runtime\CoreUObject\AssetRegistry\FARFilter) & InFilter, const [TArray](API\Runtime\Core\Containers\TArray)< [FTagAndValue](API\Runtime\AssetRegistry\AssetRegistry\FTagAndValue) > & InTagsAndValues )


description: Convert to a SoftObjectPath for loading

code: static [FSoftObjectPath](API\Runtime\CoreUObject\UObject\FSoftObjectPath) ToSoftObjectPath ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & InAssetData )


code: namespace UE { namespace AssetRegistry { enum EGetMostImportantAssetFlags { None = 0, RequireOneTopLevelAsset = 0x1, IgnoreSkipClasses = 0x2, } } }


className: UAssetRegistryHelpers

code: class UAssetRegistryHelpers : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: namespace UE { namespace AssetRegistry { enum EReadPackageDataMainErrorCode { Unknown = 0, Unknown, InvalidObjectCount = 1, InvalidTagCount = 2, InvalidTag = 3, } } }


code: namespace UE { namespace AssetRegistry { namespace Private { uint32 UE::AssetRegistry::Private::HashCombineQuick ( uint32 A, uint32 B ) } } }


code: namespace UE { namespace AssetRegistry { enum EScanFlags { None = 0, ForceRescan = 1 << 0, IgnoreDenyListScanFilters = 1 << 1, WaitForInMemoryObjects = 1 << 2, } } }


code: namespace UE { namespace AssetRegistry { [EScanFlags](API\Runtime\AssetRegistry\AssetRegistry\UE__AssetRegistry__EScanFlags) & UE::AssetRegistry::operator&= ( [EScanFlags](API\Runtime\AssetRegistry\AssetRegistry\UE__AssetRegistry__EScanFlags) & Lhs, [EScanFlags](API\Runtime\AssetRegistry\AssetRegistry\UE__AssetRegistry__EScanFlags) Rhs ) } }


code: namespace UE { namespace AssetRegistry { [EScanFlags](API\Runtime\AssetRegistry\AssetRegistry\UE__AssetRegistry__EScanFlags) & UE::AssetRegistry::operator^= ( [EScanFlags](API\Runtime\AssetRegistry\AssetRegistry\UE__AssetRegistry__EScanFlags) & Lhs, [EScanFlags](API\Runtime\AssetRegistry\AssetRegistry\UE__AssetRegistry__EScanFlags) Rhs ) } }


code: namespace UE { namespace AssetRegistry { constexpr [EScanFlags](API\Runtime\AssetRegistry\AssetRegistry\UE__AssetRegistry__EScanFlags) UE::AssetRegistry::operator& ( [EScanFlags](API\Runtime\AssetRegistry\AssetRegistry\UE__AssetRegistry__EScanFlags) Lhs, [EScanFlags](API\Runtime\AssetRegistry\AssetRegistry\UE__AssetRegistry__EScanFlags) Rhs ) } }


code: namespace UE { namespace AssetRegistry { constexpr [EScanFlags](API\Runtime\AssetRegistry\AssetRegistry\UE__AssetRegistry__EScanFlags) UE::AssetRegistry::operator^ ( [EScanFlags](API\Runtime\AssetRegistry\AssetRegistry\UE__AssetRegistry__EScanFlags) Lhs, [EScanFlags](API\Runtime\AssetRegistry\AssetRegistry\UE__AssetRegistry__EScanFlags) Rhs ) } }


code: namespace UE { namespace AssetRegistry { constexpr bool UE::AssetRegistry::operator! ( [EScanFlags](API\Runtime\AssetRegistry\AssetRegistry\UE__AssetRegistry__EScanFlags) E ) } }


code: namespace UE { namespace AssetRegistry { constexpr [EScanFlags](API\Runtime\AssetRegistry\AssetRegistry\UE__AssetRegistry__EScanFlags) UE::AssetRegistry::operator~ ( [EScanFlags](API\Runtime\AssetRegistry\AssetRegistry\UE__AssetRegistry__EScanFlags) E ) } }


code: namespace UE { namespace AssetRegistry { namespace Private { uint32 UE::AssetRegistry::Private::GetTypeHash ( const [FCachedAssetKey](API\Runtime\AssetRegistry\AssetRegistry\FCachedAssetKey) & A ) } } }


code: namespace UE { namespace AssetRegistry { namespace Private { FStringBuilderBase & UE::AssetRegistry::Private::operator<< ( FStringBuilderBase & Builder, const [FCachedAssetKey](API\Runtime\AssetRegistry\AssetRegistry\FCachedAssetKey) & Key ) } } }


code: namespace UE { namespace AssetRegistry { namespace Private { bool UE::AssetRegistry::Private::operator== ( const [FCachedAssetKey](API\Runtime\AssetRegistry\AssetRegistry\FCachedAssetKey) & A, const [FCachedAssetKey](API\Runtime\AssetRegistry\AssetRegistry\FCachedAssetKey) & B ) } } }


code: namespace UE { namespace AssetRegistry { namespace Private { bool UE::AssetRegistry::Private::operator!= ( const [FCachedAssetKey](API\Runtime\AssetRegistry\AssetRegistry\FCachedAssetKey) & A, const [FCachedAssetKey](API\Runtime\AssetRegistry\AssetRegistry\FCachedAssetKey) & B ) } } }


description: Analyze the audio buffer.

module: AudioAnalyzer

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAnalyzerResult](API\Runtime\AudioAnalyzer\IAnalyzerResult) > AnalyzeAudioBuffer ( const [TArray](API\Runtime\Core\Containers\TArray)< float > & InAudioBuffer, int32 InNumChannels, float InSampleRate )


description: Create an FAnalyzerBatch with the analyzer settings and factory name.

code: FAnalyzerFacade ( [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAnalyzerSettings](API\Runtime\AudioAnalyzer\IAnalyzerSettings) > InSettings, [IAnalyzerFactory](API\Runtime\AudioAnalyzer\IAnalyzerFactory) * InFactory )


className: FAnalyzerFacade

description: FAnalyzer provides a simplified interface for performing analysis on audio buffers from the same AudioAnalyzer.

code: class FAnalyzerFacade


description: Analyze an entire PCM16 encoded audio object. Audio for the entire sound should be contained within InRawWaveData.

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAnalyzerNRTResult](API\Runtime\AudioAnalyzer\IAnalyzerNRTResult) > AnalyzePCM16Audio ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InRawWaveData, int32 InNumChannels, float InSampleRate )


description: Create anFAnalyzerNRTFacadewith the analyzer settings and factory name.

code: FAnalyzerNRTFacade ( [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAnalyzerNRTSettings](API\Runtime\AudioAnalyzer\IAnalyzerNRTSettings) > InSettings, const [FName](API\Runtime\Core\UObject\FName) & InFactoryName )


code: FAnalyzerNRTParameters ( float InSampleRate, int32 InNumChannels )


className: FAnalyzerNRTFacade

description: FAnalyzerNRTFacadeprovides a simplified interface for running analyzer factories over complete audio resources.

code: class FAnalyzerNRTFacade


className: FAnalyzerNRTParameters

description: These parameters are pass to anIAnalyzerNRTFactorywhen creating a newIAnalyzerNRTWorkerorIAnalyzerNRTResult

code: struct FAnalyzerNRTParameters

SampleRate

type: float


code: FAnalyzerParameters ( int32 InSampleRate, int32 InNumChannels )


className: FAnalyzerParameters

description: These parameters are pass to anIAnalyzerFactorywhen creating a newIAnalyzerWorkerorIAnalyzerResult

code: struct FAnalyzerParameters


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

code: virtual void ShutdownModule()


description: IModuleInterfaceimplementation

code: virtual void StartupModule()


className: FAudioAnalyzerModule

code: class FAudioAnalyzerModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Does the task work.

code: void DoWork()


description: Move the audio buffer back out.

code: [TArray](API\Runtime\Core\Containers\TArray)< float > && GetAudioBuffer()


description: Get the results from the task.


description: Give the task the audio data to analyze.

code: void SetAudioBuffer ( [TArray](API\Runtime\Core\Containers\TArray)< float > && InAudioData )


code: FAudioAnalyzeTask ( [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [Audio::FAnalyzerFacade](API\Runtime\AudioAnalyzer\FAnalyzerFacade) > & InAnalyzerFacade, int32 InSampleRate, int32 InNumChannels )


className: FAudioAnalyzeTask

code: class FAudioAnalyzeTask : public [FNonAbandonableTask](API\Runtime\Core\Async\FNonAbandonableTask)


description: Supplied unique name ofIAnalyzerFactoryto enable querying of added analyzer factories


description: Name of specific analyzer type.


description: Human readable name of analyzer.


description: Create a new result.

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAnalyzerResult](API\Runtime\AudioAnalyzer\IAnalyzerResult) > NewResult() const


description: Create a new worker.

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAnalyzerWorker](API\Runtime\AudioAnalyzer\IAnalyzerWorker) > NewWorker ( const [FAnalyzerParameters](API\Runtime\AudioAnalyzer\FAnalyzerParameters) & InParams, const [IAnalyzerSettings](API\Runtime\AudioAnalyzer\IAnalyzerSettings) * InSettings ) const


description: Convenience function to create a new shared result by calling NewResult.

code: template<ESPMode Mode> [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAnalyzerResult](API\Runtime\AudioAnalyzer\IAnalyzerResult), Mode > NewResultShared() const


className: IAnalyzerFactory

description: Audio analyzer factory. Primarily used for creating a worker.

code: class IAnalyzerFactory : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


code: virtual ~IAnalyzerFactory()


description: Supplied unique name ofIAnalyzerNRTFactoryto enable querying of added analyzer factories


description: Create a new result.

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAnalyzerNRTResult](API\Runtime\AudioAnalyzer\IAnalyzerNRTResult) > NewResult() const


code: template<ESPMode Mode> [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAnalyzerNRTResult](API\Runtime\AudioAnalyzer\IAnalyzerNRTResult), Mode > NewResultShared() const


description: Create a new worker.

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAnalyzerNRTWorker](API\Runtime\AudioAnalyzer\IAnalyzerNRTWorker) > NewWorker ( const [FAnalyzerNRTParameters](API\Runtime\AudioAnalyzer\FAnalyzerNRTParameters) & InParams, const [IAnalyzerNRTSettings](API\Runtime\AudioAnalyzer\IAnalyzerNRTSettings) * InSettings ) const


code: virtual ~IAnalyzerNRTFactory()


className: IAnalyzerNRTFactory

description: This is used to define a non real-time analyzer.

code: class IAnalyzerNRTFactory : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


description: This virtual can be overridden to provide a faster copying scheme than full serialization when analyzing non-remote targets. If not overridden, this function will use the Serialize call.

code: virtual void CopyFrom ( [IAnalyzerNRTResult](API\Runtime\AudioAnalyzer\IAnalyzerNRTResult) * SourceResult )


description: This must be overridden to return the duration of the original audio analyzed.

code: float GetDurationInSeconds() const


code: virtual ~IAnalyzerNRTResult()


description: This is used to define how to serialize this instance of results for remote profiling.

code: void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Archive )


className: IAnalyzerNRTResult

description: This interface defines the required methods for non-real-time analyzer results.

code: class IAnalyzerNRTResult


code: virtual ~IAnalyzerNRTSettings()


description: Perform analysis of an audio stream. This method may be called multiple times with audio from the same source.

code: void Analyze ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > InAudio, [IAnalyzerNRTResult](API\Runtime\AudioAnalyzer\IAnalyzerNRTResult) * OutResult )


className: IAnalyzerNRTSettings

description: This interface defines the required methods for non-real-time analyzer settings.

code: class IAnalyzerNRTSettings


description: Called when analysis of audio asset is complete.

code: void Finalize ( [IAnalyzerNRTResult](API\Runtime\AudioAnalyzer\IAnalyzerNRTResult) * OutResult )


code: virtual ~IAnalyzerNRTWorker()


className: IAnalyzerNRTWorker

description: This interface is used to define a class that will handle actual analysis of a singular audio asset.

code: class IAnalyzerNRTWorker


className: IAnalyzerResult

description: This interface defines the required methods for real-time analyzer results.

code: class IAnalyzerResult


code: virtual ~IAnalyzerSettings()


className: IAnalyzerSettings

description: This interface defines the required methods for real-time analyzer settings.

code: class IAnalyzerSettings


code: void Analyze ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > InAudio, [IAnalyzerResult](API\Runtime\AudioAnalyzer\IAnalyzerResult) * OutResult )


className: IAnalyzerWorker

description: An audio analyzer worker.

code: class IAnalyzerWorker


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


description: Function to broadcast results.

code: virtual void BroadcastResults()


className: FResultId

description: ID to keep track of results. Useful for tracking most recent result when performing asynchronous processing.

code: typedef int32 FResultId


className: FResultSharedPtr

description: Thread safe shared point to result object.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [Audio::IAnalyzerResult](API\Runtime\AudioAnalyzer\IAnalyzerResult), ESPMode::ThreadSafe > FResultSharedPtr


description: Subclasses must override this method in order to inform this object which AnalyzerFactory to use for analysis

code: virtual [FName](API\Runtime\Core\UObject\FName) GetAnalyzerFactoryName() const


code: template<class ResultType> [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< ResultType > GetResults()


description: Implementations can override this method to create settings objects specific for their analyzer.

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [Audio::IAnalyzerSettings](API\Runtime\AudioAnalyzer\IAnalyzerSettings) > GetSettings ( const int32 InSampleRate, const int32 InNumChannels ) const


description: Starts analyzing audio from the given audio bus. Optionally override the audio bus desired to analyze.

code: void StartAnalyzing ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [UAudioBus](API\Runtime\Engine\Sound\UAudioBus) * AudioBusToAnalyze )


description: Starts analyzing using the given world.

code: void StartAnalyzing ( [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld, [UAudioBus](API\Runtime\Engine\Sound\UAudioBus) * AudioBusToAnalyze )


description: Stops analyzing audio.

code: void StopAnalyzing ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject )


className: UAudioAnalyzer

description: To support blueprint access, subclasses can implement UFUNCTIONs to expose the data returned by GetResult().

code: class UAudioAnalyzer : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

AudioBus

type: TObjectPtr<UAu...

description: TheUAudioBuswhich is analyzed in real-time.

NumFramesPerBufferToAnalyze

description: How many frames of audio to wait before analyzing the audio.


description: GetAssetActionName()returns theFTextdisplayed in the editor.

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetAssetActionName() const


description: GetSupportedClass()returns the class which should be associated with these asset actions.

code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetSupportedClass() const


description: GetTypeColor()returns the color used to display asset icons within the editor.

code: virtual [FColor](API\Runtime\Core\Math\FColor) GetTypeColor() const


code: virtual bool HasAssetActions() const


description: Performs the analaysis of the audio

code: void AnalyzeAudio()


className: UAudioAnalyzerAssetBase

description: UAudioAnalyzerAssetBaseprovides the base interface for controlling asset actions within the editor.

code: class UAudioAnalyzerAssetBase : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [Audio::IAnalyzerNRTResult](API\Runtime\AudioAnalyzer\IAnalyzerNRTResult), ESPMode::ThreadSafe > FResultSharedPtr


description: Subclasses must override this method in order to inform this object which AnalyzerNRTFactory to use for analysis

code: virtual [FName](API\Runtime\Core\UObject\FName) GetAnalyzerNRTFactoryName() const


description: Returns the result object generated by the associated IAudioAnalyzerNRTFactory. The template argument must be the IAudioAnalyzerNRTResult subclass returned by the associated IAudioAnalyzerNRTFactory.

code: template<class ResultType> [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< ResultType, ESPMode::ThreadSafe > GetResult()


code: template<class ResultType> [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const ResultType, ESPMode::ThreadSafe > GetResult() const


code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [Audio::IAnalyzerNRTSettings](API\Runtime\AudioAnalyzer\IAnalyzerNRTSettings) > GetSettings ( const float InSampleRate, const int32 InNumChannels ) const


description: This determines whether to trigger analysis by calling ShouldEventTriggerAnalysis(...)

code: virtual void PostEditChangeProperty ( struct [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Called before a UPROPERTY of this class is edited. This checks to see if the UPROPERTY is aUAudioAnalyzerNRTSettings. If so, the previous settings' AnalyzeAudioDelegate will be unbound from this object'sAnalyzeAudio()

code: virtual void PreEditChange ( [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * PropertyAboutToChange )


description: This removes the existing delegate handle from the current settings object

code: void RemoveSettingsDelegate ( [UAudioAnalyzerNRTSettings](API\Runtime\AudioAnalyzer\UAudioAnalyzerNRTSettings) * InSettings )


description: Performs serialization of results.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: void SetResult ( [FResultSharedPtr](API\Runtime\AudioAnalyzer\UAudioAnalyzerNRT\FResultSharedPtr) NewResult )


description: This will only store the result if the passed InResultId matches the CurrentResultId.

code: void SetResultIfLatest ( [FResultSharedPtr](API\Runtime\AudioAnalyzer\UAudioAnalyzerNRT\FResultSharedPtr) NewResult, [FResultId](API\Runtime\AudioAnalyzer\UAudioAnalyzerNRT\FResultId) InResultId )


description: This sets the AnalyzeAudio callback to the delegate in settings.

code: void SetSettingsDelegate ( [UAudioAnalyzerNRTSettings](API\Runtime\AudioAnalyzer\UAudioAnalyzerNRTSettings) * InSettings )


description: Returns true when the PropertyChangeEvent is due to update SoundWave or Settings.

code: virtual bool ShouldEventTriggerAnalysis ( struct [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangeEvent )


className: UAudioAnalyzerNRT

description: To support blueprint access, subclasses can implement UFUNCTIONs to expose the data returned byGetResult().

code: class UAudioAnalyzerNRT : public [UAudioAnalyzerAssetBase](API\Runtime\AudioAnalyzer\UAudioAnalyzerAssetBase)

DurationInSeconds

description: The duration of the analyzed audio in seconds.

Sound

type: TObjectPtr<USo...

description: TheUSoundWavewhich is analyzed.


description: This returns true when the PropertyChangeEvent is due to update a setting property. Override this method in order to customize this behavior.


className: UAudioAnalyzerSettings

description: UAudioAnalyzerSettingsprovides a way to store and reuse existing analyzer settings across multiple analyzers.

code: class UAudioAnalyzerSettings : public [UAudioAnalyzerAssetBase](API\Runtime\AudioAnalyzer\UAudioAnalyzerAssetBase)


className: UAudioAnalyzerNRTSettings

description: UAudioAnalyzerNRTSettingsprovides a way to store and reuse existing analyzer settings across multiple analyzers. This class provides the interface and functionality to automatically trigger reanalysis of audio across all analyzers associated with this setting when when a UPROPERTY in this setting object is edited.

code: class UAudioAnalyzerNRTSettings : public [UAudioAnalyzerAssetBase](API\Runtime\AudioAnalyzer\UAudioAnalyzerAssetBase)

AnalyzeAudioDelegate

type: FAnalyzeAudioDe...


description: Implement this for deinitialization of instances of the system

code: virtual void Deinitialize()


code: static [UAudioAnalyzerSubsystem](API\Runtime\AudioAnalyzer\UAudioAnalyzerSubsystem) * Get()


code: void RegisterAudioAnalyzer ( [UAudioAnalyzer](API\Runtime\AudioAnalyzer\UAudioAnalyzer) * InAnalyzer )


code: bool Tick ( float DeltaTime )


description: Implement this for initialization of instances of the system

code: virtual void Initialize ( [FSubsystemCollectionBase](API\Runtime\Engine\Subsystems\FSubsystemCollectionBase) & Collection )


code: void UnregisterAudioAnalyzer ( [UAudioAnalyzer](API\Runtime\AudioAnalyzer\UAudioAnalyzer) * InAnalyzer )


className: UAudioAnalyzerSubsystem

description: Class manages querying analysis results from various audio analyzers.

code: class UAudioAnalyzerSubsystem : public [UEngineSubsystem](API\Runtime\Engine\Subsystems\UEngineSubsystem)


description: Various hardware-accelerated features that an input device can have.

module: AudioCaptureCore

code: namespace Audio { enum EHardwareInputFeature { EchoCancellation, NoiseSuppression, AutomaticGainControl, } }


description: Abort the audio capture stream (stop and close)

code: bool AbortStream()


description: PCM audio format (bits per sample) supported by device layers (WASAPI, CoreAudio, etc.)

code: namespace Audio { enum EPCMAudioEncoding { UNKNOWN, PCM_8, PCM_16, PCM_24, PCM_24_IN_32, PCM_32, FLOATING_POINT_32, FLOATING_POINT_64, } }


description: Returns the audio capture device information at the given Id.

code: bool GetCaptureDeviceInfo ( [FCaptureDeviceInfo](API\Runtime\AudioCaptureCore\FCaptureDeviceInfo) & OutInfo, int32 DeviceIndex )


description: Returns the total amount of audio devices.

code: int32 GetCaptureDevicesAvailable ( [TArray](API\Runtime\Core\Containers\TArray)< [FCaptureDeviceInfo](API\Runtime\AudioCaptureCore\FCaptureDeviceInfo) > & OutDevices )


description: Closes the audio capture stream.

code: bool CloseStream()


description: Get the sample rate in use by the stream.

code: int32 GetSampleRate() const


code: bool GetIfHardwareFeatureIsSupported ( [EHardwareInputFeature](API\Runtime\AudioCaptureCore\Audio__EHardwareInputFeature) FeatureType )


description: Returns true if the audio capture stream is currently capturing audio.

code: bool IsCapturing() const


description: Get the stream time of the audio capture stream.

code: bool GetStreamTime ( double & OutStreamTime ) const


description: Returns if the audio capture stream has been opened.

code: bool IsStreamOpen() const


description: Opens the audio capture stream with the given parameters.

code: bool OpenAudioCaptureStream ( const [FAudioCaptureDeviceParams](API\Runtime\AudioCaptureCore\FAudioCaptureDeviceParams) & InParams, [FOnAudioCaptureFunction](API\Runtime\AudioCaptureCore\FOnAudioCaptureFunction) OnCapture, uint32 NumFramesDesired )


code: PRAGMA_DISABLE_DEPRECATION_WARNINGS bool OpenCaptureStream ( const [FAudioCaptureDeviceParams](API\Runtime\AudioCaptureCore\FAudioCaptureDeviceParams) & InParams, [FOnCaptureFunction](API\Runtime\AudioCaptureCore\FOnCaptureFunction) OnCapture, uint32 NumFramesDesired )


description: Adds a user to the system so we can use its devices.

code: bool RegisterUser ( const TCHAR * UserId )


code: void SetHardwareFeatureEnabled ( [EHardwareInputFeature](API\Runtime\AudioCaptureCore\Audio__EHardwareInputFeature) FeatureType, bool bIsEnabled )


description: Start the audio capture stream.

code: bool StartStream()


description: Removes a user added with RegisterUser.

code: bool UnregisterUser ( const TCHAR * UserId )


description: Stop the audio capture stream.

code: bool StopStream()


className: FAudioCapture

description: Class which handles audio capture internally, implemented with a back-end per platform.

code: class FAudioCapture


className: FAudioCaptureCoreModule

description: Public dependencies

code: class FAudioCaptureCoreModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

code: virtual void ShutdownModule()


description: FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

code: virtual void StartupModule()


className: FAudioCaptureDeviceParams

code: struct FAudioCaptureDeviceParams

bUseHardwareAEC

description: Set to true to use this device's built-in echo cancellation, if possible.

DeviceIndex

description: Set this to INDEX_NONE.

NumInputChannels

description: Number of input channels on the device available for recording audio.

PCMAudioEncoding

type: EPCMAudioEncodi...

description: The bit depth to use when recording audio on this device.

SampleRate

description: The sample rate to use when recording audio on this device.


description: Immediately stop capturing audio.

code: void AbortCapturing()


description: Retrieves audio data from the capture synth. This returns audio only if there was non-zero audio since this function was last called.

code: bool GetAudioData ( [TArray](API\Runtime\Core\Containers\TArray)< float > & OutAudioData )


description: Gets the default capture device info.

code: bool GetDefaultCaptureDeviceInfo ( [FCaptureDeviceInfo](API\Runtime\AudioCaptureCore\FCaptureDeviceInfo) & OutInfo )


description: Returns true if the capture synth is capturing audio.

code: bool IsCapturing() const


description: Returns the number of samples enqueued in the capture synth.

code: int32 GetNumSamplesEnqueued()


description: Returned if the capture synth is closed.

code: bool IsStreamOpen() const


description: Opens up a stream to the default capture device.

code: bool OpenDefaultStream()


description: Stops capturing audio.

code: void StopCapturing()


description: Starts capturing audio.

code: bool StartCapturing()


code: virtual ~FAudioCaptureSynth()


className: FAudioCaptureSynth

description: Class which contains anFAudioCaptureobject and performs analysis on the audio stream, only outputing audio if it matches a detection criteria.

code: class FAudioCaptureSynth


className: FCaptureDeviceInfo

code: struct FCaptureDeviceInfo

DeviceId

type: FString


className: FOnAudioCaptureFunction

description: Callable function type used for audio capture callbacks.

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const void *InAudio, int32 NumFrames, int32 NumChannels, int32 SampleRate, double StreamTime, bool bOverFlow)> FOnAudioCaptureFunction


className: FOnCaptureFunction

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const float *InAudio, int32 NumFrames, int32 NumChannels, int32 SampleRate, double StreamTime, bool bOverFlow)> FOnCaptureFunction


description: IModularFeaturename. Use this to register an implementation of IAudioCaptureDevice.


code: virtual ~IAudioCaptureFactory()


className: IAudioCaptureFactory

code: class IAudioCaptureFactory : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


description: Abort the audio capture stream (stop and close)

code: bool AbortStream()


description: Returns the audio capture device information at the given Id.

code: bool GetCaptureDeviceInfo ( [FCaptureDeviceInfo](API\Runtime\AudioCaptureCore\FCaptureDeviceInfo) & OutInfo, int32 DeviceIndex )


description: Returns the total amount of audio devices.

code: bool GetInputDevicesAvailable ( [TArray](API\Runtime\Core\Containers\TArray)< [FCaptureDeviceInfo](API\Runtime\AudioCaptureCore\FCaptureDeviceInfo) > & OutDevices )


code: virtual bool GetIfHardwareFeatureIsSupported ( [EHardwareInputFeature](API\Runtime\AudioCaptureCore\Audio__EHardwareInputFeature) FeatureType )


description: Get the sample rate in use by the stream.

code: int32 GetSampleRate() const


description: Get the stream time of the audio capture stream.

code: bool GetStreamTime ( double & OutStreamTime )


description: Returns true if the audio capture stream is currently capturing audio.

code: bool IsCapturing() const


description: Returns if the audio capture stream has been opened.

code: bool IsStreamOpen() const


description: This is the callback for querying audio from the input device.

code: void OnAudioCapture ( void * InBuffer, uint32 InBufferFrames, double StreamTime, bool bOverflow )


description: Opens the audio capture stream with the given parameters and using FOnAudioCaptureFunction for callbacks.

code: bool OpenAudioCaptureStream ( const [FAudioCaptureDeviceParams](API\Runtime\AudioCaptureCore\FAudioCaptureDeviceParams) & InParams, [FOnAudioCaptureFunction](API\Runtime\AudioCaptureCore\FOnAudioCaptureFunction) InOnCapture, uint32 NumFramesDesired )


description: Closes the audio capture stream.

code: bool CloseStream()


description: Lets us know which users are in the system.

code: virtual bool RegisterUser ( const TCHAR * UserId )


code: virtual void SetHardwareFeatureEnabled ( [EHardwareInputFeature](API\Runtime\AudioCaptureCore\Audio__EHardwareInputFeature) FeatureType, bool bEnabled )


description: Opens the audio capture stream with the given parameters.

code: virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS bool OpenCaptureStream ( const [FAudioCaptureDeviceParams](API\Runtime\AudioCaptureCore\FAudioCaptureDeviceParams) & InParams, [FOnCaptureFunction](API\Runtime\AudioCaptureCore\FOnCaptureFunction) InOnCapture, uint32 NumFramesDesired )


description: Start the audio capture stream.

code: bool StartStream()


description: Stop the audio capture stream.

code: bool StopStream()


description: Call this to remove a user that was added with RegisterUser.

code: virtual bool UnregisterUser ( const TCHAR * UserId )


code: virtual ~IAudioCaptureStream()


className: IAudioCaptureStream

code: class IAudioCaptureStream : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


description: Stops stream, discarding any remaining samples.

module: AudioCaptureRtAudio

code: namespace Audio { void Audio::AbortStream() }


description: Close stream and free associated memory.

code: namespace Audio { void Audio::CloseStream() }


code: namespace Audio { Audio::FRtAudioInputWrapper() }


description: Returns ID of default input device.

code: namespace Audio { uint32 Audio::GetDefaultInputDevice() }


description: Returns info about device.

code: namespace Audio { [FDeviceInfo](API\Runtime\AudioCaptureRtAudio\FDeviceInfo) Audio::GetDeviceInfo ( uint32 InDeviceID ) }


description: Returns true if the stream is open.

code: namespace Audio { bool Audio::IsStreamOpen() }


description: Opens an audio stream. Returns true on success, false on error.

code: namespace Audio { bool Audio::OpenStream ( const [FStreamParameters](API\Runtime\AudioCaptureRtAudio\FStreamParameters) & InStreamParams, float InDesiredSampleRate, uint32 * InOutDesiredBufferNumFrames, [FAudioCallback](API\Runtime\AudioCaptureRtAudio\FAudioCallback) Callback, void * InUserData ) }


description: Starts an open stream.

code: namespace Audio { void Audio::StartStream() }


className: FAudioCallback

description: FRtAudioInputWrapper wraps RtAudio implementation and provides a way to capture input audio from an hardware audio device.

code: typedef int(*)(void *OutputBuffer, void *InputBuffer, unsigned int NumFrames, double StreamTime, uint32 StreamStatus, void *UserData) FAudioCallback


description: Stops stream, allowing any remaining samples to be played.

code: namespace Audio { void Audio::StopStream() }


className: FStreamParameters

description: Parameters used for opening streams.

code: struct FStreamParameters


className: FSoundWaveProxyPtr

module: AudioCodecEngine

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FSoundWaveProxy](API\Runtime\Engine\Sound\FSoundWaveProxy), ESPMode::ThreadSafe > FSoundWaveProxyPtr


module: AudioExtensions

code: namespace Audio { virtual bool Audio::BeginSection ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar ) }


code: namespace Audio { template<typename UClassToUse> [IAudioProxyDataFactory](API\Runtime\AudioExtensions\IAudioProxyDataFactory) * Audio::CastToProxyDataFactory ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObject ) }


description: Create one.

code: namespace Audio { static FPtr Audio::Create() }


description: Factory.

code: namespace Audio { static [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IDecoderOutput](API\Plugins\ElectraBase\IDecoderOutput) > Audio::Create ( const FRequirements & Requirements, [TArrayView](API\Runtime\Core\Containers\TArrayView)< uint8 > InExternalMemory ) }


description: Factory.

code: namespace Audio { static [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IDecoderOutput](API\Plugins\ElectraBase\IDecoderOutput) > Audio::Create ( const FRequirements & Requirements ) }


code: namespace Audio { static FPtr Audio::Create ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutBuffer ) }


description: Factory.

code: namespace Audio { static [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< IEncoderInput > Audio::Create ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const int16 > InSamples, const FFormat & InInfo ) }


className: FDeviceInfo

description: Parameters describing audio input device.

code: struct FDeviceInfo


description: Factory for decoders.

code: namespace Audio { virtual [FDecoderPtr](API\Runtime\AudioExtensions\FDecoderPtr) Audio::CreateDecoder ( IDecoder::FDecoderInputPtr InSrc, IDecoder::FDecoderOutputPtr InDst ) }


code: namespace Audio { virtual [FEncoderPtr](API\Runtime\AudioExtensions\FEncoderPtr) Audio::CreateEncoder ( IEncoder::FSourcePtr ) }


description: Do the decode.

code: namespace Audio { FDecodeReturn Audio::Decode ( bool bIsLooping ) }


description: Encode.

code: namespace Audio { bool Audio::Encode ( [FSourcePtr](API\Runtime\AudioExtensions\FSourcePtr) InSrc, [FDestPtr](API\Runtime\AudioExtensions\FDestPtr) InDst, [USettingsPtr](API\Runtime\AudioExtensions\USettingsPtr) InSettingsObject ) const }


code: namespace Audio { virtual bool Audio::EndSection ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar ) }


code: namespace Audio { Audio::FCodecDetails ( [FName](API\Runtime\Core\UObject\FName) InName, [FName](API\Runtime\Core\UObject\FName) InFamilyName, uint32 InVersion, const FCodecFeatures & InFeatures ) }


code: namespace Audio { constexpr Audio::FCodecFeatures ( std::initializer_list< EFeatureBitField > InitList ) }


description: Pass in array view and we'll wrap around it.

code: namespace Audio { Audio::FDecoderInputArrayView ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > InData, uint32 InOffsetInStream ) }


description: Pass in an archive.

code: namespace Audio { Audio::FDecoderInputArrayView ( [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FArchive](API\Runtime\Core\Serialization\FArchive) > && InReader, uint32 InOffsetInStream ) }


code: namespace Audio { Audio::FEncodedSectionBase ( [FFcc](API\Runtime\AudioExtensions\Audio__FFcc) InSectionName, uint32 InVersion ) }


description: Four character code class.

code: namespace Audio { constexpr Audio::FFcc ( const char One, const char Two, const char Three, const char Four ) }


code: namespace Audio { Audio::FFormatDescriptorSection() }


code: namespace Audio { Audio::FFormatDescriptorSection ( [FName](API\Runtime\Core\UObject\FName) InCodecName, [FName](API\Runtime\Core\UObject\FName) InCodecFamilyName, uint32 InCodecVersion, uint32 InNumChannels, uint32 InNumSamples, uint32 InNumSamplesPerSec, uint32 InNumBytesPerPacket ) }


description: Find codec by finding by family name. (Version can be INDEX_NONE and give the latest version).

code: namespace Audio { [FCodecPtr](API\Runtime\AudioExtensions\FCodecPtr) Audio::FindCodecByFamilyName ( [FName](API\Runtime\Core\UObject\FName) InFamilyName, int32 InVersion ) const }


description: Deprecated* Please use IAudioFormat/IStreamedCompressedInfo instead

code: namespace Audio { Audio::FHeaderSection() }


description: Find exact code name. (Version can be INDEX_NONE and give the latest version).

code: namespace Audio { [FCodecPtr](API\Runtime\AudioExtensions\FCodecPtr) Audio::FindCodecByName ( [FName](API\Runtime\Core\UObject\FName) InName, int32 InVersion ) const }


code: namespace Audio { [FCodecPtr](API\Runtime\AudioExtensions\FCodecPtr) Audio::FindCodecByParsingInput ( IDecoderInput * InObject ) const }


description: Find default codec for a platform. (none uses host platform).

code: namespace Audio { [FCodecPtr](API\Runtime\AudioExtensions\FCodecPtr) Audio::FindDefaultCodec ( [FName](API\Runtime\Core\UObject\FName) InPlatformName ) const }


code: namespace Audio { bool Audio::FindSection ( FEncodedSectionBase & OutSection ) }


code: namespace Audio { Audio::FRawSection ( [FFcc](API\Runtime\AudioExtensions\Audio__FFcc) InName, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > InBuffer ) }


code: namespace Audio { Audio::FSampleSection() }


description: Given input and settings determine DDC key.

code: namespace Audio { [FString](API\Runtime\Core\Containers\FString) Audio::GenerateDDCKey ( [FSourcePtr](API\Runtime\AudioExtensions\FSourcePtr) Src, [USettingsPtr](API\Runtime\AudioExtensions\USettingsPtr) SettingsObject ) const }


description: Abstract Singleton.

code: namespace Audio { static ICodecRegistry & Audio::Get() }


description: TODO: Move this somewhere central.

code: namespace Audio { template<typename From, typename To> static constexpr float Audio::GetConvertScalar() }


code: namespace Audio { const [FCodecDetails](API\Runtime\AudioExtensions\Audio__FCodecDetails) & Audio::GetDetails() const }


code: namespace Audio { FRequirements Audio::GetRequirements ( const FDecodedFormatInfo & InFormat ) const }


code: namespace Audio { friend uint32 Audio::GetTypeHash ( [FFcc](API\Runtime\AudioExtensions\Audio__FFcc) InVal ) }


code: namespace Audio { bool Audio::HasError() const }


code: namespace Audio { bool Audio::HasFeature ( EFeatureBitField InBit ) const }


code: namespace Audio { bool Audio::IsEndOfStream() const }


code: namespace Audio { constexpr bool Audio::IsNone() const }


code: namespace Audio { static bool Audio::IsValidHeader ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > InBytes ) }


code: namespace Audio { static const uint32 Audio::kSectionVer = 2; }


code: namespace Audio { [FName](API\Runtime\Core\UObject\FName) Audio::GetName() const }


code: namespace Audio { bool Audio::MakeTocNested ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, uint32 HeaderStart, FNestedSection & Header ) }


code: namespace Audio { constexpr bool Audio::operator== ( const [FFcc](API\Runtime\AudioExtensions\Audio__FFcc) & InRhs ) const }


code: namespace Audio { bool Audio::operator== ( const FFormatDescriptorSection & Rhs ) const }


code: namespace Audio { bool Audio::operator== ( const [FCodecDetails](API\Runtime\AudioExtensions\Audio__FCodecDetails) & Rhs ) const }


code: namespace Audio { friend const [FFcc](API\Runtime\AudioExtensions\Audio__FFcc) & Audio::operator<< ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [FFcc](API\Runtime\AudioExtensions\Audio__FFcc) & InFcc ) }


code: namespace Audio { bool Audio::ParseSections ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar ) }


code: namespace Audio { [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Audio::PeekNextPacket ( int32 InMaxPacketLength ) const }


code: namespace Audio { int32 Audio::PopAudio ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< int16 > InExternalBuffer, FPushedAudioDetails & OutDetails ) }


code: namespace Audio { int32 Audio::PopAudio ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< float > OutExternalBuffer, FPushedAudioDetails & OutDetails ) }


code: namespace Audio { int32 Audio::PopAudio ( [TArray](API\Runtime\Core\Containers\TArray)< float > & InExternalBuffer, FPushedAudioDetails & OutDetails ) }


description: Convenience convertTArray->TArrayView.

code: namespace Audio { int32 Audio::PopAudio ( [TArray](API\Runtime\Core\Containers\TArray)< int16 > & InExternalBuffer, FPushedAudioDetails & OutDetails ) }


description: This a bit naive, but ok for proof of concept.

code: namespace Audio { template<typename T> int32 Audio::PopAudioInternal ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< T > InExternalBuffer ) }


code: namespace Audio { [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Audio::PopNextPacket ( int32 InPacketSize ) }


code: namespace Audio { int32 Audio::PushAudio ( const FPushedAudioDetails & InDetails, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const int16 > In16BitInterleave ) }


code: namespace Audio { int32 Audio::PushAudio ( const FPushedAudioDetails & InDetails, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > InFloat32Interleave ) }


code: namespace Audio { template<typename T> int32 Audio::PushAudioInternal ( const FPushedAudioDetails & InDetails, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const T > InAudio ) }


description: Register each codec.

code: namespace Audio { bool Audio::RegisterCodec ( [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< ICodec > && ) }


code: namespace Audio { bool Audio::SeekToSamplesStart ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar ) }


code: namespace Audio { virtual bool Audio::SeekToTime ( const float InSeconds ) }


code: namespace Audio { void Audio::Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar ) }


code: namespace Audio { void Audio::SetArchive ( [FArchive](API\Runtime\Core\Serialization\FArchive) * InArchive, uint32 InOffsetInStream ) }


code: namespace Audio { void Audio::SetArrayView ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< TSampleType > InBuffer ) }


code: namespace Audio { void Audio::SetArrayViewBytes ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > InBytes, uint32 InOffsetInStream ) }


code: namespace Audio { void Audio::SetArrayViewBytes ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< uint8 > InBytes ) }


code: namespace Audio { Audio::TCircularOutputBuffer ( const FRequirements & InReqs ) }


code: namespace Audio { Audio::TDecoderOutputArrayView ( const FRequirements & InReqs ) }


code: namespace Audio { template<typename T> Audio::TDecoderOutputOwnBuffer ( const IDecoderOutput::FRequirements & Requirements ) }


description: We need this for back compatibility.

code: namespace Audio { int64 Audio::Tell() const }


code: namespace Audio { bool Audio::UnregisterCodec ( [FCodecPtr](API\Runtime\AudioExtensions\FCodecPtr) ) }


code: namespace Audio { [FString](API\Runtime\Core\Containers\FString) Audio::ToString() const }


code: namespace Audio { virtual Audio::~FEncodedSectionBase() }


code: namespace Audio { virtual Audio::~ICodecRegistry() }


code: namespace Audio { virtual Audio::~IDecoder() }


code: namespace Audio { virtual Audio::~IDecoderInput() }


code: namespace Audio { virtual Audio::~IDecoderOutput() }


code: namespace Audio { virtual Audio::~IEncoderInput() }


code: namespace Audio { virtual Audio::~IEncoderOutput() }


className: DeviceID

code: typedef uint32 DeviceID


description: Static function to avoid int32 constructor collision.

code: static [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) CreateDefaultArray ( [FName](API\Runtime\Core\UObject\FName) InName, int32 InNum )


description: Common find & add algorithm for default/legacy parameter system.

code: static [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) * FindOrAddParam ( [TArray](API\Runtime\Core\Containers\TArray)< [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) > & OutParams, [FName](API\Runtime\Core\UObject\FName) InParamName )


description: Common find algorithm for default/legacy parameter system.

code: static const [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) * FindParam ( const [TArray](API\Runtime\Core\Containers\TArray)< [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) > & InParams, [FName](API\Runtime\Core\UObject\FName) InParamName )


description: Moves InParams to OutParams that are not already included. For backward compatibility (i.e. SoundCues), if a param is already in OutParams, attempts to merge param values together, but assigns the param the incoming param's type. Currently existing OutParam values left if new value of the same type is provided by InParam.

code: static void Merge ( [TArray](API\Runtime\Core\Containers\TArray)< [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) > && InParams, [TArray](API\Runtime\Core\Containers\TArray)< [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) > & OutParams )


description: Sets values specified by type field of the given parameter on this parameter. If the provided parameter is set to type 'None', takes all values of the given parameter. bInTakeName = Take the name of the provided parameter. bInTakeType = Take the type of the provided parameter. bInMergeArrayTypes - Appends array(s) for specified type if true, else swaps the local value with that of the provided parameter if false.

code: void Merge ( const [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) & InParameter, bool bInTakeName, bool bInTakeType, bool bInMergeArrayTypes )


code: [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) & operator= ( const [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) & InParameter )


code: [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) & operator= ( [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) && InParameter )


code: FAudioParameter ( [FName](API\Runtime\Core\UObject\FName) InName, const [TArray](API\Runtime\Core\Containers\TArray)< float > & InValue )


code: FAudioParameter ( [FName](API\Runtime\Core\UObject\FName) InName, [TArray](API\Runtime\Core\Containers\TArray)< float > && InValue )


code: FAudioParameter ( [FName](API\Runtime\Core\UObject\FName) InName, const [TArray](API\Runtime\Core\Containers\TArray)< bool > & InValue )


code: FAudioParameter ( [FName](API\Runtime\Core\UObject\FName) InName, [TArray](API\Runtime\Core\Containers\TArray)< int32 > && InValue )


code: FAudioParameter ( [FName](API\Runtime\Core\UObject\FName) InName, const [TArray](API\Runtime\Core\Containers\TArray)< int32 > & InValue )


code: FAudioParameter ( [FName](API\Runtime\Core\UObject\FName) InName, [TArray](API\Runtime\Core\Containers\TArray)< bool > && InValue )


code: FAudioParameter ( [FName](API\Runtime\Core\UObject\FName) InName, const [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > & InValue )


code: FAudioParameter ( [FName](API\Runtime\Core\UObject\FName) InName, [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > && InValue )


code: FAudioParameter ( [FName](API\Runtime\Core\UObject\FName) InName, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InValue )


code: FAudioParameter ( [FName](API\Runtime\Core\UObject\FName) InName, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > && InValue )


code: FAudioParameter ( [FName](API\Runtime\Core\UObject\FName) InName )


code: FAudioParameter ( [FName](API\Runtime\Core\UObject\FName) InName, EAudioParameterType Type )


code: FAudioParameter ( const [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) & InParameter )


code: FAudioParameter ( [FName](API\Runtime\Core\UObject\FName) InName, float InValue )


code: FAudioParameter ( [FName](API\Runtime\Core\UObject\FName) InName, bool InValue )


code: FAudioParameter ( [FName](API\Runtime\Core\UObject\FName) InName, int32 InValue )


code: FAudioParameter ( [FName](API\Runtime\Core\UObject\FName) InName, [UObject](API\Runtime\CoreUObject\UObject\UObject) * InValue )


code: FAudioParameter ( [FName](API\Runtime\Core\UObject\FName) InName, const [FString](API\Runtime\Core\Containers\FString) & InValue )


className: FAudioParameter

code: struct FAudioParameter

ArrayBoolParam

type: TArray< bool >

description: Boolean value of parameter.

ArrayFloatParam

type: TArray< float >

description: Array Float value of parameter.

ArrayIntParam

type: TArray< int32 >

description: Integer value of parameter.

ArrayObjectParam

type: TArray<TObject...

description: Object value of parameter.

ArrayStringParam

type: TArray<FString...

description: String value of parameter.

BoolParam

description: Boolean value of parameter.

FloatParam

description: Float value of parameter.

IntParam

description: Integer value of parameter. If set to 'Default Construct', value is number of array items to construct.

ObjectParam

type: TObjectPtr<UOb...

description: Object value of parameter.

ObjectProxies

type: TArray<TShared...

description: Object proxies to be generated when parameter is passed to the AudioThread to represent ObjectParam/ArrayObjectParam safely.

ParamName

type: FName

description: Name of the parameter.

ParamType

type: EAudioParameter...

StringParam

description: String value of parameter.

TypeName

description: Optional TypeName used to describe what constructed type this parameter should be initializing.


code: FAudioPluginInitializationParams()


className: FAudioPluginSourceOutputData

code: struct FAudioPluginSourceOutputData

AudioBuffer

description: The audio output buffer.


className: FChannelPositionInfo

code: struct FChannelPositionInfo

Azimuth

description: Horizontal angle of the position of this channel, in radians.

Channel

type: EAudioMixerChan...

Elevation

description: Vertical angle of the position of this channel, in radians.

Radius

description: Distance from the listener.


className: FCodecPtr

code: typedef ICodec * FCodecPtr


code: FAudioParameter ( [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) && InParameter )


className: FDecodeReturn

code: typedef EDecodeResult FDecodeReturn


className: FDecoderInputPtr

code: typedef IDecoderInput * FDecoderInputPtr


className: FDecoderOutputPtr

code: typedef [IDecoderOutput](API\Plugins\ElectraBase\IDecoderOutput) * FDecoderOutputPtr


className: FAudioPluginInitializationParams

code: struct FAudioPluginInitializationParams

AudioDevicePtr

type: FAudioDevice&#...

description: Pointer to audio device owning this audio plugin.

BufferLength

description: Buffer length used for each callback.

NumOutputChannels

description: Number of output channels.

NumSources

description: Maximum number of sources that can play simultaneously.

SampleRate

description: Sample rate.


className: FDecoderPtr

description: Factory for decoders.

code: typedef [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< IDecoder > FDecoderPtr


className: FDestPtr

code: typedef IEncoderOutput * FDestPtr


className: FAudioPluginSourceInputData

code: struct FAudioPluginSourceInputData

AudioBuffer

description: The audio input buffer.

AudioComponentId

description: The ID of the audio component associated with the wave instance.

ListenerOrientation

type: FQuat

description: The listener orientation.

NumChannels

description: Number of channels of the source audio buffer.

SourceId

description: The index of the source voice. Guaranteed to be between 0 and the max number of sources rendered.

SpatializationParams

type: constFSpatiali...

description: Spatialization parameters.


className: FDummyEndpointSettingsProxy

description: A blank class for when unimplemented endpoint types are returned.

code: class FDummyEndpointSettingsProxy : public [IAudioEndpointSettingsProxy](API\Runtime\AudioExtensions\IAudioEndpointSettingsProxy)


className: FEncoderPtr

description: Factory for encoders.

code: typedef [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< IEncoder > FEncoderPtr


className: FModulationMixFunction

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(float &, float)> FModulationMixFunction


className: FModulationNormalizedConversionFunction

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(float &)> FModulationNormalizedConversionFunction


code: static const [FModulationMixFunction](API\Runtime\AudioExtensions\FModulationMixFunction) & GetDefaultMixFunction()


code: static const [FModulationNormalizedConversionFunction](API\Runtime\AudioExtensions\FModulationNormalizedConversionF-) & GetDefaultNormalizedConversionFunction()


code: static const [FModulationUnitConversionFunction](API\Runtime\AudioExtensions\FModulationUnitConversionFunctio-) & GetDefaultUnitConversionFunction()


code: [FModulationParameter](API\Runtime\AudioExtensions\FModulationParameter) & operator= ( [FModulationParameter](API\Runtime\AudioExtensions\FModulationParameter) && InParam )


code: [FModulationParameter](API\Runtime\AudioExtensions\FModulationParameter) & operator= ( const [FModulationParameter](API\Runtime\AudioExtensions\FModulationParameter) & InParam )


code: FModulationParameter ( const [FModulationParameter](API\Runtime\AudioExtensions\FModulationParameter) & InParam )


code: FModulationParameter ( [FModulationParameter](API\Runtime\AudioExtensions\FModulationParameter) && InParam )


className: FModulationParameter

code: struct FModulationParameter

bRequiresConversion

type: bool

description: Whether or not unit conversion is required.

DefaultValue

type: float

description: Default value of parameter in unit space.

MaxValue

description: Default minimum value of parameter in unit space.

MixFunction

type: FModulationMixF...

description: Function used to mix normalized values together.

NormalizedFunction

type: FModulationNorm...

description: Function used to convert value buffer from unit space to normalized, unitless [0.0f, 1.0f] space.

UnitDisplayName

type: FText

UnitFunction

type: FModulationUnit...

description: Function used to convert value buffer from normalized, unitless space [0.0f, 1.0f] to unit space.


className: FModulationUnitConversionFunction

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(float &)> FModulationUnitConversionFunction


code: const [FModulationParameter](API\Runtime\AudioExtensions\FModulationParameter) & GetParameter() const


code: bool GetValueThreadSafe ( float & OutValue ) const


code: bool GetValue ( float & OutValue ) const


code: [FModulatorHandle](API\Runtime\AudioExtensions\FModulatorHandle) & operator= ( const [FModulatorHandle](API\Runtime\AudioExtensions\FModulatorHandle) & InOther )


code: [FModulatorHandle](API\Runtime\AudioExtensions\FModulatorHandle) & operator= ( [FModulatorHandle](API\Runtime\AudioExtensions\FModulatorHandle) && InOther )


code: bool operator== ( const [FModulatorHandle](API\Runtime\AudioExtensions\FModulatorHandle) & Other ) const


code: bool operator!= ( const [FModulatorHandle](API\Runtime\AudioExtensions\FModulatorHandle) & Other ) const


code: FModulatorHandle ( [Audio::FModulationParameter](API\Runtime\AudioExtensions\FModulationParameter) && InParameter )


code: FModulatorHandle ( const [FModulatorHandle](API\Runtime\AudioExtensions\FModulatorHandle) & InOther )


code: FModulatorHandle ( [FModulatorHandle](API\Runtime\AudioExtensions\FModulatorHandle) && InOther )


code: FModulatorHandle ( [IAudioModulationManager](API\Runtime\AudioExtensions\IAudioModulationManager) & InModulation, const [Audio::IModulatorSettings](API\Runtime\AudioExtensions\IModulatorSettings) & InModulatorSettings, [Audio::FModulationParameter](API\Runtime\AudioExtensions\FModulationParameter) && InParameter )


className: FModulatorHandleId

code: typedef uint32 FModulatorHandleId


className: FModulatorId

code: typedef uint32 FModulatorId


className: FModulatorTypeId

code: typedef uint32 FModulatorTypeId


className: FClassOptions

description: Options used to restrict a correspondingUClassthat interface may be applied to.

code: struct FClassOptions

bIsDefault

type: const bool

description: Whether or not the interface should be immediately added to the given class type on creation.

bIsModifiable

description: Whether or not the class may be directly modifiable on an asset implementing the given interface (added, removed, etc.)

ClassPath

type: constFTopLevel...

description: Path to restrictedUClass.


className: FEnvironmentVariable

description: Read-only variable that cannot be modified by the sound instance, and maybe shared amongst instances.

code: struct FEnvironmentVariable

DataType

type: constFName

description: FNamedescribing the type of the data.

Description

type: constFText

description: Description to be displayed in editor or tools.

DisplayName

description: Name to be displayed in editor or tools.

ParamName

description: Name of variable used as a runtime identifier.

ParamType

type: const EAudioPar...

description: Type of variable used as a runtime identifier if unspecified by the DataType.


code: [TArray](API\Runtime\Core\Containers\TArray)< const [UClass](API\Runtime\CoreUObject\UObject\UClass) * > FindSupportedUClasses() const


className: FInput

code: struct FInput

DataType

description: FNamedescribing the type of the data.

InitValue

type: constFAudioPar...

description: Initial value of the given parameter.

RequiredText

description: Text to display in the editor or tools if the consuming system of the given input parameter is not implemented (to avoid passing data using the parameter system when not operated on).

SortOrderIndex

type: const int32

description: Visual sort order of the given input with respect to other inputs either within the given interface or listed among other unrelated inputs.


className: FOutput

code: struct FOutput

DataType

description: FNamedescribing the type of the data.

ParamName

description: Name of output parameter used as a runtime identifier.

ParamType

description: Type of output parameter used as a runtime identifier if unspecified by the DataType.

description: Visual sort order of the given input with respect to other outputs either within the given interface or listed among other unrelated outputs.


className: FVersion

description: Version of interface (higher numbers are more recent)

code: struct FVersion


description: Returns read-only array of environment variables.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FEnvironmentVariable](API\Runtime\AudioExtensions\FParameterInterface\FEnvironmentVariable) > & GetEnvironment() const


className: FModulatorHandle

description: Handle to a modulator which interacts with the modulation API to manage lifetime of modulator proxy objects internal to modulation plugin implementation.

code: struct FModulatorHandle


description: Returns read-only array of inputs.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FInput](API\Runtime\AudioExtensions\FParameterInterface\FInput) > & GetInputs() const


description: Returns read-only array of outputs.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FOutput](API\Runtime\AudioExtensions\FParameterInterface\FOutput) > & GetOutputs() const


description: Deprecated* UseFParameterInterface::FindSupportedUClassesinstead

code: const [UClass](API\Runtime\CoreUObject\UObject\UClass) & GetType() const


description: If specified, options used to restrict a correspondingUClassthat interface may be applied to. If unspecified, interface is assumed to be applicable to any arbitraryUClass.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FClassOptions](API\Runtime\AudioExtensions\FParameterInterface\FClassOptions) > & GetUClassOptions() const


code: const [FVersion](API\Runtime\AudioExtensions\FParameterInterface\FVersion) & GetVersion() const


description: Constructor used for parameter interface not limited to any particularUClasstypes.

code: FParameterInterface ( [FName](API\Runtime\Core\UObject\FName) InName, const [FVersion](API\Runtime\AudioExtensions\FParameterInterface\FVersion) & InVersion )


description: Deprecated* Set UClassOptions to determine what options apply for a givenUClass(if any).

code: FParameterInterface ( [FName](API\Runtime\Core\UObject\FName) InName, const [FVersion](API\Runtime\AudioExtensions\FParameterInterface\FVersion) & InVersion, const [UClass](API\Runtime\CoreUObject\UObject\UClass) & InClass )


className: FParameterInterface

description: Interface for parameterizing data provided to or coming from an executable audio unit (ex. Sound like a MetaSoundSource, arbitrary DSP graph like a MetaSoundPatch, etc.). Can be used generically for processing either logically at a control or Game Thread tick rate (ex. SoundCues), or by an underlying DSP operation via the Audio Render Thread or delegated task (ex. MetaSounds, custom SoundGenerator, etc.)

code: struct FParameterInterface

Environment

type: TArray<FEnviro...

Inputs

type: TArray<FInput...

Outputs

type: TArray<FOutput...

UClassOptions

type: TArray<FClassO...


description: Combines names using the namespace delimiter.

code: static [FName](API\Runtime\Core\UObject\FName) CombineNames ( [FName](API\Runtime\Core\UObject\FName) InLeft, [FName](API\Runtime\Core\UObject\FName) InRight )


className: NamespaceDelimiter

code: static const [FString](API\Runtime\Core\Containers\FString) NamespaceDelimiter = TEXT( "." );


description: Splits name into namespace & parameter name.

code: static void SplitName ( [FName](API\Runtime\Core\UObject\FName) InFullName, [FName](API\Runtime\Core\UObject\FName) & OutNamespace, [FName](API\Runtime\Core\UObject\FName) & OutParameterName )