Ajouter des fonctionnalités de base à votre récepteur Web personnalisé

Cette page contient des extraits de code et une description des fonctionnalités disponibles pour une application Custom Web Receiver.

  1. Un élément cast-media-player qui représente l'interface utilisateur intégrée du lecteur fournie avec Web Receiver.
  2. Style CSS personnalisé pour l'élément cast-media-player afin d'appliquer un style à différents éléments d'interface utilisateur tels que background-image, splash-image et font-family.
  3. Un élément de script permettant de charger le framework Web Receiver.
  4. Code JavaScript pour intercepter les messages et gérer les événements.
  5. File d'attente pour lecture automatique
  6. Options pour configurer la lecture
  7. Options permettant de définir le contexte Web Receiver.
  8. Options permettant de définir les commandes compatibles avec l'application Web Receiver.
  9. Appel JavaScript pour démarrer l'application Web Receiver.

Configuration et options de l'application

Configurer l'application

CastReceiverContext est la classe externe exposée au développeur. Elle gère le chargement des bibliothèques sous-jacentes et l'initialisation du SDK Web Receiver. Le SDK fournit des API qui permettent aux développeurs d'applications de configurer le SDK via CastReceiverOptions. Ces configurations sont évaluées une fois par lancement d'application et transmises au SDK lors de la définition du paramètre facultatif dans l'appel de start.

L'exemple ci-dessous montre comment ignorer le comportement par défaut pour détecter si une connexion d'expéditeur est toujours active. Lorsque le récepteur Web n'a pas pu communiquer avec un expéditeur pendant maxInactivity secondes, un événement SENDER_DISCONNECTED est envoyé. La configuration ci-dessous remplace ce délai. Cela peut être utile lors du débogage des problèmes, car cela empêche l'application Web Receiver de fermer la session du débogueur à distance Chrome lorsqu'aucun expéditeur connecté n'a l'état IDLE.

const context = cast.framework.CastReceiverContext.getInstance();
const options = new cast.framework.CastReceiverOptions();
options.maxInactivity = 3600; // Development only
context.start(options);

Configurer le lecteur

Lors du chargement de contenu, le SDK Web Receiver permet de configurer des variables de lecture telles que les informations DRM, les nouvelles configurations et les gestionnaires de requêtes à l'aide de cast.framework.PlaybackConfig. Ces informations sont gérées par PlayerManager et évaluées au moment de la création des joueurs. Les lecteurs sont créés chaque fois qu'une nouvelle charge est transmise au SDK Web Receiver. Les modifications apportées à PlaybackConfig après la création du lecteur sont évaluées lors du prochain chargement de contenu. Le SDK fournit les méthodes suivantes pour modifier le PlaybackConfig.

  • CastReceiverOptions.playbackConfig pour remplacer les options de configuration par défaut lors de l'initialisation de CastReceiverContext.
  • PlayerManager.getPlaybackConfig() pour obtenir la configuration actuelle.
  • PlayerManager.setPlaybackConfig() pour remplacer la configuration actuelle Ce paramètre est appliqué à tous les chargements suivants ou jusqu'à ce qu'il soit de nouveau remplacé.
  • PlayerManager.setMediaPlaybackInfoHandler() pour appliquer des configurations supplémentaires uniquement à l'élément multimédia en cours de chargement, en plus des configurations actuelles. Le gestionnaire est appelé juste avant la création du lecteur. Les modifications apportées ici ne sont pas permanentes et ne sont pas incluses dans les requêtes destinées à getPlaybackConfig(). Lorsque l'élément multimédia suivant est chargé, ce gestionnaire est rappelé.

L'exemple ci-dessous montre comment définir PlaybackConfig lors de l'initialisation de CastReceiverContext. La configuration remplace les requêtes sortantes pour l'obtention de fichiers manifestes. Le gestionnaire indique que les requêtes de contrôle d'accès CORS doivent être effectuées à l'aide d'identifiants tels que des cookies ou des en-têtes d'autorisation.

const playbackConfig = new cast.framework.PlaybackConfig();
playbackConfig.manifestRequestHandler = requestInfo => {
  requestInfo.withCredentials = true;
};
context.start({playbackConfig: playbackConfig});

L'exemple ci-dessous montre comment remplacer PlaybackConfig à l'aide des méthodes getter et setter fournies dans PlayerManager. Ce paramètre configure le lecteur pour qu'il reprenne la lecture du contenu après le chargement d'un segment.

const playerManager =
    cast.framework.CastReceiverContext.getInstance().getPlayerManager();
