Intégrer le SDK Cast à votre application d'envoi Web

Ce guide du développeur explique comment rendre Google Cast compatible avec votre application Web Sender à l'aide du SDK Cast.

Remarque:Nous vous recommandons de procéder comme suit :

• Tutoriel de l'atelier de programmation "Expéditeur Web Cast : découvrez par étapes comment modifier une application vidéo Web existante pour lire du contenu sur un appareil Google Cast.
• Application exemple CastVideos-chrome (GitHub) : exécutez, parcourez et affichez cette application exemple de référence qui respecte les consignes relatives à l'expérience utilisateur et la checklist de conception.

Terminologie

L'appareil mobile ou le navigateur est l'expéditeur qui contrôle la lecture. L'appareil Google Cast est le récepteur, qui affiche le contenu à l'écran pour la lecture.

Le SDK Web Sender se compose de deux parties: l'API Framework (cast.framework) et l'API Base (chrome.cast). En général, vous effectuez des appels sur l'API Framework plus simple de niveau supérieur, qui sont ensuite traités par l'API Base de niveau inférieur.

Le framework expéditeur fait référence à l'API Framework, au module et aux ressources associées qui fournissent un wrapper pour les fonctionnalités de niveau inférieur. L'application émettrice ou l'application Chrome Google Cast fait référence à une application Web (HTML/JavaScript) exécutée dans le navigateur Chrome d'un appareil émetteur. Une application Web Receiver fait référence à une application HTML/JavaScript exécutée sur Chromecast ou un appareil Google Cast.

Le framework de l'expéditeur utilise une conception de rappel asynchrone pour informer l'application émettrice des événements et passer d'un état à l'autre du cycle de vie de l'application Cast.

Charger la bibliothèque

Pour que votre application mette en œuvre les fonctionnalités de Google Cast, elle doit connaître l'emplacement du SDK Google Cast Web Sender, comme indiqué ci-dessous. Ajoutez le paramètre de requête d'URL loadCastFramework pour charger également l'API Web Sender Framework. Toutes les pages de votre application doivent faire référence à la bibliothèque comme suit:

<script src="https://www.gstatic.com/cv/js/sender/v1/cast_sender.js?loadCastFramework=1"></script>

Framework

Le SDK Web Sender utilise l'espace de noms cast.framework.*. L'espace de noms représente les éléments suivants:

• Méthodes ou fonctions qui appellent des opérations sur l'API
• Écouteurs d'événements pour les fonctions d'écouteur dans l'API

Le framework comprend les composants principaux suivants:

• CastContext est un objet singleton qui fournit des informations sur l'état actuel de Cast et déclenche des événements pour les changements d'état de l'état Cast et de la session Cast.
• L'objet CastSession gère la session. Il fournit des informations sur l'état et déclenche des événements, tels que les modifications du volume de l'appareil, l'état du son et les métadonnées de l'application.
• L'élément Cast, qui est un élément personnalisé HTML simple qui étend le bouton HTML. Si l'icône Cast fournie n'est pas suffisante, vous pouvez l'ajouter à l'état correspondant.
• RemotePlayerController fournit la liaison de données pour simplifier l'implémentation du lecteur distant.

Consultez la documentation de référence de l'API Google Cast Web Sender pour obtenir une description complète de l'espace de noms.

Icône Cast

Le composant de l'icône Cast de votre application est entièrement géré par le framework. Cela inclut la gestion de la visibilité et de la gestion des événements de clic.

<google-cast-launcher></google-cast-launcher>

Vous pouvez également créer le bouton par programmation:

document.createElement("google-cast-launcher");

Vous pouvez appliquer un style supplémentaire à l'élément, tel que sa taille ou son positionnement, si nécessaire. Utilisez l'attribut --connected-color pour choisir la couleur de l'état du récepteur Web connecté et --disconnected-color pour l'état déconnecté.

Initialisation

Après avoir chargé l'API du framework, l'application appelle le gestionnaire window.__onGCastApiAvailable. Vous devez vous assurer que l'application définit ce gestionnaire sur window avant de charger la bibliothèque émettrice.

Dans ce gestionnaire, initialisez l'interaction Cast en appelant la méthode setOptions(options) de CastContext.

