Working with Apple Apps - The Basics (v1.4)

Download as PDF

Back to Yate Resources


This document describes how to use Yate to ensure that the tags present in your files appear properly in an Apple App (iTunes/Music/TV). The emphasis is given on making things as automatic as possible. It is assumed that you have at least a basic understanding of tagging in Yate. Most of the discussion references audio files and refers to Music. The same logic can be used with iTunes and with video files in the TV application.

Music, iTunes and TV have two settings which are detrimental to managing your collection if you rename or move files. These options should never be checked. The settings are in the following locations:

Music Settings - Files
TV Settings - Files
iTunes Preferences - Advanced

If the above options are set, the Apple application will make copies of your files and will rename them as they see fit.


Yate connects audio files to an Apple App via a transient linkage. The linkage can be established and dropped at any time. The linkage disappears each time an audio file in Yate is closed.

Yate can link files by metadata matching. This typically uses the common fields Artist, Album, Title and Track. It is far better however to link by the use of the Apple App's so called persistent IDs. A persistent ID (PID) is basically a key to an item in the application's database. Whenever Yate links to an Apple App, the PID is read and used for all interaction with the application. PIDs can be retained in the audio files.

Metadata associated with an audio file can be exactly the same as another file. For example two copies of an album encoded at different resolutions. Persistent IDs are unique. This makes linkage relatively trivial and ensures that a linkage can be established even if a file is moved or renamed. If a linked file is moved or copied, Yate can still locate the file in the Apple App and update its location. Even if a file's location is changed when not linked, Yate can still find the file in the Apple App the next time the file is linked and can still correct the location.

While PIDs are great to use it is important to note that they do not work across different libraries and they do not survive a rebuild of the libraries. We'll shortly describe an easy method of updating the saved copy of a PID in an audio file if for any reason you rebuild a library. Yate encodes PIDs for each of Music, iTunes and TV slightly differently. This means a single PID is always associated with a single application.

It is strongly recommended that you use the PID method of linking!


As discussed, one you have the PIDs in the audio files, linking is trivial. However you may have a large existing library. How do you initially get all the PIDs? Yate provides a special batch process which walks your Apple App libraries and imports the PIDs directly into the audio files. Typically this batch process only has to be run once. The batch process is run from the Action menus's Batch Processes>Batch Extract Persistent IDs item. Basically the process examines every item in a library and updates the files with the PIDs.

If you've run the batch extraction of PIDs process ... how do you link a file? Select any files loaded into Yate and do an Apple Apps>Link to Apple App. The Linkage column will update. Note that any Yate menu command can be associated with a keyboard shortcut. Also, the Link to Apple App command is available as a toolbar icon. Once linked, any changes you make in Yate will be saved to the appropriate library when the files are saved. Yate also forces a refresh in an Apple App. A refresh tells the application to reload metadata from a file. This ensures that standard metadata items such as Artist, Album, Artwork, etc. are updated as well.

If you have a new album you can add it to to an Apple App by loading the album into Yate and doing an Apple Apps>Add to Apple App. All selected files will be added, linked and the PIDs will be imported. If for any reason, you added the album directly into the Apple App simply drag the files into Yate which will load the files and will have the same effect. The success of dragging from an Apple App into Yate varies on the application's display and even which application you're using. There are lots of inconsistencies. To avoid dragging, you can select the files in the Apple App and do a File>Open Selected Items In>Apple App.

If you load files into Yate, forget to link them and then save changes ... not to worry. Simply link the files and then do an Apple Apps>Refresh Apple App. The refresh process will cause the application to reload metadata from the files and will take care of syncing those nasty library only items which you told Yate to process. Note that the Music and TV applications do not properly reload artwork when a file is refreshed. The artwork is reloaded but the image used when playing tracks or displaying an album is not updated.

A workaround for the artwork not updating issue is as follows: The Artwork menu has Patch Artwork in Apple App and Patch Artwork in Apple App if Modified items. The associated functionality is works but has a limitation, due to yet another bug, that at most one artwork item will be present in the tracks when it completes. ie. if you use these methods to patch the artwork display you can have at most one artwork item in Music or TV. Note that the files can still contain multiple artwork items.

Most metadata supported by Music, iTunes and TV is directly read from the files .. although iTunes has in earlier versions been somewhat terrible in keeping files and its library in sync ... iTunes is better at loading changes made to audio files. Further not all metadata is supported in all file types. For example, Apple simply refuses to read metadata from WAV files even though the convention for storing tags in WAV files is identical to how tags are stored in MP3 files. Yate gets around these issues by manually forcing the metadata into Music or iTunes ... even then they refuse to display an artwork item for a WAV file.

