AddonSession

Kotlin |Java

@PublicApi
interface AddonSession

---

ऐड-ऑन सेशन.

इनमें ऐसे तरीके शामिल होते हैं जो सभी ऐड-ऑन सेशन के लिए आम तौर पर इस्तेमाल होते हैं. किसी व्यक्ति के साथ मिलकर वीडियो देखने और किसी व्यक्ति के साथ मिलकर वीडियो देखने की सुविधा के लिए, getCoWatching पर कॉल करें और getCoDoing पर कॉल करें.

खास जानकारी

नेस्ट किए गए प्रकार
@PublicApi interface AddonSession.Builder AddonSession का बिल्डर.

सार्वजनिक फ़ंक्शन
ListenableFuture<Void!>!	endSession() ऐड-ऑन सेशन को खत्म करता है और Meet ऐप्लिकेशन से डिसकनेक्ट करता है.
Unit	endSuspension() निलंबित की स्थिति से बाहर निकलता है.
CoDoingClient!	getCoDoing() CoDoingClient इंस्टेंस दिखाता है.
CoWatchingClient!	getCoWatching() CoWatchingClient इंस्टेंस दिखाता है.
AddonMeetingInfo!	getMeetingInfo() यह कनेक्ट की गई मीटिंग के बारे में जानकारी दिखाता है, जैसे कि मीटिंग का यूआरएल.
Boolean	isSessionEnded() सेशन खत्म होने पर true दिखाता है.
Boolean	isSuspended() इससे पता चलता है कि सेशन निलंबित है या नहीं.
Unit	resetCollaborationStartingState() ऐड-ऑन की शुरुआती स्थिति को रीसेट करता है.
Unit	suspend() इससे ऐड-ऑन सेशन निलंबित हो जाता है.
Unit	updateCollaborationStartingState(     startingState: CollaborationStartingState! ) ऐड-ऑन की शुरुआती स्थिति को अपडेट करता है.
Unit	updateParticipantMetadata(metadata: ByteArray!) इस भागीदार के लिए मेटाडेटा अपडेट करता है.

सार्वजनिक फ़ंक्शन

endSession

fun endSession(): ListenableFuture<Void!>!

यह ऐड-ऑन सेशन को खत्म करता है और Meet ऐप्लिकेशन से डिसकनेक्ट हो जाता है. इस वजह से, Meet को न तो मीटिंग खत्म करनी होती है और न ही उपयोगकर्ता को मीटिंग छोड़नी पड़ती है.

अगर सेशन पहले ही खत्म हो चुका है, तो इसे देखने की ज़रूरत नहीं है. इससे आपको कोई अपवाद नहीं मिलेगा.

लौटाए गए प्रॉडक्ट
ListenableFuture<Void!>!	कोई ListenableFuture, जो कामयाब होने का आकलन करता है. इसके अलावा, अचानक कोई गड़बड़ी होने पर AddonException का आकलन किया जाता है

endSuspension

fun endSuspension(): Unit

निलंबित की स्थिति से बाहर निकलता है. ऐड-ऑन ऐप्लिकेशन से फिर से अपडेट भेजे और पाए जा सकते हैं.

अगर यह निलंबित की स्थिति में नहीं है, तो इसका इस्तेमाल नहीं किया जा सकता.

थ्रो
java.lang.IllegalStateException	अगर सेशन खत्म हो गया है. ऐसा endSession को साफ़ तौर पर किया गया कॉल या किसी बाहरी वजह से हो सकता है. यह कॉल onSessionEnded के ज़रिए दिखाया जाएगा.

getCoDoing

fun getCoDoing(): CoDoingClient!

CoDoingClient इंस्टेंस दिखाता है.

थ्रो
java.lang.IllegalStateException	अगर सेशन, withCoDoing को कॉल किए बिना बनाया गया हो या सेशन खत्म हो गया हो

getCoWatching

fun getCoWatching(): CoWatchingClient!

CoWatchingClient इंस्टेंस दिखाता है.

थ्रो
java.lang.IllegalStateException	अगर सेशन, withCoWatching को कॉल किए बिना बनाया गया हो या सेशन खत्म हो गया हो

getMeetingInfo

fun getMeetingInfo(): AddonMeetingInfo!

यह कनेक्ट की गई मीटिंग के बारे में जानकारी दिखाता है, जैसे कि मीटिंग का यूआरएल.

थ्रो
java.lang.IllegalStateException	अगर सेशन खत्म हो गया है. ऐसा endSession को साफ़ तौर पर किया गया कॉल या किसी बाहरी वजह से हो सकता है. यह कॉल onSessionEnded के ज़रिए दिखाया जाएगा.

isSessionEnded

fun isSessionEnded(): Boolean

