Cómo depurar apps de receptores de transmisión

1. Descripción general

Logotipo de Google Cast

En este codelab, aprenderás a agregar el registro de depuración de Cast a tu app receptora web personalizada existente.

¿Qué es Google Cast?

El SDK de Google Cast permite que tu app reproduzca contenido y controle la reproducción en dispositivos compatibles con Google Cast. Te proporciona los componentes de IU necesarios según la lista de tareas de diseño de Google Cast.

Te proporcionamos la lista de tareas de diseño de Google Cast con el fin de que la experiencia del usuario de Cast resulte sencilla y predecible en todas las plataformas compatibles.

¿Qué compilaremos?

Cuando completes este codelab, tendrás un receptor web personalizado integrado en el registrador de depuración de Cast.

Consulta la guía del registro de depuración de Cast para obtener detalles y más información.

Qué aprenderás

  • Cómo configurar tu entorno para el desarrollo del receptor web
  • Cómo integrar el registro de depuración a tu receptor de transmisión

Requisitos

Experiencia

  • Debes tener experiencia previa en Cast y comprender cómo funciona un receptor web de transmisión.
  • Debes tener conocimientos previos sobre desarrollo web.
  • También deberás tener experiencia como usuario de TV :)

¿Cómo usarás este instructivo?

Ler Leer y completar los ejercicios

¿Cómo calificarías tu experiencia con la compilación de apps web?

Principiante Intermedio Avanzado

¿Cómo calificarías tu experiencia cuando miras TV?

Principiante Intermedio Avanzado . .

2. Obtén el código de muestra

Puedes descargar el código de muestra completo a tu computadora…

y descomprimir el archivo ZIP que se descargó.

3. Implementa tu app receptora de manera local

Para poder usar tu receptor web con un dispositivo de transmisión, este debe estar alojado en un lugar donde el dispositivo pueda acceder a él. Si ya tienes un servidor disponible que admita HTTPS, omite las siguientes instrucciones y anota la URL, ya que la necesitarás en la próxima sección.

Si no tienes un servidor disponible, puedes usar Firebase Hosting o ngrok.

Ejecuta el servidor

Una vez que hayas configurado el servicio que elijas, navega a app-start y, luego, inicia tu servidor.

Toma nota de la URL de tu receptor alojado. Lo usarás en la próxima sección.

4. Registra una aplicación en Play Console de Cast

Debes registrar tu aplicación para poder ejecutar un receptor web personalizado, como se compila en este codelab, en dispositivos Chromecast. Una vez que hayas registrado tu aplicación, recibirás un ID de aplicación que la aplicación emisora deberá usar para realizar llamadas a la API, como iniciar una aplicación receptora.

Imagen de la Consola para desarrolladores de Cast con la opción para agregar una nueva aplicación botón destacado

Haz clic en "Add new application"

Imagen de la “Nueva aplicación receptora” pantalla con el mensaje "Custom Receiver" opción destacada

Selecciona "Custom Receiver", que es lo que estamos compilando.

Imagen de la “URL de la aplicación receptora” en el campo "Nuevo receptor personalizado" cuadro de diálogo que se está completando

Ingresa los detalles de la nueva app receptora; asegúrate de usar la URL de la última sección. Toma nota del ID de aplicación asignado a tu app receptora nueva.

También debes registrar tu dispositivo Google Cast para que pueda acceder a la aplicación receptora antes de publicarla. Una vez que publiques la aplicación receptora, estará disponible para todos los dispositivos Google Cast. Para los fines de este codelab, se recomienda trabajar con una aplicación receptora no publicada.

Imagen de la Consola para desarrolladores del SDK de Google Cast con la opción para agregar un dispositivo nuevo botón destacado

Haz clic en "Add new Device"

Imagen de "Agrega un dispositivo receptor de transmisión" diálogo

Ingresa el número de serie impreso en la parte posterior de tu dispositivo de transmisión y asígnale un nombre descriptivo. También puedes encontrar el número de serie si transmites la pantalla en Chrome cuando accedes a Play Console del SDK de Google Cast.

