Wdrażanie interfejsu Co-Watching API

Interfejs Co-Watching API służy do zarządzania spotkaniami wielu osób uczestników 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 utworzyć Dodatek do Meet. Jednorazowo Gdy już wykonasz te kroki, możesz zacząć korzystać z interfejsu Co-Watching API z poziomu nowego dodatku.

Aby korzystać z interfejsu Co-Watching API, zacznij od pobrania AddonSession obiekt, który jest punktem wyjś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 Twojemu projektowi Google Cloud.

Tworzenie klienta do wspólnego oglądania

Na początek utwórz CoWatchingClient obiekt z AddonSession.

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

Interfejs CoWatchingDelegate umożliwia aktualizowanie aplikacji przez interfejs Co-Watching API , gdy dostępny jest nowy stan. To normalne, że onCoWatchingStateChanged() aplikacja natychmiast stosuje 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 dotyczącym aktywności.

Zarządzaj 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. Dla: Na przykład nie trzeba dzwonić do nich za każdym razem, gdy aplikacja przesuwa odtwarzanie film. Utworzony przez Ciebie nick (CoWatchingDelegate) otrzymuje zaktualizowany scenariusz w tych okolicznościach.

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

  • notifyBuffering(): Wywołuj, gdy aplikacja użytkownika rozpocznie buforowanie z powodu buforowania poprzedniego pliku multimedialnego za pomocą przełącznika, przewijania w wyszukiwarce czy przeciążenia sieci.

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

  • notifyPlayoutRate(): Wywołuj, gdy użytkownik zaktualizuje szybkość odtwarzania do nowej wartości (na przykład 1,25x).

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

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

  • notifySwitchToMedia(): Wywołuj, gdy zmieni się aktywnie odtwarzane multimedia. Na przykład użytkownik wybierze nowy film lub autoodtwarzanie rozpocznie następny.