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

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

इस गाइड में, साथ में वीडियो देखने की सुविधा देने वाले API को लागू करने का तरीका बताया गया है.

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

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

साथ मिलकर वीडियो देखने की सुविधा देने वाले एपीआई का इस्तेमाल करने के लिए, सबसे पहले 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(): चल रहे मीडिया में बदलाव होने पर कॉल करें. उदाहरण के लिए, जब उपयोगकर्ता कोई नया वीडियो चुनता है या अपने-आप चलने की सुविधा से अगला वीडियो शुरू होता है.