El receptor y el dispositivo tardarán entre 5 y 15 minutos en estar listos para la prueba. Después de esperar entre 5 y 15 minutos, debes reiniciar el dispositivo de transmisión.

5. Ejecuta la app de muestra

Logotipo de Google Chrome

Mientras esperamos a que nuestro nuevo receptor web esté listo para las pruebas, veamos el aspecto de una app receptora web completa de muestra. La app receptora que compilaremos podrá reproducir contenido multimedia mediante la transmisión de tasa de bits adaptable.

  1. En el navegador, abre la herramienta de comando y control (CaC).

Imagen de la sección de transmisión Controles de registro de la herramienta de comando y control (CaC).

  1. Usa el ID del receptor CC1AD845 predeterminado y haz clic en el botón SET APP ID.
  2. Haz clic en el botón para transmitir ubicado en la parte superior izquierda y selecciona tu dispositivo compatible con Google Cast.

Imagen de la sección de transmisión Controles de registro Pestaña de la herramienta de comando y control (CaC) que indica que está conectada a una app receptora.

  1. Navega a la pestaña LOAD MEDIA en la parte superior.

Imagen de "Load Media" de la herramienta de comando y control (CaC).

  1. Cambia el botón de selección de tipo de solicitud a LOAD.
  2. Haz clic en el botón SEND REQUEST para reproducir un video de muestra.
  3. El video comenzará a reproducirse en tu dispositivo compatible con Google Cast para mostrar la funcionalidad básica de la app receptora con la app receptora predeterminada.

6. Prepara el proyecto inicial

Debemos agregar compatibilidad con Google Cast a la app inicial que descargaste. A continuación, se incluye la terminología de Google Cast que usaremos en este codelab:

  • una app emisora se ejecuta en un dispositivo móvil o una laptop.
  • Una app receptora se ejecuta en un dispositivo Google Cast o Android TV.

Ya tienes todo listo para compilar sobre el proyecto inicial usando tu editor de texto favorito:

  1. Selecciona el directorio ícono de carpetaapp-start de la descarga del código de muestra.
  2. Abre js/receiver.js y index.html

Ten en cuenta que, a medida que trabajes en este codelab, http-server debería registrar los cambios que realices. De lo contrario, intenta detener y reiniciar http-server.

Diseño de la app

La app receptora inicializa la sesión de transmisión y permanecerá en espera hasta que llegue una solicitud de CARGA (como el comando para reproducir un fragmento de contenido multimedia) de una emisora.

La app consta de una vista principal, definida en index.html, y un archivo JavaScript llamado js/receiver.js, que contiene toda la lógica para que funcione la app receptora.

index.html

Este archivo html contiene toda la IU de nuestra app receptora.

receiver.js

Esta secuencia de comandos administra toda la lógica de nuestra app receptora.

Preguntas frecuentes

7. Cómo realizar la integración con la API de CastDebugLogger

El SDK de app receptora de transmisión proporciona otra opción para que los desarrolladores depuren fácilmente tu app receptora mediante la API de CastDebugLogger.

Consulta la guía del registro de depuración de Cast para obtener detalles y más información.

Inicialización

Incluye la siguiente secuencia de comandos en la etiqueta <head> de la app receptora inmediatamente después de la secuencia de comandos del SDK del receptor web, en index.html:

<head>
  ...
  <script src="//www.gstatic.com/cast/sdk/libs/caf_receiver/v3/cast_receiver_framework.js"></script>
  <!-- Cast Debug Logger -->
  <script src="//www.gstatic.com/cast/sdk/libs/devtools/debug_layer/caf_receiver_logger.js"></script>
</head>

En js/receiver.js, en la parte superior del archivo y debajo de playerManager, obtén la instancia de CastDebugLogger y habilita el registrador en un objeto de escucha de eventos READY:

const context = cast.framework.CastReceiverContext.getInstance();
const playerManager = context.getPlayerManager();

// Debug Logger
const castDebugLogger = cast.debug.CastDebugLogger.getInstance();
const LOG_TAG = 'MyAPP.LOG';

