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
, czyli
jest punktem wyjścia dla wspólnych działań:
TypeScript
const session = await window.meet.addon.createAddonSession({
cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
});
Utwórz CoWatchingClient
Na początek utwórz
createCoWatchingClient
na urządzeniu AddonSession
.
Aby utworzyć CoWatchingCient
, wywołaj metodę
AddonSession.createCoWatchingClient
.
i podaj
CoWatchingDelegate
CoWatchingDelegate
to sposób, w jaki interfejs Co-Watching API aktualizuje
, gdy ma nowy stan. To normalne, że
CoWatchingDelegate.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 dotyczących aktywności.
Zarządzaj bieżącym stanem
Gdy użytkownicy wykonują działania w Twojej aplikacji, natychmiast wywołuje podane 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 powyżej identyfikator (CoWatchingDelegate
) jest aktualizowany
w tych sytuacjach.
Stan wspólnego oglądania możesz kontrolować za pomocą tych metod:
CoWatchingClient.notifySwitchToMedia
: Wywołuj, gdy zmieni się aktywnie odtwarzane multimedia. Na przykład użytkownik wybierze nowy film lub autoodtwarzanie rozpocznie następny.CoWatchingClient.notifyPauseState
: Wywołuj, gdy użytkownik wstrzyma lub wznowi odtwarzanie multimediów.CoWatchingClient.notifySeekToTimestamp
: Wywoływanie, gdy użytkownik wyraźnie zmieni pozycję odtwarzania.CoWatchingClient.notifyPlayoutRate
: Wywołuj, gdy użytkownik zaktualizuje szybkość odtwarzania do nowej wartości (na przykład 1,25x).CoWatchingClient.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.CoWatchingClient.notifyReady
: Wywołaj po zakończeniu buforowania, gdy multimedia będą gotowe do odtwarzania.