Déboguer les applications réceptrices Cast

1. Présentation

Logo Google Cast

Dans cet atelier de programmation, vous allez apprendre à ajouter l'enregistreur de débogage Cast à votre application Custom Web Receiver existante.

Qu'est-ce que Google Cast ?

Le SDK Google Cast permet à votre application de lire du contenu et de contrôler la lecture sur les appareils compatibles Google Cast. Elle fournit les composants d'interface utilisateur nécessaires, en fonction de la checklist de conception Google Cast.

La checklist de conception de Google Cast a été conçue pour garantir une expérience utilisateur simple et prévisible sur toutes les plates-formes compatibles.

Qu'allons-nous créer ?

À la fin de cet atelier de programmation, vous disposerez d'un récepteur Web personnalisé intégré à l'enregistreur de débogage Cast.

Pour en savoir plus, consultez le guide Cast Debug Logger.

Points abordés

  • Configurer votre environnement pour le développement de Web Receiver
  • Intégrer Debug Logger à votre récepteur Cast

Prérequis

Expérience

  • Vous devez avoir une expérience de Cast et savoir comment fonctionne un récepteur Web Cast.
  • Vous devez avoir une connaissance préalable du développement Web.
  • Vous devez également avoir une expérience préalable en tant que téléspectateur :)

Comment allez-vous utiliser ce tutoriel ?

Je vais le lire uniquement Je vais le lire et effectuer les exercices

Comment évalueriez-vous votre expérience en matière de création d'applications Web ?

Débutant Intermédiaire Expert

Comment évalueriez-vous votre expérience en tant que téléspectateur ?

Débutant Intermédiaire Expert

2. Obtenir l'exemple de code

Vous pouvez télécharger tout l'exemple de code sur votre ordinateur…

puis décompresser le fichier ZIP téléchargé.

3. Déployer le récepteur en local

Pour que vous puissiez utiliser votre récepteur Web avec un appareil Cast, celui-ci doit être hébergé à un emplacement auquel votre appareil Cast peut accéder. Si vous disposez déjà d'un serveur compatible avec HTTPS, ignorez les instructions ci-dessous et notez l'URL, car vous en aurez besoin dans la section suivante.

Si vous ne disposez d'aucun serveur, vous pouvez utiliser Firebase Hosting ou ngrok.

Exécuter le serveur

Une fois le service de votre choix configuré, accédez à app-start et démarrez votre serveur.

Notez l'URL de votre récepteur hébergé. Vous l'utiliserez dans la section suivante.

4. Enregistrer une application dans la console développeur Cast

Vous devez enregistrer votre application pour pouvoir exécuter un Web Receiver personnalisé, tel qu'il est intégré dans cet atelier de programmation, sur des appareils Chromecast. Une fois votre application enregistrée, vous recevrez un ID application dont l'application émettrice doit se servir pour effectuer des appels d'API, par exemple pour lancer une application réceptrice.

Image de la console de développement Cast avec l'option "Ajouter une application" bouton mis en évidence

Cliquez sur "Add new application" (Ajouter une nouvelle application).

Image de la nouvelle application réceptrice le "Récepteur personnalisé" option mise en évidence

Sélectionnez "Récepteur personnalisé". Voici la version que nous développons.

Image de l'URL de l'application du destinataire du champ "Nouveau récepteur personnalisé" boîte de dialogue en cours de remplissage

Saisissez les informations concernant votre nouveau récepteur, en veillant à utiliser l'URL de la section précédente. Notez l'ID application attribué à votre nouveau récepteur.

Vous devez également enregistrer votre appareil Google Cast afin qu'il puisse accéder à l'application réceptrice avant de le publier. Une fois votre application réceptrice publiée, elle est disponible pour tous les appareils Google Cast. Pour les besoins de cet atelier de programmation, il est recommandé d'utiliser une application réceptrice non publiée.

Image de la console développeur du SDK Google Cast avec l'option "Ajouter un appareil" bouton mis en évidence

Cliquez sur "Add new Device" (Ajouter un appareil).

Image de l'option "Ajouter un récepteur Cast" boîte de dialogue

Saisissez le numéro de série indiqué au dos de votre appareil Cast et donnez-lui un nom descriptif. Vous pouvez également trouver le numéro de série en castant votre écran dans Chrome lorsque vous accédez à la console développeur du SDK Google Cast.

La préparation du récepteur et de l'appareil peut prendre entre 5 et 15 minutes. Après 5 à 15 minutes, vous devez redémarrer votre appareil Cast.

5. Exécuter l'application exemple

Logo Google Chrome

En attendant que notre nouveau récepteur Web soit prêt à être testé, voyons à quoi ressemble un exemple d'application Web Receiver terminée. Le récepteur que nous allons créer pourra lire des contenus multimédias à l'aide du streaming à débit adaptatif.

  1. Dans votre navigateur, ouvrez l'outil Command and Control (CaC).

