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

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

इस गाइड में, को-वॉचिंग एपीआई को लागू करने का तरीका बताया गया है.

शुरू करें

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

को-वॉचिंग एपीआई का इस्तेमाल करने के लिए, सबसे पहले AddonSession ऑब्जेक्ट हासिल करें, यह Google Meet की को-ऐक्टिविटी के लिए एंट्री पॉइंट के तौर पर काम करता है:

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

को-वॉचिंग क्लाइंट बनाना

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

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

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

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

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