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

Le framework Cast est compatible avec iOS 16 et versions ultérieures, et est disponible en frameworks statiques et dynamiques.

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

Remarque : De nouvelles versions des XCFrameworks du SDK Cast pour iOS sont désormais disponibles. Elles permettent de développer sur des ordinateurs Apple Silicon.

Configuration de Xcode

Avertissement : Si vous définissez l'option Apple Clang - Code Generation Optimization Level sur -Ofast pour "Optimisations agressives les plus rapides", les applications utilisant le SDK Cast pour iOS planteront en raison d'incompatibilités avec les optimisations. Le SDK est compatible avec la valeur par défaut -Os pour "Fastest, Smallest".

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

   Si vous utilisez Swift Package Manager, mettez à jour le package google-cast-ios-sdk vers la version 4.8.6.

   Sinon, récupérez le SDK manuellement.

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

   Spécifiez NSBonjourServices dans votre Info.plist pour permettre à la découverte du réseau local de réussir.

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

   L'appID est votre receiverID, qui est le même ID que celui défini dans votre GCKDiscoveryCriteria.

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

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

3. Ajoutez NSLocalNetworkUsageDescription à votre Info.plist

   Nous vous recommandons vivement de personnaliser le message affiché dans l'invite du réseau local en ajoutant une chaîne d'autorisation spécifique à l'application dans le fichier Info.plist de votre application pour NSLocalNetworkUsageDescription, par exemple pour décrire la découverte Cast et d'autres services de découverte, comme DIAL.

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

   Ce message s'affichera dans la boîte de dialogue d'accès au réseau local iOS, comme illustré dans la maquette.

   
4. Publier à nouveau votre application sur l'App Store d'Apple

   Nous vous recommandons également de publier à nouveau votre application en utilisant la version 4.8.6 dès que possible.

Configuration de Swift Package Manager

La méthode recommandée pour intégrer Google Cast consiste à utiliser Swift Package Manager (SPM). Le package du SDK Cast pour iOS est disponible dans le dépôt GitHub google-cast-ios-sdk.

Pour ajouter le SDK Cast pour iOS à votre projet dans Xcode :

1. Dans Xcode, sélectionnez File > Add Packages... (Fichier > Ajouter des packages).
2. Saisissez l'URL du dépôt : https://github.com/googlecast/google-cast-ios-sdk.
3. Sélectionnez vos règles de gestion des versions. Par exemple, sélectionnez Jusqu'à la prochaine version majeure avec une version minimale de 4.8.6 pour recevoir des mises à jour compatibles sans modifications destructives inattendues.
4. Cliquez sur Ajouter un package.
5. Sélectionnez le produit GoogleCastDynamic ou GoogleCastStatic, puis ajoutez-le à votre cible d'application.

Avertissement : N'ajoutez qu'un seul des produits GoogleCastDynamic ou GoogleCastStatic à votre cible. N'ajoutez pas les deux variantes du SDK à la même application.

Choisir une variante de framework

Le package du SDK Cast pour iOS fournit deux produits :

• GoogleCastDynamic : framework dynamique. Il inclut toutes les ressources d'assets requises par les composants de l'UI Cast et ne nécessite aucune option d'éditeur de liens supplémentaire. Les applications compatibles avec Mac Catalyst doivent utiliser le framework dynamique. Pour en savoir plus, consultez Configuration de Mac Catalyst.
• GoogleCastStatic : framework statique. Il nécessite les étapes de configuration supplémentaires décrites dans Configuration du framework statique.

Configuration du framework statique

Les frameworks statiques ne peuvent pas inclure de bundles de ressources. Par conséquent, Swift Package Manager ne peut pas regrouper automatiquement les ressources requises par les composants de l'UI Cast (tels que les images de l'UI, les storyboards et les fichiers de localisation) avec le produit GoogleCastStatic. Si vous ajoutez GoogleCastStatic à votre cible, procédez comme suit :

1. Dans votre projet Xcode, ajoutez les flags -ObjC -lc++ à Build Settings > Other Linker Flags (Paramètres de compilation > Autres flags de linker).
2. Si votre application utilise les composants de l'UI Cast, ajoutez manuellement les bundles d'assets à votre projet :
   1. Téléchargez la bibliothèque statique depuis la page Téléchargements. Assurez-vous que la version de la bibliothèque statique correspond à celle du package que vous avez ajouté.
   2. Recherchez le dossier Resources dans le répertoire décompressé, puis faites glisser tous les fichiers .bundle dans votre projet Xcode. Cochez "Copier tous les éléments si nécessaire", puis ajoutez-les à toutes les cibles.

Remarque : Lorsque vous mettez à jour le package google-cast-ios-sdk vers une nouvelle version, remplacez les bundles d'assets de votre projet par les bundles de la bibliothèque statique de la même version.

Configuration de CocoaPods

Avertissement : CocoaPods n'est plus pris en charge. La version 4.8.6 est la dernière mise à jour publiée sur CocoaPods. Les mises à jour ultérieures seront disponibles via Swift Package Manager et continueront d'être disponibles en téléchargement direct.

Configuration manuelle

Les instructions suivantes expliquent comment ajouter le SDK Cast pour iOS à votre projet sans utiliser Swift Package Manager :

Important : À partir de la version 4.8.4, si vous utilisez une autre bibliothèque qui dépend de Protobuf (comme Firebase), l'utilisation de la bibliothèque statique augmentera la taille finale de l'application.

Nous vous recommandons d'utiliser la bibliothèque statique pour éviter d'éventuels problèmes de compatibilité de version avec Protobuf. Toutefois, si la différence de taille vous pose problème, téléchargez la bibliothèque dynamique.

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 iOS Sender 4.8.6 :

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 GoogleCastSDK :
3. Faites glisser le fichier .xcframework décompressé dans votre projet principal dans le navigateur de projet Xcode. Cochez "Copier tous les éléments si nécessaire", puis ajoutez-les à 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 dynamique, suivez ces étapes en plus des précédentes :

1. Supprimez la version actuelle de GoogleCastSDK, le cas échéant.
2. Ajoutez la bibliothèque Protobuf v3.13 ou ultérieure en suivant les instructions du dépôt GitHub Protobuf.

Si vous configurez la bibliothèque statique, suivez ces étapes en plus des précédentes :

1. Dans votre projet Xcode, ajoutez les flags -ObjC -lc++ à Build Settings > Other Linker Flags (Paramètres de compilation > Autres flags de linker).
2. Recherchez le dossier "Resources" dans le répertoire décompressé, puis faites glisser tous les fichiers .bundle dans votre projet, à côté du fichier GoogleCast.xcframework que vous avez ajouté précédemment. Cochez "Copier tous les éléments si nécessaire", puis ajoutez-les à toutes les cibles.

Configuration de Mac Catalyst

Pour les applications compatibles avec Mac Catalyst, utilisez la bibliothèque dynamique du SDK Cast. Suivez la procédure de configuration manuelle pour ajouter le framework à votre projet. Ensuite, excluez 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 entraîne une erreur de l'éditeur de liens lors de la compilation pour la cible Mac.