La API de visualización en compañía administra la experiencia de reunión de múltiples participantes que miran o escuchan contenido en tu app.
En esta guía, se explica cómo implementar la API de Co-Watching.
Comenzar
Para usar la API de visualización en compañía, primero debes implementar un Complemento de Meet. Una vez completaste esos pasos, puedes comenzar a usar la API de Co-Watching desde tu nuevo complemento.
Para usar la API de Co-Watching, comienza por obtener un
objeto AddonSession,
que sirve como punto de entrada a las actividades colaborativas de Google Meet:
TypeScript
const session = await window.meet.addon.createAddonSession({
cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
});
Reemplaza CLOUD_PROJECT_NUMBER por el número de proyecto de Google Cloud.
Crea un cliente de visualización en compañía
Para comenzar, crea un objeto CoWatchingClient a partir de tu AddonSession.
Para crear un CoWatchingCient, llama al método createCoWatchingClient() y proporciona un objeto CoWatchingDelegate.
El CoWatchingDelegate es la manera en que la API de visualización en compañía actualiza tu app.
cuando hay un nuevo estado disponible. Se espera que, cuando
onCoWatchingStateChanged()
, tu app aplica de inmediato el estado nuevo.
En la siguiente muestra de código, se muestra cómo usar la API de 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
},
});
Reemplaza ACTIVITY_TITLE por el título multimedia de tu actividad.
Administrar el estado actual
Cuando los usuarios realizan acciones en tu aplicación, se espera que esta llama inmediatamente a los métodos de la API proporcionados.
Solo debes llamar a estos métodos en respuesta a eventos significativos. Para
ejemplo, no necesitas llamarlos cada vez que tu app avanza en un
video. El CoWatchingDelegate que creas controla la actualización de las posiciones de reproducción en estas circunstancias.
Puedes controlar el estado de reproducción en compañía con estos métodos:
notifyBuffering(): Llama cuando la app de un usuario comienza a almacenarse en búfer debido al almacenamiento en búfer de un cambio de contenido multimedia anterior, un salto de contenido multimedia o una congestión de red.notifyPauseState(): Llama cuando un usuario pausa o reanuda la reproducción de contenido multimedia.notifyPlayoutRate(): Se llama cuando un usuario actualiza la velocidad de reproducción a un nuevo valor (por ejemplo, 1.25x).notifyReady(): Realiza una llamada cuando se complete el almacenamiento en búfer y el contenido multimedia esté listo para reproducirse.notifySeekToTimestamp(): Llama cuando un usuario cambia explícitamente la posición de reproducción.notifySwitchToMedia(): Llama cada vez que cambia el contenido multimedia que se está reproduciendo de forma activa. Por ejemplo, el usuario selecciona un video nuevo o la reproducción automática inicia el siguiente.