Application icon

Apple Music Suite

The Apple Music actions are designed to provide various means of extracting metadata from Apple Music. On tracks purchased from the iTunes store this process is simpler.

A number of actions are provided but the following are user accessible.


AM: Profile Manager

The Profile Manager is used to create/edit/delete profiles used by all user facing actions. You can configure as many profiles as you wish but you must have at least one. There is also the concept of a default profile which can be directly accessed. More information on the settings in a profile can be found in Profile Settings.

When editing a profile, this action can directly run the actions which import metadata.


AM: Extract Metadata by Playlist ID

When you purchase albums from the iTunes store the tracks have an Apple Music Playlist ID. This ID provides sufficient context to locate the album in the appropriate iTunes store. Purchased tracks also have an Apple Music Catalog ID which can be used to properly map files to individual tracks. Yate stores both these IDs as UDTIs.

This action only processes files with an Apple Music Playlist ID. All other files are ignored. It will attempt to import metadata for each unique Apple Music Playlist ID in the selected files. When called directly, the default profile is always used.

When files do not contain an Apple Music Catalog ID a mapping panel will be presented, if necessary, to allow you to change the file to track mappings.

Whenever per track metadata is imported an Apple Storefront UDTI will be written to the files. When this action is directly started, a consistant Apple Storefront value across all files will supercede the storefront specified in the profile.

Note that as with the Discogs and MusicBrainz wizards, you can elect to run an action whenever metadata is imported. You configure this in the Profile Manager.


AM: Extract Metadata

This action is an alias for AM: Extract Metadata by Playlist ID. Prior to v3.0 of the suite, it was the action's name.


AM: Extract Metadata by Catalog ID

This action extracts on a per track basis as opposed to an album basis. It only processes tracks which have an Apple Music Catalog ID. Apple Music Playlist IDs, if any are ignored and removed when the extraction starts.

AM: Extract Metadata by Playlist or Catalog ID

All tracks with an Apple Music Playlist ID are processed as in the AM: Extract Metadata by Playlist ID action. All selected tracks which do not have an Apple Music Playlist ID but have a Apple Music Catalog ID will be processed as in the AM: Extract Metadata by Catalog ID action.


AM: Album Search

This action groups selected files according to the profile settings and performs an album search for each grouping. You enter a query which is typically the album or artist name. A database will be presented with each album which satisfies the query. You would then select a single album in the results and continue.

At this point, the Apple Music Playlist ID will be stored in the files and the AM: Extract Metadata by Playlist ID action will be called to import the metadata.

This action emulates the Discogs and MusicBrainz wizards with the added ability to work on more than one album at a time.


AM: Search for Songs by Title and Artist
AM: Search for Songs by Title

These two actions perform individual searches for a matching song on each selected file. The first action searches using the contents of the Title and Artist fields. The second uses only the Title field.

These actions are I'm feeling lucky actions as they are primarily based on text comparisons and the results are not vetted. Failed searches are silent. Results could be incorrect.

Successful matches are determined by fuzzy comparisons. You can specify individual compare thresholds for Title and Artist in your profile.

Songs in the iTunes store often contain qualifiers enclosed in (  ) or [  ] sequences at the end of a field name. This can cause compares to fail. By default, these two actions will perform comparisons twice if required. Once with the published name and once with the qualifiers removed. You can disable this behaviour when configuring.

You can further modify the matching algorithm by specifying a Preferred match behaviour in the configuration:

First Best

In all matches with the best fuzzy compare score, the first is chosen. You can elect to optionally use Album metadata with this mode.

Earliest Best

In all matches with the best fuzzy compare score, the one with the earliest release date is chosen.

Earliest Any

In all matches which satisfy the fuzzy thresholds, the one with the earliest release date is chosen.

Workflow

You must create at least one profile before you start. If you want to import metadata for files purchased from the iTunes store, you can directly run AM: Extract Metadata by Playlist ID. If you want to search for albums you would run the AM: Album Search action.

All panels presented by the various actions have a help button which provides browser based help for the panel.


Post Processing after an Import

If you wish you can specify an action for a profile's Post Import Action field. The specified action will be run automatically each time something is matched/imported.

The following extension actions are provided:

AM Extension: Remove HTML from Description Field
The Description field downloaded from Apple Music sometimes has embedded {X}HTML sequences. This action strips them out and performs a few other modifications.

Any variable of <br> will be replaced with a \n sequence. Note that this may cause the Description field's displayed text to be blue as \n is technically invalid. However, it doesn't hurt and inserting newline characters where intended makes the description easier to read. Escaped < and > sequences are unescaped.

