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

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

CoWatchingClient बनाएं

शुरू करने के लिए, शुरू करें में बनाए गए AddonSession से एक createCoWatchingClient बनाएं.

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

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

नीचे दिया गया कोड सैंपल, Co-watch 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
    },
  });

ACTIVITY_TITLE को अपनी गतिविधि के मीडिया टाइटल से बदलें.

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

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

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

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

• CoWatchingClient.notifySwitchToMedia: जब भी मीडिया में बदलाव किया जा रहा हो, तब कॉल करें. उदाहरण के लिए, कोई व्यक्ति नया वीडियो चुनता है या अगला वीडियो अपने-आप चलने की सुविधा चालू करता है.
• CoWatchingClient.notifyPauseState: कॉल तब करें, जब कोई उपयोगकर्ता चल रहे मीडिया को रोक दे या फिर से चालू करे.
• CoWatchingClient.notifySeekToTimestamp: कॉल तब करें, जब कोई उपयोगकर्ता, प्ले आउट पोज़िशन में साफ़ तौर पर बदलाव करे.
• CoWatchingClient.notifyPlayoutRate: कॉल तब करें, जब कोई उपयोगकर्ता वीडियो चलाने की स्पीड को नई वैल्यू पर अपडेट करता है (उदाहरण के लिए, 1.25x).
• CoWatchingClient.notifyBuffering: कॉल तब करें, जब पहले से मीडिया स्विच करने, मीडिया खोजने या इंटरनेट बंद होने की वजह से उपयोगकर्ता का ऐप्लिकेशन बफ़र हो रहा हो.
• CoWatchingClient.notifyReady: बफ़रिंग पूरी होने पर कॉल करें और मीडिया चलाए जाने के लिए तैयार हो.