const playbackConfig = (Object.assign(
            new cast.framework.PlaybackConfig(), playerManager.getPlaybackConfig()));
playbackConfig.autoResumeNumberOfSegments = 1;
playerManager.setPlaybackConfig(playbackConfig);

L'exemple ci-dessous montre comment remplacer PlaybackConfig pour une requête de chargement spécifique à l'aide du gestionnaire d'informations sur la lecture de contenus multimédias. Le gestionnaire appelle une méthode getLicenseUrlForMedia implémentée par une application pour obtenir le licenseUrl à partir du contentId de l'élément actuel.

playerManager.setMediaPlaybackInfoHandler((loadRequestData, playbackConfig) => {
  const mediaInformation = loadRequestData.media;
  playbackConfig.licenseUrl = getLicenseUrlForMedia(mediaInformation.contentId);

  return playbackConfig;
});

Écouteur d'événements

Le SDK Web Receiver permet à votre application Web Receiver de gérer les événements du lecteur. L'écouteur d'événements utilise un paramètre cast.framework.events.EventType (ou un tableau de ces paramètres) qui spécifie le ou les événements qui doivent déclencher l'écouteur. Les tableaux préconfigurés de cast.framework.events.EventType qui sont utiles pour le débogage se trouvent dans cast.framework.events.category. Le paramètre d'événement fournit des informations supplémentaires sur l'événement.

Par exemple, si vous souhaitez savoir quand une modification mediaStatus est diffusée, vous pouvez gérer l'événement à l'aide de la logique suivante:

const playerManager =
    cast.framework.CastReceiverContext.getInstance().getPlayerManager();
playerManager.addEventListener(
    cast.framework.events.EventType.MEDIA_STATUS, (event) => {
      // Write your own event handling code, for example
      // using the event.mediaStatus value
});

Interception de messages

Le SDK Web Receiver permet à votre application Web Receiver d'intercepter des messages et d'exécuter du code personnalisé sur ces messages. L'intercepteur de messages utilise un paramètre cast.framework.messages.MessageType qui spécifie le type de message à intercepter.

L'intercepteur doit renvoyer la requête modifiée ou une promesse qui se résout avec la valeur de requête modifiée. Le renvoi de null empêche l'appel du gestionnaire de messages par défaut. Pour en savoir plus, consultez Charger des contenus multimédias.

Par exemple, si vous souhaitez modifier les données de la requête de chargement, vous pouvez utiliser la logique suivante pour les intercepter et les modifier:

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

playerManager.setMessageInterceptor(
    cast.framework.messages.MessageType.LOAD, loadRequestData => {
      const error = new cast.framework.messages.ErrorData(
                      cast.framework.messages.ErrorType.LOAD_FAILED);
      if (!loadRequestData.media) {
        error.reason = cast.framework.messages.ErrorReason.INVALID_PARAM;
        return error;
      }

      if (!loadRequestData.media.entity) {
        return loadRequestData;
      }

      return thirdparty.fetchAssetAndAuth(loadRequestData.media.entity,
                                          loadRequestData.credentials)
        .then(asset => {
          if (!asset) {
            throw cast.framework.messages.ErrorReason.INVALID_REQUEST;
          }

          loadRequestData.media.contentUrl = asset.url;
          loadRequestData.media.metadata = asset.metadata;
          loadRequestData.media.tracks = asset.tracks;
          return loadRequestData;
        }).catch(reason => {
          error.reason = reason; // cast.framework.messages.ErrorReason
          return error;
        });
    });

context.start();

Gestion des exceptions

Lorsque des erreurs se produisent dans l'intercepteur de messages, votre application réceptrice Web doit renvoyer les éléments cast.framework.messages.ErrorType et cast.framework.messages.ErrorReason appropriés.

playerManager.setMessageInterceptor(
    cast.framework.messages.MessageType.LOAD, loadRequestData => {
      const error = new cast.framework.messages.ErrorData(
                      cast.framework.messages.ErrorType.LOAD_CANCELLED);
      if (!loadRequestData.media) {
        error.reason = cast.framework.messages.ErrorReason.INVALID_PARAM;
        return error;
      }

      ...

      return fetchAssetAndAuth(loadRequestData.media.entity,
                               loadRequestData.credentials)
        .then(asset => {
          ...
          return loadRequestData;
        }).catch(reason => {
          error.reason = reason; // cast.framework.messages.ErrorReason
          return error;
        });
    });

Interception de messages et écouteur d'événements

