L'API Co-Watching gère l'expérience de réunion de plusieurs participants qui regardent ou écoutent du contenu dans votre application.
Ce guide explique comment implémenter l'API Co-Watching.
Premiers pas
Pour utiliser l'API Co-Watching, vous devez d'abord créer un le module complémentaire Meet. Une fois que vous avez terminé ces étapes, vous pouvez commencer à utiliser l'API Co-Watching depuis votre nouveau module complémentaire.
Pour utiliser l'API Co-Watching, commencez par obtenir un objet AddonSession, qui sert de point d'entrée pour les activités de groupe Google Meet :
TypeScript
const session = await window.meet.addon.createAddonSession({
cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
});
Remplacez CLOUD_PROJECT_NUMBER par le numéro de projet de votre projet Google Cloud.
Créer un client de visionnage à plusieurs
Pour commencer, créez un
CoWatchingClient
de votre AddonSession.
Pour créer un CoWatchingCient, appelez la méthode
createCoWatchingClient()
et fournissez une
CoWatchingDelegate
.
CoWatchingDelegate permet à l'API Co-Watching de mettre à jour votre appli
dès qu'un nouvel état est disponible. Lorsque la méthode onCoWatchingStateChanged() est appelée, votre application devrait appliquer immédiatement le nouvel état.
L'exemple de code suivant montre comment utiliser l'API Co-Watching :
TypeScript
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 les 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. Pour
Par exemple, vous n'avez pas besoin de les appeler chaque fois que votre application
vidéo. L'CoWatchingDelegate que vous créez permet de mettre à jour la lecture
dans ces circonstances.
Vous pouvez contrôler l'état de visionnage à plusieurs à l'aide des méthodes suivantes:
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 contenu multimédia précédent le commutateur, la recherche multimédia ou l'encombrement du réseau.notifyPauseState(): appel à effectuer lorsqu'un utilisateur met en pause ou réactive la lecture du contenu multimédia.notifyPlayoutRate(): Appelez lorsqu'un utilisateur définit une nouvelle valeur pour la vitesse de lecture (par exemple, x 1,25).notifyReady(): Appelez lorsque la mise en mémoire tampon est terminée et que le contenu multimédia est prêt à être lu.notifySeekToTimestamp(): Appelé lorsqu'un utilisateur modifie explicitement la position de lecture.notifySwitchToMedia(): Appelez 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.