MusicKit for Swiftについて

MusicKit for Swiftについて

MusicKitによって、Apple MusicをAppに簡単に統合することができます。このSwiftベースのフレームワークにおける、コンテンツの検索、リクエスト、再生など、MusicKitの基本的な使い方を説明します。また、Apple Musicにまだ登録していない人がいる場合に、音楽サブスクリプションのワークフローをAppに組み込む方法についても解説します。

リソース
関連ビデオ

WWDC22
- MusicKitでコンテンツをさらに見つける
WWDC21
ダウンロード

WWDCへようこそ Joelです本日はMusicKitを使い Appに音楽を追加する方法についてお話しします MusicKitはAppleプラットフォームの新フレームワークで AppがSwiftの音楽にアクセスするためのエクスプレッシブAPIを提供しますこれはSwiftUIと併用するために一から設計された新しいSwift並行構文を活用するものです MusicKitはAppが Apple Musicの多様なカタログコンテンツにアクセスするためのサーバーサイドAPIである Apple Music APIとの連携を加速するため Apple Musicに直結する魅力的なAppの構築をより簡単にしますまず MusicKitで音楽コンテンツをリクエストする方法についてお話しします次にAppがApple Musicと連携する方法に関して重要な以下のその他のトピックに関してお話します AppがApple Music関連データにアクセスするためのユーザーの同意のリクエスト方法や Apple Music APIのアクセスに必要なトークンの管理方法サブスクリプション情報と関連機能へのアクセス方法 Apple Musicカタログからの音楽の再生方法そして最後にユーザーがまだサブスクリプションしていない場合に Apple Musicのサブスクリプションオファーを表示する方法です MusicKitは音楽アイテムのアクセス用の新しいモデルレイヤと Apple Music APIからのコンテンツのフェッチを許可する構造化リクエストを提供します Apple Musicカタログでコンテンツを検索するか特定のフィルタに基づきリソースをフェッチできますこれらのリクエストはページネーションのサポートが内蔵され初期応答からアイテムの次のバッチを取得するグループ化されたアイテムのコレクションとして応答を生成しますではこの音楽アイテムとはどういうものでしょう？ Albumを使って具体的な例を見てみましょう “Album”とは値型でプロパティが３つのカテゴリに分類されています最初のカテゴリには次の簡単な属性が含まれています “title”などの文字列プロパティ “isCompilation”などのブーリアンプロパティあるいはアートワークのURLや関連のサイズ色などの情報にアクセスできるartwork のようなより構造化されたプロパティがありますアルバムは関連のアーティストやジャンル特定のアルバムの曲目などいくつかの関係も提供しますたとえば“tracks”の関係の結果は別の音楽アイテムのタイプである “track”タイプの値のコレクションです最後にこれらの強いモデルレベルの関係に加えて “Album”は関連コンテンツの弱い関連付けも提供します関連付けは関係と類似しますが通常一時的なものかエディターベースのものですたとえばあるアルバムの ”appearsOn"の関連付けはプレイリストのコレクションを返しますが関係のコレクションとは異なりタイトルも含まれています MusicKitを使用した関係の読み込みとアクセスは非常に簡単ですアルバムの“artists”や “tracks”などの関係を含むこの同じアルバムの別の表現や “related albums”などの関連付けを単一の演算で簡単にフェッチできます “with”メソッドは“await”という特別なSwiftキーワードで呼び出す必要があり裏で非同期演算を行うことを示していますこれはApple Music APIからネットワーク経由でこのアルバムのより完全な表現をフェッチします次にこの詳細なアルバムから曲目を取得し通常の配列のようにこれらの曲を反復しますこちらがこのコードのコンソール出力です “related albums”などの関連付けへのアクセスは同じように機能しますが唯一の違いは通常直接コレクションからアクセス可能なタイトルが含まれている点ですコレクションを同じ方法で反復すれば関連のアルバムをプリントできますこちらがこのコードのコンソール出力ですでは MusicKitで音楽のコンテンツをリクエストするデモを見てみましょう Apple Musicからアルバムを検索して楽しめるAppを作成中です検索フィールドを使ってアルバムを検索できますこれは音楽カタログ検索リクエストを使い一致する検索結果を読み込むコードにすでに接続されていますこのAppは最近表示したアルバムのリストを記録します “Catch A Vibe - EP”というアルバムの情報を得るにはこれを選択しますそうするとこのアルバムの曲目がこの詳細ビューが表示された後に表示されますこれはこのアルバムの “tracks”関係を読み込むことで行われ SwiftUIビューの状態変数を更新しこのリストを追加するのに使用されますアートワークの下にある再生ボタンを押すか特定の曲を選択すればこのアルバムを聴くことができますこれはMusicKitの再生APIを使用しこの曲目でキューを設定しプレイヤーの再生メソッドを呼び出しますでは試してみましょう Karun & MONBRUの “Catch a Vibe”という曲を選択します曲が再生されています ♪ オーオーノー ♪ このAppはロック画面のメディアコントロールで自動的に動作し曲の真ん中まで早送りできます
しかし僕のやりたいことは CDライブラリからたとえばこのPhoenixのアルバムなど古い音楽を再発見することですなのでiPhoneのカメラを古いCDのバーコードに向け Appがこのアルバムのデジタル版を見つける機能を追加したいと思いますこの機能の実験的なコードはすでに追加していますこれを有効にすると下部にバーコードボタンが表示されカメラビューを呼び出しますこのCDのバーコードにカメラを向けると自動的にバーコード値を認識して表示しますあとはMusicKitを使用して同じアルバムを検索するコードが必要なだけですではそれをAppに追加しましょう MusicCatalogResourceRequestで albumsRequestを行います探したいのはアルバムです
ここではバーコードの技術的用語 Universal Product Code いわゆるUPCプロパティが equalTo: detectedBarcode のアルバムを検索しますこれを非同期でリクエストできます
albumsRequest.response
そしてこの応答から検出された最初のアルバムを見ます
次のこの最初のアルバムを下部のヘルパーメソッド handleDetectedAlbumにパスします
handleDetectedAlbum (firstAlbum)
このメソッドはバーコードスキャンビューを却下し検知されたアルバム詳細ビューをプッシュします
そしてメインスレッドで実行されるよう MainActorで装飾されますですのでこれを呼び出す場合 awaitキーワードを必ず追加しましょう
これを構築し再び Appで実行してみましょう
バーコードボタンをタップしアルバムをかざすと
成功しました！
これでApple Music上で昔の音楽をデジタル形式で簡単に楽しめるようになりました MusicKitは一般的な目的のデータリクエストも提供し構造化されたリクエストとは異なり独自のURLを使用して任意のApple Music APIエンドポイントからコンテンツを読み込むことができます
このリクエストで得るのは Apple Music APIからの JSON応答の生データですこれをJSONDecoderで解読する必要がありますが難しくはありませんなぜなら既存の音楽アイテムタイプが Codableプロトコルと一致し活用できるからです例を見てみましょう Apple Musicの人気のジャンルをリストで表示したい場合この特定のURLでコンテンツを読み込むことができますこちらが対応するJSON応答ですこの結果を詳しく見るとジャンルのリソースのようなものが真ん中にありますではこれをSwiftで表現するにはどうすればいいでしょう　案の定MusicKitには Genreタイプがありますでは応答全体を Swiftで表現するには？ジャンルの簡単な配列であるデータメンバーで構造体を作成できますこの構造体を必ず Decodableにしてくださいこれには追加のデコードロジックを書く必要はありません “Genre”自体がDecodableに適合するからですこのデータをAppに読み込むにはこの構造体をファイルの最上部に配置しユーザーの国コードを使用して URLを構築します先ほどと同じパターンに従ってこのURLを使用して音楽データを作成しそこから応答を得ます応答を得たらデコードメソッドに MyGenresResponseタイプでパスし JSONDecoderでデータを解読します以上です！これで強く型付されたジャンル応答で個々のジャンルにアクセスできますご覧のとおりMusicKitの他のリクエストでフェッチできるのと同じ音楽アイテムを取得できますこれがApple Music APIの任意のURLから音楽コンテンツを読み込む方法でした音楽アイテムの読み込み方法がわかったところで AppとApple Musicの連携における重要な事前ステップについてお話ししますまずはプライバシーからどのAppがユーザーの個人情報にアクセスするのかをユーザーが管理できることが重要ですユーザーの再生履歴やミュージックライブラリを含むApple Music APIのデータをリクエストする前に AppがApple Musicにアクセスするためにはユーザーのインフォームドコンセントが必要ですこのユーザーの同意はデバイスごとかつAppごとに得る必要がありますこれはZovaというAppでの同意に関するダイアログの例です Apple Musicまたはユーザー自身のプレイリストで音楽を再生しながらワークアウトができるすばらしいAppですこれを使用して初めてワークアウトする時 ZovaはApple MusicへのアクセスをリクエストしますこのダイアログではなぜAppが Apple Musicにアクセスする必要があるのか理由を伝えなければいけませんそのため Appの Apple Musicの使用説明を Info.plistで定義する必要がありこのダイアログのサブタイトルとして表示されますこれはMusicKit向けのユーザー同意をリクエストする例です Appに MusicKitを必要とする機能があるとしますそして isAuthorizedForMusicKit 状態変数を使用しこの機能へのアクセスをゲーティングするとしましょう MusicKitの使用を試みる前に適切なポイントでこの非同期のリクエストメソッドを使用し Apple Musicへのアクセスの許可をリクエストしますこれはユーザーがまだ同意していない場合のみプロンプトされますリクエストメソッドは状態値を返し状態が“authorized”に等しい場合 isAuthorizedForMusicKit 変数を“true”に設定します Apple Music APIからデータを読み込む際に必要なトークンについて簡単に説明します Apple Music APIには AppをAPIで認証するデベロッパトークンが必要です以前このデベロッパトークンを得るにはデベロッパポータルで MusicKit秘密鍵を作成してサーバーに配備し鍵の非公開に保つため自己管理しサーバから新しいデベロッパトークンをリクエストする必要がありましたしかし現在 SwiftのためのMusicKitならデベロッパトークンはAppで自動的に生成されるためこれらについて心配する必要がなくなりました単にデベロッパポータルに登録してこの自動動作をオプトインするだけです具体的に説明すると App IDを登録したページで下部のApp Servicesを選択し「MusicKit」チェックボックスを有効にすれば完了ですさらにApple Music APIはパーソナライズされたエンドポイントにトークンを必要としますデベロッパトークンと同様今年ユーザートークンも自動的に生成されるようになりました AppでのMusicKitの使用でもう１つ必要なのはユーザーがApple Musicをサブスクリプション登録しているかどうかを知る方法です MusicKitのサブスクリプション情報は３つの特徴的な特性で把握されますユーザーがApple Musicカタログから音楽を再生できるか iCloud Music Libraryが有効になっているかそして有効なサブスクリプションがない場合サブスクリプション登録者になれるかどうかです
AppのApple Music関連の機能に適した特性を確認してくださいたとえば音楽を再生するための再生ボタンがある場合ユーザーがApple Musicのカタログコンテンツを再生できない場合ボタンを無効にするべきですビューの状態変数を定義し音楽サブスクリプションを追跡できますそして無効化の修飾子をボタンに適用し音楽サブスクリプションプロパティの "canPlayCatalogContent" が“false”なら無効のままになるようにしますそして最後に新規タスク修飾子にパスされた非同期ブロックの中で新しいサブスクリプション更新ストリームを使用して音楽サブスクリプションの変更の通知を受けることができます次はMusicKitを使った再生についてです MusicKitは２つのプレイヤーを提供します SystemMusicPlayerと ApplicationMusicPlayerです例を使ってこれらの違いを説明しましょうソーシャルメディアAppはシステム音楽Appで再生される音楽を SystemMusicPlayerで変更することを好みフィットネスAppはシステム音楽Appから完全に独立して再生状態を維持するため ApplicationMusicPlayerを好む場合がありますどちらのプレイヤーも自動的に “再生中”の情報を報告し遠隔コマンドを処理しますこれが前半でお話ししたロック画面でシステムメディアコントロールとの深い連携を可能にしましたしかし“再生中”Appは異なるものを報告しています SystemMusicPlayerを使用した場合 Music Appが“再生中”Appとして報告されます ApplicationMusicPlayerを使用した場合皆さんのAppが“再生中”Appとして報告されます再生キューの所有権も異なります SystemMusicPlayerでは皆さんのAppは単にシステムの Music Appのリモコン的役割ですが ApplicationMusicPlayerでは完全に異なる再生キューを所有していますどちらのプライヤーも１つ以上のアイテムをキューに設定し次に再生や後で再生に追加できますただし真ん中にアイテムを挿入したり以前追加したアイテムを削除したりするなどの追加のコントロールが行えるのは ApplicationMusicPlayerのみです最後にユーザーがまだ Apple Musicの登録者でない場合デベロッパのApp内でApple Musicを無料で試してもらうことができますそうすれば皆さんが努力して改善したすべての機能を試してもらうことができますサブスクリプションオファーは曲の再生などの Appの機能性をうまく伝えるためにユーザーへのメッセージを調整して提供できます
さらにコンテクストを加えて特定の曲やアルバムプレイリストをハイライトすることもできます
Appでサブスクリプションオファーシートを使用することで Apple Musicの新規登録者の獲得時に Apple Services Performance Partners Programという提携プログラムを通してリワードがもらえます App内の音楽サブスクリプションオファーにコンテクストを追加するには先ほど紹介したように音楽サブスクリプションを追跡する必要がありますまたオファーが表示されているかを追跡するために状態変数が必要となりますアルバムのIDをサブスクリプションオファーオプションの itemIDプロパティにパスするとしましょう音楽サブスクリプションで canBecomeSubscriberが “false”の場合はオファーボタンを無効にします次に isShowingOfferプロパティにバインディングした musicSubscriptionOffer 修飾子を使用しオプションも含みます最後にisShowingOffer 変数を“true”にします Appに戻ってApple Musicのコンテクストを追加したオファーを見てみましょうデモの前半ですでに有効な Apple Musicサブスクリプションにサインインしています Apple Music サブスクリプションオファーのシナリオを再現するために設定画面に移動しアカウントからサインアウトします
Appに戻ると再生ボタンが無効になりApple Musicにユーザーを招待するためのボタンが追加されていますこのボタンをタップするとサブスクリプションオファーが表示され Appで先ほど見たアルバムカバーがハイライトされていますこのようにしてユーザーが皆さんのApp内で Apple Musicの無料トライアルを開始できます結論として多くのAppは音楽を追加することでユーザー体験を強化できますたとえばゲームのムードに合った BGMを再生してより没入型のゲーム体験にしたりテンポの早い音楽でフィットネスAppのユーザーにやる気を起こさせたりできますまたソーシャルメディアAppでは音楽でアクセントを加えたコンテンツでユーザーエンゲージメントを高められます
詳細については関連のセッションをご覧ください ShazamKitでShazamのパワーを最大限活用する方法や SwiftUIの並行処理について深く学べますご清聴ありがとうございました [パーカッシブな音楽]

2:56 - Loading and accessing relationships

// Loading and accessing relationships

let detailedAlbum = try await album.with([.artists, .tracks, .relatedAlbums])
print("\(detailedAlbum)")

if let tracks = detailedAlbum.tracks {
    print("  Tracks:")
    tracks.prefix(2).forEach { track in
        print("    \(track)")
    }
}

3:31 - Loading and accessing associations

// Loading and accessing associations

let detailedAlbum = try await album.with([.artists, .tracks, .relatedAlbums])
print("\(detailedAlbum)")

if let relatedAlbums = detailedAlbum.relatedAlbums {
    print("  \(relatedAlbums.title ?? ""):")
    relatedAlbums.prefix(2).forEach { relatedAlbum in
        print("    \(relatedAlbum)")
    }
}

9:02 - Loading top level genres

// Loading top level genres

struct MyGenresResponse: Decodable {
    let data: [Genre]
}

let countryCode = try await MusicDataRequest.currentCountryCode
let url = URL(string: "https://api.music.apple.com/v1/catalog/\(countryCode)/genres")!

let dataRequest = MusicDataRequest(urlRequest: URLRequest(url: url))
let dataResponse = try await dataRequest.response()

let decoder = JSONDecoder()
let genresResponse = try decoder.decode(MyGenresResponse.self, from: dataResponse.data)
print("\(genresResponse.data[9])")

10:49 - Requesting user consent for MusicKit

// Requesting user consent for MusicKit

@State var isAuthorizedForMusicKit = false

func requestMusicAuthorization() {
    detach {
        let authorizationStatus = await MusicAuthorization.request()
        if authorizationStatus == .authorized {
            isAuthorizedForMusicKit = true
        } else {
            // User denied permission.
        }
    }
}

12:54 - Using music subscription to drive state of a play button

// Using music subscription to drive state of a play button

@State var musicSubscription: MusicSubscription?

var body: some View {
    Button(action: handlePlayButtonSelected) {
        Image(systemName: "play.fill")
    }
    .disabled(!(musicSubscription?.canPlayCatalogContent ?? false))
    .task {
        for await subscription in MusicSubscription.subscriptionUpdates {
            musicSubscription = subscription
        }
    }
}

15:34 - Showing contextual music subscription offer

// Showing contextual music subscription offer

@State var musicSubscription: MusicSubscription?
@State var isShowingOffer = false

var offerOptions: MusicSubscriptionOffer.Options {
    var offerOptions = MusicSubscriptionOffer.Options()
    offerOptions.itemID = album.id
    return offerOptions
}

var body: some View {
    Button("Show Subscription Offers", action: showSubscriptionOffer)
        .disabled(!(musicSubscription?.canBecomeSubscriber ?? false))
        .musicSubscriptionOffer(isPresented: $isShowingOffer, options: offerOptions)
}

func showSubscriptionOffer() {
    isShowingOffer = true
}

特定のトピックをお探しの場合は、上にトピックを入力すると、関連するトピックにすばやく移動できます。

クエリの送信中にエラーが発生しました。インターネット接続を確認して、もう一度お試しください。

リソース

関連ビデオ

WWDC22

WWDC21