It's recommended that you apply the following settings in Settings - Apple Apps - General. More information on these settings can be found in the setting panel's online help.



Settings - Apple Apps - General

We've already gone over the extraction and value of PIDs. The Prefer PIDs when linking setting ensures that the PIDs get used wherever possible.

With the release of iTunes v12.5.2, an incompatibility was introduced with the separate retention of Grouping and Work Name metadata in mp3 and aiff files. This incompatibility is also present in the Music application. The Maximum Grouping-Work Name Compatibility option in can be used to get around the issue. More information on this option can be found in Classical Metadata and the Grouping Field.

The two Update on empty settings ensure that the Apple App is made aware of fields becoming empty. Apple APps do not always reread files which have been changed and they have to be notified.

Most audio players treat the default comment as the first comment in an audio file which has an empty description field. Apple applications tend to add the requirement that the comment's language is eng. You can force Yate to use this stricter definition by setting the Use strict definition of 'default' comment option.

Album ratings in iTunes/Music are a mess. As the values can be synthesized, you may see track ratings in grey/black which you never set. You can automatically attempt to clear out album ratings whenever library only values are exported to an Apple App. More information can be found in Apple App Album Rating.

Various metadata items are only kept in an Apple App's library and do not get written out to the audio files. Yate however can retain all these library only items in the audio files. Managing these items and keeping them synchronized with the files can be a pain if it is not automatically done for you. These items include: Category, Classical Metadata, Loved / Disliked, Media Kind, Persistent ID, Play Count, Rating, Remember Playback Position, Skip when Shuffling, Start Time, Stop Time and Volume Adjustment. Yate can also clear Music's and iTunes' automatically calculated album rating.

Only iTunes supports all of these library only metadata types. Music and TV support a subset. On the Settings - Apple Apps - Fields of Interest panel you tell Yate which metadata types you're interested in. Whenever you link an audio file to an Apple App the Linked column will show an indicator for each of the fields of interest which have different values in the Apple App and the audio file where Yate retains them. The advantage of retaining the information in the files is that if you ever have to rebuild an application's database, nothing will be lost. The following screenshot shows a sample Fields of Interest panel. You can choose whatever fields you want but please ensure that Persistent ID is checked.

You should enable the display of the Linked column in Yate's main window. This column displays the link status of a file. Empty implies not linked. A check mark implies linked and everything of interest to you is the same in the audio files and the Apple App library. Other indicators imply differences in items of interest. You can always see the indicator definitions by hovering the mouse pointer over the Linked column's header.

The Fields of Interest panel, displays those library only fields that you're interested in. The are the fields identified in the Link column and also represent the fields which get exported to Apple APps whenever an export occurs. Note that the Album Rating item only controls the Link link column identification. The desire to clean up album ratings when exporting setting has already been discused as it is on the General panel.



Settings - Apple Apps - Fields of Interest

Settings - Apple Apps - Auto Import looks almost the same. It describes those fields that are to be imported into Yate each time a file is linked. As you are going to be editing in Yate you need not check anything other that Persistent ID ... which you always want to automatically import. The entire linkage methodology used in this document falls apart if you do not check Persistent ID.



Settings - Apple Apps - Auto Import

Settings - Apple Apps - Auto Export describes those metadata items that Yate will force into an Apple App each time a file is saved in Yate. Which fields you auto export is entirely up to you. You'll notice that Persistent ID is missing. That's because the Apple App always owns the Persistent ID and Yate cannot set it. Auto Export always processing album ratings as indicated the General setting.



Settings - Apple Apps - Auto Export


Summary


There are lots of other things you can do with Apple Apps when linked. The functions are all on the Apple Apps menu. You can find help for any Yate menu item via Help>Quick Reference>Help by Menu. The main thing is not to be intimidated by the functionality. You'll develop your own workflow over time and eventually it will all appear to be easy.

If you're a Music user and you purchase from the iTunes store, the Apple Music suite of actions provide various means of extracting metadata. This includes artwork which Apple no longer provides when purchasing songs. The suite can be found on the resources web page ... Help>Resources (Sample Actions, Templates, Documentation). Alternately you can use the Action Installer item on the Yate menu to install the actions.







Document History


Date Version Information
2020-07-09 1.1 First general release.
2022-02-01 1.2 Added Apple application settings locations and warning.
2022-08-30 1.3 Added information on the Grouping field.
2026-04-01 1.4 General cleanup.


Copyright ©️ 2026 2ManyRobots.  All rights reserved





Download as PDF



Back to Yate Resources