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

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

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

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

Co-watch API का इस्तेमाल करने के लिए, आपको पहले एक Meet ऐड-ऑन. एक बार आपने ये चरण पूरे कर लिए हैं, तो Co-watch API का इस्तेमाल करके ऐड-ऑन का इस्तेमाल करें.

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

TypeScript

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

CLOUD_PROJECT_NUMBER को इसकी प्रोजेक्ट संख्या से बदलें आपका Google Cloud प्रोजेक्ट.

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

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

CoWatchingCient बनाने के लिए, createCoWatchingClient() इस्तेमाल किया जा सकता है और CoWatchingDelegate ऑब्जेक्ट है.

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

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

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

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

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

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

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

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

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