साथ मिलकर देखने का एपीआई लागू करना

Co-Watch API, एक से ज़्यादा लाइव स्ट्रीम के मीटिंग अनुभव को मैनेज करता है आपके ऐप्लिकेशन की सामग्री को देखने या सुनने वाले लोगों की संख्या.

इस गाइड में, Co-watch API को लागू करने का तरीका बताया गया है.

अपनी प्रोफ़ाइल बनाना शुरू करें

साथ मिलकर वीडियो देखने की सुविधा देने वाले एपीआई का इस्तेमाल करने के लिए, आपको सबसे पहले Meet ऐड-ऑन डिप्लॉय करना होगा. ये चरण पूरे करने के बाद, अपने नए ऐड-ऑन में जाकर, एक साथ वीडियो देखने की सुविधा देने वाले एपीआई का इस्तेमाल शुरू किया जा सकता है.

Co-watch API का इस्तेमाल करने के लिए, AddonSession ऑब्जेक्ट, यह Google Meet को-गतिविधियों में शामिल होने का एंट्री पॉइंट है:

TypeScript

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

CLOUD_PROJECT_NUMBER की जगह अपने Google Cloud प्रोजेक्ट का प्रोजेक्ट नंबर डालें.

साथ मिलकर वीडियो देखने के लिए क्लाइंट बनाएं

शुरू करने के लिए, अपने AddonSession से CoWatchingClient ऑब्जेक्ट बनाएं.

CoWatchingCient बनाने के लिए, createCoWatchingClient() तरीका कॉल करें और CoWatchingDelegate ऑब्जेक्ट दें.

CoWatchingDelegate की मदद से, साथ में वीडियो देखने की सुविधा देने वाला एपीआई, आपके ऐप्लिकेशन को अपडेट करता है. ऐसा तब होता है, जब एपीआई के पास कोई नई स्थिति उपलब्ध हो. ऐसी उम्मीद की जाती है कि जब onCoWatchingStateChanged() तरीका कॉल किया जाता है, तो आपका ऐप्लिकेशन तुरंत नई स्थिति लागू कर देता है.

यहां दिए गए कोड सैंपल में, एक साथ वीडियो देखने की सुविधा देने वाले एपीआई का इस्तेमाल करने का तरीका बताया गया है:

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 हैंडल को अपडेट किया जाता है नहीं कर सकते.

साथ में वीडियो देखने की सुविधा को इन तरीकों से कंट्रोल किया जा सकता है:

  • notifyBuffering(): पहले के मीडिया से बफ़र होने की वजह से, उपयोगकर्ता का ऐप्लिकेशन बफ़र होने पर कॉल करें स्विच करना, मीडिया में आगे/पीछे जाना या नेटवर्क में रुकावट डालना.

  • notifyPauseState(): जब कोई उपयोगकर्ता चल रहे मीडिया को रोक दे या फिर से चालू कर दे, तब कॉल करें.

  • notifyPlayoutRate(): जब कोई उपयोगकर्ता वीडियो चलाने की स्पीड को किसी नई वैल्यू (उदाहरण के लिए, 1.25x) पर अपडेट करता है, तब यह कॉल ट्रिगर होता है.

  • notifyReady(): बफ़रिंग पूरी होने और मीडिया के चलने के लिए तैयार होने पर कॉल करें.

  • notifySeekToTimestamp(): जब कोई उपयोगकर्ता साफ़ तौर पर वीडियो चलाने की जगह बदलता है, तब कॉल करें.

  • notifySwitchToMedia(): चल रहे मीडिया में बदलाव होने पर कॉल करें. उदाहरण के लिए, उपयोगकर्ता नया वीडियो चुनता है या अगला वीडियो अपने-आप चलने की सुविधा चालू करता है.