Les principales différences entre l'interception de messages et l'écouteur d'événements sont les suivantes:

  • Un écouteur d'événements ne vous permet pas de modifier les données de requête.
  • Il est préférable d'utiliser un écouteur d'événements pour déclencher des données analytiques ou une fonction personnalisée.
playerManager.addEventListener(cast.framework.events.category.CORE,
    event => {
        console.log(event);
    });
  • L'interception de messages vous permet d'écouter un message, de l'intercepter et de modifier les données de requête proprement dites.
  • L'interception de messages est idéale pour gérer une logique personnalisée en ce qui concerne les données de requête.

Chargement de contenu multimédia

MediaInformation fournit de nombreuses propriétés permettant de charger des contenus multimédias dans le message cast.framework.messages.MessageType.LOAD, y compris entity, contentUrl et contentId.

  • entity est la propriété suggérée à utiliser dans votre implémentation pour les applications émettrices et réceptrices. La propriété est un lien profond qui peut correspondre à une playlist ou à un contenu multimédia. Votre application doit analyser cette URL et remplir au moins l'un des deux autres champs.
  • Le contentUrl correspond à l'URL lisible que le lecteur utilisera pour charger le contenu. Par exemple, cette URL peut pointer vers un fichier manifeste DASH.
  • contentId peut être une URL de contenu lisible (semblable à celle de la propriété contentUrl) ou un identifiant unique pour le contenu ou la playlist en cours de chargement. Si vous utilisez cette propriété comme identifiant, votre application doit insérer une URL lisible dans contentUrl.

Nous suggérons d'utiliser entity pour stocker l'ID réel ou les paramètres clés, et d'utiliser contentUrl pour l'URL du média. Un exemple est illustré dans l'extrait de code suivant, où entity est présent dans la requête LOAD et où la contentUrl lisible est récupérée:

playerManager.setMessageInterceptor(
    cast.framework.messages.MessageType.LOAD, loadRequestData => {
      ...

      if (!loadRequestData.media.entity) {
        // Copy the value from contentId for legacy reasons if needed
        loadRequestData.media.entity = loadRequestData.media.contentId;
      }

      return thirdparty.fetchAssetAndAuth(loadRequestData.media.entity,
                                          loadRequestData.credentials)
        .then(asset => {
          loadRequestData.media.contentUrl = asset.url;
          ...
          return loadRequestData;
        });
    });

Fonctionnalités de l'appareil

La méthode getDeviceCapabilities fournit des informations sur l'appareil Cast connecté et sur l'appareil vidéo ou audio qui y est associé. La méthode getDeviceCapabilities fournit des informations de compatibilité pour l'Assistant Google, le Bluetooth, ainsi que les appareils audio et les écrans connectés.

Cette méthode renvoie un objet que vous pouvez interroger en transmettant l'une des énumérations spécifiées pour obtenir la capacité de l'appareil pour cette énumération. Les énumérations sont définies dans cast.framework.system.DeviceCapabilities.

Cet exemple vérifie si le récepteur Web est capable de lire des contenus HDR et DolbyVision (DV) avec les clés IS_HDR_SUPPORTED et IS_DV_SUPPORTED, respectivement.

const context = cast.framework.CastReceiverContext.getInstance();
context.addEventListener(cast.framework.system.EventType.READY, () => {
  const deviceCapabilities = context.getDeviceCapabilities();
  if (deviceCapabilities &&
      deviceCapabilities[cast.framework.system.DeviceCapabilities.IS_HDR_SUPPORTED]) {
    // Write your own event handling code, for example
    // using the deviceCapabilities[cast.framework.system.DeviceCapabilities.IS_HDR_SUPPORTED] value
  }
  if (deviceCapabilities &&
      deviceCapabilities[cast.framework.system.DeviceCapabilities.IS_DV_SUPPORTED]) {
    // Write your own event handling code, for example
    // using the deviceCapabilities[cast.framework.system.DeviceCapabilities.IS_DV_SUPPORTED] value
  }
});
context.start();

Gérer les interactions des utilisateurs

Un utilisateur peut interagir avec votre application Récepteur Web via des applications émettrices (Web, Android et iOS), des commandes vocales sur des appareils avec Assistant Google intégré, des commandes tactiles sur des écrans connectés et des télécommandes sur les appareils Android TV. Le SDK Cast fournit diverses API permettant à l'application Web Receiver de gérer ces interactions, de mettre à jour l'interface utilisateur de l'application via les états d'action de l'utilisateur, et éventuellement d'envoyer les modifications pour mettre à jour les services de backend.

Commandes multimédias compatibles

