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 wdrożyć interfejs Co-Watching API.

Rozpocznij

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

Aby korzystać z interfejsu Co-Watching API, zacznij od pobrania obiektu AddonSession, który służy jako punkt wejścia do wspólnych działań 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 CoWatchingClient obiekt z AddonSession.

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

Dzięki CoWatchingDelegate interfejs Co-Watching API aktualizuje Twoją aplikację, gdy tylko dostępny jest nowy stan. Oczekuje się, że gdy zostanie wywołana metoda onCoWatchingStateChanged(), Twoja 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 Twojej aktywności.

Zarządzanie bieżącym stanem

Gdy użytkownicy wykonują działania w Twojej aplikacji, oczekuje się, że aplikacja natychmiast wywoła podane metody interfejsu API.

Te metody należy wywoływać tylko w odpowiedzi na ważne zdarzenia. Nie musisz ich na przykład wywoływać za każdym razem, gdy aplikacja przechodzi do następnego odtwarzanego filmu. W takich przypadkach CoWatchingDelegate, który utworzysz, będzie obsługiwać aktualizowanie pozycji odtwarzania.

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

  • notifyBuffering(): wywołaj, gdy aplikacja użytkownika zacznie buforować z powodu buforowania po przełączeniu multimediów, wyszukiwaniu multimediów lub przeciążeniu sieci.

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

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

  • notifyReady(): wywołaj, gdy buforowanie się zakończy i multimedia będą gotowe do odtworzenia.

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

  • notifySwitchToMedia(): wywołaj, gdy aktywnie odtwarzane multimedia się zmienią. Na przykład użytkownik wybierze nowy film lub automatyczne odtwarzanie rozpocznie odtwarzanie następnego filmu.