Penyiapan untuk Mengembangkan Dengan Framework Aplikasi Cast (CAF) untuk iOS

Framework Cast mendukung iOS 16 dan yang lebih baru, serta tersedia dalam framework statis dan dinamis.

Lihat Referensi Google Cast iOS API untuk mengetahui deskripsi semua class dan metode.

Catatan: Versi baru XCFramework Cast iOS SDK kini tersedia, yang mendukung pengembangan di komputer Apple Silicon.

Penyiapan Xcode

Peringatan: Menetapkan tanda Apple Clang - Code Generation Optimization Level ke -Ofast untuk 'Pengoptimalan Tercepat dan Agresif' akan menyebabkan aplikasi yang menggunakan Cast iOS SDK error karena tidak kompatibel dengan pengoptimalan. SDK mendukung nilai default -Os untuk 'Tercepat, Terkecil'.

1. Tambahkan Cast iOS SDK 4.8.6 ke project Anda

   Jika menggunakan Swift Package Manager, update paket google-cast-ios-sdk ke versi 4.8.6.

   Jika tidak, tarik SDK secara manual.

   Catatan: Jika Anda membuat pemilih perangkat kustom di aplikasi, Anda harus memanggil metode startDiscovery secara eksplisit di GCKDiscoveryManager class untuk memulai penemuan perangkat. Pemindaian otomatis dinonaktifkan secara default mulai rilis Cast SDK v4.5.0.
2. Tambahkan NSBonjourServices ke Info.plist Anda

   Tentukan NSBonjourServices di Info.plist Anda untuk mengizinkan penemuan jaringan lokal berhasil.

   Anda harus menambahkan _googlecast._tcp dan _<your-app-id>._googlecast._tcp sebagai layanan agar penemuan perangkat berfungsi dengan baik.

   appID adalah receiverID Anda, yang merupakan ID yang sama yang ditentukan di GCKDiscoveryCriteria.

   Perbarui definisi NSBonjourServices contoh berikut dan ganti "ABCD1234" dengan appID Anda.

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

3. Tambahkan NSLocalNetworkUsageDescription ke Info.plist

   Sebaiknya sesuaikan pesan yang ditampilkan di dialog Jaringan Lokal dengan menambahkan string izin khusus aplikasi di file Info.plist aplikasi untuk NSLocalNetworkUsageDescription, seperti untuk mendeskripsikan penemuan Cast dan layanan penemuan lainnya, seperti DIAL.

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

   Pesan ini akan muncul sebagai bagian dari dialog Akses Jaringan Lokal iOS seperti yang ditunjukkan dalam tiruan.

   
4. Merilis ulang aplikasi Anda ke Apple App Store

   Sebaiknya Anda juga merilis ulang aplikasi menggunakan 4.8.6 sesegera mungkin.

Penyiapan Swift Package Manager

Cara yang direkomendasikan untuk mengintegrasikan Google Cast adalah dengan menggunakan Swift Package Manager (SPM). Paket Cast iOS SDK tersedia dari repositori GitHub google-cast-ios-sdk.

Untuk menambahkan Cast iOS SDK ke project Anda di Xcode:

1. Di Xcode, pilih File > Add Packages....
2. Masukkan URL repositori: https://github.com/googlecast/google-cast-ios-sdk.
3. Pilih aturan pembuatan versi Anda. Misalnya, pilih Hingga Versi Utama Berikutnya dengan versi minimum 4.8.6 untuk menerima update yang kompatibel tanpa perubahan yang tidak terduga.
4. Klik Tambahkan Paket.
5. Pilih produk GoogleCastDynamic atau GoogleCastStatic, lalu tambahkan ke target aplikasi Anda.

Peringatan: Tambahkan hanya satu produk GoogleCastDynamic atau GoogleCastStatic ke target Anda. Jangan menambahkan kedua varian SDK ke aplikasi yang sama.

Memilih varian framework

Paket Cast iOS SDK menyediakan dua produk:

• GoogleCastDynamic: Framework dinamis. Library ini mencakup semua resource aset yang diperlukan oleh komponen UI Cast, dan tidak memerlukan flag linker tambahan. Aplikasi yang mendukung Mac Catalyst harus menggunakan framework dinamis. Untuk mengetahui informasi selengkapnya, lihat Penyiapan Mac Catalyst.
• GoogleCastStatic: Framework statis. Hal ini memerlukan langkah-langkah penyiapan tambahan yang dijelaskan dalam Penyiapan framework statis.

