Asset Inventory API Reference

This reference is generated from the shipped Asset Inventory assemblies and their XML documentation.

AssetInventory

AddFileTagStep: Assigns a configured tag to every indexed file in the current Automator action context.
AddPackageTagStep: Assigns a configured tag to every package in the current Automator action context.
AI: Process-wide Asset Inventory facade for initialization, configuration persistence, dependency calculation, refresh notifications, and supported…
AI.AssetGroup: API type
AI.InitializationState: API type
AnimData: Metadata for standalone .anim (AnimationClip) files. Similar to FBXData but for animation-only assets.
ArchiveImporter: Indexes supported archive files and nested archives as Asset Inventory package records.
Asset: Persistent package or source record containing identity, location, version, compatibility, licensing, and indexing state.
Asset.OfficialStateType: API type
Asset.Source: API type
Asset.State: API type
Asset.Strategy: API type
Asset.SubState: API type
AssetDownloader.State: API type
AssetFile: Indexed file record with package ownership, project and source paths, media metadata, and preview state.
AssetFile.PreviewOptions: API type
AssetHeader: Parsed Unity package header metadata used to associate imported archives with Asset Store identity and publisher/category records.
AssetHeaderIdLabel: Identifier and display label pair used for publisher and category entries in parsed Unity package headers.
AssetHeaderIdType: Identifier and relationship type pair used for links in parsed Unity package headers.
AssetImportCollisionMode: API type
AssetImporter: Coordinates package download, extraction, indexing, persistence, media analysis, and import-state transitions.
AssetInfo: Combines a catalog file record with its owning package metadata, indexing state, tags, dependencies, and preview data for search results and package…
AssetInfo.DependencyStateOptions: API type
AssetInfo.ImportStateOptions: API type
AssetInfoAudioSource: Bridges AssetInventory’s AssetInfo to AudioTool’s IAudioSource interface. Enables seamless integration between AssetInventory and the standalone…
AssetInventoryActionContext: AssetInventory-specific action context that extends the base context with loaded assets and files for action steps to use.
AssetInventoryActionRunnerConfig: Configuration for ActionRunner that uses AssetInventory’s logging settings.
AssetManagerImporter: Importer for discovering, indexing, and persisting asset manager content in the Asset Inventory catalog.
AssetMedia: Persistent media attachment for a package, including its remote URL, cached path, preview identity, dimensions, and duration.
AssetOrigin: Serializable Asset Store origin metadata used to stamp imported files with their product, package, version, and upload identity.
Assets: Provides package-level catalog operations, including loading package records, extracting archives into the managed cache, and importing selected…
AssetSearch: Searches indexed files using catalog metadata, tags, dimensions, media properties, and caller-provided paging and sorting options.
AssetSearch.Diagnostics: Controls opt-in Asset Search timing and SQL diagnostics without changing query results.
AssetSearch.InMemoryMode: API type
AssetSearch.Options: Controls file search text, package and media filters, dimensions, tags, metadata, sorting, paging, and in-memory refinement.
AssetSearch.QueryResult: Contains the parameterized SQL variants, ordered arguments, and validation error produced for an asset search.
AssetSearch.Result: Contains the current page of matching indexed files, total and pre-filter counts, execution mode, and any nonfatal search error.
AssetVersion: Asset Store version metadata containing the release name, revision, upload identity, publishing date, size, and supported Unity versions.
Author: Unity registry package author metadata containing the publisher name, email address, and website.
BackupInfo: Identifies one locally available package backup by its storage location and parsed semantic version.
Category: Asset Store category identity and display label parsed from a Unity package header.
ChangedTextMeshProMaterialsValidator: Finds TextMeshPro SDF materials that were changed to an SRP Lit shader and can safely restore the standard distance-field shader.
ChinaBasedAssets: Provides lookup functionality for assets that have been migrated to the China-only Asset Store. These assets are still available for download but…
CodeChunk.ChunkStatus: API type
CodeDocument.DocumentStatus: API type
CodeDocument.SourceKindType: API type
CodeIndexConsistencyValidator: Finds orphaned chunks in the optional code-search index without changing the main catalog database.
CodeSearch: Search facade for querying code records with structured options and result metadata.
CodeSearch.CodeSearchFileResult: Groups the ranked code matches for one indexed source file with its package, language, path, and aggregate relevance score.
CodeSearch.CodeSearchMatch: One ranked code-search match with its source range, symbol, snippet, content, and relevance score.
CodeSearch.Options: Controls the code-search phrase, result page, maximum files, and maximum matches retained per file.
CodeSearch.Result: Reports code-index availability, total matches and documents, ranked file results, and any nonfatal search error.
CopyCoordinator: Coordinates asset copy operations across parallel tasks to prevent duplicate work, race conditions, and excessive AssetDatabase.Refresh() calls…
CopyCoordinator.FileCategory: Categories for file classification based on metadata availability.
CorruptDatabaseValidator: Runs the database engine’s integrity check and reports catalog corruption.
CSVExport: Exports selected Asset Inventory fields and rows to a configurable comma-separated file.
CSVExportSettings: Serializable settings controlling csv export behavior in Asset Inventory.
CSVExportStep: Writes the packages in the current Automator action context to a CSV file using the saved CSV export settings.
CustomAction: Persistent named Automator workflow with its ordered Asset Inventory action steps and last execution state.
CustomAction.Mode: API type
CustomActionStep: Persistent action-step entry that links an Automator step definition to its saved parameter values and execution order.
CustomMaterialPreviewGenerator: Custom preview generator for materials. Renders materials on primitive meshes (Sphere, Cube, Plane) with configurable lighting.
CustomMaterialPreviewGenerator.PreviewMeshType: Mesh shape options for material preview rendering.
CustomPrefabPreviewGenerator.PrefabType: API type
CustomPreviewBackgroundType: API type
DeletedAssetFilesValidator: Finds indexed media-folder files whose source files no longer exist.
Dependency: Reference to a dependent indexed file by catalog identity, name, and source location.
DependencyResultCache: Cache for dependency calculation results to avoid redundant traversal of the same dependency trees. When File A and File B both depend on Material…
DependencyResultCache.CachedDependencyResult: Result of a cached dependency calculation for a single file
DependencyResultCache.CacheStatistics: Counts entries held by a dependency result cache so callers can monitor reuse and memory pressure.
DevPackageImporter: Importer for discovering, indexing, and persisting dev package content in the Asset Inventory catalog.
DuplicateMediaIndexValidator: Finds media records that point to the same source location.
DuplicatePackageEntriesValidator: Finds Asset Store and custom package records that point to the same cached package file.
EmbedOriginalPreviewValidator: Finds previews missing from the cache after switching from direct originals to fully cached preview storage.
ExportTypeInfo: Class to hold export type information for the wizard UI
FBXAnimationPreviewMode: API type
FolderImporter: Indexes configured filesystem folders and their contents as Asset Inventory sources.
FolderSpec: Describes one configured source folder, its scan rules, and how discovered content is classified and indexed.
FTPActionStep: Base class for FTP/SFTP action steps with common functionality.
FTPConnection: Serializable FTP or SFTP endpoint and credential configuration used by remote automation steps.
FTPConnection.FTPProtocol: API type
FTPDeleteStep: Automator action step that recursively deletes a configured remote directory over FTP or SFTP while preserving explicitly excluded relative paths.
FTPUploadStep: Uploads a local directory tree to a configured FTP or SFTP destination.
HiddenFilePreviewsValidator: Finds cached previews that are no longer needed because their indexed files are hidden.
HTMLExportStep: Exports the catalog to a target folder using a selected HTML template.
IncorrectPreviewsValidator: Finds cached previews that contain error shaders or Unity’s generic fallback icons.
InstallPackagesByTagStep: Imports every catalog package carrying a configured tag into the open Unity project.
InstallRegistryPackageByNameStep: Adds a named Unity registry package and optional version to the open project’s manifest.
InstallRegistryPackageByPathStep: Adds a Unity registry package from a local path, Git URL, tarball, or package URL to the open project.
InventoryStats: Snapshot of catalog totals, storage use, source distribution, and optional semantic and code index statistics.
InventoryStats.CodeIndexStatistics: Health, size, document, chunk, and maintenance statistics for the optional code-search index.
InventoryStats.SemanticIndexStatistics: Health, provider, model, coverage, cache, and maintenance statistics for the optional semantic-search index.
InventoryStats.SourceBreakdown: Catalog package counts grouped by Asset Store, custom, directory, registry, archive, and Asset Manager source.
LoadAssetsStep: Loads packages from a package-type filter or saved search into the Automator action context.
LoadAssetsStep.AssetOperation: API type
LoadFilesStep: Loads indexed files from a saved file search into the Automator action context.
LoadFilesStep.FileOperation: API type
MaterializationMode: Determines the materialization strategy for preview generation.
MediaImporter: Importer for discovering, indexing, and persisting media content in the Asset Inventory catalog.
Metadata: Stateless API for metadata definitions, assignments, typed values, and package metadata lookup.
MetadataAssignment: Persistent link between a metadata definition and either a package or indexed file.
MetadataAssignment.Target: API type
MetadataDefinition: Defines a named custom metadata field, its value type, visibility, display order, and available list values.
MetadataDefinition.DataType: API type
MetadataInfo: Joined metadata assignment and definition data, including the typed value and its package or file target.
MissingAudioLengthValidator: Finds indexed audio files whose duration has not been determined.
MissingParentPackagesValidator: Finds package records whose referenced parent package no longer exists.
MissingPreviewFilesValidator: Finds indexed files that should have a preview but no preview file exists.
OrphanedAssetFilesValidator: Finds indexed file records whose owning package no longer exists.
OrphanedCacheFoldersValidator: Finds package cache folders that are no longer referenced by the catalog.
OrphanedDirectoryPackagesValidator: Finds directory-source packages that are no longer covered by a configured source folder.
OrphanedPackagesValidator: Finds custom package records whose source package file no longer exists.
OrphanedPreviewFilesValidator: Finds preview files that are no longer referenced by an indexed file.
OrphanedPreviewFoldersValidator: Finds preview cache folders that are no longer referenced by the catalog.
OrphanedTagAssignmentsValidator: Finds tag assignments whose target package no longer exists.
OutdatedPackagesValidator: Finds obsolete cached Asset Store package copies left behind after publisher metadata changed their storage path.
OutdatedSavedSearch: Search facade for querying outdated saved records with structured options and result metadata.
Package: Unity registry package metadata parsed from package.json, including versions, dependencies, samples, repository, author, and lifecycle flags.
PackageImporter: Importer for discovering, indexing, and persisting package content in the Asset Inventory catalog.
PackageOverrides: Per-package overrides for identity, display metadata, compatibility, location, indexing, and update behavior.
PackageSearch: Searches cataloged packages by source, maintenance state, render-pipeline compatibility, ownership metadata, tags, dates, price, and package size.
PackageSearch.MaintenanceOption: API type
PackageSearch.Options: Controls package search text, source and compatibility filters, lifecycle and project state, price and date ranges, tags, metadata, sorting, and…
PackageSearch.Result: Contains the current page of matching packages, the total match count, and any nonfatal query error.
PackageTileStatus: API type
Paths: Path-related operations including folder locations, relative paths, caching, and cache size calculations.
PipelineConverter: Handles conversion of materials from the Built-in Render Pipeline (BIRP) to the current Scriptable Render Pipeline (URP or HDRP). Two conversion…
PrefabPreviewUtilities.PrefabType: API type
PreviewCameraSetup: Centralized camera creation and positioning for all preview types. Consolidates camera logic from PreviewManager, CustomPreviewStage, and…
PreviewLightingSetup: Centralized lighting creation and positioning for all preview types. Consolidates lighting logic from PreviewManager, CustomPreviewStage, and…
PreviewRenderUtilities: Centralized render texture management and utilities for preview generation.
PreviewSceneContext: Context for preview scene setup that needs to be restored
PreviewTypeFlags: Flags to track which preview types need regeneration
ProjectAssetSearch: Searches assets already present in the open Unity project and returns their catalog relationships.
ProjectAssetSearch.Options: Controls project search text, asset type, extension handling, result limits, tags, metadata, and optional usage calculation.
ProjectAssetSearch.Result: Contains project asset records matching the supplied filters and the total number of matches.
ProjectDependencyAnalysis: Scans serialized project assets for GUID references and resolves the files that depend on a selected project asset.
Publisher: Asset Store publisher identity and display label parsed from a Unity package header.
ReassignedMediaIndexValidator: Finds duplicate unassigned media records after the same files become associated with a package.
RelativeLocation: Maps a logical storage key and machine identifier to a normalized filesystem location.
RemoveFileTagStep: Removes a configured tag from every indexed file in the current Automator action context.
RemovePackageTagStep: Removes a configured tag from every package in the current Automator action context.
Repository: Source-control repository metadata declared by a Unity registry package.
RunActionStep: Invokes another predefined or saved Automator action from the current workflow.
Sample: Importable sample definition declared by a Unity registry package, including its display name, description, and package-relative path.
SavedCodeSearch: Search facade for querying saved code records with structured options and result metadata.
SavedPackageSearch: Search facade for querying saved package records with structured options and result metadata.
SavedSearch: Search facade for querying saved records with structured options and result metadata.
SceneViewCameraRenderer: Utility for rendering GameObjects using a temporary scene and camera. This bypasses VFX Graph’s visibility limitations with custom cameras.
ScheduledPreviewRecreationValidator: Finds preview images currently queued for regeneration.
SearchVariable: Represents a variable that can be used in search queries. Variables allow parameterization of saved searches for reusability.
SearchVariableCollection: Collection of search variables with JSON serialization support. Used to persist variable definitions in saved searches.
SemanticIndexConsistencyValidator: Finds orphaned rows or cache data in the optional semantic-search index without changing the main catalog database.
SemanticItem.ItemStatus: API type
SemVer: Parsed semantic version with precedence comparison, prerelease support, and helpers for normalizing patch and minor components.
SubPackageRenderPipelineValidator: Finds nested packages whose render-pipeline compatibility conflicts with their package names.
SuspiciousBackupsValidator: Finds package backups whose version and release-date ordering suggest inconsistent publisher versioning.
Tag: Persistent hierarchical tag definition with its display name, parent relationship, and optional color.
TagActionStepBase: Base Automator step for assigning or removing a configured tag from the packages or files in the current action context.
TagAssignment: Persistent link between a tag and either a package or indexed file.
TagAssignment.Target: API type
Tagging: Stateless API for creating tags, assigning or removing package and file tags, and querying tag metadata.
TagInfo: Joined tag assignment and tag-definition data for a package or indexed file.
TagSlashHandling: API type
TemplateExport: Exports catalog data through a named text template and an explicit variable environment.
TemplateExportEnvironment: Named value map supplied to template exports for caller-defined placeholders.
TemplateExportSettings: Serializable settings controlling template export behavior in Asset Inventory.
TemplateInfo: Describes an export template’s identity, inheritance, required data, file operations, parameters, and discovered source paths.
TemplateVariables: Placeholder names available to package, file, and environment sections of an Asset Inventory export template.
TMPStep: Imports the selected TextMeshPro essential resources or examples into the open Unity project.
TreeElement: Stable identifier and hierarchy base shared by catalog records that can be presented in Asset Inventory trees.
UIStyles.TagStyle: API type
UnindexedSubPackagesValidator: Finds Unity packages and supported archives nested inside indexed packages but not yet indexed as child packages.
UninstallFeatureByNameStep: Removes a named Unity feature package and its unlocked dependencies from the open project.
UninstallRegistryPackageByNameStep: Removes a named direct Unity registry package dependency from the open project.
UnityPackageImporter: Importer for discovering, indexing, and persisting unity package content in the Asset Inventory catalog.
UpdateAction.Phase: API type
UpdateRegistryPackageByNameStep: Updates a named Unity registry package in the open project to the requested version.
UploadInfo: Asset Store upload metadata containing package version, archive keys, file count, download size, render pipelines, and dependencies.
UseOriginalPreviewValidator: Finds cached previews that can be replaced by smaller original media files to save disk space.
Validator: Base contract for inspecting catalog and filesystem consistency and optionally applying reported repairs.
Validator.State: API type
Validator.ValidatorSpeed: API type
Validator.ValidatorType: API type
Workspace: Named collection of saved package and file searches that can be restored together.
WorkspaceSearch: Search facade for querying workspace records with structured options and result metadata.
WrongDimensionPreviewFilesValidator: Finds preview images larger than the dimensions currently configured for the preview cache.