############### Builtin Plugins ############### PixStor Search is packages with various plugins. These are divided into two categories, 'core', and 'lab'. .. note:: Builtin plugins are not enabled by default. To see which plugins are currently enabled, use the command ``searchctl plugins list`` Additional plugins are available in the PixStor `official GitHub repo `_ Users can also :doc:`develop their own ` plugins. For a listing of the full schema of builtin plugins, see :doc:`schema` Core Plugins ============ Core plugins are those which have been extensively tested and are believed to be stable. analytics::AnalyticsPlugin -------------------------- Dynamic plugin which provides a link to view a directory in the PixStor Analytics UI **namespace:** pixstor **handles:** directories camera::CameraPlugin -------------------- Metadata related to the camera an image was captured with. **namespace:** camera **handles:** jpeg images common_attributes::CommonAttributesPlugin ----------------------------------------- Attributes that can apply to multiple file types. **namespace:** common **handles:** any files desktopconnector::DesktopConnectorDirPlugin ------------------------------------------- Dynamic plugin which adds "Open containing directory" entries to the Search UI context menu **namespace:** desktop_connector **handles:** directories desktopconnector::DesktopConnectorFilePlugin -------------------------------------------- Dynamic plugin which adds "Open File" entries to the Search UI context menu. **namespace:** desktop_connector **handles**: any files dpx::DpxPlugin -------------- Plugin to extract DPX specific metadata. **namespace:** dpx **handles:** dpx images dynamic_file_status::DynamicMigrationStatus ------------------------------------------- Dynamic plugin which indicates whether a file is currently offline **namespace:** gpfs **handles:** any file or directory gpfs::GPFSPolicyPlugin ---------------------- GPFS-related attributes returned by a policy run. **namespace:** gpfs **handles:** any file or directory hsm_status::HSMStatusPlugin --------------------------- Determine HSM status of files - resident, premigrated, migrated Note: this plugin only records the HSM status at the time of ingest. See the ``dynamic_file_status`` plugin for whether the file is currently offline. **namespace:** hsm **handles:** any file or directory image::ImagePlugin ------------------ Extract image metadata from some image file types **namespace:** image **handles:** psd, psb, exr, jpeg, dpx imagepreview::CoreImageThumbnail -------------------------------- General purpose thumbnail and preview generator for image files. **namespace:** image **handles:** bmp, dpx, gif, jpeg, pcx, png, rgb, svg, tga location::LocationPlugin ------------------------ Extract data about where a photo was taken. **namespace:** location **handles:** jpeg images ngenea::NgeneaPlugin -------------------- Ngenea-related extended attributes. **namespace:** ngenea **handles:** any file or directory photoshop::PhotoshopMetaDataPlugin ---------------------------------- Extract Basic Metadata from PSD Files. **namespace:** image **handles:** psd, psb prunedirectory::PruneDirectoryPlugin ------------------------------------ Plugin to remove entries which no longer exist from a directory. **namespace:** directory **handles:** directories psd_exr_preview::PSDEXRthumbnail -------------------------------- Plugin to make proxies of PSD and EXR files. **namespace:** image **handles:** psd, psb, exr sha512hash::Sha512HashOfflinePlugin ----------------------------------- Plugin that gets the sha512 hash of an offline file. This is taken from the ngenea ``dmapi.APXSHA512`` extended attribute (if present) **namespace:** core **handles:** any file sha512hash::Sha512HashPlugin ---------------------------- Plugin that calculates the sha512 hash of a file. **namespace:** core **handles:** any file stat::StatPlugin ---------------- Basic plugin which returns metadata from 'os.stat' **namespace:** core **handles:** any file or directory tags::TagSchemaPlugin ---------------- Plugin which provides a schema for tags. Tags are user-defined strings, and can be added to any file or directory via the REST API. The plugin extracts no metadata during ingest. **namespace:** search **handles:** any file or directory video::VideoImagePlugin ----------------------- Extract 'image' metadata for videos - e.g. width, height **namespace:** image **handles:** mov video::VideoPlugin ------------------ Extract video metadata for video files. **namespace:** video **handles:** mov videopreview::VideoPreview -------------------------- Generate a preview video for video files. **namespace:** video **handles:** avi, flv, m4v, mkv, mov, mp4, mpeg, ogg, webm, wmv videopreview::VideoThumbnail ---------------------------- Generate static and animated thumbnails for video files. **namespace:** video **handles:** avi, flv, m4v, mkv, mov, mp4, mpeg, ogg, webm, wmv Lab Plugins =========== Lab plugins are new plugins which have gone through limited testing. They are expected to be stable, but may break unexpectedly when encountering novel, real-world data. When a lab plugin has proven to be stable, it will be promoted to core. audio::AudioPlugin ------------------ Plugin to extract audio metadata. **namespace:** audio **handles:** mp3, wav, aac, aiff, flac, au, m4a, m4b, opus, ra, rm, wma audio_proxy::AudioProxy ----------------------- Generate a waveform video for the audio files **namespace:** video **handles:** mp3, wav, aac, aiff, flac, au, m4a, m4b, opus, ra, rm, wma core_metadata::CoreMetadataPlugin --------------------------------- Extract Endian type metadata of the files. **namespace:** core **handles:** dpx curate::CuratePlugin -------------------- Plugin to remove entries which have been duplicated. This plugin should only be enabled as needed, for one-off runs. **namespace:** maintenance **handles:** all files and directories mxf_preview::MXFVideoPreview ---------------------------- Generate preview for MXF videos. **namespace:** video **handles:** mxf mxf_preview::MXFVideoThumbnail ------------------------------ Generate thumbnail for MXF videos. **namespace:** video **handles:** mxf navigation::NavigationPlugin ---------------------------- Dynamic plugin which provides 'Look Above', 'Look Into', 'Look Around' links in the Search UI **namespace:** navigation **handles:** any file or directory oiiopreview::OiioThumbnail -------------------------- Plugin to make proxies for specialist image files. This plugin typically performs better than ``psd_exr_preview::PSDEXRthumbnail`` for psd and exr files. **namespace:** image **handles:** dpx, exr, psd, tif, tiff pdf::PDFDocumentMetaDataPlugin ------------------------------ PDF Document namespaced metadata. **namespace:** document **handles:** pdf pdf::PDFMetaDataPlugin ---------------------- PDF specific metadata. **namespace:** pdf **handles:** pdf pdf_preview::PDFThumbnail ------------------------- Plugin to make proxies for PDF files i.e. those which have multiple 'layers'. Uses the Poppler pdftoppm XPDFv3 based commandline tool **namespace**: image **handles:** pdf, ai show_duplicates::DuplicatesPlugin --------------------------------- Dynamic plugin to add link for finding duplicates of a file. **namespace:** tools **handles:** any file timeline::TimeLinePlugin ------------------------ Adobe Premier timeline plugin. **namespace:** timeline **handles:** prproj vantage::VantageVideoProxy -------------------------- Create proxies of video files using Telestream Vantage. **namespace:** video **handles:** ari, asf, avc, avi, dv, gxf, h264, hev, hm10, lxf, m1v, m2v, m4v, mkv, mov, mp2v, mp4, mpe, mpeg, mpeg1, mpeg2, mpg, mpg2, mpv, mpv2, mxf, webm, wmv xsym::XSymPlugin ---------------- Extract the link target from a XSym symlink. **namespace:** xsym **handles:** xsym