Implémenter l'API de co-visionnage

Ce guide explique comment implémenter l'API Co-Watching.

Créer un élément CoWatchingClient

Pour commencer, créez un createCoWatchingClient à partir du AddonSession que vous avez créé dans Premiers pas.

Pour créer un CoWatchingCient, appelez la méthode AddonSession.createCoWatchingClient et fournissez un CoWatchingDelegate.

CoWatchingDelegate est la manière dont l'API Co-Watching met à jour votre application chaque fois qu'un nouvel état est disponible. Lorsque la méthode CoWatchingDelegate.onCoWatchingStateChanged est appelée, votre application applique immédiatement le nouvel état.

L'exemple de code suivant montre comment utiliser l'API Co-Watching:

 const coWatchingClient = await addonSession.createCoWatchingClient({
    activityTitle: "ACTIVITY_TITLE",
    onCoWatchingStateQuery() {
      // This function should return the current state of your CoWatching activity
      return getMyApplicationCoWatchingState();
    },
    onCoWatchingStateChanged(coWatchingState: CoWatchingState) {
      // This function should apply newState to your ongoing CoWatching activity
    },
  });

Remplacez ACTIVITY_TITLE par le titre multimédia de votre activité.

Gérer l'état actuel

Lorsque des utilisateurs effectuent une action dans votre application, celle-ci doit appeler immédiatement les méthodes d'API fournies.

Vous ne devez appeler ces méthodes qu'en réponse à des événements importants. Par exemple, vous n'avez pas besoin de les appeler chaque fois que votre application avance une vidéo en cours de lecture. Le CoWatchingDelegate que vous avez créé ci-dessus gère la mise à jour des positions de lecture dans ces circonstances.

Vous pouvez contrôler l'état de visionnage à plusieurs à l'aide des méthodes suivantes:

• CoWatchingClient.notifySwitchToMedia : appelé chaque fois que le contenu multimédia en cours de lecture change. Par exemple, l'utilisateur sélectionne une nouvelle vidéo ou la lecture automatique lance la vidéo suivante.
• CoWatchingClient.notifyPauseState : appel lorsqu'un utilisateur met en pause ou réactive le contenu multimédia en cours de lecture.
• CoWatchingClient.notifySeekToTimestamp : appel lorsqu'un utilisateur modifie explicitement la position de lecture.
• CoWatchingClient.notifyPlayoutRate : appel lorsqu'un utilisateur met à jour la vitesse de lecture sur une nouvelle valeur (par exemple, 1,25x).
• CoWatchingClient.notifyBuffering : appel lorsque l'application d'un utilisateur commence à mettre en mémoire tampon en raison de la mise en mémoire tampon d'un commutateur multimédia précédent, d'une recherche multimédia ou d'une congestion du réseau.
• CoWatchingClient.notifyReady : appelé lorsque la mise en mémoire tampon est terminée et que le contenu multimédia est prêt à être lu.