Base de Conocimiento

Requisitos previos

• iOS 14.1 y superior
• Una cuenta existente en TeamViewer

Si no tienes una cuenta en TeamViewer, sigue los pasos que se indican a continuación para crear una:

1. Visita https://login.teamviewer.com/ y haz clic en Registrarse.
2. Completa los pasos para crear una cuenta y validar tu dirección de correo electrónico.

Configuración del proyecto Xcode

El SDK de TeamViewer utiliza la cámara y el micrófono durante una sesión de asistencia remota.

1) Añade las siguientes claves al archivo Info.Plist:

• NSMicrophoneUsageDescription
• NSCameraUsageDescription

2) Establece un delegado conforme al protocolo TeamViewerSDKDelegate.

De este modo, podrás reaccionar a los acontecimientos que se produzcan durante la vida útil de tu conexión TeamViewer.

3) Conectarte a un código de sesión

El SDK compartido proporciona un método para establecer una conexión con un código de sesión. Este código de sesión puede ser de dos tipos:

• Asistencia remota o
• Assist AR

4) Crea códigos de sesión en tu cliente TeamViewer o a través de la API REST TeamViewer.

El método connectToSessionCode devuelve una sesión TeamViewer.

🚨IMPORTANTE: Eres responsable de mantener viva esta variable, y también responsable de liberar esta variable. De lo contrario, la interfaz de usuario de la sesión podría mantenerse activa incluso después de que la sesión remota haya finalizado.

🚨IMPORTANTE: Una vez que el SDK se conecta a un código de sesión, entra en un estado de espera, se te notifica sobre el cambio de estado a través del método delegado handle SessionCodeOnline.

En este punto, no debes permitir que el usuario se conecte a un código de sesión diferente. Sólo está autorizado permitir que el usuario abandone la conexión actual.

En el lado del partidario, el código de sesión aparecerá como en línea, permitiendo al cliente establecer una conexión con ese código de sesión.

Reacción ante las conexiones entrantes

El SDK proporciona métodos delegados para reaccionar a los eventos de conexión entrantes.

Una vez iniciada la conexión en TeamViewer, el SDK recibe una notificación sobre este intento de conexión a través del método delegado handle ConnectionRequestWithAuthenticationData.

En el parámetro de datos de autenticación se encuentra el nombre del partidario, el tipo de conexión entrante (ScreenShare o Assist AR) y una función callback para permitir o rechazar la conexión entrante.

Si se acepta la conexión entrante, se establece la conexión TeamViewer correspondiente.

• En el caso de la conexión ScreenShare, se muestra al usuario una solicitud para compartir el micrófono y la pantalla.

La interfaz de usuario de su aplicación se captura mediante el kit de reproducción y existe una comunicación VoIP bidireccional entre el usuario y el colaborador.

• Para la conexión Assist AR, se muestran los permisos del sistema para el acceso a la cámara y al micrófono. Si el usuario lo permite, se inicia la sesión de RA. Hay comunicación VoIP bidireccional entre el usuario y el partidario.
• El método delegado handleConnectionRequestAbort debe ser implementado para ser notificado cuando el usuario remoto cancela la solicitud de conexión. Es responsable de borrar cualquier aviso que se muestre al usuario, o de cancelar cualquier notificación de llamada entrante de CallKit.

Reacción ante eventos opcionales del SDK

• handleSessionCodeOnline: Este método se llama cuando el seguidor ha finalizado la sesión, también se llama cuando el usuario ha finalizado localmente la sesión.
• handleSupporterDisconnected: Este método se llama cuando el seguidor ha finalizado la sesión, también se llama cuando el usuario ha finalizado localmente la sesión.

💡Sugerencia: Debes limpiar las referencias a la sesión ya que en este momento se considera que la sesión ya no es válida.

• handleError: Este método se llama si el código de sesión o el token de API utilizado para establecer una conexión no son válidos.

💡Sugerencia: Debes limpiar los recursos utilizados para la sesión actual, ya que la propia sesión se considera inválida.

Reacción ante eventos opcionales de la sesión

• handleSessionError: Se llama cuando se ha producido un error durante la sesión. Por ejemplo, se ha solicitado una función pero no se ha cumplido la compatibilidad entre cliente y servidor.

💡 Sugerencia: Este error es sólo informativo. Puede escribirlo en un archivo de registro.

Nota sobre la compatibilidad con CallKit

Si tu aplicación es compatible con CallKit:

• Proporciona al SDK TeamViewer información sobre el identificador único de tu llamada.
• TeamViewer pregunta al sistema si hay una llamada en curso y no intenta establecer una conexión VoIP si este es el caso.
• Díle a TeamViewer que la llamada actual es tuya para que podamos hacernos cargo del canal de audio e iniciar la transmisión VoIP:
  1. Llama al método setupCallUUID.
  2. Informa al SDK de que tu llamada ha finalizado llamando al método clearCall UUID.

Activación de los modos de fondo

Asegúrate de tener activado al menos uno de estos modos de fondo en tu archivo Info.plist:

• Audio,
• AirPlay o
• Modo de fondo de voz sobre IP.

🚨IMPORTANTE: Si no lo haces, la aplicación se suspenderá sólo unos segundos después de haberla puesto en segundo plano durante una sesión activa de TeamViewer.

Configuración de audio

El SDK para móviles trabaja con los valores de configuración por defecto de AVAudioSession.

• Si quieres anular estos valores para soportar Bluetooth, Airplay mix, usar altavoces, etc., asegúrate de cambiar esto antes de que se establezca una sesión. En caso de que tu aplicación silencie otras apps, el momento recomendado para configurar la sesión de audio es justo antes de aceptar la conexión.
• Si el audio de tu aplicación se mezcla con el de otras aplicaciones, puedes configurar las opciones de audio al iniciar la aplicación.