Get Info

Yate retains many different kinds of information. This statement allows you to extract most of it. For convenience the information types are separated into various submenus. Some menu items are duplicated where it makes sense.

In all of the available functions, extracted list items are separated by the default list delimiter \~. Unless otherwise mentioned, returned lists are sorted. When a key-value list is being produced, the default key-value separator \k is used. All text fields may contain any of the escape sequences described in Escape Sequences.

The information returned by the functions is typically stored to a named variable. A few of the functions store information to multiple named variables.

The following types of items can be extracted:

Action Lists

Action Runtime Settings Lists

Filename Extension Lists

Filtered List of Credit Roles

Import Set Lists

List of Containers

List of File Browser Pinned Folders

List of Finder Colour Tags

List of Picture Types

List of Supplied Fields

List of System Sounds

Action Runtime Settings Lists

This submenu contains functions to return information relating to action runtime settings. All functions return a list.

List of Action Runtime Settings Sets: A list containing the names of all action runtime settings sets will be saved to the specified named variable.
Action Runtime Settings with Prefix ➞ Named Variables: A named variable will be created for every Action Runtime Setting, in the currently mapped set, which starts with the supplied prefix. The named variables will have the same name as the runtime settings. The produced variables always represent the contents of the replacement set currently mapped to the runtime setting functionality. See Action Runtime Settings for more information. This function is deprecated. as the usefulness of this function is dubious. It was introduced at a time when the runtime settings were always grouped together. Being able to partition the settings into separate sets eliminates the need to prefix the settings.
List of Mapped Action Runtime Settings: A list containing the names of all action runtime settings in the currently mapped set.

Field Lists

This submenu contains functions to return lists of various types of fields.

List of All Fields: A list of all fields is returned.
List of Single Item Fields: A list of all built in fields which can have at most a single item is returned.
List of Multiple Item Fields: A list of all fields which can have more than one item is returned.
List of Simple Text Fields: A list of all fields which can have a single item and all multiple item fields, (except Artwork), which have a default item.
List of Simple Text Multiple Item Fields: A list of all fields which can have multiple items and have a default item is returned. Note that Artwork which has a default item is not returned as the default item cannot be textually represented. The multiple item fields which have a default item are: Comments, Commercial Information Webpage, Lyrics, Official Artist/Performer Webpage, Rating and Terms of Use.
List of Non Simple Text Fields: A list of all fields which can have multiple items and do not have a default item is returned. Note that Artwork which has a default item is returned as the default item cannot be textually represented.
List of Custom Fields: A list of all defined Custom Fields is returned.
List of Credit Fields: A list of fields which are credits. This includes custom fields defined as credits.
List of Date Fields: A list of fields which are dates or timestamps. Note that it is possible that there are custom fields which are dates which are not returned in this list.
List of Fields Mapped to an Application List: A list of fields which are currently mapped to an application list as displayed in Settings - Lists - List Mappings.
List of Formatted Fields: A list of fields which have an implied or enforced formatting. While date, numeric and URL items are formatted, they are not returned in this list. The following fields are returned: AAC Kind, Classification, Content Advisory, Encoder Settings, Episode ID, File Type, Identification, Initial Key, Involved People, ISRC, Language, Media Type, Music CD Identifier, Musician Credits, Owner, Price Paid, Reverb, Seller, Start Time, Stop Time, Video Definition
List of Numeric Fields: A list of fields which are treated as numbers. This includes boolean fields such as Part of a Compilation. Custom fields defined as Yes/No values are included. Note that the Year field is not included in the produced list. Year is considered a date. The multiple item Rating field is returned as it has a default value. Note that it is possible that there are custom fields which are numeric which are not returned in this list.
List of URL Fields: A list of fields which contain a URL. This includes the multiple item fields Commercial Information Webpage and Official Artist/Performer Webpage as they have default values. Note that it is possible that there are custom fields which are URLs which are not returned in this list.
List of Track Variables: A list of all track variables is returned.
List of Plain Text Fields: This is a convenience method which returns Simple Text Fields after removing: Date Fields, Formatted Fields, Numeric Fields and URL Fields.
List of Plain Text Fields Plus Numeric: This is a convenience method which is the same as List of Plain Text Fields with the exception that Numeric Fields are not removed.
List of Supplied Fields: See List of Supplied Fields.

