הטמעת ממשק ה-API לצפייה משותפת

ה-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 בשם המדיה של הפעילות.

ניהול המצב הנוכחי

כשמשתמשים מבצעים פעולה באפליקציה, האפליקציה צפויה קוראת מיד ל-methods של ה-API.

כדאי להפעיל את השיטות האלה רק בתגובה לאירועים משמעותיים. עבור למשל, אין צורך לקרוא להם בכל פעם שהאפליקציה מקדמת וידאו. הכינויים של CoWatchingDelegate שיצרת למעלה מתעדכנים במצבי מהלך המשחק בנסיבות האלה.

אתם יכולים לשלוט במצב הצפייה המשותפת בשיטות הבאות:

  • CoWatchingClient.notifySwitchToMedia: קוראים בכל פעם שמדיה שמופעלת כרגע משתנה. לדוגמה, המשתמש בוחר סרטון חדש, או שההפעלה האוטומטית מפעילה את הסרטון הבא.
  • CoWatchingClient.notifyPauseState: הקריאה מופעלת כשמשתמש משהה את המדיה המופעלת או מבטל את ההשהיה שלה.
  • CoWatchingClient.notifySeekToTimestamp: קריאה כשמשתמש משנה באופן מפורש את מיקום ההפעלה.
  • CoWatchingClient.notifyPlayoutRate: קוראים לפונקציה כשמשתמש מעדכן את מהירות ההפעלה לערך חדש (לדוגמה, 1.25x).
  • CoWatchingClient.notifyBuffering: התקשרות כשאפליקציה של משתמש מתחילה בתהליך אגירת נתונים בגלל אגירת נתונים ממדיה קודמת מתג, חיפוש מדיה או עומס ברשת.
  • CoWatchingClient.notifyReady: השיחה תסתיים כשתהליך אגירת הנתונים יסתיים והתוכן מוכן להפעלה.