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 wdrożyć interfejs Co-Watching API.
Rozpocznij
Aby korzystać z interfejsu Co-Watching API, musisz najpierw wdrażać dodatki 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 Google Cloud.
Utwórz klienta, który wspólnie ogląda
Aby rozpocząć, utwórz obiekt CoWatchingClient
w sekcji 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ć 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łanie, gdy użytkownik wstrzyma lub wznowi odtwarzanie multimediów.notifyPlayoutRate()
: wywołaj, gdy użytkownik zaktualizuje prędkość odtwarzania do nowej wartości (na przykład 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łuj, gdy zmieni się aktywnie odtwarzane multimedia. Na przykład użytkownik wybierze nowy film lub autoodtwarzanie rozpocznie następny.