Filename Extension Lists

This submenu contains functions to return the filename extensions used by various file types.

List of Media Filename Extensions: A list of filename extensions whose associated files can be tagged.
List of Database Filename Extensions: A list of filename extensions whose associated files can be opened as Yate databases.
List of Playlist Filename Extensions: A list of filename extensions whose associated files can be opened as playlist files (m3u).
List of Image Filename Extensions: A list of filename extensions whose associated files can be opened as images. This list is provided by OS X. This function is now deprecated. The list that is returned is now a most common subset of those supported extensions. Yate reads all images which can be opened by macOS. The image types are not defined by their filename extensions. You can determine if a given extension represents an image by using the File Path Manipulation's Is this an Image File? function. When processing lists you can also use the List Manipulate statement's Filter image tests.

Filtered List of Credit Roles

A list of credit roles as displayed in the Combined Credits Editor. The list is filtered by setting an encoded value in he Filter field.

The filter is specified in the Filter field and may contain any of the escape sequences described in Escape Sequences. If no filter information is provided, all credit roles will be returned.

The filter is provided as a sequence of case insensitive character codes. These codes are the same as those displayed in the Combined Credits Editor's known credits filter window:

D
The credit is a known Discogs credit.
B
The credit is a known MusicBrainz credit.
R
The credit is a known Roon credit.
U
The credit is user defined.
I
The credit has a default mapping to the Involved People field.
M
The credit has a default mapping to the Musician Credits field.
S
The credit has a specified mapping of Composer, Conductor, Lyricist or Remixer.
H
The credit has been marked as hidden in the Combined Credits Editor.
*
A built in credit's mapping or alias field has been changed.

When a code is encountered it by default implies must match. This is equivalent to ✓ in the Combined Credits Editor. You can explicitly force a must match scenario by specifying a + code. example: +DB or DB implies only include credits used by Discogs and MusicBrainz.

You can also specify must not match which is equivalent to ✕ in the Combined Credits Editor. You do this by specifying a - code. For example +D-B implies only display credits used by Discogs but not by MusicBrainz.

You can also filter on text. All text following an = code will only include items which contain the specified case insensitive text. No further codes are extracted after an = code. +R=Guitar implies only include credits used by Roon which contain 'guitar'.

The encoding is designed such that at runtime you can construct a filter exactly as employed in the Combined Credits Editor.

Import Set Lists

This submenu contains functions to return the contents of import sets used by Discogs and MusicBrainz. Other than examine the contents of the returned lists, there's not much you can do with them.

List of Discogs Import Sets: A list containing the names of all Discogs import sets will be saved to the specified named variable.
List of MusicBrainz Import Sets: A list containing the names of all MusicBrainz import sets will be saved to the specified named variable.

Action Lists

This submenu contains functions to return various lists of actions:

List of Actions

A list containing the names of all actions will be saved to the specified named variable. Note that the list is flat. The action folder structure is ignored.

List of Actions (Non Hidden)

Same as List of Actions except that hidden actions are not returned.

Action Structure to Container

A complete representation of the actions as displayed in the Action Manager is saved to the specified container. If the container name is invalid, no error will be issued.

The created container can be used as a menu wherever container based menus are valid.

A subset of the standard container menu items as defined in Prompt Menu Formatting may be created. These include:

name: A string key describing the action or folder's name.
hidden: An optional boolean key. true if the action is hidden.
items: An optional array key containing the actions in a folder.
icon: A numeric key describing the icon to be displayed.

Additionally the following items may be created:

association: A string value representing the Association column in the Action Manager.
allFiles: A boolean value representing the All Files column in the Action Manager.
always: A boolean value representing the Always column in the Action Manager.
date: A string value representing the Date Modified column in the Action Manager.
priority: A numeric value representing the Priority column in the Action Manager.
grouping: A string value representing the Grouping column in the Action Manager.

