تتيح واجهة برمجة التطبيقات Co-Watching API إدارة تجربة الاجتماعات لعدة المشاركين الذين يشاهدون أو يستمعون إلى المحتوى في تطبيقك
يشرح هذا الدليل كيفية استخدام واجهة برمجة التطبيقات Co-Watching API.
البدء
لاستخدام واجهة برمجة التطبيقات Co-Watching API، عليك أولاً إنشاء إضافة Meet مرة واحدة بعد إكمال هذه الخطوات، يمكنك البدء باستخدام واجهة برمجة التطبيقات Co-Watching API. من داخل إضافتك الجديدة.
لاستخدام واجهة برمجة التطبيقات Co-Watching API، يمكنك البدء من خلال الحصول على
AddonSession
،
تعمل كنقطة دخول للأنشطة المشتركة:
TypeScript
const session = await window.meet.addon.createAddonSession({
cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
});
إنشاء CoWatchingClient
للبدء، أنشئ
createCoWatchingClient
من AddonSession
.
لإنشاء CoWatchingCient
، يمكنك طلب
AddonSession.createCoWatchingClient
طريقة وتوفير
CoWatchingDelegate
CoWatchingDelegate
هي الطريقة التي تعدّل بها واجهة برمجة التطبيقات Co-Watching API
كلما توفرت حالة جديدة. يُتوقع أنه عندما
CoWatchingDelegate.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 بعنوان الوسائط الخاص بنشاطك.
إدارة الحالة الحالية
عندما يتخذ المستخدمون إجراءً في تطبيقك، من المتوقع أن يستخدم تطبيقك على الفور بطرق واجهة برمجة التطبيقات المقدمة.
ويجب عدم استدعاء هذه الطرق إلا استجابةً للأحداث المهمة. بالنسبة
على سبيل المثال، لا تحتاج إلى الاتصال بها في كل مرة يتقدم فيها تطبيقك
الفيديو القادم. جارٍ تعديل الأسماء المعرِّفة التي أنشأتها CoWatchingDelegate
أعلاه
المواقف المختلفة في هذه الظروف.
يمكنك التحكّم في حالة المشاهدة مع الآخرين بالطُرق التالية:
CoWatchingClient.notifySwitchToMedia
: يمكنك الاتصال عند تغيّر الوسائط النشطة. على سبيل المثال، قد يرغب المستخدم فيديو جديدًا، أو تبدأ الفيديو التالي تلقائيًا.CoWatchingClient.notifyPauseState
: يتم الاتصال عند إيقاف المستخدم مؤقتًا للوسائط التي يتم تشغيلها أو إلغاء إيقافها مؤقتًا.CoWatchingClient.notifySeekToTimestamp
: يتم الاتصال عندما يغيّر المستخدم موضع التشغيل بشكل صريح.CoWatchingClient.notifyPlayoutRate
: يتم الاتصال عندما يعدِّل المستخدم سرعة التشغيل إلى قيمة جديدة (على سبيل المثال، 1.25x).CoWatchingClient.notifyBuffering
: الاتصال عندما يبدأ تطبيق المستخدم في التخزين المؤقت بسبب التخزين المؤقت من وسائط سابقة التبديل أو الانتقال إلى الوسائط أو ازدحام الشبكة.CoWatchingClient.notifyReady
: يمكنك الاتصال عند اكتمال التخزين المؤقت وتكون الوسائط جاهزة الآن للتشغيل.