AM Extension: Save Artist Artwork to Folder and Remove
Imported artist artwork is saved as an artwork item with a picture type of Artist/performer and a description field which is the artist's name. This action saves all artwork items with a picture type of Artist/performer to a sub folder named Artist Artwork. The sub folder will be in the same folder as the tracks. The saved artwork items are then removed from the tracks.

AM Extension: Save Artist Artwork to Parent Folder and Remove
This action is exactly the same as AM Extension: Save Artist Artwork to Folder and Remove, with the exception that the Artist Artwork subfolder is placed in the folder above the one containing the tracks.

A sample container action named AM Extension: Sample Extension Container is provided which runs the first two of the provided extensions. If you want to manually create your own container action, perform the following steps:

If you want to use the AM Extension: Sample Extension Container action, a profile's Post Import Action field must be set to AM Extension: Sample Extension Container.

If you want to modify the AM Extension: Sample Extension Container action it is recommended that you duplicate and rename the action. Subsequent action updates may overwrite AM Extension: Sample Extension Container.



Content List, Requirements & History

Actions:

Folder: Apple Music

AM Extension: Remove HTML from Description Field

AM Extension: Sample Extension Container

AM Extension: Save Artist Artwork to Folder and Remove

AM Extension: Save Artist Artwork to Parent Folder and Remove

AM Helper (extracter): Album Artwork

AM Helper (extracter): Album Artwork URL

AM Helper (extracter): Album URL

AM Helper (extracter): Artist Artwork

AM Helper (extracter): Barcode

AM Helper (extracter): Disc Count

AM Helper (extracter): Genre

AM Helper (extracter): Mood

AM Helper (extracter): Original Release Time

AM Helper (extracter): Single

AM Helper (extracter): Part of a Compilation

AM Helper (extracter): Track Count

AM Helper (extracter): Year

AM Helper: Build Artist-ID List

AM Helper: Create Config Container

AM Helper: Create New Profile Obj

AM Helper: Execute Post Processing Action

AM Helper: Extract Disc/Track Metadata

AM Helper: Extract Fields

AM Helper: Extract Metadata Main

AM Helper: Extract Profile Metadata

AM Helper: Patch Profile

AM Helper: Setup Storefront List

AM Helper: Extract Metadata via Playlist ID

AM Helper: Get Album Metadata

AM Helper: Skip Selected Files

AM Helper: Set Import Time

AM Helper: Present Mapping Results

AM Helper: Extract Metadata via Catalog ID

AM Helper: Results to Database

AM Helper: Search for Album

AM Helper: Search for Song

AM: Album Search

AM: Extract Metadata

AM: Extract Metadata by Playlist ID

AM: Extract Metadata by Catalog ID

AM: Extract Metadata by Playlist or Catalog ID

AM: Profile Manager

AM: Search for Song by Title

AM: Search for Song by Title and Artist


Export Sets:

Search Apple Music

Requirements:

Yate v8.2

History:


Date Version Information
2021-12-04 v1.0 First release.
2022-01-09 v1.1 Added warnings if AM: Extract Metadata was run and no tracks have an Apple Playist ID. Bug fix: If grouping tracks by the Album field and a track had trailing spaces in the Album field, the track would not be processed.
2022-05-18 v1.2 Added support for Artist artwork and URLs. Request limit is now selected from a popup list. The post processing action can now be selected from a popup list.
2023-01-02 v1.3 Added placeholders to editable config settings.
2023-06-30 v1.4 Changes for Yate v6.16. Fixed a bug where after searching, the per track data might not be imported.
2025-02-19 v2.0
  • Skip UDTIs were always written even if disabled.
  • Track list display now uses a proportional font for the text.
  • The search generated database is no longer preserved and cannot be closed by the user.
  • Search now defaults to artist-album which is now included on the disclosure menu.
  • The profile configuration setting Write imported tags is now a tri-state.
  • All configuration items now support popup help by selecting an item and pressing the spacebar.
  • A first time usage panel has been added to the profile display/edit panel.
  • Added two new actions to search for songs.
2025-03-07 v2.1 The storefront was not editable in the configuration panel.
2025-04-09 v3.0 Added new user facing actions for track based extraction and searching. New profile settings. Added the ability to duplicate profiles.
2025-04-21 v3.1 Changes for Yate v8.1.1. Added back placeholder for post processing action. All track variables preserved before calling post processing action, then restored.
2025-06-14 v3.2 Added the ability to import the artist ID and an artist names-IDs items.
2025-08-06 v3.3 Importing of Part of a Compilation and Single were not setting 0 or 1. The values may have been symbolic.

Download


Back to Yate Resources