Action Structure to Menu

Same as Action Structure to Container, except only those keys required to display the container as a menu will be saved to the container. Empty folders will not be displayed. Note that all actions, even those marked as hidden, will be present when the menu is displayed. The only keys which potentially can be set are: name, items and icon.

Action Structure to Menu (Not Hidden)

Same as Action Information to Menu, except actions marked as hidden will not be displayed.

List of Containers

A list containing the names of all defined containers will be saved to the specified named variable.

List of File Browser Pinned Folders

A list containing the names of all folders pinned in the File Browser.

List of Finder Colour Tags

A list containing the names of all Finder colour tags.

List of Picture Types

A list of all ID3 Picture Types will be saved to the specified named variable. Note that this list is not sorted. The list is ordered by each type's hard coded index.

List of Supplied Fields

The list of returned fields is determined as follows:

If the action was started from the Multi Field Editor and had a Supported Fields statement, the fields selected in the Multi Field Editor after removing all fields which are known to be invalid, will be returned.
If the action was started from the Multi Field Editor and the started action did not have a Supported Fields statement, the fields selected in the Multi Field Editor will be returned.
If the action was started from a function button, the button's associated field will be returned.
If none of the previous conditions hold, nothing will be returned.

List of System Sounds

A list of the system sounds available on the Play System Sound statement.

Application Lists

This menu contains additional submenus accessing various functionality regarding application lists.

Contents of Application List

This submenu contains the names of all the application lists. The names represent the possibly renamed names. Selecting an application list will return all items in the list.
At the bottom of the submenu there is a menu item named Indirect Application List. Named variable Indirect Application List must contain the name of an application list. An original or renamed list name is acceptable. The application list associated with the indirectly specified name will have its items stored to the specified named variable.

Application List Names

This submenu contains items to return the names of the application lists in various ways.
List of Application List Names

A list of the current names of the application lists is returned in the specified named variable.

Current Application List Names ≔ Defaults

A key-value list is returned in the specified named variable. Keys are the current application list names and values are the default names.

Default Application List Names ≔ Current

A key-value list is returned in the specified named variable. Keys are the current default list names and values are the current names.

Application List Mappings

This submenu contains additional functions describing various mappings between fields and application lists.
Fields ≔ Application Lists

A key-value list is returned in the specified named variable. Keys are field names and values are the name of the application list to which it is mapped.

List of Fields Mapped to an Application List

A list of fields currently mapped to an application list is returned in the supplied named variable.

Application Lists ≔ Fields

A key-value list is returned in the specified named variable. Keys are the current application list names and values are the names of fields associated with the list. Field names are separated by the secondary list delimiter (\:)

Application Sets

This menu contains additional submenus describing various functionality regarding application sets.

Content of Named Application Set

This submenu contains additional contains items to provide the contents of named application set items.
Named Exception Set

The set name can be directly or indirectly specified (via escape sequences). You can choose two scenarios as to how to handle the named exception set not existing at runtime. You can have the action terminate or you can set the action test state where true means it existed and false means it did not. The set is extracted in one of the following ways:
Extract list to named variable

The exception set will be stored to the specified named variable as a list of the exception fields.

Extract key-value list to named variable

The exception set will be stored to the specified named variable as a key-value list. The exception fields become the keys. The values are encoded as a single character as follows:
N
No case change.
L
lower case
U
UPPER CASE
C
Capitalize
F
Force Exception
n, l, u, c, f
Same as above with No Change on Exact Match specified
Named Rename Template

The contents of a named rename template are saved as a list to the specified named variable. The list returned consists of tokens and text. List items which are tokens start with the Rename Template Token Indicator (\?ri) and are followed by the name of the token as it appears in the rename template editor. There is not much you can do with this content other than use it for validation purposes.

Named Replacement Set

