นำ Co-Watching API ไปใช้

โปรแกรมทดลองใช้ก่อนเปิดตัว: ฟีเจอร์นี้พร้อมให้บริการใน เวอร์ชันตัวอย่างแบบจำกัดผ่านโปรแกรมทดลองใช้ก่อนเปิดตัวเท่านั้น ขณะนี้โปรแกรมนี้ปิดรับการลงชื่อสมัครใช้ใหม่แล้ว

Co-Watching API จะจัดการประสบการณ์การประชุมของผู้เข้าร่วมหลายคน ที่ดูหรือฟังเนื้อหาในแอปของคุณ

คู่มือนี้อธิบายวิธีใช้ Co-Watching API

เริ่มต้นใช้งาน

หากต้องการใช้ Co-Watching API คุณต้องติดตั้งใช้งาน ส่วนเสริม Meet ก่อน เมื่อทำตามขั้นตอนเหล่านั้นเสร็จแล้ว คุณจะเริ่มใช้ Co-Watching API จากภายในส่วนเสริมใหม่ได้

หากต้องการใช้ Co-Watching API ให้เริ่มต้นด้วยการรับออบเจ็กต์ AddonSession ซึ่งทำหน้าที่เป็นจุดแรกเข้าสำหรับกิจกรรมร่วมใน Google Meet

TypeScript

const session = await window.meet.addon.createAddonSession({
    cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
});

แทนที่ CLOUD_PROJECT_NUMBER ด้วยหมายเลขโปรเจ็กต์ของ โปรเจ็กต์ Google Cloud

สร้างไคลเอ็นต์การดูร่วมกัน

สร้างออบเจ็กต์ CoWatchingClient จาก AddonSession เพื่อเริ่มต้นใช้งาน

หากต้องการสร้าง CoWatchingCient ให้เรียกใช้เมธอด createCoWatchingClient() และระบุออบเจ็กต์ CoWatchingDelegate

CoWatchingDelegate คือวิธีที่ Co-Watching API อัปเดตแอปของคุณ เมื่อมีสถานะใหม่พร้อมใช้งาน เมื่อมีการเรียกใช้เมธอด onCoWatchingStateChanged() แอปของคุณควรใช้สถานะใหม่ทันที

ตัวอย่างโค้ดต่อไปนี้แสดงวิธีใช้ 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
    },
  });

แทนที่ ACTIVITY_TITLE ด้วยชื่อสื่อของกิจกรรม

จัดการสถานะปัจจุบัน

เมื่อผู้ใช้ดำเนินการในแอปพลิเคชันของคุณ คาดว่าแอปพลิเคชันของคุณ จะเรียกใช้เมธอด API ที่ระบุทันที

คุณควรเรียกใช้เมธอดเหล่านี้เพื่อตอบสนองต่อเหตุการณ์สำคัญเท่านั้น เช่น คุณไม่จำเป็นต้องเรียกใช้ทุกครั้งที่แอปเลื่อนวิดีโอที่กำลังเล่น CoWatchingDelegate ที่คุณสร้างจะจัดการการอัปเดตตำแหน่งการเล่น ในสถานการณ์เหล่านี้

คุณควบคุมสถานะการดูร่วมกันได้โดยใช้วิธีต่อไปนี้

• notifyBuffering(): เรียกใช้เมื่อแอปของผู้ใช้เริ่มบัฟเฟอร์เนื่องจากการบัฟเฟอร์จากสื่อก่อนหน้า การสลับสื่อ การค้นหาสื่อ หรือเครือข่ายหนาแน่น

• notifyPauseState(): เรียกใช้เมื่อผู้ใช้หยุดชั่วคราวหรือยกเลิกการหยุดชั่วคราวของสื่อที่เล่น

• notifyPlayoutRate(): เรียกใช้เมื่อผู้ใช้อัปเดตความเร็วในการเล่นเป็นค่าใหม่ (เช่น 1.25x)

• notifyReady(): เรียกใช้เมื่อบัฟเฟอร์เสร็จสมบูรณ์และสื่อพร้อมเล่นแล้ว

• notifySeekToTimestamp(): เรียกใช้เมื่อผู้ใช้เปลี่ยนตำแหน่งการเล่นอย่างชัดเจน

• notifySwitchToMedia(): เรียกใช้ทุกครั้งที่สื่อที่เล่นอยู่มีการเปลี่ยนแปลง เช่น ผู้ใช้ เลือกวิดีโอใหม่ หรือการเล่นอัตโนมัติเริ่มวิดีโอถัดไป