Application icon

Indexed Artwork

The Artwork Information statement provides the ability to perform various operations on artwork items in a position independent manner. This statement provides access to various functionality on a single artwork item at a specified index. Note that the indexes are zero based. Index zero represents the default artwork item in any file.

All text fields may contain any of the sequences described in Escape Sequences.

The Get Index of Matching Item function is radically different than the other functions in that it is the only function which does not supply an index. The Get Index of Matching Item function is described at the end of the document.

By default, the index field is only evaluated once. This means that a single index is used for all files. When not saving results to a named variable, there is a Per file option. When Per file is set, the index will be evaluated for every file.

If you pass \sa for the index, it will match a single selected artwork item. More information can be found in the Accessing Selected Artwork topic.

The action test state is set as follows:

If information is being saved and the function fails for any reason, the stored result will be the empty string. This is on a per file basis.

The following functions are currently available:

Set description
Set the artwork item's description field to the specified data. The data field is evaluated for each file.

Set picture type
Set the artwork item's picture type to the specified data. The data must either be one of the well defined picture types or an integer value representing the index of the picture type. If the data is not valid the picture type will be set to Other. A value picker is supplied as a convenience.

Get description
Set the destination variable to the artwork item's description field.

Get index of picture type
Set the destination variable to the index of the artwork item's picture type.

Get picture type
Set the destination variable to the textual representation of the artwork item's picture type.

Get mime type
Set the destination variable to the artwork item's mime type. Note that the * indicator used to denote a progressive JPEG in the UI is not returned here. Use the Get is Progressive JPEG function to determine if an image is progressive.

Get width x height
Set the destination variable to the artwork item's dimensions.

Get pixel count
Set the destination variable to the artwork item's pixel count.

Get data size
Set the destination variable to the size of the artwork data in bytes.

Set as Default
The artwork item at the specified index is moved to index 0 and as such becomes the default artwork.

Get is Progressive JPEG
Set the destination variable to 1 if the image is a progressive JPEG, otherwise 0.

Get Resolution
Set the destination variable to the resolution (PPI) of the image.

The following list describes the supported picture types and their associated indexes.

  1. Other
  2. 32x32 pixels 'file icon' PNG only
  3. Other file icon
  4. Cover (front)
  5. Cover (back)
  6. Leaflet page
  7. Media (CD label)
  8. Lead artist/lead performer/soloist
  9. Artist/performer
  10. Conductor
  11. Band/Orchestra
  12. Composer
  13. Lyricist/text writer
  14. Recording Location
  15. During recording
  16. During performance
  17. Movie/video screen capture
  18. A bright coloured fish
  19. Illustration
  20. Band/artist logotype
  21. Publisher/Studio logotype

Get Index of Matching Item

The function is used to find the first artwork item in every active file which matches a picture type and/or description. The description test is performed case insensitive and can require an entire match or that the supplied text is contained in the description. The picture type data must either be one of the well defined picture types or an integer value representing the index of the picture type. If the picture type data is invalid, no attempt will be made to match the picture type.

A matched index or -1 is returned in the specified named or track variable.

It makes no sense to save the results to a named variable unless you know that there is only a single active file. Only a single file is processed when a named variable is used.

The action test state is set to true if any matches were made, otherwise false.