Les états des commandes d'interface utilisateur sont basés sur MediaStatus.supportedMediaCommands pour les manettes d'envoi étendues iOS et Android, pour les applications de récepteur et de télécommande exécutées sur des appareils tactiles, et pour les applications réceptrices sur les appareils Android TV. Lorsqu'un Command au niveau du bit particulier est activé dans la propriété, les boutons associés à cette action sont activés. Si la valeur n'est pas définie, le bouton est désactivé. Ces valeurs peuvent être modifiées sur le récepteur Web en:

  1. Utiliser PlayerManager.setSupportedMediaCommands pour définir le Commands spécifique
  2. Ajouter une commande à l'aide de addSupportedMediaCommands
  3. Supprimez une commande existante à l'aide de removeSupportedMediaCommands.
playerManager.setSupportedMediaCommands(cast.framework.messages.Command.SEEK |
  cast.framework.messages.Command.PAUSE);

Lorsque le récepteur prépare le MediaStatus mis à jour, il inclut les modifications dans la propriété supportedMediaCommands. Lorsque l'état est diffusé, les applications émettrices connectées mettent à jour les boutons de leur UI en conséquence.

Pour en savoir plus sur les commandes multimédias et les appareils tactiles compatibles, consultez le guide Accessing UI controls.

Gérer les états des actions des utilisateurs

Lorsque les utilisateurs interagissent avec l'interface utilisateur ou envoient des commandes vocales, ils peuvent contrôler la lecture du contenu et des propriétés liés à la lecture de l'élément. Les requêtes qui contrôlent la lecture sont gérées automatiquement par le SDK. Les requêtes qui modifient les propriétés de l'élément en cours de lecture, telles qu'une commande LIKE, nécessitent que l'application réceptrice les gère. Le SDK fournit une série d'API pour gérer ces types de requêtes. Pour répondre à ces requêtes, vous devez procéder comme suit:

  • Définissez les MediaInformation userActionStates avec les préférences de l'utilisateur lors du chargement d'un élément multimédia.
  • Interceptez les messages USER_ACTION et déterminez l'action requise.
  • Mettez à jour le UserActionState MediaInformation pour mettre à jour l'UI.

L'extrait de code suivant intercepte la requête LOAD et renseigne l'élément MediaInformation de LoadRequestData. Dans ce cas, l'utilisateur aime le contenu en cours de chargement.

playerManager.setMessageInterceptor(
    cast.framework.messages.MessageType.LOAD, (loadRequestData) => {
      const userActionLike = new cast.framework.messages.UserActionState(
          cast.framework.messages.UserAction.LIKE);
      loadRequestData.media.userActionStates = [userActionLike];

      return loadRequestData;
    });

L'extrait de code suivant intercepte le message USER_ACTION et gère l'appel au backend avec la modification demandée. Il effectue ensuite un appel pour mettre à jour le UserActionState sur le récepteur.

playerManager.setMessageInterceptor(cast.framework.messages.MessageType.USER_ACTION,
  (userActionRequestData) => {
    // Obtain the media information of the current content to associate the action to.
    let mediaInfo = playerManager.getMediaInformation();

    // If there is no media info return an error and ignore the request.
    if (!mediaInfo) {
        console.error('Not playing media, user action is not supported');
        return new cast.framework.messages.ErrorData(messages.ErrorType.BAD_REQUEST);
    }

    // Reach out to backend services to store user action modifications. See sample below.
    return sendUserAction(userActionRequestData, mediaInfo)

    // Upon response from the backend, update the client's UserActionState.
    .then(backendResponse => updateUserActionStates(backendResponse))

    // If any errors occurred in the backend return them to the cast receiver.
    .catch((error) => {
      console.error(error);
      return error;
    });
});

L'extrait de code suivant simule un appel à un service de backend. La fonction vérifie le UserActionRequestData pour voir le type de modification demandée par l'utilisateur et n'effectue un appel réseau que si l'action est acceptée par le backend.

function sendUserAction(userActionRequestData, mediaInfo) {
  return new Promise((resolve, reject) => {
    switch (userActionRequestData.userAction) {
      // Handle user action changes supported by the backend.
      case cast.framework.messages.UserAction.LIKE:
      case cast.framework.messages.UserAction.DISLIKE:
      case cast.framework.messages.UserAction.FOLLOW:
      case cast.framework.messages.UserAction.UNFOLLOW:
      case cast.framework.messages.UserAction.FLAG:
      case cast.framework.messages.UserAction.SKIP_AD:
        let backendResponse = {userActionRequestData: userActionRequestData, mediaInfo: mediaInfo};
        setTimeout(() => {resolve(backendResponse)}, 1000);
        break;
      // Reject all other user action changes.
      default:
        reject(
          new cast.framework.messages.ErrorData(cast.framework.messages.ErrorType.INVALID_REQUEST));
    }
  });
}

