Wdrażanie interfejsu Co-Watching API

Interfejs Co-Watching API zarządza spotkaniami, w których uczestniczy wiele osób oglądających lub słuchających treści w Twojej aplikacji.

Z tego przewodnika dowiesz się, jak zaimplementować interfejs Co-Watching API.

Rozpocznij

Aby korzystać z interfejsu Co-Watching API, musisz najpierw wdrożyć dodatek do Meet. Po wykonaniu tych czynności możesz zacząć korzystać z interfejsu Co-Watching API w nowym dodatku.

Aby użyć interfejsu Co-Watching API, zacznij od uzyskania obiektu AddonSession, który służy jako punkt wejścia dla wspólnych czynności w Google Meet:

TypeScript

const session = await window.meet.addon.createAddonSession({
    cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
});

Zastąp CLOUD_PROJECT_NUMBER numerem projektu Google Cloud.

Tworzenie klienta wspólnego oglądania

Aby rozpocząć, utwórz obiekt CoWatchingClient z AddonSession.

Aby utworzyć obiekt CoWatchingCient, wywołaj metodę createCoWatchingClient() i podaj obiekt CoWatchingDelegate.

CoWatchingDelegate to sposób, w jaki interfejs Co-Watching API aktualizuje aplikację, gdy jest dostępny nowy stan. Oczekuje się, że po wywołaniu metody onCoWatchingStateChanged() aplikacja natychmiast zastosuje nowy stan.

Poniższy przykładowy kod pokazuje, jak korzystać z interfejsu Co-Watching API:

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
    },
  });

Zastąp ACTIVITY_TITLE tytułem multimediów aktywności.

Zarządzanie bieżącym stanem

Gdy użytkownicy wykonują działanie w aplikacji, oczekuje się, że aplikacja natychmiast wywoła udostępnione metody interfejsu API.

Te metody należy wywoływać tylko w odpowiedzi na ważne zdarzenia. Nie musisz na przykład wywoływać tych funkcji za każdym razem, gdy aplikacja przechodzi do kolejnego odtwarzanego filmu. Utworzony przez Ciebie CoWatchingDelegate będzie w takich sytuacjach aktualizować pozycje odtwarzania.

Stan wspólnego oglądania możesz kontrolować za pomocą tych metod:

  • notifyBuffering(): wywołanie, gdy aplikacja użytkownika zaczyna buforować z powodu buforowania z poprzedniego przełączenia multimediów, wyszukiwania multimediów lub przeciążenia sieci.

  • notifyPauseState(): wywołanie, gdy użytkownik wstrzyma lub wznowi odtwarzanie multimediów.

  • notifyPlayoutRate(): wywołanie, gdy użytkownik zmieni szybkość odtwarzania na nową wartość (np.1,25x).

  • notifyReady(): wywołanie po zakończeniu buforowania i przygotowaniu multimediów do odtwarzania.

  • notifySeekToTimestamp(): Wywołaj, gdy użytkownik wyraźnie zmieni pozycję odtwarzania.

  • notifySwitchToMedia(): Wywoływana za każdym razem, gdy zmienia się aktywnie odtwarzany element multimedialny. Na przykład użytkownik wybierze nowy film lub autoodtwarzanie rozpocznie odtwarzanie następnego filmu.