// Enable debug logger and show a 'DEBUG MODE' overlay at top left corner.
context.addEventListener(cast.framework.system.EventType.READY, () => {
  if (!castDebugLogger.debugOverlayElement_) {
      castDebugLogger.setEnabled(true);
  }
});

Cuando el registro de depuración está habilitado, se muestra una superposición de DEBUG MODE en el receptor.

Imagen de un video reproduciendo con un “MODO DE DEPURACIÓN” mensaje que aparece sobre un fondo rojo en la esquina superior izquierda del marco

Eventos del reproductor de registro

Con CastDebugLogger, puedes registrar fácilmente los eventos del reproductor que activa el SDK de Cast Web Receiver y usar diferentes niveles de registrador para registrar los datos de eventos. La configuración de loggerLevelByEvents toma cast.framework.events.EventType y cast.framework.events.category para especificar los eventos que se registrarán.

Agrega lo siguiente debajo del objeto de escucha de eventos READY para registrar cuando se activen los eventos CORE del reproductor o se transmita un cambio mediaStatus:

...

// Set verbosity level for Core events.
castDebugLogger.loggerLevelByEvents = {
  'cast.framework.events.category.CORE': cast.framework.LoggerLevel.INFO,
  'cast.framework.events.EventType.MEDIA_STATUS': cast.framework.LoggerLevel.DEBUG
};

Mensajes de registro y etiquetas personalizadas

La API de CastDebugLogger te permite crear mensajes de registro que aparecen en la superposición de depuración del receptor con diferentes colores. Usa los siguientes métodos de registro, ordenados de mayor a menor prioridad:

  • castDebugLogger.error(custom_tag, message);
  • castDebugLogger.warn(custom_tag, message);
  • castDebugLogger.info(custom_tag, message);
  • castDebugLogger.debug(custom_tag, message);

Para cada método de registro, el primer parámetro debe ser una etiqueta personalizada y el segundo parámetro es el mensaje de registro. La etiqueta puede ser cualquier cadena que te resulte útil.

Para mostrar los registros en acción, agrega registros a tu interceptor LOAD.

playerManager.setMessageInterceptor(cast.framework.messages.MessageType.LOAD,
      loadRequestData => {
    // Listed in order from highest to lowest priority.
    castDebugLogger.error(LOG_TAG, 'Test error log');

    castDebugLogger.warn(LOG_TAG, 'Test warn log');

    castDebugLogger.info(LOG_TAG, 'Intercepting LOAD request', loadRequestData);

    castDebugLogger.debug(LOG_TAG, 'Test debug log');

    return loadRequestData;
  }
);

Puedes controlar qué mensajes aparecen en la superposición de depuración configurando el nivel de registro en loggerLevelByTags para cada etiqueta personalizada. Por ejemplo, si habilitas una etiqueta personalizada con el nivel de registro cast.framework.LoggerLevel.DEBUG, se mostrarán todos los mensajes de registro que se agregaron con errores, advertencias, información y depuración. Otro ejemplo es que la habilitación de una etiqueta personalizada con el nivel WARNING solo mostraría mensajes de registro de error y advertencia.

La configuración de loggerLevelByTags es opcional. Si una etiqueta personalizada no está configurada para su nivel de registrador, todos los mensajes del registro se mostrarán en la superposición de depuración.

Agrega lo siguiente debajo de la llamada loggerLevelByEvents:

...

// Set verbosity level for custom tags.
castDebugLogger.loggerLevelByTags = {
    LOG_TAG: cast.framework.LoggerLevel.DEBUG, // display all levels
};

...

8. Cómo usar la superposición de depuración

El registro de depuración de Cast proporciona una superposición de depuración en la app receptora para mostrar tus mensajes de registro personalizados. Usa showDebugLogs para activar o desactivar la superposición de depuración y clearDebugLogs para borrar los mensajes del registro en la superposición.

Agrega lo siguiente al objeto de escucha de eventos READY para obtener una vista previa de la superposición de depuración en tu receptor:

