API การดูร่วมกันจะจัดการประสบการณ์การประชุมของผู้ใช้ ผู้ชมที่ดูหรือฟังเนื้อหาในแอปของคุณ
คู่มือนี้อธิบายวิธีใช้ API การดูร่วมกัน
เริ่มต้นใช้งาน
หากต้องการใช้ API การดูร่วมกัน ขั้นแรกคุณต้องสร้าง ส่วนเสริม Meet ครั้งเดียว เมื่อดำเนินการขั้นตอนเหล่านี้เสร็จแล้ว คุณจะเริ่มใช้ API การดูร่วมกันได้ จากภายในส่วนเสริมใหม่ของคุณ
หากต้องการใช้ API การดูร่วมกัน ให้เริ่มด้วยการรับ
AddonSession
ซึ่ง
ทำหน้าที่เป็นจุดแรกเข้าสำหรับกิจกรรมร่วม
TypeScript
const session = await window.meet.addon.createAddonSession({
cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
});
สร้าง CoWatchingClient
ในการเริ่มต้นใช้งาน ให้สร้าง
createCoWatchingClient
จาก AddonSession
ของคุณ
หากต้องการสร้าง CoWatchingCient
ให้เรียกใช้
AddonSession.createCoWatchingClient
และระบุ
CoWatchingDelegate
CoWatchingDelegate
คือวิธีที่ API การดูร่วมกันอัปเดต
เมื่อใดก็ตามที่มีสถานะใหม่ คาดว่าเมื่อ
CoWatchingDelegate.onCoWatchingStateChanged
จะถูกเรียก แอปพลิเคชันของคุณจะใช้สถานะใหม่ทันที
ตัวอย่างโค้ดต่อไปนี้แสดงวิธีใช้ 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
ที่คุณสร้างไว้ข้างต้นกำลังได้รับการอัปเดต
ตำแหน่งที่เล่นได้ในสถานการณ์เหล่านี้
คุณควบคุมสถานะการดูร่วมกันได้โดยใช้วิธีการเหล่านี้
CoWatchingClient.notifySwitchToMedia
: โทรเมื่อสื่อที่เล่นอยู่มีการเปลี่ยนแปลง ตัวอย่างเช่น ผู้ใช้ เลือกวิดีโอใหม่ หรือเล่นอัตโนมัติจะเริ่มวิดีโอถัดไปCoWatchingClient.notifyPauseState
: โทรเมื่อผู้ใช้หยุดชั่วคราวหรือยกเลิกการหยุดสื่อที่เล่นไว้ชั่วคราวCoWatchingClient.notifySeekToTimestamp
: เรียกใช้เมื่อผู้ใช้เปลี่ยนตำแหน่งการเล่นอย่างชัดเจนCoWatchingClient.notifyPlayoutRate
: เรียกใช้เมื่อผู้ใช้อัปเดตความเร็วในการเล่นเป็นค่าใหม่ (เช่น 1.25x)CoWatchingClient.notifyBuffering
: เรียกใช้เมื่อแอปของผู้ใช้เริ่มบัฟเฟอร์เนื่องจากมีการบัฟเฟอร์จากสื่อก่อนหน้า การค้นหาสื่อ ความคับคั่งของเครือข่ายCoWatchingClient.notifyReady
: โทรเมื่อบัฟเฟอร์เสร็จสมบูรณ์ และสื่อก็พร้อมที่จะเล่น