L'API Co-Watching gestisce l'esperienza delle riunioni di più persone partecipanti che guardano o ascoltano contenuti nella tua app.
Questa guida spiega come implementare l'API Co-Watching.
Inizia
Per utilizzare l'API Co-Watching, devi prima creare una componente aggiuntivo di Meet. Una volta hai completato questi passaggi, puoi iniziare a usare l'API Co-Watching dal nuovo componente aggiuntivo.
Per utilizzare l'API Co-Watching, inizia ottenendo un
AddonSession
, che
funge da punto di accesso per le co-attività:
TypeScript
const session = await window.meet.addon.createAddonSession({
cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
});
Crea un CoWatchingClient
Per iniziare, crea un
createCoWatchingClient
da AddonSession
.
Per creare un CoWatchingCient
, chiama il
AddonSession.createCoWatchingClient
e fornirà un
CoWatchingDelegate
.
CoWatchingDelegate
è il modo in cui l'API Co-Watching aggiorna i tuoi
ogni volta che è disponibile un nuovo stato. Ci si aspetta che, quando
CoWatchingDelegate.onCoWatchingStateChanged
, la tua applicazione applicherà immediatamente il nuovo stato.
Il seguente esempio di codice mostra come utilizzare 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
},
});
Sostituisci ACTIVITY_TITLE con il titolo multimediale della tua attività.
Gestisci stato attuale
Quando gli utenti intraprendono un'azione nella tua applicazione, si prevede che quest'ultima chiama immediatamente i metodi API forniti.
Devi chiamare questi metodi solo in risposta a eventi significativi. Per
Ad esempio, non è necessario chiamarli ogni volta che l'app va avanti
video. Gli handle di CoWatchingDelegate
che hai creato sopra verranno aggiornati
posizioni nei playout in queste circostanze.
Puoi controllare lo stato di visualizzazione condivisa utilizzando questi metodi:
CoWatchingClient.notifySwitchToMedia
: Chiama ogni volta che cambia il contenuto multimediale in riproduzione. Ad esempio, l'utente seleziona un nuovo video, oppure avvia la riproduzione automatica il video successivo.CoWatchingClient.notifyPauseState
: Chiama quando un utente mette in pausa o riattiva la riproduzione di contenuti multimediali.CoWatchingClient.notifySeekToTimestamp
: Richiama quando un utente cambia esplicitamente la posizione di riproduzione.CoWatchingClient.notifyPlayoutRate
: Chiama quando un utente aggiorna la velocità di riproduzione impostando un nuovo valore (ad esempio, 1,25x).CoWatchingClient.notifyBuffering
: Chiama quando l'app di un utente avvia il buffering a causa del buffering di un contenuto multimediale precedente switch, ricerca di contenuti multimediali o congestione di rete.CoWatchingClient.notifyReady
: Chiama al termine del buffering e il contenuto multimediale è pronto per la riproduzione.