Plug-in provided SDK - Metadata tagset provider

The metadata-tagset provider is a Lua file that returns a tagset definition for filtering metadata displayed in the Library module's Metadata panel. Tagset defintions available to Lightroom are selected using the drop-down menu at the top left of the Metadata panel.

First supported in version 2.0 of the Lightroom SDK.

Summary

id
(string, required) This table member defines an identifier for this tagset that is unique within this plug-in.
items
(table, required) This table member defines an array of metadata fields that appear in this tagset, in order of appearance.
title
(string, required) This table member defines the localizable display name of the tagset, which appears in the popup menu for the Metadata panel.

Properties

id : (Read-Only)
(string, required) This table member defines an identifier for this tagset that is unique within this plug-in. The name must conform to the same naming conventions as Lua variables; that is, it must start with a letter, followed by letters or numbers. Case is significant.
items : (Read-Only)
(table, required) This table member defines an array of metadata fields that appear in this tagset, in order of appearance. Each entry in the items array identifies a field to be included in the Metadata menu. It can be a simple string specifying the field name, or an array that specifies the field name and additional information about that field.

If present, it should be a table containing the following elements:

  • (string) The first element in the array is the unique identifying name of the field, or one of the special values described below.
  • height_in_lines: (number) (optional) For text-entry fields, the number of lines of text for the field.
  • label: (string, optional) When the field name is the special value 'com.adobe.label', this is the localizable string to use as the section label.

