Base de connaissance

Prérequis

• iOS 14.1 ou ultérieur
• Un compte TeamViewer existant

Si vous n'avez pas de compte TeamViewer, suivez les étapes ci-dessous pour en créer un :

1. Allez sur https://login.teamviewer.com/ et cliquez sur S'inscrire.
2. Complétez les étapes pour créer un compte puis validez votre adresse e-mail.

Mise en place du projet Xcode

Le SDK TeamViewer utilise la caméra et le microphone lors d'une session d'assistance à distance.

1. Ajoutez les clés suivantes au fichier Info.Plist :

• NSMicrophoneUsageDescription
• NSCameraUsageDescription

2. Définir un délégué conforme au protocole TeamViewerSDKDelegate.

Vous êtes ainsi en mesure de réagir aux événements qui se produisent pendant la durée de vie de votre connexion TeamViewer.

3. Connexion à un code de session

Le SDK partagé fournit une méthode pour établir une connexion avec un code de session. Ce code de session peut être de deux types :

• Support à distance ou
• Assist AR

4. Créez des codes de session dans votre client TeamViewer ou via l'API REST TeamViewer.

La méthode connectToSessionCode renvoie une session TeamViewer.

🚨IMPORTANT : Vous êtes responsable du maintien de cette variable et de sa libération. Si vous ne le faites pas, l'interface utilisateur de la session risque d'être maintenue en vie même après la fin de la session à distance.

🚨IMPORTANT : une fois que le SDK se connecte à un code de session, il entre dans un état d'attente. Vous êtes informé du changement d'état par la méthode déléguée handleSessionCodeOnline.

À ce stade, vous ne devez pas permettre à l'utilisateur de se connecter à un autre code de session. Il est seulement permis d'autoriser l'utilisateur à quitter la connexion en cours.

Du côté du supporter, le code de session apparaît comme étant en ligne, ce qui permet au client d'établir une connexion avec ce code de session.

Réagir aux connexions entrantes

Le SDK fournit des méthodes de délégation pour réagir aux événements de connexion entrants.

Une fois la connexion initiée du côté de TeamViewer, le SDK est informé de cette tentative de connexion via la méthode déléguée handleConnectionRequestWithAuthenticationData.

Le paramètre des données d'authentification contient le nom du supporter, le type de connexion entrante (ScreenShare ou Assist AR) et une fonction de rappel pour autoriser ou rejeter la connexion entrante.

Si la connexion entrante est acceptée, la connexion TeamViewer correspondante est établie.

• Pour la connexion ScreenShare, une invite pour le microphone et le partage d'écran est présentée à l'utilisateur.

L'interface utilisateur de votre application est capturée à l'aide du kit de relecture et il existe une communication VoIP bidirectionnelle entre l'utilisateur et le supporter.

• Pour la connexion Assist AR, les autorisations système pour l'accès à la caméra et au microphone sont affichées. Si l'utilisateur l'autorise, la session de RA est lancée. Une communication VoIP bidirectionnelle est établie entre l'utilisateur et le supporter.
• La méthode déléguée handleConnectionRequestAbort doit être implémentée afin d'être notifiée lorsque l'utilisateur distant annule la demande de connexion. Il est de votre responsabilité d'effacer toutes les invites qui sont montrées à l'utilisateur, ou d'annuler toutes les notifications d'appels entrants de CallKit.

Réagir aux événements optionnels du SDK

• handleSupporterConnected: Cette méthode est appelée lorsque le supporter a mis fin à la session. Elle est également appelée lorsque l'utilisateur a mis fin à la session localement.
• handleSupporterDisconnected: Cette méthode est appelée lorsque le supporter a mis fin à la session. Elle est également appelée lorsque l'utilisateur a mis fin à la session localement.

💡Astuce: Il convient de supprimer les références à la session, car celle-ci n'est plus considérée comme valide à ce stade.

• handleError: Cette méthode est appelée si le code de session ou le jeton API utilisé pour établir une connexion n'est pas valide.

💡Astuce: Vous devez nettoyer les ressources utilisées pour la session en cours, car la session elle-même est considérée comme invalide.

Réagir aux événements facultatifs de la session

• handleSessionError: Cette fonction est appelée lorsqu'une erreur s'est produite au cours de la session. Par exemple, une fonctionnalité a été demandée mais la compatibilité entre le client et le serveur n'a pas été respectée.

💡Astuce : Cette erreur n'est qu'informative. Vous pouvez l'écrire dans un fichier journal.

Note sur la prise en charge de CallKit

Si votre application prend en charge CallKit :

• Fournissez au SDK TeamViewer des informations sur l'identifiant unique de votre appel.
• TeamViewer demande au système s'il y a un appel en cours et n'essaie pas d'établir une connexion VoIP si c'est le cas.
• Indiquez à TeamViewer que l'appel en cours est le vôtre afin que nous puissions prendre en charge le pipeline audio et démarrer la transmission VoIP :
  1. Appeler la méthode setupCallUUID.
  2. Indiquez au SDK que votre appel est terminé en appelant la méthode clearCallUUID.

Activation des modes d'arrière-plan

Assurez-vous qu'au moins l'un de ces modes d'arrière-plan est activé dans votre fichier Info.plist :

• Audio,
• AirPlay ou
• Mode d'arrière-plan pour la voix sur IP.

🚨IMPORTANT : si vous ne le faites pas, l'application sera suspendue quelques secondes seulement après avoir été placée en arrière-plan lors d'une session active sur TeamViewer.

Configuration audio

Le SDK mobile utilise les valeurs de configuration par défaut d'AVAudioSession.

• Si vous souhaitez remplacer ces valeurs pour prendre en charge Bluetooth, Airplay mix, utiliser des haut-parleurs, etc., veillez à les modifier avant l'établissement d'une session. Si votre application met en sourdine d'autres applications, il est recommandé de configurer la session audio juste avant d'accepter la connexion.
• Si le son de votre application se mélange à celui d'autres applications, vous pouvez configurer les options audio au lancement de l'application.