使用 Cast 应用框架 (CAF) 开发 iOS 版应用的设置

Cast 框架支持 iOS 13 及更高版本,并且提供静态框架和动态框架。

有关所有类和方法的说明,请参阅 Google Cast iOS API 参考文档

Xcode 设置

iOS 14

  1. 将 Cast iOS SDK 4.8.0 添加到项目中

    如果使用的是 CocoaPods,请使用 pod update 将 4.8.0 SDK 添加到您的项目中。

    否则,请 手动拉取 SDK

  2. NSBonjourServices 添加到 Info.plist

    Info.plist 中指定 NSBonjourServices,以允许本地网络发现功能在 iOS 14 上成功运行。

    您需要将 _googlecast._tcp_<your-app-id>._googlecast._tcp 添加为服务,设备发现功能才能正常运行。

    appID 是您的接收器 ID,与 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.

    Cast Local Network Access permissions dialog image
  4. Re-release your app to the Apple App Store

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

iOS 13

iOS 12

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. CocoaPods is supported for both the Universal Framework and XCFramework.

For a Universal Framework integration, use the google-cast-sdk and google-cast-sdk-no-bluetooth CocoaPods.

For an XCFramework integration, use the google-cast-sdk-xcframework and google-cast-sdk-no-bluetooth-xcframework 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, '13.0'

def target_pods
  pod 'google-cast-sdk'
end

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

以下示例说明了如何将 google-cast-sdk-no-bluetooth CocoaPod 添加到 Podfile

use_frameworks!

platform :ios, '13.0'

def target_pods
  pod 'google-cast-sdk-no-bluetooth'
end

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

podfile 指南中所述,应为您的项目指定 pod 范围,以防止意外的重大更改。

在此代码段中,可以使用版本 4.8.0 和下一个主要版本 (major.minor.patch) 的版本:

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

例如,“~> 1.6.7”将涵盖 1.6.7 到 2.0.0 之间的所有版本。

手动设置

以下说明介绍了如何在不使用 CocoaPods 的情况下将 Cast iOS SDK 添加到您的项目中:

下载

下载合适的库后,请按照设置步骤将框架添加到项目中。XCFramework 的设置要求与旧版通用框架相同。

通用框架

Cast iOS Sender SDK 4.8.0 库:

通过蓝牙静态配置 不使用蓝牙的静态配置

通过蓝牙进行动态 不使用蓝牙进行动态

XCFrame

Cast iOS SDK 支持 XCFrameworks,从而允许在使用 Apple silicon 的 Mac 计算机上进行开发,以及使用 iOS 模拟器进行调试。

Cast iOS Sender SDK XCFramework 4.8.0 库:

使用蓝牙的静态 XCFramework 不使用蓝牙的静态 XCFramework

使用蓝牙的动态 XCFramework 不使用蓝牙的动态 XCFramework

设置步骤

如需安装其中一个静态库,请执行以下操作:

  1. 下载并解压缩适合项目的静态 SDK。
  2. 使用最低版本 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 或更高版本。
  3. 将解压缩的 .framework.xcframework 拖动到 Xcode 项目导航器中的主项目中,而不是拖入 Pod 项目中(如果有)。选中“复制所有需要的内容”,然后添加到所有目标。
  4. 在 Xcode 项目中,将标记 -ObjC -lc++ 添加到 Build Settings(构建设置)> Other Linker Flags(其他链接器标记)
  5. 右键点击项目中的 GoogleCast.frameworkGoogleCast.xcframework,然后选择“Show In Finder”。
  6. GoogleCastCoreResources.bundleGoogleCastUIResources.bundle 拖到项目中您先前添加的 GoogleCast.frameworkGoogleCast.xcframework 旁边,然后勾选“Copy all items if needed”并添加到所有目标。

如需安装其中一个动态库,请执行以下操作:

  1. 下载并解压缩适合您项目的动态 SDK。
  2. 设置动态 GoogleCastSDK 库:
    1. 如果您的项目使用 CocoaPods:
      1. 打开您的 Podfile 并移除:
        pod 'google-cast-sdk'
      2. 在项目的根文件夹中运行 pod install
    2. 如果您的项目未使用 CocoaPods,请移除当前的 Google Cast 库。
  3. 将解压缩的 .framework.xcframework 拖动到 Xcode 项目导航器中的主项目中,而不是拖入 Pod 项目中(如果有)。选中“复制所有需要的内容”,然后添加到所有目标。
  4. 在 Xcode 目标的 General 标签页下,为 GoogleCast.frameworkGoogleCast.xcframework 选择 Embed and Sign

Mac Catalyst 设置

对于支持 Mac Catalyst 的应用,请使用 Cast SDK 的动态库。 按照手动设置流程将框架添加到项目中。然后,有条件地将 Cast SDK 从 Mac 目标中排除(如 Apple 文档中所述)。静态库是针对 iOS 架构预先编译的,这会导致在针对 Mac 目标进行构建时发生链接器错误。

将应用发布到 App Store

在将您的应用发布到 App Store 之前,您需要运行 shell 脚本 strip_unused_archs.sh 来从 app bundle 中删除未使用的架构。此脚本位于 Cast SDK for iOS 中。