Einrichtung für die Entwicklung mit dem Cast Application Framework (CAF) für iOS

Das Cast-Framework unterstützt iOS 16 und höher und ist sowohl als statisches als auch als dynamisches Framework verfügbar.

Beschreibungen aller Klassen und Methoden finden Sie in der Google Cast iOS API-Referenz.

Xcode-Einrichtung

  1. Cast iOS SDK 4.8.6 zu Ihrem Projekt hinzufügen

    Wenn Sie den Swift Package Manager verwenden, aktualisieren Sie das google-cast-ios-sdk-Paket auf Version 4.8.6.

    Andernfalls müssen Sie das SDK manuell abrufen.

  2. NSBonjourServices zu Info.plist hinzufügen

    Geben Sie NSBonjourServices in Ihrem Info.plist an, damit die Erkennung lokaler Netzwerke erfolgreich ist.

    Sie müssen sowohl _googlecast._tcp als auch _<your-app-id>._googlecast._tcp als Dienste hinzufügen, damit die Geräteerkennung richtig funktioniert.

    Die appID ist deine receiverID, also dieselbe ID, die in deinem GCKDiscoveryCriteria definiert ist.

    Aktualisieren Sie die folgende NSBonjourServices-Beispieldefinition und ersetzen Sie „ABCD1234“ durch Ihre App-ID.

    <key>NSBonjourServices</key>
    <array>
      <string>_googlecast._tcp</string>
      <string>_ABCD1234._googlecast._tcp</string>
    </array>
  3. NSLocalNetworkUsageDescription zu Ihrem Info.plist hinzufügen

    Wir empfehlen dringend, die im Dialogfeld „Lokales Netzwerk“ angezeigte Meldung anzupassen. Fügen Sie dazu in der Datei Info.plist Ihrer App für die NSLocalNetworkUsageDescription einen app-spezifischen Berechtigungsstring hinzu, um z. B. die Suche nach Cast-Geräten und andere Suchdienste wie DIAL zu beschreiben.

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

    Diese Meldung wird im Dialogfeld für den Zugriff auf das lokale Netzwerk unter iOS angezeigt, wie im Mockup zu sehen ist.

    Bild für das Dialogfeld „Berechtigungen für den Zugriff auf das lokale Netzwerk für Google Cast“
  4. App im Apple App Store neu veröffentlichen

    Wir empfehlen Ihnen, Ihre App so bald wie möglich mit Version 4.8.6 neu zu veröffentlichen.

Swift Package Manager einrichten

Die empfohlene Methode zum Integrieren von Google Cast ist die Verwendung von Swift Package Manager (SPM). Das Cast iOS SDK-Paket ist im GitHub-Repository google-cast-ios-sdk verfügbar.

So fügen Sie Ihrem Projekt in Xcode das Cast iOS SDK hinzu:

  1. Wählen Sie in Xcode File > Add Packages... aus.
  2. Geben Sie die Repository-URL ein: https://github.com/googlecast/google-cast-ios-sdk.
  3. Wählen Sie Ihre Versionsregeln aus. Wählen Sie beispielsweise Bis zur nächsten Hauptversion mit einer Mindestversion von 4.8.6 aus, um kompatible Updates ohne unerwartete Änderungen zu erhalten.
  4. Klicken Sie auf Paket hinzufügen.
  5. Wählen Sie entweder das Produkt GoogleCastDynamic oder GoogleCastStatic aus und fügen Sie es Ihrem App-Ziel hinzu.

Framework-Variante auswählen

Das Cast iOS SDK-Paket bietet zwei Produkte:

  • GoogleCastDynamic: Das dynamische Framework. Sie enthält alle Asset-Ressourcen, die von den Cast-UI-Komponenten benötigt werden, und erfordert keine zusätzlichen Linker-Flags. Apps, die Mac Catalyst unterstützen, müssen das dynamische Framework verwenden. Weitere Informationen finden Sie unter Mac Catalyst-Einrichtung.
  • GoogleCastStatic: Das statische Framework. Dazu sind die zusätzlichen Einrichtungsschritte erforderlich, die unter Einrichtung des statischen Frameworks beschrieben werden.

Einrichtung des statischen Frameworks