L'extrait de code suivant utilise l'UserActionRequestData et ajoute ou supprime l'UserActionState de MediaInformation. La mise à jour de l'UserActionState de MediaInformation modifie l'état du bouton associé à l'action demandée. Cette modification se reflète dans l'interface utilisateur des commandes d'écran connecté, l'application de télécommande et l'interface utilisateur d'Android TV. Elle est également diffusée via des messages MediaStatus sortants afin de mettre à jour l'UI du contrôleur étendu pour les expéditeurs iOS et Android.

function updateUserActionStates(backendResponse) {
  // Unwrap the backend response.
  let mediaInfo = backendResponse.mediaInfo;
  let userActionRequestData = backendResponse.userActionRequestData;

  // If the current item playing has changed, don't update the UserActionState for the current item.
  if (playerManager.getMediaInformation().entity !== mediaInfo.entity) {
    return;
  }

  // Check for existing userActionStates in the MediaInformation.
  // If none, initialize a new array to populate states with.
  let userActionStates = mediaInfo.userActionStates || [];

  // Locate the index of the UserActionState that will be updated in the userActionStates array.
  let index = userActionStates.findIndex((currUserActionState) => {
    return currUserActionState.userAction == userActionRequestData.userAction;
  });

  if (userActionRequestData.clear) {
    // Remove the user action state from the array if cleared.
    if (index >= 0) {
      userActionStates.splice(index, 1);
    }
    else {
      console.warn("Could not find UserActionState to remove in MediaInformation");
    }
  } else {
    // Add the UserActionState to the array if enabled.
    userActionStates.push(
      new cast.framework.messages.UserActionState(userActionRequestData.userAction));
  }

  // Update the UserActionState array and set the new MediaInformation
  mediaInfo.userActionStates = userActionStates;
  playerManager.setMediaInformation(mediaInfo, true);
  return;
}

Commandes vocales

Les commandes multimédias suivantes sont actuellement compatibles avec le SDK Web Receiver pour les appareils avec Assistant Google intégré. Les implémentations par défaut de ces commandes se trouvent dans cast.framework.PlayerManager.

Commande Description
Lire Lire ou reprendre la lecture à partir d'une mise en pause
Pause Mettre en pause le contenu en cours de lecture.
Précédent Passer à l'élément multimédia précédent de la file d'attente
Suivant Passer à l'élément multimédia suivant de la file d'attente
Arrêter Arrêtez le contenu multimédia en cours de lecture.
Aucune répétition Désactiver la répétition des éléments multimédias de la file d'attente une fois la lecture du dernier élément de la file d'attente terminée
Répéter un seul Répéter indéfiniment le contenu multimédia en cours de lecture
Tout répéter Répéter tous les éléments de la file d'attente après la lecture du dernier élément
Tout répéter et en mode aléatoire Une fois la lecture du dernier élément de la file d'attente terminée, passez en mode aléatoire et répétez tous les éléments de la file d'attente.
Aléatoire Lisez les éléments multimédias de votre file d'attente en mode aléatoire.
Activer / Désactiver les sous-titres Activer / Désactiver les sous-titres pour votre contenu multimédia L'option d'activation ou de désactivation est également disponible pour chaque langue.
Rechercher jusqu'à une heure absolue Passer à l'heure absolue spécifiée
Rechercher vers l'heure par rapport à l'heure actuelle Avance ou recule de la période spécifiée par rapport à l'heure de lecture actuelle.
Rejouer Redémarre le contenu multimédia en cours de lecture ou lit le dernier élément multimédia lu si rien n'est en cours de lecture.
Définir la vitesse de lecture Varier la vitesse de lecture des contenus multimédias. Cette opération est généralement gérée par défaut. Vous pouvez utiliser l'intercepteur de messages SET_PLAYBACK_RATE pour ignorer les requêtes de tarifs entrantes.

Commandes vocales compatibles avec les contenus multimédias

Pour empêcher une commande vocale de déclencher une commande multimédia sur un appareil avec Assistant Google intégré, vous devez d'abord définir les commandes multimédias compatibles que vous prévoyez de prendre en charge. Vous devez ensuite appliquer ces commandes en activant la propriété CastReceiverOptions.enforceSupportedCommands. L'interface utilisateur des émetteurs du SDK Cast et des appareils tactiles sera modifiée pour refléter ces configurations. S'il n'est pas activé, les commandes vocales entrantes s'exécuteront.