सेशन खत्म होने पर true दिखाता है. ऐसा endSession को किए गए किसी अश्लील कॉल की वजह से हो सकता है. इसके अलावा, ऐसा किसी बाहरी वजह से भी हो सकता है जो onSessionEnded के ज़रिए पता चलेगा.

थ्रो
java.lang.IllegalStateException	अगर सेशन खत्म हो गया है. ऐसा endSession को साफ़ तौर पर किया गया कॉल या किसी बाहरी वजह से हो सकता है. यह कॉल onSessionEnded के ज़रिए दिखाया जाएगा

isSuspended

fun isSuspended(): Boolean

इससे पता चलता है कि सेशन निलंबित है या नहीं. suspend और endSuspension देखें.

थ्रो
java.lang.IllegalStateException	अगर सेशन खत्म हो गया है. ऐसा endSession को साफ़ तौर पर किया गया कॉल या किसी बाहरी वजह से हो सकता है. यह कॉल onSessionEnded के ज़रिए दिखाया जाएगा.

resetCollaborationStartingState

fun resetCollaborationStartingState(): Unit

ऐड-ऑन की शुरुआती स्थिति को रीसेट करता है. ऐसा करने से, मीटिंग में हिस्सा लेने वाले दूसरे लोगों को पहले से ही बातचीत की शुरुआत करने की स्थिति से हटा दिया जाएगा. शुरुआती स्थिति को सिर्फ़ शुरू करने वाला व्यक्ति रीसेट कर सकता है.

suspend

fun suspend(): Unit

इससे ऐड-ऑन सेशन निलंबित हो जाता है. यह Meet ऐप्लिकेशन से डिसकनेक्ट नहीं होता है. इस वजह से, SDK टूल आपके CoDoingHandler और CoWatchingHandler पर अपडेट नहीं भेजता. साथ ही, इसकी वजह से SDK टूल, कॉल को अनदेखा करने के लिए कॉल को अनदेखा करता है और ग्लोबल स्थिति को अपडेट करने के लिए कॉल को अनदेखा करता है.

अगर सेशन पहले ही निलंबित हो चुका है, तो उसे हल नहीं किया जा सकता.

उदाहरण के लिए, suspend को तब कॉल किया जा सकता है, जब विज्ञापन देखने के लिए हर उपयोगकर्ता के बजाय, हर उपयोगकर्ता ने वीडियो चलाने में रुकावट डाल दी हो, जब कोई उपयोगकर्ता ऐप्लिकेशन को बैकग्राउंड में देख रहा हो वगैरह.

थ्रो
java.lang.IllegalStateException	अगर सेशन खत्म हो गया है. ऐसा endSession को साफ़ तौर पर किया गया कॉल या किसी बाहरी वजह से हो सकता है. यह कॉल onSessionEnded के ज़रिए दिखाया जाएगा.

updateCollaborationStartingState

fun updateCollaborationStartingState(
    startingState: CollaborationStartingState!
): Unit

ऐड-ऑन की शुरुआती स्थिति को अपडेट करता है. यह जानकारी, मीटिंग में हिस्सा लेने वाले दूसरे लोगों को तब मिलती है, जब वे साथ मिलकर काम करने का न्योता स्वीकार करते हैं. शुरुआती स्थिति को सिर्फ़ शुरू करने वाला व्यक्ति अपडेट कर सकता है.

पैरामीटर
startingState: CollaborationStartingState!	ऐड-ऑन की शुरुआती स्थिति

updateParticipantMetadata

fun updateParticipantMetadata(metadata: ByteArray!): Unit

इस भागीदार के लिए मेटाडेटा अपडेट करता है.

मीटिंग में हिस्सा लेने वाले दूसरे लोगों से मेटाडेटा पाने के लिए, AddonSession बनाते समय, withPartnerMetadata को कॉल करके, हैंडलर को रजिस्टर किया जाना चाहिए.

कोड में बदले गए मेटाडेटा को हर व्यक्ति के लिए, MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES बाइट तक सीमित किया गया है.

पैरामीटर
metadata: ByteArray!	मेटाडेटा का कोड में बदला गया ब्लॉब, जो स्थानीय मीटिंग में हिस्सा लेने वाले व्यक्ति के काम के मेटाडेटा के बारे में बताता है

थ्रो
java.lang.IllegalArgumentException	अगर दिया गया मेटाडेटा MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES बाइट से ज़्यादा हो
java.lang.IllegalStateException	अगर सेशन खत्म हो गया है. ऐसा endSession को साफ़ तौर पर किया गया कॉल या किसी बाहरी वजह से हो सकता है. यह कॉल onSessionEnded के ज़रिए दिखाया जाएगा.