// Enable debug logger and show a 'DEBUG MODE' overlay at top left corner.
context.addEventListener(cast.framework.system.EventType.READY, () => {
  if (!castDebugLogger.debugOverlayElement_) {
      castDebugLogger.setEnabled(true);

      // Show debug overlay.
      castDebugLogger.showDebugLogs(true);

      // Clear log messages on debug overlay.
      castDebugLogger.clearDebugLogs();
  }
});

Imagen que muestra la superposición de depuración, una lista de mensajes del registro de depuración sobre un fondo translúcido sobre un fotograma de video

9. Cómo usar la herramienta de comando y control (CaC)

Descripción general

La herramienta de comando y control (CaC) captura tus registros y controla la superposición de depuración.

Existen dos maneras de conectar tu receptor a la herramienta de CaC:

Inicia una nueva conexión de transmisión:

  1. Abre la herramienta de CaC, configura el ID de app del receptor y haz clic en el botón para transmitir a fin de transmitir al receptor.
  2. Transmite una app de emisor separada al mismo dispositivo con el mismo ID de app receptora.
  3. Carga contenido multimedia desde la app remitente y los mensajes de registro se mostrarán en la herramienta.

Únete a una sesión de transmisión existente:

  1. Obtén el ID de la sesión de transmisión en ejecución mediante el SDK del receptor o el SDK del remitente. Desde el lado del receptor, ingresa lo siguiente para obtener el ID de sesión en la consola del Depurador remoto de Chrome:
cast.framework.CastReceiverContext.getInstance().getApplicationData().sessionId;

O bien, si deseas obtener el ID de sesión de un remitente web conectado, usa el siguiente método:

cast.framework.CastContext.getInstance().getCurrentSession().getSessionId();

Imagen de la sección de transmisión Controles de registro de la herramienta de comando y control (CaC) para reanudar la sesión

  1. Ingresa el ID de sesión en la herramienta de CaC y haz clic en el botón RESUME.
  2. El botón para transmitir debe estar conectado y comenzar a mostrar mensajes de registro en la herramienta.

Qué puedes probar

A continuación, usaremos la herramienta CaC para ver los registros en tu receptor de muestra.

  1. Abre la herramienta de CaC.

Imagen de la sección de transmisión Controles de registro de la herramienta de comando y control (CaC).

  1. Ingresa el ID de app receptor de tu app de ejemplo y haz clic en el botón SET APP ID.
  2. Haz clic en el botón para transmitir ubicado en la parte superior izquierda y selecciona tu dispositivo compatible con Google Cast para abrir la app receptora.

Imagen de la sección de transmisión Controles de registro Pestaña de la herramienta de comando y control (CaC) que indica que está conectada a una app receptora.

  1. Navega a la pestaña LOAD MEDIA en la parte superior.

Imagen de &quot;Load Media&quot; de la herramienta de comando y control (CaC).

  1. Cambia el botón de selección de tipo de solicitud a LOAD.
  2. Haz clic en el botón SEND REQUEST para reproducir un video de muestra.

Imagen de la sección de transmisión Controles de registro Pestaña de la herramienta de comando y control (CaC) con mensajes de registro que ocupan el panel inferior

  1. El dispositivo debería estar reproduciendo un video de muestra. Deberías comenzar a ver los registros de los pasos anteriores en el cuadro de “Mensajes de registro”. en la parte inferior de la herramienta.

Intenta explorar las siguientes funciones para investigar los registros y controlar el receptor:

  • Haz clic en las pestañas MEDIA INFO o MEDIA STATUS para ver la información y el estado del contenido multimedia.
  • Haz clic en el botón SHOW OVERLAY para ver una superposición de depuración en la app receptora.
  • Usa el botón CLEAR CACHE AND STOP para volver a cargar la app receptora y volver a transmitir.

10. Felicitaciones

Ahora sabes cómo agregar el registrador de depuración de Cast a tu app de receptor web compatible con Cast con el SDK de la app receptora de transmisión más reciente.

Para obtener más detalles, consulta las guías para desarrolladores sobre el registro de depuración de Cast y la herramienta de comando y control (CaC).