Co-Watching API mengelola pengalaman rapat dari peserta yang menonton atau mendengarkan konten di aplikasi Anda.
Panduan ini menjelaskan cara menerapkan Co-Watching API.
Mulai
Untuk menggunakan Co-Watching API, Anda harus terlebih dahulu Membuat Add-on Meet. Satu kali telah menyelesaikan langkah-langkah tersebut, Anda dapat mulai menggunakan Co-Watching API dari dalam add-on baru Anda.
Untuk menggunakan Co-Watching API, mulailah dengan mendapatkan
AddonSession
, yang
berfungsi sebagai titik masuk untuk aktivitas bersama:
TypeScript
const session = await window.meet.addon.createAddonSession({
cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
});
Membuat CoWatchingClient
Untuk memulai, buat
createCoWatchingClient
dari AddonSession
Anda.
Untuk membuat CoWatchingCient
, panggil metode
AddonSession.createCoWatchingClient
dan menyediakan
CoWatchingDelegate
.
CoWatchingDelegate
adalah cara Co-Watching API mengupdate
aplikasi setiap kali memiliki status baru yang tersedia. Diharapkan bahwa, ketika
CoWatchingDelegate.onCoWatchingStateChanged
dipanggil, aplikasi Anda akan segera menerapkan status baru.
Contoh kode berikut menunjukkan cara menggunakan 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
},
});
Ganti ACTIVITY_TITLE dengan judul media aktivitas Anda.
Kelola status saat ini
Saat pengguna mengambil tindakan dalam aplikasi, aplikasi Anda diharapkan segera memanggil metode API yang disediakan.
Anda hanya boleh memanggil metode ini sebagai respons terhadap peristiwa signifikan. Sebagai
Anda tidak perlu memanggilnya setiap kali aplikasi Anda memajukan pemutaran
video Anda. CoWatchingDelegate
yang Anda buat di atas menangani pembaruan
posisi {i>playout<i} dalam
situasi seperti ini.
Anda dapat mengontrol status menonton bersama menggunakan metode berikut:
CoWatchingClient.notifySwitchToMedia
: Panggil setiap kali media yang sedang diputar berubah. Misalnya, pengguna memilih video baru, atau putar otomatis memulai video berikutnya.CoWatchingClient.notifyPauseState
: Lakukan panggilan saat pengguna menjeda atau melanjutkan pemutaran media.CoWatchingClient.notifySeekToTimestamp
: Memanggil saat pengguna secara eksplisit mengubah posisi pemutaran.CoWatchingClient.notifyPlayoutRate
: Memanggil saat pengguna memperbarui kecepatan pemutaran ke nilai baru (misalnya, 1,25x).CoWatchingClient.notifyBuffering
: Panggilan saat aplikasi pengguna mulai buffering karena buffering dari media sebelumnya {i>switch<i}, pencarian media, atau kemacetan jaringan.CoWatchingClient.notifyReady
: Panggil saat buffering selesai dan media kini siap untuk diputar.