Meet MusicKit for Swift

RSS for tag

Discuss the WWDC21 session Meet MusicKit for Swift.

View Session

Posts under wwdc21-10294 tag

49 results found
Sort by:
Post not yet marked as solved
271 Views

Any way to check if song is in Library with MusicKit? ?relate=library not working for me

For my app that heavily uses both ShazamKit and MusicKit, I need to be able to check if the matched song is in the user's library or not. I couldn't find an easy way to do this with MusicKit so I first then turned to the Apple Music API as they introduced the new parameter ?relate=library during this year's WWDC. When I first tried it, it worked as expected, and was very happy to have gotten it to work. However, it stopped working lately and now I turned to use MPMediaLibrary as that still works but is a lot slower in performance. Anyone has any idea why the ?relate=library stopped working for me or know a better way to check if the Song exists in the user's library? func checkInLibrary(from appleMusicID: String) async { do { let countryCode = try await MusicDataRequest.currentCountryCode let libURL = URL(string: "https://api.music.apple.com/v1/catalog/\(countryCode)/songs/\(appleMusicID)?relate=library")! let request = MusicDataRequest(urlRequest: URLRequest(url: libURL)) let dataResponse = try await request.response() print(dataResponse.debugDescription)               } catch { // I'm handling errors here }}
Asked Last updated
.
Post not yet marked as solved
308 Views

Cache SwiftUI ArtworkImage

Hi, is there a way to cache the data from the SwiftUI ArtworkImage across App starts and maybe even for offline use? Best regards Julian
Asked
by juka1205.
Last updated
.
Post marked as solved
419 Views

Having trouble getting MusicKit Data into my SwiftUI view

Having trouble getting the data from MusicKit Searches back to my SwiftUI view. Normally I would use a @State variable for the decodable structure, but with MusicKit you dont need to decode anything and I can't figure out how to best get the data back to my view. I call the MusicKit function using .onAppear in my SwiftUI view func getAlbum() async throws -> MusicItemCollection<Album> {         var request = MusicCatalogResourceRequest<Album>(matching: \.id, equalTo: "1440881121")         let response = try await request.response()         print(response.debugDescription)         return response.items        printing debugDescription give these results: MusicCatalogResourceResponse<Album>(   items: [     Album(       id: "1440881121",       title: "Colors",       artistName: "Beck",       contentRating: "explicit",       copyright: Fonograf Records/Capitol Records; ℗ 2017 Fonograf Records, under exclusive license to UMG Recordings, Inc.,       genreNames: [         "Alternative",         "Music"       ],       isCompilation: false,       isComplete: true,       isDigitalMaster: true,       isSingle: false,       releaseDate: "2017-10-13",       trackCount: 11,       upc: "00602557176827" Hoe would you access all of the data in the debugDescription and use it in your SwiftUI view? I can only access the standard name and id. Is anyone using Codable to move the data through a data model? The documentation is not making sense to me even though I am usually ok using it. Also, should I be using `func getAlbum() async throws -> MusicCatalogResourceResponse {' instead of using MusicItemCollection? Thanks
Asked Last updated
.
Post not yet marked as solved
99 Views

Using MusicItemID

I have two questions related to the id for Playlist and Song. (1) There are two properties named id in each type. One is defined to be a MusicItemID and one is an ObjectIdentifier. How does one distinguish between them? What is the difference in how we are two use them. (2) Suppose the user has built a custom playlist of Song items in my app. Should I persist the MusicItemID and then retrieve the Song later using a MusicCatalogResourceRequest? It's a fun API to play with but there's little documentation. Thank you, Daniel
Asked Last updated
.
Post not yet marked as solved
128 Views

ApplicationMusicPlayer automatically turns Shuffle Mode On

Hi all, I am playing songs via ApplicationMusicPlayer with MusicKit for Swift and I am running into an issue where shuffle mode is sometimes automatically turned on. Even though there was no code related to shuffle mode. Here's a snippet //myQueue is an array of Tracks let player = ApplicationMusicPlayer.shared player.queue = ApplicationMusicPlayer.Queue(for: myQueue) // player.state.shuffleMode = .off // I tried explicitly setting shuffle mode off, which has no effect try await player.play() This issue is not easily reproducible, it occurs rarely and at random. But once this issue occurs it persists even after uninstalling and reinstalling the app. When I tried it to reproduce it with another device and everything works properly. Anyone else running into this issue? For Apple Engineers, here is the ticket: FB9816030
Asked Last updated
.
Post marked as solved
152 Views

How to get recommendations based on multiple tracks?

Hello, I am trying to get recommendations based on the identifier of multiple tracks. But I am unable to get any results Here is the code I have used to try to get recommendations based on one album let dataRequest = MusicDataRequest(urlRequest: URLRequest(url: URL(string: "https://api.music.apple.com/v1/me/recommendations/1571344275")!)) let dataResponse = try await dataRequest.response() For this I am getting the response: Failed to perform MusicDataRequest.Context(   url: https://api.music.apple.com/v1/me/recommendations/1571344275,   currentRetryCounts: [.other: 1] ) with MusicDataRequest.Error(   status: 404,   code: 40400,   title: "Resource Not Found",   detailText: "Resource with requested id was not found", I have tried used the identifier of songs/albums, to no success. What am I doing wrong?
Asked Last updated
.
Post marked as solved
708 Views

Cannot decode library songs response for a non-Apple Music item

Hi there! I am fetching library songs using the endpoint: https://api.music.apple.com/v1/me/library/songs Here's the code snippet - struct Songs: Decodable { let data: [Song] } public func librarySongs() async throws { let url = URL(string: "https://api.music.apple.com/v1/me/library/songs")   guard let url = url else { return }   let dataRequest = MusicDataRequest(urlRequest: URLRequest(url: url)) do { let dataResponse = try await dataRequest.response() print(dataResponse.debugDescription) let response = try JSONDecoder().decode(Songs.self, from: dataResponse.data) } catch { print("**ERROR**") print(error) print(error.localizedDescription)     } } Trying to decode it using a custom struct gives me the following error. - **ERROR** keyNotFound(CodingKeys(stringValue: "artistName", intValue: nil), Swift.DecodingError.Context(codingPath: [CodingKeys(stringValue: "data", intValue: nil), _JSONKey(stringValue: "Index 20", intValue: 20), CodingKeys(stringValue: "attributes", intValue: nil)], debugDescription: "No value associated with key CodingKeys(stringValue: \"artistName\", intValue: nil) (\"artistName\").", underlyingError: nil)) The data couldn’t be read because it is missing. On digging through the response, I found that one of the songs doesn't have an artist name because it is just a recording of my song I added to the library through GarageBand. In this case, what should be the approach?
Asked
by snuff4.
Last updated
.
Post not yet marked as solved
226 Views

MusicKit Custom Data Request

Hi, I am trying to use MusicDataRequest from MusicKit to get the user's library artists (https://api.music.apple.com/v1/me/library/artists). This works well, until I am trying to use pagination with it. The data returned by this endpoint contains a "next" property, which reads /v1/me/library/artists?offset=25. Replacing the URL as such resulting in https://api.music.apple.com/v1/me/library/artists?offset=25 no longer works, as the request returns an error: MusicDataRequest.Error( status: 400, code: 40008, title: "Invalid Path Value", detailText: "Unknown library resource type 'artists?offset=25'", ... ) It seems like the request cannot handle query parameters and considers them as part of the request's path. Is there any way to use query parameters with MusicDataRequest? Thanks for any response.
Asked Last updated
.
Post marked as solved
277 Views

Not getting results when searching MusicKit using MusicDataRequest

I am trying to use MusicDataRequest to search for albums, artists, and tracks using a search term like the album's names. If I use an albums Id, for example, I get results. The following code gets me results. First is the data model, the I have a class with code for authorization and then the function that searches using Music Kit struct MyAlbumResponse: Decodable {     let data: [Album] } class music {     @State var isAuthorizedForMusicKit = false     var searchTerm = ""     func requestMusicAuthorization() {         Task.detached {             let authorizationStatus = await MusicAuthorization.request()             if authorizationStatus == .authorized {                 self.isAuthorizedForMusicKit = true             } else {                 }             }         } func album() async throws {         let auth = requestMusicAuthorization()         let url = URL(string: "https://api.music.apple.com/v1/catalog/US/albums/1440881121")!         let dataRequest = MusicDataRequest(urlRequest: URLRequest(url: url))         let dataResponse = try await dataRequest.response()         let decoder = JSONDecoder()         let albumResponse = try decoder.decode(MyAlbumResponse.self, from: dataResponse.data)         print(albumResponse.data)     } The above code returns the results I expect. But If I change the function to use the search endpoint, I do not get any results. I dont get any errors either. The data model is also different. struct AlbumSearchResponse: Decodable {     var albums: Albums }      struct Albums: Codable {     var data: [AlbumsDatum]     var href, next: String } struct AlbumsDatum: Codable {     var attributes: Attributes     var href, id, type: String } struct Attributes: Codable {     var artistName: String     var artwork: Artwork     var copyright: String     var genreNames: [String]     var isComplete, isMasteredForItunes, isSingle: Bool     var name: String     var playParams: PlayParams     var releaseDate: String     var trackCount: Int     var url: String     var editorialNotes: EditorialNotes? } class music {     @State var isAuthorizedForMusicKit = false     var searchTerm = ""          func requestMusicAuthorization() {         Task.detached {             let authorizationStatus = await MusicAuthorization.request()             if authorizationStatus == .authorized {                 self.isAuthorizedForMusicKit = true             } else {                                                       }             }         } func musicSearch() async throws {         var auth = requestMusicAuthorization()         let url = URL(string: "https://api.music.apple.com/v1/catalog/us/search?term=colors&limit=10&types=albums")!         let dataRequest = MusicDataRequest(urlRequest: URLRequest(url: url))         let dataResponse = try await dataRequest.response()         let decoder = JSONDecoder()         let albumSearchResponse = try decoder.decode(AlbumSearchResponse.self, from: dataResponse.data)         print(albumSearchResponse.albums)         } I have gone through all of the documentation and example applications but can't find an answer to this. I dont understand why the search endpoint would be not usable, if that is the case. The workaround I have been using is to use MusicCatalogSearchRequest instead, but this does not return enough attributes and I cannot figure out how to have it return more attributes such as totalTracks, copyright, etc. I would be fine using the method if there is a way to add attributes to be included with the results. Here is the code I am using that works. It is also under the same class as the other functions. func Search() async throws {         let auth = requestMusicAuthorization()         let searchTerm = "colors"         Task {                 do {                     // Issue a catalog search request for albums matching the search term.                     var searchRequest = MusicCatalogSearchRequest(term: searchTerm, types: [Album.self])                     searchRequest.limit = 20                     let searchResponse = try await searchRequest.response()                     print(searchResponse)                 }             }         } any and all help is much appreciated. Thanks
Asked Last updated
.
Post marked as solved
234 Views

Track vs Song and Disc Numbers

I'm trying to construct what I would consider a tracklist of an Album from MusicKit for Swift, but the steps I've had to take don't feel right to me, so I feel like I am missing something. The thing is that I don't just want a bag of tracks, I want their order (trackNumber) AND what disc they're on (discNumber), if more than one disc. At the moment, I can get to the tracks for the album with album.with([.tracks]) to get a (MusicItemCollection<Track>), but each Track DOES NOT have a discNumber. Which means, in multi disc Albums all the tracks are munged together. To get to the discNumber's, I've had to get an equivalent Song using the same ID, which DOES contain the discNumber, as well as the trackNumber. But this collection is not connected to the Album strongly, so I've had to create a containing struct to hold both the Album (which contains Track's) and some separate Song's, making my data model slightly more complex. (Note that you don't appear to be able to do album.with([.songs]) to skip getting to a Song via a Track.) I can't get my head around this structure - what is the difference between a Track and a Song? I would think that the difference is that a Track is a specific representation on a specific Album, and a Song is a more general representation that might be shared amongst more Album's (like compilations). But therefore, surely discNumber should actually be on the Track as it is specific to the Album, and arguably Song shouldn't even have trackNumber of it's own? In any case, can anyone help with what is the quickest way to get get the trackNumber's and discNumbers' of each actual track on an Album (starting with an MusicItemID) please? var songs = [Song]() let detailedAlbum = try await album.with([.tracks]) if let tracks = detailedAlbum.tracks { for track in tracks { let resourceRequest = MusicCatalogResourceRequest<Song>(matching: \.id, equalTo: track.id) async let resourceResponse = resourceRequest.response() guard let song = try await resourceResponse.items.first else { break } songs.append(song) } }
Asked
by hepto.
Last updated
.
Post marked as solved
712 Views

How to get the album info for a song fetched by MusicDataRequest?

I'm slowly learning the new MusicKit beta for swift. I've learned to successfully retrieve tracks of type Song using MusicDataRequest, using the following: ... let countryCode = try await MusicDataRequest.currentCountryCode if let url = URL(string: "https://api.music.apple.com/v1/catalog/\(countryCode)/songs?filter[isrc]=\(isrc)") {   let dataRequest = MusicDataRequest(urlRequest: URLRequest(url: url))   let dataResponse = try await dataRequest.response() ... However, when I decode the data, there does not seem to be any album information that I can see. I've tried adding includes=albums to the URL, but I don't think that's the right approach, because when I veiw the Song struct in MusicKit, I don't see a reference to an Album type anywhere. Any advice on how to retrieve the album information would be most appreciated. Thanks.
Asked Last updated
.
Post not yet marked as solved
138 Views

MusicKit search for the new Siri playlists

How do we use MusicKit to search for the new Siri playlists for mood etc? I understand that Voice subscribers can't search for songs using API searches - I'm asking a question in the opposite direction. If full subscribers know the names of the new playlists they can access and play them - are there searches that will surface them? Thank you Daniel
Asked Last updated
.
Post not yet marked as solved
282 Views

MusicKit business questions

Hi, Given yesterday's announcement of a new subscription I have some business/permissions questions about apps built on MusicKit. If this is not the place to ask them can you please direct me to where would be more appropriate. (1) When we test to see if someone has a subscription, is there any difference between a Voice subscription and a regular subscription? i.e. will we be able to query and vend any song in Apple Music if the user has a Voice sub the same way we can if they have an individual or family sub? (2) Can our app require that they have some sort of subscription or do we have to provide functionality even if they don't? (3) If I read the agreement correctly, we can't store music for offline listening but we can create and use a playlist in Music. Is there a way to prompt the user to download the music to this playlist? Thank you, Daniel
Asked Last updated
.
Post marked as solved
285 Views

Playing Songs and Albums with MusicKit (Bug?)

Hi, I am trying to use MusicKit for playing a song or an album. I am using the following code for it: Tested on iPhone 11 Pro, iOS 15.0.1 @MainActor private func play<I: PlayableMusicItem>(_ item: I) async throws { let systemPlayer = SystemMusicPlayer.shared if !systemPlayer.isPreparedToPlay { try await systemPlayer.prepareToPlay() } let queue = systemPlayer.queue try await queue.insert(item, position: .afterCurrentEntry) try await systemPlayer.play() } Before I was using the "oldschool" way using the MusicPlayer framework as follows: @MainActor private func playOldschool(identifier: String) { let systemPlayer = MPMusicPlayerController.systemMusicPlayer if !systemPlayer.isPreparedToPlay { systemPlayer.prepareToPlay() } systemPlayer.setQueue(with: [identifier]) systemPlayer.play() } Both have been tested under the same conditions (permissions, same MusicSubscription), however the one using MusicKit does not seem to work well as try await systemPlayer.prepareToPlay() fails. If I remove the prepareForPlay code, it fails on play() with the same message and error as prepareForPlay. The logs show this: [SDKPlayback] prepareToPlay failed [no target descriptor] Error Domain=MPMusicPlayerControllerErrorDomain Code=1 "(null)" I could not find anything for that error domain and code 1, however prepareToPlay fails even in playOldschool, if I use the async variant of the function. At the moment I am staying with playOldschool, because that actually plays music. I wonder if I should file a radar for this or if there is any additional requirement for MusicKit that I haven't fulfilled causing it to fail. Any help is appreciated!
Asked Last updated
.
Post marked as solved
172 Views

Understanding .musicSubscriptionOffer view modifier

Hi, I am trying to implement the new view modifier to show a subscription view for AppleMusic. In the #wwdc-10294 (Meet MusicKit for Swift) talk, the use case is very clear and it makes sense. We have an album and if the user wants to play it without an active subscription, we show toggle the binding that makes the view appear. However, using a single boolean removes flexibility so I am trying to figure out the following: I have two buttons: "Play" and "Add", which will either play the album as in the talk or add it to the user library using the Apple MusicAPI. In both cases if there is no subscription, I'd like to show the offer. This means I will have two different MusicSubscriptionOffer.Options configuration, one where the messageIdentifier is .playMusic and the other one .addMusic. This also means that I need to use two viewModifiers .musicSubscriptionOffer resulting in two different bindings (otherwise I assume both view controllers will show when the binding changes?). Worst case is if I show a list of songs and want to have options for .playMusic and .addMusic for each song, then I need a dynamic amount of bindings for the view modifier. Would I need to handle this like list bindings? Ideally I'd like an API that allows me to pass in an enum and provide options based on the enum cases like other SwiftUI API (like .sheet). This would allow for dynamic options and only requiring one single .musicSubscriptionOffer. Is there any solid solution for this at the moment? Any insights would be helpful, thanks!
Asked Last updated
.