Statische Frameworks dürfen keine Ressourcenbündel enthalten. Daher kann Swift Package Manager die von den Cast-UI-Komponenten benötigten Asset-Ressourcen (z. B. UI-Bilder, Storyboards und Lokalisierungsdateien) nicht automatisch mit dem GoogleCastStatic-Produkt bündeln. Wenn Sie GoogleCastStatic Ihrem Ziel hinzufügen, führen Sie die folgenden Schritte aus:

  1. Fügen Sie in Ihrem Xcode-Projekt die Flags -ObjC -lc++ zu Build Settings > Other Linker Flags hinzu.
  2. Wenn Ihre App die Cast-UI-Komponenten verwendet, fügen Sie die Asset-Bundles manuell zu Ihrem Projekt hinzu:
    1. Laden Sie die statische Bibliothek unter Downloads herunter. Achten Sie darauf, dass die Version der statischen Bibliothek mit der Version des Pakets übereinstimmt, das Sie hinzugefügt haben.
    2. Suchen Sie im entzippten Verzeichnis nach dem Ordner Resources und ziehen Sie alle .bundle-Dateien in Ihr Xcode-Projekt. Aktivieren Sie „Alle Elemente bei Bedarf kopieren“ und fügen Sie alle Ziele hinzu.

CocoaPods-Einrichtung

Manuelle Einrichtung

Die folgende Anleitung beschreibt, wie Sie das Cast iOS SDK Ihrem Projekt hinzufügen, ohne den Swift Package Manager zu verwenden:

Downloads

Nachdem Sie die entsprechende Bibliothek unten heruntergeladen haben, folgen Sie der Einrichtungsanleitung, um das Framework Ihrem Projekt hinzuzufügen.

Cast iOS Sender SDK 4.8.6-Bibliotheken:

Statisch Dynamisch

Einrichtungsschritte

So installieren Sie die Bibliothek:

  1. Laden Sie das entsprechende SDK für Ihr Projekt herunter und entpacken Sie es.
  2. Richten Sie die dynamische GoogleCastSDK-Bibliothek ein:
  3. Ziehen Sie die entzippte Datei .xcframework in Ihr Hauptprojekt in der Xcode-Projektnavigation. Setzen Sie ein Häkchen bei „Alle Elemente bei Bedarf kopieren“ und fügen Sie die Kampagne allen Zielen hinzu.
  4. Wählen Sie in Ihrem Xcode-Ziel unter dem Tab General die Option Embed and Sign für GoogleCast.xcframework aus.

Wenn Sie die dynamische Bibliothek einrichten, führen Sie zusätzlich zu den vorherigen Schritten die folgenden Schritte aus:

  1. Entfernen Sie die aktuelle Version von GoogleCastSDK, falls vorhanden.
  2. Fügen Sie die Protobuf-Bibliothek v3.13 oder höher hinzu. Folgen Sie dazu der Anleitung im Protobuf-GitHub-Repository.

Wenn Sie die statische Bibliothek einrichten, führen Sie zusätzlich zu den vorherigen Schritten die folgenden Schritte aus:

  1. Fügen Sie in Ihrem Xcode-Projekt die Flags -ObjC -lc++ zu Build Settings > Other Linker Flags hinzu.
  2. Suchen Sie im entzippten Verzeichnis nach dem Ordner „Resources“ und ziehen Sie alle .bundle-Dateien in Ihr Projekt, neben die GoogleCast.xcframework-Datei, die Sie zuvor hinzugefügt haben. Setzen Sie ein Häkchen bei „Alle Elemente bei Bedarf kopieren“ und fügen Sie die Kampagne allen Zielen hinzu.

Mac Catalyst-Einrichtung

Verwenden Sie für Apps, die Mac Catalyst unterstützen, die dynamische Bibliothek des Cast SDK. Folgen Sie der Anleitung für die manuelle Einrichtung, um das Framework Ihrem Projekt hinzuzufügen. Schließen Sie das Cast SDK dann bedingt aus dem Mac-Ziel aus, wie in der Apple-Dokumentation beschrieben. Statische Bibliotheken werden für die iOS-Architektur vorkompiliert, was zu einem Linker-Fehler führt, wenn sie für das Mac-Ziel erstellt werden.