Image de l'écran "Cast Connect & Logger Controls' de l'outil Command and Control (CaC)

  1. Utilisez l'ID de récepteur CC1AD845 par défaut, puis cliquez sur le bouton SET APP ID.
  2. Cliquez sur l'icône Cast en haut à gauche, puis sélectionnez votre appareil compatible Google Cast.

Image de l'écran "Cast Connect & Logger Controls' de l'outil Command and Control (CaC) indiquant qu'il est connecté à une appli de réception

  1. Accédez à l'onglet LOAD MEDIA en haut de la page.

Image de l'option "Charger l'élément multimédia" de l'outil Command and Control (CaC)

  1. Définissez la case d'option "Type de requête" sur LOAD.
  2. Cliquez sur le bouton SEND REQUEST pour lire un exemple de vidéo.
  3. La lecture de la vidéo commence sur votre appareil compatible Google Cast pour montrer à quoi ressemble le fonctionnement de base du récepteur avec le récepteur par défaut.

6. Préparer le projet de départ

Nous objectif est de rendre l'application de départ que vous avez téléchargée compatible avec Google Cast. Voici quelques termes liés à Google Cast que nous utiliserons dans cet atelier de programmation:

  • Une appli de type émetteur s'exécute sur un appareil mobile ou un ordinateur portable.
  • Une application de récepteur s'exécute sur l'appareil Google Cast ou Android TV.

Vous êtes maintenant prêt à développer le projet de démarrage à l'aide de votre éditeur de texte préféré:

  1. Sélectionnez le répertoire Icône Dossierapp-start à partir de l'exemple de code téléchargé.
  2. Ouvrez js/receiver.js et index.html.

Notez que tout au long de cet atelier de programmation, http-server devrait appliquer les modifications que vous apportez. Si ce n'est pas le cas, essayez d'arrêter et de redémarrer http-server.

Conception de l'application

L'application réceptrice initialise la session Cast et reste en veille jusqu'à l'arrivée d'une requête LOAD (la commande de lecture d'un contenu multimédia, par exemple) de l'expéditeur.

L'application comprend une vue principale, définie dans index.html, et un fichier JavaScript appelé js/receiver.js qui contient toute la logique permettant au récepteur de fonctionner.

index.html

Ce fichier HTML contient toute l'interface utilisateur de notre application réceptrice.

receiver.js

Ce script gère toute la logique de notre application réceptrice.

Questions fréquentes

7. Intégrer à l'API CastDebugLogger

Le SDK Récepteur Cast offre aux développeurs une autre option pour déboguer facilement votre application réceptrice à l'aide de l'API CastDebugLogger.

Pour en savoir plus, consultez le guide Cast Debug Logger.

Initialisation

Incluez le script suivant dans la balise <head> de votre application réceptrice, juste après le script du SDK Web Receiver, dans 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>

Dans js/receiver.js, en haut du fichier et sous playerManager, récupérez l'instance CastDebugLogger et activez l'enregistreur dans un écouteur d'événements 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);
  }
});

Lorsque l'enregistreur de débogage est activé, une superposition de DEBUG MODE s'affiche sur le récepteur.

Image d&#39;une vidéo en cours de lecture avec le MODE DE DÉBOGAGE message apparaissant sur un fond rouge dans le coin supérieur gauche du cadre

Événements du lecteur de journal

CastDebugLogger vous permet de consigner facilement les événements du lecteur qui sont déclenchés par le SDK Cast Web Receiver et d'utiliser différents niveaux d'enregistreur pour consigner les données des événements. La configuration loggerLevelByEvents utilise cast.framework.events.EventType et cast.framework.events.category pour spécifier les événements à enregistrer.

Ajoutez le code suivant sous l'écouteur d'événements READY pour consigner le déclenchement des événements CORE du lecteur ou la diffusion d'une modification de 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
};

Messages de journal et balises personnalisées

L'API CastDebugLogger vous permet de créer des messages de journal qui apparaissent avec différentes couleurs sur la superposition de débogage du récepteur. Utilisez les méthodes de journalisation suivantes, classées de la priorité la plus haute à la plus basse:

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

Pour chaque méthode d'enregistrement, le premier paramètre doit être une balise personnalisée, et le second le message de journal. La balise peut être n'importe quelle chaîne que vous jugez utile.

Pour les afficher en action, ajoutez-les à votre intercepteur 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;
  }
);

Vous pouvez contrôler les messages qui s'affichent sur le calque de débogage en définissant le niveau de journalisation dans loggerLevelByTags pour chaque balise personnalisée. Par exemple, l'activation d'une balise personnalisée avec le niveau de journalisation cast.framework.LoggerLevel.DEBUG affiche tous les messages ajoutés avec une erreur, un avertissement, des informations et des messages de débogage. Autre exemple : l'activation d'une balise personnalisée avec le niveau WARNING n'affiche que les messages de journal d'erreur et d'avertissement.

La configuration loggerLevelByTags est facultative. Si aucune balise personnalisée n'est configurée pour son niveau d'enregistreur, tous les messages de journal s'affichent sur le calque de débogage.

Ajoutez le code suivant sous l'appel loggerLevelByEvents:

...

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

...

8. Utiliser la superposition de débogage

L'enregistreur de débogage Cast fournit un calque de débogage sur le récepteur pour afficher vos messages de journal personnalisés. Utilisez showDebugLogs pour activer/désactiver le calque de débogage et clearDebugLogs pour effacer les messages de journal sur la superposition.

Ajoutez le code suivant à l'écouteur d'événements READY pour prévisualiser la superposition de débogage sur votre récepteur:

// 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();
  }
});

Image montrant le calque de débogage, une liste de messages du journal de débogage sur un arrière-plan translucide au-dessus d&#39;une image vidéo

9. Utiliser l'outil de commande et de contrôle (CaC)

Présentation

L'outil Command and Control (CaC) enregistre vos journaux et contrôle le calque de débogage.

Il existe deux façons de connecter votre récepteur à l'outil CaC:

Démarrez une nouvelle connexion Cast:

  1. Ouvrez l'outil CaC, définissez l'ID de l'application du récepteur, puis cliquez sur l'icône Cast pour caster du contenu sur le récepteur.
  2. Castez une application sender distincte sur le même appareil avec le même ID d'application destinataire.
  3. Les fichiers multimédias à charger à partir de l'application émettrice et les messages de journal s'afficheront dans l'outil.

Rejoindre une session Cast existante:

  1. Obtenez l'ID de la session Cast en cours d'exécution à l'aide du SDK du récepteur ou du SDK de l'expéditeur. Du côté du récepteur, saisissez la commande suivante pour obtenir l'ID de session dans la console Chrome Remote Debugger:
cast.framework.CastReceiverContext.getInstance().getApplicationData().sessionId;

Vous pouvez également obtenir l'ID de session auprès d'un expéditeur Web connecté à l'aide de la méthode suivante:

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

Image de l&#39;écran &quot;Cast Connect & Logger Controls&#39; de l&#39;outil Command and Control (CaC) pour reprendre la session

  1. Saisissez l'ID de session dans l'outil CaC, puis cliquez sur le bouton RESUME.
  2. L'icône Cast doit être connectée et commencer à afficher des messages de journal sur l'outil.

À essayer

Nous allons ensuite utiliser l'outil CaC pour afficher les journaux sur votre exemple de récepteur.

  1. Ouvrez l'outil CAC.

Image de l&#39;écran &quot;Cast Connect & Logger Controls&#39; de l&#39;outil Command and Control (CaC)

  1. Saisissez l'ID d'application destinataire de votre exemple d'application, puis cliquez sur le bouton SET APP ID.
  2. Cliquez sur l'icône Cast en haut à gauche, puis sélectionnez votre appareil compatible Google Cast pour ouvrir le récepteur.

Image de l&#39;écran &quot;Cast Connect & Logger Controls&#39; de l&#39;outil Command and Control (CaC) indiquant qu&#39;il est connecté à une appli de réception

  1. Accédez à l'onglet LOAD MEDIA en haut de la page.

Image de l&#39;option &quot;Charger l&#39;élément multimédia&quot; de l&#39;outil Command and Control (CaC)

  1. Définissez la case d'option "Type de requête" sur LOAD.
  2. Cliquez sur le bouton SEND REQUEST pour lire un exemple de vidéo.

Image de l&#39;écran &quot;Cast Connect & Logger Controls&#39; Onglet de l&#39;outil Command and Control (CaC) avec des messages de journal remplissant le volet inférieur

  1. Un échantillon vidéo devrait maintenant être en cours de lecture sur votre appareil. Les journaux des étapes précédentes devraient commencer à s'afficher dans la section "Messages de journal" en bas de l'outil.

Essayez d'explorer les fonctionnalités suivantes pour examiner les journaux et contrôler le récepteur:

  • Cliquez sur l'onglet MEDIA INFO ou MEDIA STATUS pour afficher les informations et l'état du contenu multimédia.
  • Cliquez sur le bouton SHOW OVERLAY pour afficher un calque de débogage sur le récepteur.
  • Utilisez le bouton CLEAR CACHE AND STOP pour actualiser l'application réceptrice et caster à nouveau.

10. Félicitations

Vous savez maintenant ajouter l'enregistreur de débogage Cast à votre application réceptrice Web compatible Cast à l'aide du dernier SDK Cast Receiver.

Pour en savoir plus, consultez les guides du développeur Cast Debug Logger et Command and Control (CaC) Tool.