Exemple :

<script>
window['__onGCastApiAvailable'] = function(isAvailable) {
  if (isAvailable) {
    initializeCastApi();
  }
};
</script>

Ensuite, initialisez l'API comme suit:

initializeCastApi = function() {
  cast.framework.CastContext.getInstance().setOptions({
    receiverApplicationId: applicationId,
    autoJoinPolicy: chrome.cast.AutoJoinPolicy.ORIGIN_SCOPED
  });
};

L'application récupère d'abord l'instance du singleton de l'objet CastContext fourni par le framework. Il utilise ensuite setOptions(options) à l'aide d'un objet CastOptions pour définir applicationID.

Si vous utilisez le récepteur multimédia par défaut, qui ne nécessite pas d'enregistrement, vous devez utiliser une constante prédéfinie par le SDK Web Sender, comme indiqué ci-dessous, à la place de applicationID:

cast.framework.CastContext.getInstance().setOptions({
  receiverApplicationId: chrome.cast.media.DEFAULT_MEDIA_RECEIVER_APP_ID
});

Commande multimédia

Une fois le CastContext initialisé, l'application peut récupérer le CastSession actuel à tout moment à l'aide de getCurrentSession().

var castSession = cast.framework.CastContext.getInstance().getCurrentSession();

CastSession peut être utilisé pour charger des contenus multimédias sur l'appareil Cast connecté à l'aide de loadMedia(loadRequest). Commencez par créer un élément MediaInfo à l'aide des éléments contentId et contentType, ainsi que de toute autre information liée au contenu. Créez ensuite un LoadRequest à partir de celui-ci, en définissant toutes les informations pertinentes pour la requête. Enfin, appelez loadMedia(loadRequest) sur votre CastSession.

var mediaInfo = new chrome.cast.media.MediaInfo(currentMediaURL, contentType);
var request = new chrome.cast.media.LoadRequest(mediaInfo);
castSession.loadMedia(request).then(
  function() { console.log('Load succeed'); },
  function(errorCode) { console.log('Error code: ' + errorCode); });

La méthode loadMedia renvoie une promesse qui peut être utilisée pour effectuer les opérations nécessaires à la réussite du résultat. Si la promesse est rejetée, l'argument de la fonction sera un chrome.cast.ErrorCode.

Vous pouvez accéder aux variables d'état du lecteur dans RemotePlayer. Toutes les interactions avec RemotePlayer, y compris les rappels et les commandes d'événements multimédias, sont gérées avec RemotePlayerController.

var player = new cast.framework.RemotePlayer();
var playerController = new cast.framework.RemotePlayerController(player);

RemotePlayerController donne à l'application le contrôle total des options de lecture, de pause, d'arrêt et de recherche pour le contenu multimédia chargé.

• LECTURE/PAUSE: playerController.playOrPause();
• ARRÊTER: playerController.stop();
• RECHERCHER: playerController.seek();

RemotePlayer et RemotePlayerController peuvent être utilisés avec des frameworks de liaison de données, tels que Polymer ou Angular, pour implémenter un lecteur distant.

Voici un extrait de code pour Angular:

<button id="playPauseButton" class="playerButton"
  ng-disabled="!player.canPause"
  ng-click="controller.playOrPause()">
    {{player.isPaused ? 'Play' : 'Pause'}}
</button>
<script>
var player = new cast.framework.RemotePlayer();
var controller = new cast.framework.RemotePlayerController(player);
// Listen to any player update, and trigger angular data binding
update.controller.addEventListener(
  cast.framework.RemotePlayerEventType.ANY_CHANGE,
  function(event) {
    if (!$scope.$$phase) $scope.$apply();
  });
</script>

État du contenu multimédia

Lors de la lecture de contenus multimédias, divers événements se produisent. Vous pouvez les capturer en définissant des écouteurs pour différents événements cast.framework.RemotePlayerEventType sur l'objet RemotePlayerController.

Pour obtenir les informations sur l'état du contenu multimédia, utilisez l'événement cast.framework.RemotePlayerEventType.MEDIA_INFO_CHANGED, qui se déclenche lorsque la lecture change et lorsque CastSession.getMediaSession().media change.

