การตั้งค่าสำหรับการพัฒนาด้วย Cast Application Framework (CAF) สำหรับ iOS

เฟรมเวิร์ก Cast รองรับ iOS 14 ขึ้นไป และมาในเฟรมเวิร์กทั้งแบบคงที่และแบบไดนามิก

ดูคำอธิบายคลาสและเมธอดทั้งหมดได้ที่ข้อมูลอ้างอิง API ของ Google Cast สำหรับ iOS

หมายเหตุ: Cast iOS SDK XCFrameworks เวอร์ชันใหม่พร้อมใช้งานแล้ว ซึ่งรองรับการพัฒนาในคอมพิวเตอร์ Apple Silicon

การตั้งค่า Xcode

คำเตือน: การตั้งค่า Flag Apple Clang - Code Generation Optimization Level เป็น -Ofast สำหรับ "การเพิ่มประสิทธิภาพโดยรวมให้เร็วที่สุด" จะทำให้แอปที่ใช้ Cast iOS SDK ขัดข้องเนื่องจากทำงานร่วมกับการเพิ่มประสิทธิภาพไม่ได้ SDK รองรับค่าเริ่มต้น -Os สําหรับ "เร็วที่สุด, เล็กที่สุด"

iOS 14

คำเตือนสำหรับ iOS 14: การเปลี่ยนแปลงสิทธิ์การเข้าถึงเครือข่าย LAN ใน iOS 14 ส่งผลต่อ Google Cast iOS SDK หลายอย่าง โปรดดูเอกสาร การเปลี่ยนแปลงใน iOS 14 เพื่อดูผลกระทบที่มีต่อแอปของคุณ

1. เพิ่ม Cast iOS SDK 4.8.1 ลงในโปรเจ็กต์ของคุณ

   หากใช้ CocoaPods ให้ใช้ pod update เพื่อเพิ่ม SDK 4.8.1 ในโปรเจ็กต์ของคุณ

   ไม่เช่นนั้น ให้ ดึง SDK ด้วยตนเอง

   หมายเหตุ: หากสร้างเครื่องมือเลือกอุปกรณ์ที่กำหนดเองไว้ในแอป คุณจะต้องเรียกใช้เมธอด startDiscovery อย่างชัดแจ้งในคลาส GCKDiscoveryManager เพื่อเริ่มการค้นหาอุปกรณ์ การสแกนอัตโนมัติถูกปิดใช้โดยค่าเริ่มต้นตั้งแต่เวอร์ชัน 4.5.0 ของ Cast SDK
2. เพิ่ม NSBonjourServices ลงใน Info.plist

   ระบุ NSBonjourServices ใน Info.plist เพื่อให้การค้นหาเครือข่ายภายในเครื่องประสบความสำเร็จใน iOS 14

   คุณจะต้องเพิ่มทั้ง _googlecast._tcp และ _<your-app-id>._googlecast._tcp เป็นบริการเพื่อให้การค้นหาอุปกรณ์ทำงานได้อย่างถูกต้อง

   appID คือ ReceiverID ซึ่งเป็นรหัสเดียวกับที่ระบุไว้ใน GCKDiscoveryCriteria

   อัปเดตคําจํากัดความ NSBonjourServices ตัวอย่างต่อไปนี้และแทนที่ "ABCD1234" ด้วยรหัสแอปของคุณ

   <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

สำหรับโปรเจ็กต์ คุณควรระบุช่วงสำหรับพ็อดเพื่อป้องกันการเปลี่ยนแปลงที่เสียหายที่ไม่คาดคิดตามรายละเอียดในคำแนะนำสำหรับ Podfile

ในข้อมูลโค้ดนี้ เราอนุญาตให้ใช้เวอร์ชัน 4.8.1 และเวอร์ชันจนถึงเวอร์ชันหลักถัดไป (major.minor.patch)

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

ตัวอย่างเช่น "~> 1.6.7" จะรวมทุกเวอร์ชันตั้งแต่ 1.6.7 ขึ้นไป แต่ไม่รวมเวอร์ชัน 2.0.0

ตั้งค่าด้วยตนเอง

วิธีการต่อไปนี้มีไว้สำหรับการเพิ่ม Cast iOS SDK ลงในโปรเจ็กต์โดยไม่ต้องใช้ CocoaPods

