Swiftpack.co - rryam/MusadoraKit as Swift Package

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
See all packages published by rryam.
rryam/MusadoraKit v4.2.0
The ultimate companion to MusicKit.
⭐️ 291
🕓 2 days ago
iOS macOS watchOS tvOS
.package(url: "https://github.com/rryam/MusadoraKit.git", from: "v4.2.0")

MusadoraKit

MusadoraKit (pronounced 'myu' za' 'do' 'ra') is the ultimate companion to MusicKit. Working with MusicKit and Apple Music API is much easier, with one-liner APIs for effortless implementation.

MusadoraKit Logo

MusadoraKit is a Swift framework that uses the latest MusicKit and Apple Music API, making it easy to integrate Apple Music into your app. It uses the new async/await pattern introduced in Swift 5.5. Currently, it is available for iOS 15.0+, macOS 12.0+, watchOS 8.0+ and tvOS 15.0+. There are new methods coming every month to support iOS 16, macOS 13, watchOS 9 and tvOS 16 features. The framework now also supports iOS 17, macOS 14, watchOS 10, tvOS 17 and visionOS 1.0.

It goes well with my book on Exploring MusicKit and Apple Music API, as all the documentation and references are mentioned in the book. Otherwise, the code itself is well documented.

Also, join the Discord Community for discussing anything about MusadoraKit, the book "Exploring MusicKit", MusicKit or your favorite music!

Exploring MusicKit and Apple Music API Book

You can support my open-source by buying my book, "Exploring MusicKit and Apple Music API". 2 books a day, and I can happily continue working on MusadoraKit.

Sponsors

PlaylistAI Logo

PlaylistAI by Brett Bauman

Documentation using DocC

Musadora Sample App

I am open-sourcing an app I worked on last year called Musadora. (MusadoraKit started as RRMusicKit for the Musadora app!)

I am slowly adding all the methods used in MusadoraKit to it, so you can refer to how easy it is to use the Swift package.

Apps Using MusadoraKit

  • Sonar: Music & Community. Stream, Share & Discover
  • Tuneder: An open-source iOS app that helps Apple Music users discover new songs with a Tinder-like UI.
  • Musadora: Apple Music client focused on playlists
  • Musadora Labs: A companion app to explore MusicKit
  • Euphonic: Apple Music client focused on recommendations

Start Working with MusicKit

Follow the steps below to setup MusicKit for your app:

Step 1: Enable MusicKit for Your Bundle Identifier

  1. Visit the Apple Developer Portal.
  2. Navigate to Certificates, Identifiers & Profiles.
  3. Select Identifiers from the left panel.
  4. Find your App's Bundle Identifier from the list and select it.
  5. Under Services, ensure MusicKit is enabled. If not, enable it.

Step 2: Add NSAppleMusicUsageDescription to Info.plist

To inform the user why your app requires access to their media library, add NSAppleMusicUsageDescription to your Info.plist file.

  1. Open your project in Xcode.
  2. Select Info.plist from the Project Navigator.
  3. Click on the + button to add a new key.
  4. Add NSAppleMusicUsageDescription as a key.
  5. Set its value to the reason why your app needs access to Apple Music, e.g., Our app uses Music access to play music and create a pleasant experience..

Step 3: Request Authorization for Apple Music

Before your app can interact with Apple Music, it needs to request the user's authorization. This can be done using MusicAuthorization.request().

Here's a Swift code example:

import MusicKit

class MusicAuthorizationManager: ObservableObject {
    @Published var isAuthorizedForMusicKit = false
    @Published var musicKitError: MusicKitError?

    func requestMusicAuthorization() async {
        let status = await MusicAuthorization.request()

        switch status {
        case .authorized:
            isAuthorizedForMusicKit = true
        case .restricted:
            musicKitError = .restricted
        case .notDetermined:
            musicKitError = .notDetermined
        case .denied:
            musicKitError = .denied
        @unknown default:
            musicKitError = .notDetermined
        }
    }
}

This MusicAuthorizationManager class checks the authorization status for MusicKit. If the user grants authorization, isAuthorizedForMusicKit is set to true. If access is denied or restricted, or if the status is not determined, an appropriate MusicKitError is set.

Remember to call requestMusicAuthorization() at an appropriate time in your application flow to request the user's authorization.

Catalog

To easily access the Apple Music Catalog, you can use pre-defined methods from MusadoraKit. The methods are similar across the music items.

Example of working with fetching a catalog song by its identifier:

let song = try await MCatalog.song(id: "1613834314", with: [.albums])

Searching the Catalog

Example of searching the catalog:

let searchResponse = try await MCatalog.search(for: "the weeknd", types: [.songs, .stations, .albums, .playlists, .artists], limit: 10)

print(searchResponse.songs)
print(searchResponse.artists)

Library

While this is natively not available in MusicKit, you can fetch library resources using MusadoraKit that uses Apple Music API under the hood. The method are similar across the music items.

Example of fetching all library songs in alphabetical order:

let songs = try await MLibrary.songs()

Example of searching the user's library:

let searchResponse = try await MLibrary.search(for: "hello", types: [Song.self])

print(searchResponse.songs)

Recommendations

You can take advantage of Apple's Music recommendation system and use it in your app. For example, to fetch the default recommendations:

let recommendations = try await MRecommendation.default()

guard let recommendation = recommendations.first else { return }

print(recommendation.albums)
print(recommendation.playlists)
print(recommendation.stations)

History

You can also fetch historial data from the user's library. For example, to get the recently played resources:

let recentlyPlayedItems = try await MLibrary.recentlyPlayed()

let recentlyPlayedAlbums = try await MLibrary.recentlyPlayedAlbums()
}

Referencing content across different geographical regions

In the example below, the target storefront is "tw" for Taiwan:

let album = MCatalog.album(id: "1223618217")
let equivalentAlbum = try await album.equivalent(for: "tw")

let albums = MCatalog.albums(ids: ["1223618217", "1603171516"])
let equivalentAlbums = try await albums.equivalents(for: "tw")

Explicit to clean-equivalent content:

let song = MCatalog.song(id: "1603171970")
let cleanSong = try await song.clean

let songs = MCatalog.songs(ids: ["1603171970", "1531327246"])
let cleanSongs = try await songs.clean

MusicCatalogResourcesRequest:

To fetch multiple catalog music items by their identifiers in the same request. For example:

let request = MusicCatalogResourcesRequest(types: [.songs: ["1456313177"], .albums: ["1531125029", "1575203352"]])
let response = try await request.response()

print(response.songs)
print(response.albums)

MusicLibraryResourcesRequest:

To fetch multiple library music items by their identifiers in the same request. For example:

let request = MusicLibraryResourcesRequest(types: [.songs: ["i.pmzqzM0S2rl5N4L"], .playlists: ["p.PkxVBgps2zOdV3r"]])
let response = try await request.response()

print(response.songs)
print(response.playlists)

I hope you love working with MusadoraKit!

GitHub

link
Stars: 291
Last commit: 2 days ago
Advertisement: IndiePitcher.com - Cold Email Software for Startups

Release Notes

Version 4.2.0
2 days ago

New in This Release

Removed MusadoraLabsKit

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics