iOS 用 Cast Application Framework（CAF）を使用した開発のセットアップ

Cast フレームワークは iOS 14 以降をサポートし、静的フレームワークと動的フレームワークの両方で利用できます。

すべてのクラスとメソッドの説明については、Google Cast iOS API リファレンスをご覧ください。

注: 新しいバージョンの Cast iOS SDK XCFrameworks が提供されました。これにより、Apple シリコン コンピュータでの開発がサポートされます。

Xcode の設定

警告: 「Fastest, Aggresive Optimizations」に対して Apple Clang - Code Generation Optimization Level フラグを -Ofast に設定すると、最適化との互換性がないため、Cast iOS SDK を使用するアプリはクラッシュします。SDK は、「Fastest, Smallest」のデフォルト値 -Os をサポートしています。

iOS 14

iOS 14 に関する警告: iOS 14 のローカル ネットワーク アクセス権限を変更すると、Google Cast iOS SDK にさまざまな影響が及びました。アプリへの影響については、iOS 14 の変更点に関するドキュメントをご覧ください。

1. プロジェクトに Cast iOS SDK 4.8.1 を追加する

   CocoaPods を使用している場合は、pod update を使用して 4.8.1 SDK をプロジェクトに追加します。

   それ以外の場合は、 SDK を手動で取り込みます。

   注: アプリでカスタム デバイス選択ツールを構築した場合、デバイスの検出を開始するには、 GCKDiscoveryManager クラスの startDiscovery メソッドを明示的に呼び出す必要があります。Cast SDK の v4.5.0 リリース以降、自動スキャンはデフォルトで無効になりました。
2. NSBonjourServices を Info.plist に追加する

   Info.plist に NSBonjourServices を指定して、iOS 14 でのローカル ネットワークの検出が成功するようにします。

   デバイス検出を適切に機能させるには、_googlecast._tcp と _<your-app-id>._googlecast._tcp の両方をサービスとして追加する必要があります。

   appID は receiverID であり、GCKDiscoveryCriteria で定義されている ID と同じです。

   次の NSBonjourServices 定義の例を更新し、「ABCD1234」を実際の appID に置き換えます。

   <key>NSBonjourServices</key>
   <array>
     <string>_googlecast._tcp</string>
     <string>_ABCD1234._googlecast._tcp</string>
   </array>

3. Add NSLocalNetworkUsageDescription to your Info.plist

   We strongly recommend that you customize the message shown in the Local Network prompt by adding an app-specific permission string in your app's Info.plist file for the NSLocalNetworkUsageDescription such as to describe Cast discovery and other discovery services, like DIAL.

   <key>NSLocalNetworkUsageDescription</key>
   <string>${PRODUCT_NAME} uses the local network to discover Cast-enabled devices on your WiFi
   network.</string>

   This message will appear as part of the iOS Local Network Access dialog as shown in the mock.

   
4. Re-release your app to the Apple App Store

   We recommend you also re-release your app using 4.8.1 as soon as possible.

iOS 13

iOS 13 Warning: Apple permissions changes to iOS 13 and Xcode 11 have impacted the Google Cast iOS SDK in a number of ways. Please see the iOS 13 Changes document to see how your app will be impacted.

iOS 12

iOS 12 Warning: If developing using Xcode 10, the "Access WiFi Information" capability is required in order to discover and connect to Cast devices.

Ensure that the Access WiFi Information switch in the Capabilities section of the target is set to "On".

Additionally, your provisioning profile will need to support the Access WiFi Information capability. This can be added in the Apple Developer Portal.

CocoaPods setup

The recommended way of integrating Google Cast is using CocoaPods. For integration, use the google-cast-sdk CocoaPods.

To get started, follow the getting started guide.

Once CocoaPods is set up, follow the using CocoaPods guide to get your Podfile created and your project ready to use with the Google Cast SDK.

Here's an example of how to add the google-cast-sdk CocoaPod to your Podfile:

use_frameworks!

platform :ios, '14.0'

def target_pods
  pod 'google-cast-sdk'
end

target 'CastVideos-objc' do
  target_pods
end
target 'CastVideos-swift' do
  target_pods
end

プロジェクトでは、Pod の範囲を指定して、予期しない互換性を損なう変更を防止する必要があります。詳細については、podfile ガイドをご覧ください。

このスニペットでは、バージョン 4.8.1 と、次のメジャー バージョン（major.minor.patch）までのバージョンが許可されます。

pod 'google-cast-sdk', '~> 4.8.1'

たとえば、「~> 1.6.7」と指定すると、1.6.7 から 2.0.0 までのすべてのバージョンが含まれますが、バージョン 2.0.0 までは含まれません。

手動セットアップ

CocoaPods を使用せずに Cast iOS SDK をプロジェクトに追加する手順は次のとおりです。

キーポイント: バージョン 4.3.1 以降、CocoaPods は静的ライブラリを使用して、Firebase と Cast SDK を一緒に使用する際に、Protobuf ライブラリの共有依存関係によって発生する重複したシンボル警告を回避します。この変更によりダウンロードのサイズは大きくなりますが、最終的なアプリのサイズは拡大しません。

サイズの違いが懸念される場合は、動的ライブラリをダウンロードして、4.3.1 より前のバージョンの CocoaPods ライブラリと同様のサイズを取得してください。

ダウンロード

以下の適切なライブラリをダウンロードしたら、設定手順に沿ってプロジェクトにフレームワークを追加します。

Cast iOS Sender SDK 4.8.1 ライブラリ:

静的 動的

設定の手順

ライブラリをインストールするには:

1. プロジェクトに適した SDK をダウンロードして展開します。
2. 動的 GoogleCastSDK ライブラリをセットアップします。
3. 解凍した .xcframework を、Xcode プロジェクト ナビゲータのメイン プロジェクト（Pod プロジェクトがある場合は、Pod プロジェクト）にドラッグします。[必要に応じてすべてのアイテムをコピーする] チェックボックスをオンにして、すべてのターゲットに追加します。
4. Xcode ターゲットの General タブで、GoogleCast.xcframework に Embed and Sign を選択します。

静的ライブラリを設定する場合は、上記の手順に加えて、次の操作を行います。

1. 最小バージョン v3.13 で Protobuf ライブラリをセットアップします。
1. プロジェクトで CocoaPods を使用している場合:
1. Podfile を開き、google-cast-sdk が存在する場合は削除します。

   pod 'google-cast-sdk'

2. Protobuf ライブラリが存在しない場合は追加します。

   pod 'Protobuf', '3.13'

3. プロジェクトのルートフォルダで pod install を実行します。
2. プロジェクトで CocoaPods を使用していない場合:
1. GoogleCastSDK の現在のバージョンを削除します（存在する場合）。
2. Protobuf GitHub リポジトリの手順に沿って、Protobuf ライブラリ v3.13 以降を追加します。
2. Xcode プロジェクトで、フラグ -ObjC -lc++ を [Build Settings] > [Other Linker Flags] に追加します。
3. 解凍したディレクトリで Resources フォルダを見つけて、GoogleCastCoreResources.bundle、GoogleCastUIResources.bundle、MaterialDialogs.bundle を、先ほど追加した GoogleCast.xcframework の隣のプロジェクトにドラッグします。[必要に応じてすべてのアイテムをコピーする] チェックボックスをオンにして、すべてのターゲットに追加します。

Mac の Catalyst の設定

Mac Catalyst をサポートするアプリの場合は、Cast SDK の動的ライブラリを使用します。手動設定プロセスに沿って、フレームワークをプロジェクトに追加します。次に、Apple のドキュメントに記載されているように、Mac ターゲットから条件付きで Cast SDK を除外します。静的ライブラリは iOS アーキテクチャ用にプリコンパイルされているため、Mac ターゲットに対してビルドするとリンカーエラーが発生します。