The field names accepted within tagsets are as follows:

  • com.adobe.filename: The leaf name of the file (for example, "myFile.jpg").
  • com.adobe.originalFilename.ifDiffers: The leaf name of the file (for example, "myFile.jpg") prior to renaming. Only displayed if differs from the current file name.
  • com.adobe.sidecars: If any "sidecar" files are associated with this file (for instance, .xmp or .thm files), this item will list the extensions of those files.
  • com.adobe.copyname: The name associated with this copy.
  • com.adobe.folder: The name of the folder the file is in.
  • com.adobe.filesize: The formatted size of the file (for example, "6.01 MB")
  • com.adobe.fileFormat: The user-visible file type (DNG, RAW, etc.).
  • com.adobe.metadataStatus: The status of the metadata in the file, as compared to the metadata in the Lightroom catalog. Typical values (in English) are "Up to date", "Has been changed", or "Conflict exists". (This list is not exhaustive.)
  • com.adobe.metadataDate: Date/time when Lightroom last updated metadata in this file.
  • com.adobe.audioAnnotation: If an audio file (typically .wav file) is associated with this photo, this will contain the name of that file. Only displayed if there is an audio file.
  • com.adobe.separator: Inserts a dividing line.
  • com.adobe.rating: The user rating of the file (number of stars).
  • com.adobe.colorLabels: The name of assigned color label. Despite the plural name, only one color label can be assigned to a photo.
  • com.adobe.title: The title of photo.
  • com.adobe.caption: The caption for photo.
  • com.adobe.label: This entry allows you to insert a custom label describing the items that follow it.
  • com.adobe.imageFileDimensions: The original dimensions of the file (for example, "3072 x 2304").
  • com.adobe.imageCroppedDimensions: The cropped dimensions of file (for example, "3072 x 2304").
  • com.adobe.exposure: The exposure summary (for example, "1/60 sec at f/2.8")
    • exposureTime?
  • com.adobe.shutterSpeedValue: The shutter speed (for example, "1/60 sec")
  • com.adobe.apertureValue: The aperture (for example, "f/2.8")
  • com.adobe.brightnessValue: The brightness value
  • com.adobe.exposureBiasValue: The exposure bias/compensation (for example, "-2/3 EV")
  • com.adobe.flash: Whether the flash fired or not (for example, "Did fire")
  • com.adobe.exposureProgram: The exposure program (for example, "Aperture priority")
  • com.adobe.meteringMode: The metering mode (for example, "Pattern")
  • com.adobe.ISOSpeedRating: The ISO speed rating (for example, "ISO 200")
  • com.adobe.focalLength: The focal length of lens as shot (for example, "132 mm")
  • com.adobe.focalLength35mm: The focal length as 35mm equivalent (for example, "211 mm")
  • com.adobe.lens: The lens (for example, "28.0-135.0 mm")
  • com.adobe.subjectDistance: The subject distance (for example, "3.98 m"). Approximate value only, and some camera vendors discourage its use.
  • com.adobe.dateTimeOriginal: The date and time of capture (for example, "09/15/2005 17:32:50") Formatting can vary based on the user's localization settings
  • com.adobe.dateTimeDigitized: The date and time of scanning (for example, "09/15/2005 17:32:50") Formatting can vary based on the user's localization settings
  • com.adobe.dateTime: Adjusted date and time (for example, "09/15/2005 17:32:50") Formatting can vary based on the user's localization settings
  • com.adobe.make: The camera manufacturer
  • com.adobe.model: The camera model
  • com.adobe.serialNumber: The camera serial number
  • com.adobe.userComment: The comments recorded by the user in camera
  • com.adobe.artist: The artist's name
  • com.adobe.software: The software used to process/create photo
  • com.adobe.GPS: The location of this photo (for example, "37°56'10" N 27°20'42" E")
  • com.adobe.GPSAltitude: The GPS altitude for this photo (for example, "82.3 m")
  • com.adobe.GPSImgDirection: The GPS direction for this photo (for example, "South")
  • com.adobe.creator: The name of the person that created this image
  • com.adobe.creatorJobTitle: The job title of the person that created this image
  • com.adobe.creatorAddress: The address for the person that created this image
  • com.adobe.creatorCity: The city for the person that created this image
  • com.adobe.creatorState: The state or city for the person that created this image
  • com.adobe.creatorZip: The postal code for the person that created this image
  • com.adobe.creatorCountry: The country for the person that created this image
  • com.adobe.creatorWorkPhone: The phone number for the person that created this image
  • com.adobe.creatorWorkEmail: The email address for the person that created this image
  • com.adobe.creatorWorkWebsite: The web URL for the person that created this image
  • com.adobe.headline: A brief, publishable synopsis or summary of the contents of this image
  • com.adobe.iptcSubjectCode: Values from the IPTC Subject NewsCode Controlled Vocabulary (see: http://www.newscodes.org/)
  • com.adobe.descriptionWriter: The name of the person involved in writing, editing or correcting the description of the image
  • com.adobe.category: Deprecated field; included for transferring legacy metadata
  • com.adobe.supplementalCategories: Deprecated field; included for transferring legacy metadata
  • com.adobe.dateCreated: The IPTC-formatted creation date (for example, "2005-09-20T15:10:55Z")
  • com.adobe.intellectualGenre: A term to describe the nature of the image in terms of its intellectual or journalistic characteristics, such as daybook, or feature (examples at: http://www.newscodes.org/)
  • com.adobe.scene: Values from the IPTC Scene NewsCodes Controlled Vocabulary (see: http://www.newscodes.org/)
  • com.adobe.location: Details about a location which is shown in this image
  • com.adobe.city: The name of the city pictured in this image
  • com.adobe.state: The name of the state pictured in this image
  • com.adobe.country: The name of the country pictured in this image
  • com.adobe.isoCountryCode: The 2 or 3 letter ISO 3166 Country Code of the country pictured in this image
  • com.adobe.jobIdentifier: A number or identifier needed for workflow control or tracking
  • com.adobe.instructions: Information about embargoes, or other restrictions not covered by the Rights Usage field
  • com.adobe.provider: Name of person who should be credited when this image is published
  • com.adobe.source: The original owner of the copyright of this image
  • com.adobe.copyright: The copyright text for this image
  • com.adobe.rightsUsageTerms: Instructions on how this image can legally be used
  • com.adobe.copyrightInfoURL
  • com.adobe.allPluginMetadata: All metadata defined by plug-ins.
  • (plugin ID).*: All metadata defined by the plug-in with the given ID.
  • (plugin ID).(field ID): A specific plug-in provided metadata field.

The following items are first supported in version 3.0 of the Lightroom SDK.

  • com.adobe.personInImage: Name of a person shown in the image
  • com.adobe.locationCreated: The Location the photo was taken. Each element in the return table is a table which is a structure named LocationDetails as defined in the IPTC Extension spec. Definition details can be found at http://www.iptc.org/std/photometadata/2008/specification/.
  • com.adobe.locationShown: The Location shown in the image. Each element in the return table is a table which is a structure named LocationDetails as defined in the IPTC Extension spec. Definition details can be found at http://www.iptc.org/std/photometadata/2008/specification/.
  • com.adobe.organisationInImageName: Name of the organization or company which is featured in the image
  • com.adobe.organisationInImageCode: Code from a controlled vocabulary for identifying the organization or company which is featured in the image
  • com.adobe.event: Names or describes the specific event at which the photo was taken
  • com.adobe.artworkOrObject: A set of metadata about artwork or an object in the image. Each element in the return table is a table which is a structure named ArtworkOrObjectDetails as defined in the IPTC Extension spec. Definition details can be found at http://www.iptc.org/std/photometadata/2008/specification/.
  • com.adobe.additionalModelInfo: Information about the ethnicity and other facets of model(s) in a model-released image
  • com.adobe.modelAge: Age of human model(s) at the time this image was taken in a model released image
  • com.adobe.minorModelAgeDisclosure: Age of the youngest model pictured in the image, at the time that the image was made.
  • com.adobe.modelReleaseStatus: Summarizes the availability and scope of model releases authorizing usage of the likenesses of persons appearing in the photograph.
  • com.adobe.modelReleaseID: A PLUS-ID identifying each Model Release
  • com.adobe.imageSupplier: Identifies the most recent supplier of item, who is not necessarily its owner or creator. Each element in the return table is a table which is a structure named ImageSupplierDetail defined in PLUS. Definition details can be found at http://ns.useplus.org/LDF/ldf-XMPReference.
  • com.adobe.imageSupplierImageId: Identifier assigned by the Image Supplier. Definition details can be found at http://ns.useplus.org/LDF/ldf-XMPReference.
  • com.adobe.registryId: Both a Registry Item Id and a Registry Organization Id to record any registration of this item with a registry. Each element in the return table is a table which is a structure named RegistryEntryDetail as defined in the IPTC Extension spec. Definition details can be found at http://www.iptc.org/std/photometadata/2008/specification/.
  • com.adobe.maxAvailWidth: The maximum available width in pixels of the original photo from which this photo has been derived by downsizing
  • com.adobe.maxAvailHeight: The maximum available height in pixels of the original photo from which this photo has been derived by downsizing
  • com.adobe.digitalSourceType: The type of the source of this digital image, selected from a controlled vocabulary
  • com.adobe.imageCreator: Creator or creators of the image. Each element in the return table is a table which is a structure named ImageCreatorDetail defined in PLUS. Definition details can be found at http://ns.useplus.org/LDF/ldf-XMPReference.
  • com.adobe.copyrightOwner: Owner or owners of the copyright in the licensed image. Each element in the return table is a table which is a structure named CopyrightOwnerDetail defined in PLUS. Definition details can be found at http://ns.useplus.org/LDF/ldf-XMPReference.
  • com.adobe.licensor: A person or company that should be contacted to obtain a license for using the item or who has licensed the item. Each element in the return table is a table which is a structure named LicensorDetail defined in PLUS. Definition details can be found at http://ns.useplus.org/LDF/ldf-XMPReference.
  • com.adobe.propertyReleaseID: A PLUS-ID identifying each Property Release
  • com.adobe.propertyReleaseStatus: Summarizes the availability and scope of property releases authorizing usage of the likenesses of persons appearing in the photograph.
  • com.adobe.digImageGUID: Globally unique identifier for the item, created and applied by the creator of the item at the time of its creation
  • com.adobe.plusVersion: The version number of the PLUS standards in place at the time of the transaction

The following items are first supported in version 4.0 of the Lightroom SDK.

  • com.adobe.duration: The duration of the media file in minutes and seconds. (for example, 01:59.0)
  • com.adobe.duration.combined.optional: The duration of the media file, and the duration of the trimmed media file (if trimmed).
  • com.adobe.trimmed_duration.optional: The duration of the trimmed media file (if trimmed).
  • com.adobe.videoFrameRate: The video frame rate, in frames per second.
  • com.adobe.videoAlphaMode: The alpha mode (for example, straight, pre-multiplied or none).
  • com.adobe.videoFrameSize: The frame size in pixels. For example: 640 x 480.
  • com.adobe.audioChannelType: The audio channel type. Valid text values are predefined in the XMP Dynamic Media namespace. Details can be found at http://www.adobe.com/content/dam/Adobe/en/devnet/xmp/pdfs/XMPSpecificationPart2.pdf
  • com.adobe.audioSampleRate: The audio sample rate. Can be any value, but commonly 32000, 44100, or 48000 Hz.
  • com.adobe.audioSampleType: The audio sample type.
  • com.adobe.speakerPlacement: A description of the speaker angles from centre front in degrees. For example: "Left = -30, Right = 30, Centre = 0, LFE = 45, Left Surround = -110, Right Surround = 110"
  • com.adobe.tapeName: The name of the tape from which the clip was captured, as set during the capture process.
  • com.adobe.altTapeName: An alternative tape name.
  • com.adobe.dm_scene: The name of the scene.
  • com.adobe.shotName: The name of the shot or take.
  • com.adobe.shotDate: The date and time when the video was shot.
  • com.adobe.shotLocation: The name of the location where the video was shot. For example: "Oktoberfest, Munich Germany"
  • com.adobe.logComment: User&rs_quot;s log comments.
  • com.adobe.dm_artist: The name of the artist or artists.
  • com.adobe.album: The name of the album.
  • com.adobe.genre: The name of the genre.
  • com.adobe.releaseDate: The date the title was released.
  • com.adobe.composer: The composer&rs_quot;s name.
  • com.adobe.engineer: The engineer&rs_quot;s name.
  • com.adobe.instrument: The musical instrument.
  • com.adobe.comment: A user&rs_quot;s comments
  • com.adobe.client: The client for the job of which this shot or take is a part.
  • com.adobe.good: A selection for tracking whether a shot is a keeper.
  • com.adobe.projectName: The name of the project of which this file is a part.
  • com.adobe.director: The director of the scene.
  • com.adobe.directorPhotography: The director of photography for the scene.
  • com.adobe.cameraModel: The make and model of the camera used for a shoot.
  • com.adobe.cameraAngle: The orientation of the camera to the subject in a static shot, from a fixed set of industry standard terminology. A selection from values are predefined in the XMP Dynamic Media namespace. Details can be found at http://www.adobe.com/content/dam/Adobe/en/devnet/xmp/pdfs/XMPSpecificationPart2.pdf
  • com.adobe.cameraMove: The movement of the camera during the shot, from a fixed set of industry standard terminology. A selection from values are predefined in the XMP Dynamic Media namespace. Details can be found at http://www.adobe.com/content/dam/Adobe/en/devnet/xmp/pdfs/XMPSpecificationPart2.pdf
  • com.adobe.shotDay: The day in a multiday shoot. For example: "Day 2", "Friday".
  • com.adobe.dng.version: The version of the DNG standard used by the image.
  • com.adobe.dng.backwardVersion: The version of the DNG standard this image is backwards compatible with.
  • com.adobe.dng.compatibility: The earliest version of Lightroom this image is compatible with.
  • com.adobe.dng.hasFastLoadData: Whether the DNG has fast load data embedded or not (for example, "Embedded").
  • com.adobe.dng.lossyCompression: Whether the DNG uses lossy compression or not (for example, "No").
  • com.adobe.dng.hasEmbeddedOriginalRawFile: Whether the DNG has the original raw file embedded or not (for example, "None Embedded").
  • com.adobe.dng.hasMosaicData: Whether the DNG contains mosaic data or not (for example, "Yes").
  • com.adobe.dng.hasTransparency: Whether the DNG contains transparency data or not (for example, "No").
  • com.adobe.dng.floatingPointType: Whether the DNG uses integer or floating point pixel data (for example, "Integer").
  • com.adobe.dng.bitsPerSample: The number of bits used per DNG data sample.
  • com.adobe.dng.originalRawFileName: The name of the original raw file used when creating the DNG.
  • com.adobe.dng.originalImageDimensions: The dimensions of the original raw file used when creating the DNG (for example, "4288 x 2848").
  • com.adobe.dng.imageDimensions: The dimensions of the DNG image file (for example, "4288 x 2848").
  • com.adobe.dng.previewDimensions: The dimensions of the embedded preview within this DNG image file (for example, "3882 x 2579").
title : (Read-Only)
(string, required) This table member defines the localizable display name of the tagset, which appears in the popup menu for the Metadata panel.