playerController.addEventListener(
  cast.framework.RemotePlayerEventType.MEDIA_INFO_CHANGED, function() {
    // Use the current session to get an up to date media status.
    let session = cast.framework.CastContext.getInstance().getCurrentSession();

    if (!session) {
        return;
    }

    // Contains information about the playing media including currentTime.
    let mediaStatus = session.getMediaSession();
    if (!mediaStatus) {
        return;
    }

    // mediaStatus also contains the mediaInfo containing metadata and other
    // information about the in progress content.
    let mediaInfo = mediaStatus.media;
  });

Lorsque des événements tels que la mise en pause, la lecture, la reprise ou la recherche se produisent, l'application doit agir dessus et se synchroniser avec l'application Web Receiver sur l'appareil Cast. Pour en savoir plus, consultez la section Mises à jour de l'état.

Fonctionnement de la gestion des sessions

Le SDK Cast introduit le concept d'une session Cast, qui combine les étapes de connexion à un appareil, de lancement (ou de jonction) d'une application de récepteur Web, de connexion à cette application et d'initialisation d'un canal de commande multimédia. Pour en savoir plus sur les sessions Cast et le cycle de vie de Web Receiver, consultez le guide du cycle de vie de l'application Web Receiver.

Les sessions sont gérées par la classe CastContext, que votre application peut récupérer via cast.framework.CastContext.getInstance(). Les sessions individuelles sont représentées par des sous-classes de la classe Session. Par exemple, CastSession représente les sessions avec des appareils Cast. Votre application peut accéder à la session Cast actuellement active via CastContext.getCurrentSession().

Pour surveiller l'état de la session, ajoutez un écouteur à CastContext pour le type d'événement CastContextEventType.SESSION_STATE_CHANGED.

var context = cast.framework.CastContext.getInstance();
context.addEventListener(
  cast.framework.CastContextEventType.SESSION_STATE_CHANGED,
  function(event) {
    switch (event.sessionState) {
      case cast.framework.SessionState.SESSION_STARTED:
      case cast.framework.SessionState.SESSION_RESUMED:
        break;
      case cast.framework.SessionState.SESSION_ENDED:
        console.log('CastContext: CastSession disconnected');
        // Update locally as necessary
        break;
    }
  })

En cas de déconnexion, par exemple lorsque l'utilisateur clique sur le bouton "Arrêter la diffusion" de la boîte de dialogue "Caster", vous pouvez ajouter un écouteur pour le type d'événement RemotePlayerEventType.IS_CONNECTED_CHANGED dans votre écouteur. Dans votre écouteur, vérifiez si RemotePlayer est déconnecté. Le cas échéant, mettez à jour l'état du lecteur local. Exemple :

playerController.addEventListener(
  cast.framework.RemotePlayerEventType.IS_CONNECTED_CHANGED, function() {
    if (!player.isConnected) {
      console.log('RemotePlayerController: Player disconnected');
      // Update local player to disconnected state
    }
  });

Bien que l'utilisateur puisse contrôler directement l'arrêt de la diffusion via l'icône Cast du framework, l'émetteur lui-même peut arrêter de caster à l'aide de l'objet CastSession actuel.

function stopCasting() {
  var castSession = cast.framework.CastContext.getInstance().getCurrentSession();
  // End the session and pass 'true' to indicate
  // that Web Receiver app should be stopped.
  castSession.endSession(true);
}

Transfert de diffusion

La préservation de l'état de la session constitue la base du transfert de flux, qui permet aux utilisateurs de déplacer des flux audio et vidéo existants d'un appareil à l'autre à l'aide de commandes vocales, de l'application Google Home ou d'écrans connectés. La lecture du contenu multimédia s'arrête sur un appareil (la source) et continue sur un autre (la destination). Tout appareil Cast doté de la dernière version du micrologiciel peut servir de sources ou de destinations lors d'un transfert de flux.

Pour obtenir le nouvel appareil de destination pendant le transfert de flux, appelez CastSession#getCastDevice() lorsque l'événement cast.framework.SessionState.SESSION_RESUMED est appelé.

Pour en savoir plus, consultez la section Transfert de flux sur Web Receiver.