The set name can be directly or indirectly specified (via escape sequences). You can choose two scenarios as to how to handle the named replacement set not existing at runtime. You can have the action terminate or you can set the action test state where true means it existed and false means it did not. The set is extracted in one of the following ways:
Extract named variables

Every item in the replacement set will become a named variable where the from field is the name and the to field is the value.

Extract list to named variable

The replacement set will be stored to the specified named variable as a list of the from fields.

Extract key-value list to named variable

The replacement set will be stored to the specified named variable as a key-value list. The from fields become the keys and the to fields are the values.
Named Runtime Settings Set

The set name can be directly or indirectly specified (via escape sequences). You can choose two scenarios as to how to handle the named runtime settings set not existing at runtime. You can have the action terminate or you can set the action test state where true means it existed and false means it did not. The set is extracted in one of the following ways:
Extract named variables

Every item in the action runtime settings set will become a named variable where the from field is the name and the to field is the value.

Extract list to named variable

The action runtime settings set will be stored to the specified named variable as a list of the from fields.

Extract key-value list to named variable

The action runtime settings set will be stored to the specified named variable as a key-value list. The from fields become the keys and the to fields are the values.
Named Tag Set

The set name can be directly or indirectly specified (via escape sequences). You can choose two scenarios as to how to handle the named tag set not existing at runtime. You can have the action terminate or you can set the action test state where true means it existed and false means it did not. A list of the fields enabled in a tag set is returned. If the tag set is inverted, the non inverted equivalent fields are returned. ie. an inverted set with all fields except Artist selected will return Artist. Note that Track Variables may be returned.

List of Application Sets

This submenu contains additional contains submenus providing lists of all named application sets of a particular type.
List of Exception Sets

A list containing the names of all exception sets will be saved to the specified named variable.

List of Export Sets

This submenu provides access to the names of different export sets.
List of All Export Sets

A list containing the names of all export sets will be saved to the specified named variable.

List of Album Export Sets

A list containing the names of those export sets which are sufficient to produce an album database will be saved to the specified named variable.

List of Track Export Sets

A list containing the names of those export sets which are sufficient to produce a track database will be saved to the specified named variable.
List of File to Tag Templates

A list containing the names of all file to tag templates will be saved to the specified named variable.

List of Rename Templates

A list containing the names of all rename templates will be saved to the specified named variable.

List of Replacement Sets

A list containing the names of all replacement sets will be saved to the specified named variable.

List of Search Templates

A list containing the names of all Search templates will be saved to the specified named variable.

List of Tag Sets

A list containing the names of all tag sets will be saved to the specified named variable.

Name of Special Exception Set

This submenu contains additional contains items describing the names of exception sets associated with a particular special status code.
Name of Default Exception Set (✓)

The name of the default exception set will be saved to the specified named variable. If the item is not assigned, the named variable will be set to empty.

Name of Names Exception Set (N)

The name of the names exception set will be saved to the specified named variable. If the item is not assigned, the named variable will be set to empty.

Name of Natural Sort Exception Set (S)

The name of the natural sort exception set will be saved to the specified named variable. If the item is not assigned, the named variable will be set to empty.

Name of Title Case Exception Set (T)

The name of the title case exception set will be saved to the specified named variable. If the item is not assigned, the named variable will be set to empty.

Name of Weight Exception Set (W)

The name of the weight exception set will be saved to the specified named variable. If the item is not assigned, the named variable will be set to empty.

Name of Special Replacement Set

This submenu contains additional contains items describing the names of replacement sets associated with a particular special status code.
Name of Default Replacement Set (✓)

The name of the default exception set will be saved to the specified named variable. If the item is not assigned, the named variable will be set to empty.

Name of Case Replacement Set (C)

The name of the case replacement set will be saved to the specified named variable. If the item is not assigned, the named variable will be set to empty.

Name of Fold Characters Replacement Set (F)

The name of the fold characters replacement set will be saved to the specified named variable. If the item is not assigned, the named variable will be set to empty.

Name of Rename Replacement Set (R)

The name of the rename replacement set will be saved to the specified named variable. If the item is not assigned, the named variable will be set to empty.

