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

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

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

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

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

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

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

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

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

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

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

यहां दिए गए कोड सैंपल में, Co-Watching API का इस्तेमाल करने का तरीका बताया गया है:

 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
    },
  });

मौजूदा स्थिति मैनेज करना

जब उपयोगकर्ता आपके ऐप्लिकेशन में कोई कार्रवाई करते हैं, तो यह ज़रूरी है कि आपका ऐप्लिकेशन, दिए गए एपीआई तरीकों को तुरंत कॉल करे.

आपको इन तरीकों का इस्तेमाल सिर्फ़ ज़रूरी इवेंट के जवाब में करना चाहिए. उदाहरण के लिए, जब आपका ऐप्लिकेशन कोई वीडियो चलाता है, तो आपको हर बार उन्हें कॉल करने की ज़रूरत नहीं होती. CoWatchingDelegate बनाने पर, इन स्थितियों में वीडियो चलाने की जगहें अपडेट हो जाती हैं.

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

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

• notifyPauseState(): जब कोई उपयोगकर्ता मीडिया को चलाने की सुविधा को रोकता है या फिर से शुरू करता है, तब इस फ़ंक्शन को कॉल करें.

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

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

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

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