Configuration pour le développement avec le framework d'application Cast (CAF) pour iOS

Le framework Cast est compatible avec iOS 14 et versions ultérieures, et est disponible dans les frameworks statiques et dynamiques.

Consultez la documentation de référence de l'API Google Cast pour iOS pour obtenir des descriptions de toutes les classes et méthodes.

Remarque:De nouvelles versions de XCFrameworks du SDK Cast pour iOS sont désormais disponibles. Elles sont compatibles avec le développement sur les ordinateurs Apple Silicon.

Configuration de Xcode

Avertissement :Si vous définissez l'indicateur Apple Clang - Code Generation Optimization Level sur -Ofast pour "Optimisations les plus rapides et agrégables", les applications qui utilisent le SDK Cast pour iOS planteront en raison d'incompatibilités avec les optimisations. Le SDK accepte la valeur par défaut -Os pour "Le plus rapide, le plus petit".

iOS 14

Avertissement iOS 14: Les modifications apportées aux autorisations d'accès au réseau local iOS 14 ont eu plusieurs conséquences sur le SDK Google Cast pour iOS. Veuillez consulter le document Modifications apportées à iOS 14 pour connaître les conséquences pour votre application.

1. Ajouter le SDK Cast pour iOS 4.8.1 à votre projet

   Si vous utilisez CocoaPods, utilisez pod update pour ajouter le SDK 4.8.1 à votre projet.

   Sinon, importez le SDK manuellement.

   Remarque: Si vous avez créé un sélecteur d'appareil personnalisé dans votre application, vous devez appeler explicitement la méthode startDiscovery sur la classe GCKDiscoveryManager pour lancer la détection d'appareils. L'analyse automatique était désactivée par défaut à partir de la version 4.5.0 du SDK Cast.
2. Ajouter NSBonjourServices à votre Info.plist

   Spécifiez NSBonjourServices dans votre fichier Info.plist pour permettre la réussite de la détection du réseau local sur iOS 14.

   Vous devez ajouter les services _googlecast._tcp et _<your-app-id>._googlecast._tcp pour que la détection d'appareils fonctionne correctement.

   L'appID correspond à votre "receiveID" (ID du récepteur), qui est le même que celui défini dans votre GCKDiscoveryCriteria.

   Mettez à jour l'exemple de définition NSBonjourServices suivant et remplacez "ABCD1234" par l'ID de votre application.

   <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

Pour votre projet, vous devez spécifier une plage pour vos pods afin d'éviter toute modification destructive inattendue, comme indiqué dans le guide Podfile.

Dans cet extrait, la version 4.8.1 et les versions jusqu'à la version majeure suivante (major.minor.patch) sont autorisées:

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

Par exemple, "~> 1.6.7" inclut toutes les versions à partir de la version 1.6.7 et jusqu'à la version 2.0.0 (non comprise).

Configuration manuelle

Les instructions suivantes permettent d'ajouter le SDK Cast pour iOS à votre projet sans utiliser CocoaPods:

Important:À partir de la version 4.3.1, CocoaPods utilise des bibliothèques statiques pour éviter les avertissements de symboles en double causés par une dépendance de bibliothèque Protobuf partagée lors de l'utilisation conjointe des SDK Firebase et Cast. Bien que ce changement entraîne un téléchargement plus volumineux, la taille finale de l'application n'augmentera pas.

Si la différence de taille vous pose problème, téléchargez la bibliothèque dynamique pour obtenir une taille semblable à celle des versions de la bibliothèque CocoaPods antérieures à la version 4.3.1.

Téléchargements

Après avoir téléchargé la bibliothèque appropriée ci-dessous, suivez les étapes de configuration pour ajouter le framework à votre projet.

Bibliothèques du SDK Cast pour iOS Sender 4.8.1:

Statique Dynamique

Procédure de configuration

Pour installer la bibliothèque:

1. Téléchargez et extrayez le SDK approprié pour votre projet.
2. Configurez la bibliothèque dynamique du SDK GoogleCast:
3. Faites glisser le fichier .xcframework décompressé dans votre projet principal dans le navigateur de projets Xcode (et non dans le projet "Pods", le cas échéant). Cochez la case "Copier tous les éléments si nécessaire", puis ajoutez à toutes les cibles.
4. Dans votre cible Xcode, sous l'onglet General, sélectionnez Embed and Sign pour GoogleCast.xcframework.

Si vous configurez la bibliothèque statique, effectuez les étapes suivantes, en plus des étapes précédentes:

1. Configurez la bibliothèque Protobuf avec la version 3.13 minimale.
1. Si votre projet utilise CocoaPods:
1. Ouvrez Podfile et supprimez l'élément google-cast-sdk, le cas échéant :

   pod 'google-cast-sdk'

2. Ajoutez la bibliothèque Protobuf si elle n'est pas présente :

   pod 'Protobuf', '3.13'

3. Exécutez pod install dans le dossier racine de votre projet.
2. Si votre projet n'utilise pas CocoaPods:
1. Supprimez la version actuelle de GoogleCastSDK, le cas échéant.
2. Ajoutez la bibliothèque Protobuf version 3.13 ou ultérieure en suivant les instructions du dépôt GitHub Protobuf.
2. Dans votre projet Xcode, ajoutez les indicateurs -ObjC -lc++ à Build Settings > Other Linker Flags (Paramètres de compilation > Autres indicateurs Linker).
3. Recherchez le dossier "Resources" dans le répertoire décompressé, puis faites glisser GoogleCastCoreResources.bundle, GoogleCastUIResources.bundle et MaterialDialogs.bundle dans votre projet, à côté du GoogleCast.xcframework que vous avez ajouté précédemment. Cochez la case "Copier tous les éléments si nécessaire", puis ajoutez à toutes les cibles.

Configuration de Catalyst sur Mac

Pour les applications compatibles avec Mac Catalyst, utilisez la bibliothèque dynamique du SDK Cast. Suivez le processus de configuration manuelle pour ajouter le framework à votre projet. Excluez ensuite de manière conditionnelle le SDK Cast de la cible Mac, comme indiqué dans la documentation Apple. Les bibliothèques statiques sont précompilées pour l'architecture iOS, ce qui provoque une erreur de l'éditeur de liens lors de la compilation avec la cible Mac.