ประเด็นหลัก: ตั้งแต่เวอร์ชัน 4.3.1 เป็นต้นไป CocoaPods จะใช้ไลบรารีแบบคงที่เพื่อหลีกเลี่ยงคำเตือนสัญลักษณ์ที่ซ้ำกันซึ่งเกิดจากทรัพยากร Dependency ของไลบรารี Protobuf ที่แชร์เมื่อใช้ Firebase และ Cast SDK ร่วมกัน แม้ว่าการเปลี่ยนแปลงนี้จะทำให้การดาวน์โหลดมีขนาดใหญ่ขึ้น แต่ขนาดแอปสุดท้ายจะไม่เพิ่มขึ้น

หากสถานการณ์ของคุณกังวลเรื่องความแตกต่างของขนาด ให้ดาวน์โหลดไลบรารีแบบไดนามิกเพื่อรับขนาดที่คล้ายกับไลบรารี CocoaPods เวอร์ชันก่อนหน้า 4.3.1

รายการที่ดาวน์โหลด

หลังจากดาวน์โหลดไลบรารีที่เหมาะสมด้านล่าง ให้ทำตามขั้นตอนการตั้งค่าเพื่อเพิ่มเฟรมเวิร์กลงในโปรเจ็กต์ของคุณ

ไลบรารีของ Cast iOS Sender SDK 4.8.1

คงที่ ไดนามิก

ขั้นตอนการตั้งค่า

วิธีติดตั้งไลบรารี

1. ดาวน์โหลดและดึงข้อมูล SDK ที่เหมาะสมสำหรับโปรเจ็กต์ของคุณ
2. ตั้งค่าไลบรารี GoogleCastSDK แบบไดนามิกโดยทำดังนี้
3. ลาก .xcframework ที่แตกแล้วไปยังโปรเจ็กต์หลักในโปรแกรมนำทางโปรเจ็กต์ Xcode (ไม่ใช่ลงในโปรเจ็กต์พ็อด หากมี) เลือก "คัดลอกรายการทั้งหมดหากจำเป็น" แล้วเพิ่มลงในเป้าหมายทั้งหมด
4. ในเป้าหมาย Xcode ในแท็บ General ให้เลือก Embed and Sign สำหรับ GoogleCast.xcframework

หากคุณกำลังตั้งค่าไลบรารีแบบคงที่ โปรดทำตามขั้นตอนเหล่านี้เพิ่มเติมจากขั้นตอนก่อนหน้า

1. ตั้งค่าไลบรารี Protobuf ด้วยเวอร์ชัน v3.13 ขั้นต่ำ
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 เวอร์ชัน 3.13 ขึ้นไป โดยทำตามวิธีการที่อยู่ในที่เก็บ Protobuf GitHub
2. ในโปรเจ็กต์ Xcode ให้เพิ่มแฟล็ก -ObjC -lc++ ไปยังการตั้งค่าบิลด์ > แฟล็ก Linker อื่นๆ
3. ค้นหาโฟลเดอร์ "ทรัพยากร" ในไดเรกทอรีที่คลายการบีบอัด แล้วลาก GoogleCastCoreResources.bundle, GoogleCastUIResources.bundle และ MaterialDialogs.bundle ไปยังโปรเจ็กต์ที่ติดกับ GoogleCast.xcframework ที่คุณเพิ่มไว้ก่อนหน้านี้ เลือก "คัดลอกรายการทั้งหมดหากจำเป็น" แล้วเพิ่มลงในเป้าหมายทั้งหมด

ตั้งค่า Mac Catalyst

สำหรับแอปที่รองรับ Mac Catalyst ให้ใช้ไลบรารีแบบไดนามิกของ Cast SDK ทำตามขั้นตอนการตั้งค่าด้วยตนเองเพื่อเพิ่มเฟรมเวิร์กลงในโปรเจ็กต์ จากนั้นยกเว้น Cast SDK จากเป้าหมาย Mac อย่างมีเงื่อนไขตามที่ระบุไว้ในเอกสารประกอบของ Apple ไลบรารีแบบคงที่ได้รับการคอมไพล์ล่วงหน้าสำหรับสถาปัตยกรรม iOS ซึ่งทำให้เกิดข้อผิดพลาด Linker เมื่อสร้างตามเป้าหมายของ Mac