Par exemple, si vous autorisez PAUSE à partir des applications émettrices et des appareils tactiles, vous devez également configurer votre récepteur pour refléter ces paramètres. Une fois configurées, toutes les commandes vocales entrantes seront supprimées si elles ne figurent pas dans la liste des commandes compatibles.

Dans l'exemple ci-dessous, nous fournissons CastReceiverOptions lors du démarrage de CastReceiverContext. Nous avons ajouté la compatibilité avec la commande PAUSE et forcé le lecteur à n'accepter que cette commande. Désormais, si une commande vocale demande une autre opération telle que SEEK, elle sera refusée. L'utilisateur sera informé que la commande n'est pas encore prise en charge.

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

context.start({
  enforceSupportedCommands: true,
  supportedCommands: cast.framework.messages.Command.PAUSE
});

Vous pouvez appliquer une logique distincte pour chaque commande que vous souhaitez restreindre. Supprimez l'option enforceSupportedCommands. Pour chaque commande que vous souhaitez restreindre, vous pouvez intercepter le message entrant. Ici, nous interceptons la requête fournie par le SDK afin que les commandes SEEK envoyées aux appareils avec Assistant Google intégré ne déclenchent pas de recherche dans votre application Web Receiver.

Pour les commandes multimédias non compatibles avec votre application, renvoyez un motif d'erreur approprié, tel que NOT_SUPPORTED.

playerManager.setMessageInterceptor(cast.framework.messages.MessageType.SEEK,
  seekData => {
    // Block seeking if the SEEK supported media command is disabled
    if (!(playerManager.getSupportedMediaCommands() & cast.framework.messages.Command.SEEK)) {
      let e = new cast.framework.messages.ErrorData(cast.framework.messages.ErrorType
      .INVALID_REQUEST);
      e.reason = cast.framework.messages.ErrorReason.NOT_SUPPORTED;
      return e;
    }

    return seekData;
  });

Mise en arrière-plan à partir de l'activité vocale

Si la plate-forme Cast met en arrière-plan le son de votre application en raison de l'activité de l'Assistant (par exemple, en écoutant les paroles de l'utilisateur ou en lui répondant), un message FocusState de NOT_IN_FOCUS est envoyé à l'application Web Receiver lorsque l'activité commence. Un autre message avec IN_FOCUS est envoyé à la fin de l'activité. En fonction de votre application et du contenu multimédia en cours de lecture, vous pouvez mettre en pause le contenu multimédia lorsque FocusState est défini sur NOT_IN_FOCUS en interceptant le type de message FOCUS_STATE.

Par exemple, mettre en pause la lecture d'un livre audio si l'Assistant répond à une requête de l'utilisateur constitue une bonne expérience utilisateur.

playerManager.setMessageInterceptor(cast.framework.messages.MessageType.FOCUS_STATE,
  focusStateRequestData => {
    // Pause content when the app is out of focus. Resume when focus is restored.
    if (focusStateRequestData.state == cast.framework.messages.FocusState.NOT_IN_FOCUS) {
      playerManager.pause();
    } else {
      playerManager.play();
    }

    return focusStateRequestData;
  });

Langue des sous-titres spécifiée par la voix

Lorsqu'un utilisateur n'indique pas explicitement la langue des sous-titres, celle-ci est celle utilisée pour la commande. Dans ces scénarios, le paramètre isSuggestedLanguage du message entrant indique si la langue associée a été suggérée ou explicitement demandée par l'utilisateur.

Par exemple, isSuggestedLanguage est défini sur true pour la commande "Ok Google, active les sous-titres", car la langue a été déduite en fonction de la langue dans laquelle la commande a été parlée. Si la langue est demandée explicitement, par exemple si vous dites "Ok Google, active les sous-titres en anglais", isSuggestedLanguage est défini sur false.

Métadonnées et diffusion vocale

Bien que les commandes vocales soient gérées par défaut par le Web Receiver, vous devez vous assurer que les métadonnées de votre contenu sont complètes et exactes. Cela garantit que les commandes vocales sont correctement gérées par l'Assistant et que les métadonnées s'affichent correctement sur les nouveaux types d'interfaces tels que l'application Google Home et les écrans connectés comme Google Home Hub.

Transfert de diffusion

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

Le flux d'événements pour le transfert de diffusion est le suivant:

  1. Sur l'appareil source :
    1. La lecture du contenu multimédia s'arrête.
    2. L'application Web Receiver reçoit une commande pour enregistrer l'état actuel du contenu multimédia.
    3. L'application Web Receiver est arrêtée.
  2. Sur l'appareil de destination :
    1. L'application Web Receiver est chargée.
    2. L'application Web Receiver reçoit une commande pour restaurer l'état du contenu multimédia enregistré.
    3. La lecture du contenu multimédia reprend.

Voici les différents éléments de l'état de l'élément multimédia:

  • Position ou code temporel spécifique du titre, de la vidéo ou de l'élément multimédia
  • Elles sont placées dans une file d'attente plus large (par exemple, une playlist ou une radio d'artiste).
  • Utilisateur authentifié.
  • État de la lecture (en cours de lecture ou mise en pause, par exemple)