Name of Sort Form Name Prefix Set (P)

The name of the sort form name prefix set will be saved to the specified named variable. If the item is not assigned, the named variable will be set to empty.

Name of Sort Form Ignore Suffix Set (S)

The name of the sort form ignore suffix set will be saved to the specified named variable. If the item is not assigned, the named variable will be set to empty.

Application Settings

These functions return the current value of the specified setting. The following settings can be read:

Abbreviate Paths

Returns the Settings - File List Abbreviate file and folder paths setting. 0 for do not abbreviate or 1 for abbreviate.

Action Pending Window Font

0 for a proportional font or 1 for a monospaced font.

Apple Apps

Maximum Grouping-Work Name Compatibility: 0 for disabled. 1 for enabled.
Prefer PIDs When Linking: 0 for disabled. 1 for enabled.

Artwork

Artwork Scale Only if Square: 0 for disabled. 1 for enabled.
Artwork Scale Size: 0 do not scale otherwise the size.
Discogs Import All Artwork: 0 do not import all artwork. 1 for import all artwork
MusicBrainz Import All Artwork: 0 do not import all artwork. 1 for import all artwork
Round Icon Corners: 0 for disabled. 1 for enabled.

Ask

Ask False Button Label: The configured text or empty.
Ask True Button Label: The configured text or empty.

Automatically SetFinder Tags

Automatically Process Finder Tags Disliked

The configured disliked tag, if any.

Automatically Process Finder Tags Loved

The configured loved tag, if any.

Automatically Process Finder Tags Mode

Returns the following:

0: Never
1: When Files are Loaded
2: When Files are Saved
3: When Files are Loaded and Saved

Automatically Process Finder Tags Sort

0 for disabled. 1 for enabled.

Batch Processor

Auto Close Batch Processor Window: 0 for disabled. 1 for enabled.
Batch Auto Save Files: 0 for disabled. 1 for enabled.
Batch Verbose Logging: 0 for disabled. 1 for enabled.

Container Object Name Case Insensitivity

Returns 0 for case sensitive or 1 for case insensitive.

Copy Initial to Editing State On Save

0 for disabled. 1 for enabled.

Do not Treat 'mix' as a Roman Numeral

0 for disabled. 1 for enabled.

Fanart API Key is Set

Returns 1 if the Fanart API key is set, 0 otherwise.

File Browser Display Status (read only)

Returns 1 if the File Browser is displayed, 0 otherwise.

Free Space

Audio Free Space Padding: Returns the Settings-Audio-Common free space padding value.
Audio Remove Free Space: 0 for disabled. 1 for enabled.
Video Aggressively Free Space: 0 for disabled. 1 for enabled.
Video Free Space Padding: Returnsthe Settings-Video free space padding value.
Video Override Audio Free Space Settings: 0 for disabled. 1 for enabled.
Video Remove Free Space: 0 for disabled. 1 for enabled.

Import Metadata Archive Prefer Auto

1 for prefer auto import, 0 for do not prefer auto import.

Log Raw Data Limit

0 for unlimited or the configured limit value.

m3u File Encoding

Returns ASCII, Latin-1 or UTF-8.

Notifications

0 for disabled. 1 for enabled.

Open Mode

Returns the current open mode. The following characters are used to describe the current setting:

A (Album Mode)
P (Playlist Mode)
+ (add to the file list)
- (replace the file list)
S (process subfolders)
X (do not process subfolders)

Preserve Mod Date/Time when Saving Files

0 for disabled. 1 for enabled.

Rename

Auto Truncate Path Components: 0 for disabled. 1 for enabled.
Rename Multi Value Delimiter Substitution: Returns empty for the default behaviour of truncating at the first multi value delimiter. Non empty is the replacement text.
Rename Space Handling: Returns 0 for No Changes, 1 for Remove Leading/Trailing or 2 for Remove Leading/Trailing and Compress.

Unique Value Mode

Returns 0 for UUID or 2 for GUS.

Video Fast Rewrites

0 for disabled. 1 for enabled.