Cómo depurar apps de receptores de transmisión

1. Descripción general

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 la 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 registrador de depuración de Cast para obtener más información.

Qué aprenderás

• Cómo configurar tu entorno para el desarrollo de receptores web
• Cómo integrar el registrador de depuración en tu receptor de Cast

Requisitos

• La versión más reciente del navegador Google Chrome
• Un servicio de hosting HTTPS, como Firebase Hosting o ngrok
• Un dispositivo Google Cast, como Chromecast o Android TV, que esté configurado con acceso a Internet
• Una TV o un monitor con entrada HDMI

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 :)

2. Obtén el código de muestra

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

file_downloadDescargar código fuente

y descomprimir el archivo ZIP que se descargó.

3. Implementa tu receptor de forma 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 siguiente sección.

Si no tienes un servidor disponible para usar, 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.

Anota 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 la aplicación, recibirás un ID de aplicación que la aplicación emisora debe utilizar para realizar llamadas a la API, como, por ejemplo, para iniciar una aplicación receptora.

Haz clic en "Add new application".

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

Ingresa los detalles del nuevo receptor. 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 realizar este codelab, se recomienda trabajar con una aplicación receptora no publicada.

Haz clic en "Add new Device"

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 la Consola del SDK de Google Cast para programadores

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

Mientras esperamos que nuestro nuevo receptor web esté listo para la prueba, veamos qué aspecto tiene una app de receptor web de muestra completa. El receptor 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).

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

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

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

6. Prepara el proyecto inicial

Debemos agregar compatibilidad con Google Cast a la app inicial que descargaste. Estos son algunos términos relacionados con 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 puedes compilar sobre el proyecto inicial con tu editor de texto favorito:

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

Ten en cuenta que, a medida que trabajas en este codelab, http-server debe incorporar los cambios que apliques. Si no es así, intenta detener y reiniciar http-server.

Diseño de apps

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

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 el receptor.

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

• ¿Qué es Google Cast?
• ¿Cómo me convierto en desarrollador de Google Cast?

7. Realiza la integración con la API de CastDebugLogger

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

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

Inicialización

Incluye la siguiente secuencia de comandos en la etiqueta <head> de tu app del receptor justo 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 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.

Registra eventos del reproductor

Con CastDebugLogger, puedes registrar fácilmente los eventos del reproductor que activa el SDK de la app receptora web de Cast y usar diferentes niveles de registro para acceder a los datos del evento. La configuración 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, que se ordenan 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 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 habilitar una etiqueta personalizada con el nivel WARNING solo mostraría mensajes de error y advertencias.

La configuración 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 transmisión (Cast Debug Logger) proporciona una superposición de depuración en el receptor 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 el 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();
  }
});

9. Usa 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 el receptor a la herramienta de CaC:

Inicia una nueva conexión de Cast:

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

Cómo unirse a una sesión de Cast existente:

1. Obtén el ID de sesión de Cast en ejecución con 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;

También puedes obtener el ID de sesión de un remitente web conectado. Para ello, usa el siguiente método:

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

2. Ingresa el ID de sesión en la herramienta de CaC y haz clic en el botón RESUME.
3. El botón de transmisión debería estar conectado y comenzar a mostrar mensajes de registro en la herramienta.

Qué puedes probar

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

1. Abre la herramienta de CaC.

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

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

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

7. El dispositivo debería estar reproduciendo un video de muestra. Deberías comenzar a ver que los registros de los pasos anteriores comienzan a mostrarse en la pestaña "Log Messages" en la parte inferior de la herramienta.

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

• Haz clic en la pestaña 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 del receptor y transmitir de nuevo.

10. Felicitaciones

Ahora sabes cómo agregar el registrador de depuración de Cast a tu app receptora web compatible con Cast con el SDK de app receptora de Cast 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).