Activer le transfert de diffusion

Pour implémenter le transfert de flux pour votre Web Receiver:

  1. Mettez à jour supportedMediaCommands avec la commande STREAM_TRANSFER :
    playerManager.addSupportedMediaCommands(
cast.framework.messages.Command.STREAM_TRANSFER, true);
  2. Vous pouvez également ignorer les intercepteurs de messages SESSION_STATE et RESUME_SESSION, comme décrit dans la section Conserver l'état de la session. Ne les remplacez que si des données personnalisées doivent être stockées dans l'instantané de session. Sinon, l'implémentation par défaut pour conserver les états de session sera compatible avec le transfert de flux.

Conserver l'état de la session

Le SDK Web Receiver fournit une implémentation par défaut pour que les applications Web Receiver conservent les états de session en prenant un instantané de l'état actuel du contenu multimédia, en convertissant l'état en requête de chargement et en relançant la session avec la requête de chargement.

La requête de chargement générée par le récepteur Web peut être remplacée dans l'intercepteur de messages SESSION_STATE si nécessaire. Si vous souhaitez ajouter des données personnalisées à la requête de chargement, nous vous suggérons de les placer dans loadRequestData.customData.

playerManager.setMessageInterceptor(
    cast.framework.messages.MessageType.SESSION_STATE,
    function (sessionState) {
        // Override sessionState.loadRequestData if needed.
        const newCredentials = updateCredentials_(sessionState.loadRequestData.credentials);
        sessionState.loadRequestData.credentials = newCredentials;

        // Add custom data if needed.
        sessionState.loadRequestData.customData = {
            'membership': 'PREMIUM'
        };

        return sessionState;
    });

Les données personnalisées peuvent être extraites de loadRequestData.customData dans l'intercepteur de messages RESUME_SESSION.

let cred_ = null;
let membership_ = null;

playerManager.setMessageInterceptor(
    cast.framework.messages.MessageType.RESUME_SESSION,
    function (resumeSessionRequest) {
        let sessionState = resumeSessionRequest.sessionState;

        // Modify sessionState.loadRequestData if needed.
        cred_ = sessionState.loadRequestData.credentials;

        // Retrieve custom data.
        membership_ = sessionState.loadRequestData.customData.membership;

        return resumeSessionRequest;
    });

Préchargement du contenu

Web Receiver accepte le préchargement des éléments multimédias après l'élément en cours de lecture dans la file d'attente.