Penyiapan framework statis

Framework statis tidak dapat menyertakan paket resource. Akibatnya, Swift Package Manager tidak dapat secara otomatis memaketkan resource aset yang diperlukan oleh komponen UI Cast (seperti gambar UI, papan alur, dan file pelokalan) dengan produk GoogleCastStatic. Jika Anda menambahkan GoogleCastStatic ke target, selesaikan langkah-langkah berikut:

1. Di project Xcode, tambahkan flag -ObjC -lc++ ke Build Settings > Other Linker Flags.
2. Jika aplikasi Anda menggunakan komponen UI Cast, tambahkan paket aset ke project Anda secara manual:
   1. Download library statis dari Download. Pastikan bahwa versi library statis cocok dengan versi paket yang Anda tambahkan.
   2. Temukan folder Resources di direktori yang telah diekstrak dan tarik semua file .bundle ke project Xcode Anda. Centang 'Salin semua item jika diperlukan', dan tambahkan ke semua target.

Catatan: Saat Anda mengupdate paket google-cast-ios-sdk ke versi baru, ganti paket aset di project Anda dengan paket dari library statis versi yang sama.

Penyiapan CocoaPods

Peringatan: Dukungan untuk CocoaPods tidak digunakan lagi. Versi 4.8.6 adalah update terakhir yang dipublikasikan ke CocoaPods. Update berikutnya akan tersedia menggunakan Swift Package Manager, dan akan terus tersedia dari download langsung.

Penyiapan manual

Petunjuk berikut adalah untuk menambahkan Cast iOS SDK ke project Anda tanpa menggunakan Swift Package Manager:

Poin Penting: Mulai dari versi 4.8.4, jika Anda menggunakan library lain yang bergantung pada Protobuf (seperti Firebase), menggunakan library statis akan meningkatkan ukuran aplikasi akhir.

Sebaiknya gunakan library statis untuk menghindari potensi masalah kompatibilitas versi dengan Protobuf. Namun, jika perbedaan ukuran menjadi masalah bagi situasi Anda, download library dinamis.

Download

Setelah mendownload library yang sesuai di bawah, ikuti langkah penyiapan untuk menambahkan framework ke project Anda.

Library Cast iOS Sender SDK 4.8.6:

Statis Dinamis

Langkah-langkah penyiapan

Untuk menginstal library:

1. Download dan ekstrak SDK yang sesuai untuk project Anda.
2. Siapkan library GoogleCastSDK dinamis:
3. Tarik .xcframework yang belum di-unzip ke project utama Anda di Project Navigator Xcode. Centang 'Salin semua item jika diperlukan', lalu tambahkan ke semua target.
4. Di target Xcode Anda, di tab General, pilih Embed and Sign untuk GoogleCast.xcframework.

Jika Anda menyiapkan library dinamis, ikuti langkah-langkah berikut selain langkah-langkah sebelumnya:

1. Hapus versi GoogleCastSDK saat ini jika ada.
2. Tambahkan library Protobuf v3.13 atau yang lebih baru, dengan mengikuti petunjuk yang ada di repo Protobuf GitHub.

Jika Anda menyiapkan library statis, ikuti langkah-langkah berikut selain langkah-langkah sebelumnya:

1. Di project Xcode, tambahkan flag -ObjC -lc++ ke Build Settings > Other Linker Flags.
2. Temukan folder Resources di direktori yang telah diekstrak dan tarik semua file .bundle ke project Anda di samping GoogleCast.xcframework yang Anda tambahkan sebelumnya. Centang 'Salin semua item jika diperlukan', lalu tambahkan ke semua target.

Penyiapan Mac Catalyst

Untuk Aplikasi yang mendukung Mac Catalyst, gunakan library dinamis Cast SDK. Ikuti proses penyiapan manual untuk menambahkan framework ke project Anda. Kemudian, kecualikan Cast SDK secara bersyarat dari target Mac seperti yang disebutkan dalam dokumentasi Apple. Library statis telah dikompilasi sebelumnya untuk arsitektur iOS, yang menyebabkan error linker saat membangun terhadap target Mac.