Knowledge Base

Xcode-Projekt einrichten

Das TeamViewer SDK verwendet während einer Remote-Support-Session die Kamera und das Mikrofon.

Fügen Sie der Datei Info.Plist die folgenden Schlüssel hinzu:

• NSMicrophoneUsageDescription
• NSCameraUsageDescription

2. Legen Sie einen Delegaten fest, der dem Protokoll TeamViewerSDKDelegate entspricht.

Dadurch wird sichergestellt, dass Sie auf Ereignisse reagieren können, die während der Dauer Ihrer TeamViewer Verbindung auftreten.

3. Verbinden Sie sich mit einem Session-Code

Das gemeinsam genutzte SDK bietet eine Methode zum Herstellen einer Verbindung zu einem Session-Code. Dieser Session-Code kann zwei Arten entsprechen:

• Remote Support oder 
• Assist AR

4. Erstellen Sie Session-Codes in Ihrem TeamViewer Client oder über die TeamViewer REST-API.

Die Methode connectToSessionCode resultiert in einer TeamViewer Session.

WICHTIG:

• Sie sind dafür verantwortlich, diese Variable aufrechtzuerhalten und auch freizugeben. Andernfalls kann es vorkommen, dass die Benutzeroberfläche der Session auch nach Beendigung der Remote-Session weiterhin aktiv bleibt. 
• Sobald das SDK eine Verbindung zu einem Session-Code herstellt, wechselt es in einen Wartezustand. Über die Delegate-Methode handleSessionCodeOnline werden Sie über die Statusänderung benachrichtigt.

Zu diesem Zeitpunkt sollten Sie dem Benutzer nicht erlauben, eine Verbindung zu einem anderen Session-Code herzustellen. Es ist nur möglich, dem Benutzer zu erlauben, die aktuelle Verbindung zu verlassen.

Auf der Supporter-Seite wird der Session-Code als online angezeigt, so dass der Client eine Verbindung zu diesem Session-Code herstellen kann.

Auf eingehende Verbindungen reagieren

Das SDK bietet Delegate-Methoden, um auf eingehende Verbindungsereignisse zu reagieren.

Sobald die Verbindung auf der TeamViewer Seite initiiert wurde, wird das SDK über die Delegate-Methode handleConnectionRequestWithAuthenticationData über diesen Verbindungsversuch informiert.

Der Parameter für die Authentifizierungsdaten enthält den Namen des Supporters, die Art der eingehenden Verbindung (ScreenShare oder Assist AR) und eine Callback-Funktion zum Zulassen oder Ablehnen der eingehenden Verbindung.

Wird die eingehende Verbindung akzeptiert, wird die entsprechende TeamViewer Verbindung aufgebaut.

• Bei der ScreenShare-Verbindung wird dem Benutzer eine Aufforderung zur Mikrofon- und Bildschirmfreigabe angezeigt.

Die Benutzeroberfläche Ihrer Anwendung wird mit dem Replay-Kit erfasst und es findet eine bidirektionale VoIP-Kommunikation zwischen dem Benutzer und dem Supporter statt.

• Für die Assist AR-Verbindung werden die Systemberechtigungen für den Zugriff auf Kamera und Mikrofon angezeigt. Wenn der Benutzer dies zulässt, wird die AR-Sitzung gestartet. Es findet eine bidirektionale VoIP-Kommunikation zwischen dem Benutzer und dem Supporter statt.
• Die Delegate-Methode handleConnectionRequestAbort sollte implementiert werden, um benachrichtigt zu werden, wenn der Remote-Benutzer die Verbindungsanfrage abbricht. Sie sind dafür verantwortlich, alle Eingabeaufforderungen zu löschen, die dem Benutzer angezeigt werden, oder alle CallKit-Benachrichtigungen über eingehende Anrufe abzubrechen.

Auf optionale SDK-Ereignisse reagieren

• handleSupporterConnected: Diese Methode wird aufgerufen, wenn der Supporter die Session gestartet hat. Sie wird auch aufgerufen, wenn der Benutzer die Session lokal gestartet hat.
• handleSupporterDisconnected: Diese Methode wird aufgerufen, wenn der Supporter die Session beendet hat. Sie wird auch aufgerufen, wenn der Benutzer die Session lokal beendet hat.

Hinweis: Sie sollten die Verweise auf die Session löschen, da die Session zu diesem Zeitpunkt als nicht mehr gültig betrachtet wird.

• handleError: Diese Methode wird aufgerufen, wenn der Session-Code oder das für den Verbindungsaufbau verwendete API-Token nicht gültig sind.

Hinweis: Sie sollten die für die aktuelle Session verwendeten Ressourcen bereinigen, da die Session selbst als ungültig betrachtet wird.

Auf optionale Session-Ereignisse reagieren

• handleSessionError: Diese Methode wird aufgerufen, wenn während der Session ein Fehler aufgetreten ist. Beispielsweise wurde eine Funktion angefordert, aber die Kompatibilität zwischen Client und Server war nicht gegeben.

Hinweis: Dieser Fehler dient nur zu Informationszwecken. Sie können ihn in eine Protokolldatei schreiben.

Hinweis zur CallKit-Unterstützung

Wenn Ihre Anwendung CallKit unterstützt:

• Stellen Sie TeamViewer SDK Informationen über die eindeutige Kennung Ihres Anrufs zur Verfügung.
• TeamViewer fragt das System, ob ein Anruf läuft, und versucht in diesem Fall nicht, eine VoIP-Verbindung herzustellen.
• Teilen Sie TeamViewer mit, dass der aktuelle Anruf von Ihnen stammt, damit wir die Audio-Pipeline übernehmen und die VoIP-Übertragung starten können:
  1. Rufen Sie die Methode setupCallUUID auf.
  2. Teilen Sie dem SDK mit, dass Ihr Anruf beendet ist, indem Sie die Methode clearCallUUID aufrufen.

Hintergrundmodi aktivieren

Stellen Sie sicher, dass mindestens einer dieser Hintergrundmodi in Ihrer Info.plist-Datei aktiviert ist:

• Audio,
• AirPlay oder
• Voice-over-IP-Hintergrundmodus.

WICHTIG: Wenn Sie dies nicht tun, wird die App nur wenige Sekunden nach dem Wechsel in den Hintergrund während einer aktiven TeamViewer Session angehalten.

Audio-Einstellungen

Das mobile SDK arbeitet mit den Standardkonfigurationswerten von AVAudioSession.

• Wenn Sie diese Werte überschreiben möchten, um Bluetooth, Airplay, Lautsprecher usw. zu unterstützen, müssen Sie dies vor dem Aufbau einer Session ändern. Falls Ihre Anwendung andere Apps stummschaltet, empfiehlt es sich, die Audio-Session unmittelbar vor der Annahme der Verbindung zu konfigurieren.
• Wenn sich das Audio Ihrer Anwendung mit anderen Apps mischt, können Sie die Audiooptionen beim Start der Anwendung konfigurieren.