L'opération de préchargement précharge plusieurs segments des éléments à venir. La spécification est effectuée sur la valeur preloadTime de l'objet QueueItem (la valeur par défaut est de 20 secondes si elle n'est pas fournie). Cette durée est exprimée en secondes par rapport à la fin de l'élément en cours de lecture . Seules les valeurs positives sont valides. Par exemple, si la valeur est de 10 secondes, cet élément sera préchargé 10 secondes avant la fin de l'élément précédent. Si le temps de préchargement est supérieur à celui restant pour l'élément currentItem, le préchargement aura lieu dès que possible. Ainsi, si une valeur de préchargement très élevée est spécifiée dans queueItem, il est possible que chaque fois que nous lisons l'élément actuel, nous préchargeons déjà l'élément suivant. Toutefois, nous laissons le paramétrage et le choix de cette option au développeur, car elle peut affecter la bande passante et les performances de streaming de l'élément en cours de lecture.

Par défaut, le préchargement fonctionne pour les flux HLS, DASH et lissés.

Les fichiers audio et vidéo MP4 standards, tels que MP3, ne seront pas préchargés, car les appareils Cast n'acceptent qu'un seul élément multimédia et ne peuvent pas être utilisés pour le préchargement lorsqu'un élément de contenu existant est encore en cours de lecture.

Messages personnalisés

L'échange de messages est la méthode d'interaction clé pour les applications réceptrices Web.

Un expéditeur envoie des messages à un Web Receiver à l'aide des API de l'expéditeur pour la plate-forme qu'il exécute (Android, iOS, Web). L'objet événement (qui est le manifeste d'un message) transmis aux écouteurs d'événements comporte un élément de données (event.data) dans lequel les données prennent les propriétés du type d'événement spécifique.

Une application Web Receiver peut choisir d'écouter les messages sur un espace de noms spécifié. De ce fait, l'application Web Receiver est considérée comme compatible avec ce protocole d'espace de noms. Il appartient ensuite à tous les expéditeurs connectés qui souhaitent communiquer sur cet espace de noms d'utiliser le protocole approprié.

Tous les espaces de noms sont définis par une chaîne et doivent commencer par "urn:x-cast:", suivi de n'importe quelle chaîne. Exemple : "urn:x-cast:com.example.cast.mynamespace".

Voici un extrait de code permettant au Web Receiver d'écouter les messages personnalisés d'expéditeurs connectés:

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

const CUSTOM_CHANNEL = 'urn:x-cast:com.example.cast.mynamespace';
context.addCustomMessageListener(CUSTOM_CHANNEL, function(customEvent) {
  // handle customEvent.
});

context.start();

De même, les applications Web Receiver peuvent tenir les expéditeurs informés de l'état du récepteur Web en envoyant des messages aux expéditeurs connectés. Une application de récepteur Web peut envoyer des messages à l'aide de sendCustomMessage(namespace, senderId, message) sur CastReceiverContext. Un récepteur Web peut envoyer des messages à un expéditeur individuel, en réponse à un message reçu ou en raison d'un changement d'état d'application. Au-delà de la messagerie point à point (avec une limite de 64 Ko), un récepteur Web peut également diffuser des messages à tous les expéditeurs connectés.

Cast pour les appareils audio

Pour obtenir de l'aide concernant la lecture en mode audio uniquement, consultez le guide Google Cast pour les appareils audio.

Android TV

Cette section explique comment Google Web Receiver utilise vos entrées pour la lecture et décrit la compatibilité avec Android TV.

Intégrer votre application à la télécommande

Le récepteur Web Google exécuté sur l'appareil Android TV traduit l'entrée des entrées de commande de l'appareil (télécommande portable) en messages de lecture multimédia définis pour l'espace de noms urn:x-cast:com.google.cast.media, comme décrit dans la section Messages de lecture multimédia. Votre application doit prendre en charge ces messages pour contrôler la lecture des contenus multimédias de l'application afin de permettre la commande de lecture de base à partir des entrées de commande d'Android TV.

Consignes relatives à la compatibilité avec Android TV

Voici quelques recommandations et les pièges courants à éviter pour vous assurer que votre application est compatible avec Android TV:

  • Sachez que la chaîne user-agent contient à la fois "Android" et "C communiqué". Certains sites peuvent rediriger les utilisateurs vers un site réservé aux mobiles, car ils détectent le libellé "Android". Ne partez pas du principe qu'"Android" dans la chaîne de user-agent indique toujours un utilisateur mobile.
  • La pile multimédia d'Android peut utiliser un fichier GZIP transparent pour récupérer les données. Assurez-vous que vos données multimédias peuvent répondre à Accept-Encoding: gzip.
  • Les événements multimédias HTML5 d'Android TV peuvent être déclenchés à des moments différents de ceux de Chromecast, ce qui peut révéler des problèmes masqués sur Chromecast.
  • Lors de la mise à jour du contenu multimédia, utilisez les événements liés aux contenus multimédias déclenchés par les éléments <audio>/<video>, tels que timeupdate, pause et waiting. Évitez d'utiliser des événements liés à la mise en réseau tels que progress, suspend et stalled, car ils dépendent généralement de la plate-forme. Pour en savoir plus sur la gestion des événements multimédias dans votre récepteur, consultez la section Événements multimédias.
  • Lorsque vous configurez les certificats HTTPS de votre site récepteur, veillez à inclure des certificats CA intermédiaires. Consultez la page de test SSL de Qualsys pour vérifier que si le chemin de certification de confiance de votre site inclut un certificat CA intitulé "Téléchargement supplémentaire", il est possible qu'il ne se charge pas sur les plates-formes Android.
  • Alors que Chromecast affiche la page du récepteur sur un plan graphique 720p, d'autres plates-formes Cast, y compris Android TV, peuvent afficher la page avec une résolution jusqu'à 1080p. Assurez-vous que votre page réceptrice s'adapte correctement à différentes résolutions.
Précédent
Récepteur Web personnalisé
Suivant
HLS sur la migration des joueurs Shaka