Wdrażanie interfejsu Co-Watching API

Interfejs API wspólnego oglądania zarządza przebiegiem spotkania z udziałem wielu uczestników, którzy oglądają lub słuchają 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 wdrażać dodatki 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 pobrania obiektu AddonSession, który służy jako punkt wejścia do 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 do wspólnego oglądania

Zacznij od utworzenia obiektu CoWatchingClient z AddonSession.

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

Interfejs CoWatchingDelegate informuje aplikację o nowych stanach interfejsu Co-Watching API. Oczekuje się, że gdy wywołana zostanie metoda 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 mediów z Twojej aktywności.

Zarządzanie bieżącym stanem

Gdy użytkownicy podejmują działania w aplikacji, powinna ona natychmiast wywołać odpowiednie metody interfejsu API.

Te metody należy wywoływać tylko w odpowiedzi na ważne zdarzenia. Nie musisz ich wywoływać za każdym razem, gdy aplikacja przewija odtwarzany film. W takich okolicznościach utworzony przez Ciebie CoWatchingDelegate obsługuje aktualizowanie pozycji odtwarzania.

Stan wspólnego oglądania możesz kontrolować na te sposoby:

  • 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łaj, gdy użytkownik zaktualizuje prędkość odtwarzania do nowej wartości (np.1,25 x).

  • notifyReady(): wywołaj po zakończeniu buforowania, gdy multimedia będą gotowe do odtwarzania.

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

  • notifySwitchToMedia(): wywoływanie za każdym razem, gdy zmienia się aktywnie odtwarzany materiał. Na przykład użytkownik wybiera nowy film lub autoodtwarzanie uruchamia następny film.