chrome.bluetoothSocket

ब्यौरा

RFCOMM और L2CAP कनेक्शन की मदद से ब्लूटूथ डिवाइसों पर डेटा भेजने और पाने के लिए, chrome.bluetoothSocket API का इस्तेमाल करें.

मेनिफ़ेस्ट

इस एपीआई का इस्तेमाल करने के लिए, मेनिफ़ेस्ट में इन कुंजियों का एलान करना ज़रूरी है.

"bluetooth"

टाइप

AcceptError

Enum

"system_error"
सिस्टम में कोई गड़बड़ी हुई और हो सकता है कि कनेक्शन ठीक न हो.

"not_listening"
सॉकेट सुन नहीं रहा है.

AcceptErrorInfo

प्रॉपर्टी

  • गड़बड़ी

    AcceptError

    गड़बड़ी का एक कोड, जो बताता है कि क्या गड़बड़ी हुई.

  • errorMessage

    स्ट्रिंग

    गड़बड़ी का मैसेज.

  • socketId

    संख्या

    सर्वर सॉकेट आइडेंटिफ़ायर.

AcceptInfo

प्रॉपर्टी

  • clientSocketId

    संख्या

    क्लाइंट सॉकेट आइडेंटिफ़ायर, यानी कि नए कनेक्शन का सॉकेट आइडेंटिफ़ायर. इस सॉकेट आइडेंटिफ़ायर का इस्तेमाल सिर्फ़ chrome.bluetoothSocket नेमस्पेस के फ़ंक्शन के साथ किया जाना चाहिए. ध्यान दें कि क्लाइंट सॉकेट शुरुआती तौर पर रुक गया है और डेटा पाना शुरू करने के लिए ऐप्लिकेशन की ओर से उसे साफ़ तौर पर अन-रोका गया होना चाहिए.

  • socketId

    संख्या

    सर्वर सॉकेट आइडेंटिफ़ायर.

CreateInfo

प्रॉपर्टी

  • socketId

    संख्या

    नए बनाए गए सॉकेट का आईडी. ध्यान दें कि इस एपीआई से बनाए गए सॉकेट आईडी, अन्य एपीआई से बनाए गए सॉकेट आईडी, जैसे कि [sockets.tcp](../sockets_tcp/) एपीआई के साथ काम नहीं करते हैं.

ListenOptions

प्रॉपर्टी

  • बैकलॉग

    नंबर वैकल्पिक

    सॉकेट की सुनने की सूची की अवधि. डिफ़ॉल्ट वैल्यू, ऑपरेटिंग सिस्टम के होस्ट सबसिस्टम पर निर्भर करती है.

  • चैनल

    नंबर वैकल्पिक

    listenUsingRfcomm, RFCOMM चैनल का इस्तेमाल करता है. अगर बताया गया है, तो ज़रूरी है कि यह चैनल पहले इस्तेमाल न किया जा रहा हो. ऐसा न करने पर, तरीके से कॉल नहीं किया जा सकेगा. अगर इसके बारे में नहीं बताया जाता है, तो इस्तेमाल न होने वाले चैनल को अपने-आप बांट दिया जाएगा.

  • पीएसएम

    नंबर वैकल्पिक

    listenUsingL2cap ने L2CAP PSM का इस्तेमाल किया. अगर बताया गया हो, तो ज़रूरी है कि यह पीएसएम पहले इस्तेमाल में न हो या मेथड कॉल फ़ेल हो गया हो. अगर नीति के बारे में नहीं बताया गया है, तो इस्तेमाल नहीं किए गए पीएसएम को अपने-आप बांट दिया जाएगा.

ReceiveError

Enum

"डिसकनेक्ट किया गया"
कनेक्शन डिसकनेक्ट हो गया था.

"system_error"
सिस्टम में कोई गड़बड़ी हुई और हो सकता है कि कनेक्शन ठीक न हो.

"not_linked"
सॉकर कनेक्ट नहीं हुआ है.

ReceiveErrorInfo

प्रॉपर्टी

  • गड़बड़ी

    ReceiveError

    गड़बड़ी का एक कोड, जो बताता है कि क्या गड़बड़ी हुई.

  • errorMessage

    स्ट्रिंग

    गड़बड़ी का मैसेज.

  • socketId

    संख्या

    सॉकेट आइडेंटिफ़ायर.

ReceiveInfo

प्रॉपर्टी

  • डेटा

    अरेबफ़र

    bufferSize के अधिकतम आकार वाला डेटा मिला.

  • socketId

    संख्या

    सॉकेट आइडेंटिफ़ायर.

SocketInfo

प्रॉपर्टी

  • पता

    स्ट्रिंग ज़रूरी नहीं

    यदि अंतर्निहित सॉकेट कनेक्ट है, तो उस डिवाइस का ब्लूटूथ पता शामिल होता है जिससे वह कनेक्ट है.

  • bufferSize

    नंबर वैकल्पिक

    डेटा पाने के लिए इस्तेमाल किए गए बफ़र का साइज़. अगर साफ़ तौर पर कोई बफ़र साइज़ तय नहीं किया गया है, तो वैल्यू नहीं दी जाएगी.

  • कनेक्ट किया गया

    बूलियन

    इस फ़्लैग से पता चलता है कि सॉकेट किसी रिमोट मिलते-जुलते ऐप्लिकेशन से कनेक्ट है या नहीं.

  • नाम

    स्ट्रिंग ज़रूरी नहीं

    सॉकेट से जुड़ी ऐप्लिकेशन-तय स्ट्रिंग.

  • रोका गया

    बूलियन

    यह फ़्लैग बताता है कि कनेक्ट किया गया सॉकेट, अपने साथी को ज़्यादा डेटा भेजने से ब्लॉक करता है या नहीं. इसके अलावा, यह भी पता चलता है कि सुनने की सुविधा वाले सॉकेट पर कनेक्शन के अनुरोध, onAccept इवेंट के ज़रिए भेजे जाते हैं या सूची में मौजूद सूची के बैकलॉग में, सूची में हैं. setPaused देखें. डिफ़ॉल्ट वैल्यू "false" है.

  • अनवरत

    बूलियन

    इस फ़्लैग से पता चलता है कि ऐप्लिकेशन के इवेंट पेज के अनलोड होने के बाद भी सॉकेट खुला रहता है या नहीं (SocketProperties.persistent देखें). डिफ़ॉल्ट वैल्यू "false" है.

  • socketId

    संख्या

    सॉकेट आइडेंटिफ़ायर.

  • यूयूआईडी

    स्ट्रिंग ज़रूरी नहीं

    अगर मौजूद सॉकेट कनेक्ट है, तो उसमें उस सेवा के UUID की जानकारी शामिल होती है जिससे वह कनेक्ट है. अगर सॉकेट कनेक्ट नहीं है, तो उसमें उस सेवा UUID की जानकारी शामिल होती है जिस पर वह सुन रही है.

SocketProperties

प्रॉपर्टी

  • bufferSize

    नंबर वैकल्पिक

    डेटा पाने के लिए इस्तेमाल किए गए बफ़र का साइज़. डिफ़ॉल्ट तौर पर, यह वैल्यू 4096 है.

  • नाम

    स्ट्रिंग ज़रूरी नहीं

    सॉकेट से जुड़ी ऐप्लिकेशन-तय स्ट्रिंग.

  • अनवरत

    बूलियन ज़रूरी नहीं

    इस फ़्लैग से पता चलता है कि ऐप्लिकेशन के इवेंट पेज के अनलोड होने पर, सॉकेट को खुला छोड़ दिया गया है या नहीं. (ऐप्लिकेशन लाइफ़साइकल मैनेज करना देखें). इसकी डिफ़ॉल्ट वैल्यू false. है. ऐप्लिकेशन लोड होने पर, पहले से खोले गए किसी भी सॉकेट को परसिस्टेंट=true, getSockets के साथ फ़ेच किया जा सकता है.

तरीके

close()

प्रॉमिस 
chrome.bluetoothSocket.close(
  socketId: number,
  callback?: function,
)

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

पैरामीटर

  • socketId

    संख्या

    सॉकेट आइडेंटिफ़ायर.

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

    callback पैरामीटर ऐसा दिखता है: 

    () => void

रिटर्न

  • प्रॉमिस<void>

    Chrome 91 और उसके बाद वाले वर्शन के लिए

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और उसके बाद के वर्शन पर काम करता है. दूसरे प्लैटफ़ॉर्म को कॉलबैक इस्तेमाल करने होते हैं.

connect()

प्रॉमिस 
chrome.bluetoothSocket.connect(
  socketId: number,
  address: string,
  uuid: string,
  callback?: function,
)

सॉकेट को किसी रिमोट ब्लूटूथ डिवाइस से कनेक्ट करता है. connect कार्रवाई पूरी होने के बाद, मिलते-जुलते ऐप्लिकेशन से डेटा मिलने पर onReceive इवेंट शुरू किए जाते हैं. अगर रनटाइम को पैकेट मिलते समय कोई नेटवर्क गड़बड़ी होती है, तो एक onReceiveError इवेंट शुरू हो जाता है. इसके बाद, जब तक setPaused(false) तरीका कॉल नहीं किया जाता, तब तक इस सॉकेट के लिए कोई और onReceive इवेंट नहीं किया जाएगा.

पैरामीटर

  • socketId

    संख्या

    सॉकेट आइडेंटिफ़ायर.

  • पता

    स्ट्रिंग

    ब्लूटूथ डिवाइस का पता.

  • यूयूआईडी

    स्ट्रिंग

    जिस सेवा से कनेक्ट करना है उसका यूयूआईडी.

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

    callback पैरामीटर ऐसा दिखता है: 

    () => void

रिटर्न

  • प्रॉमिस<void>

    Chrome 91 और उसके बाद वाले वर्शन के लिए

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और उसके बाद के वर्शन पर काम करता है. दूसरे प्लैटफ़ॉर्म को कॉलबैक इस्तेमाल करने होते हैं.

create()

प्रॉमिस 
chrome.bluetoothSocket.create(
  properties?: SocketProperties,
  callback?: function,
)

ब्लूटूथ सॉकेट बनाता है.

पैरामीटर

  • प्रॉपर्टी

    SocketProperties ज़रूरी नहीं है

    सॉकेट प्रॉपर्टी (ज़रूरी नहीं).

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

    callback पैरामीटर ऐसा दिखता है: 

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

      सॉकेट बनाने का नतीजा.

रिटर्न

  • Promise&lt;CreateInfo&gt;

    Chrome 91 और उसके बाद वाले वर्शन के लिए

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और उसके बाद के वर्शन पर काम करता है. दूसरे प्लैटफ़ॉर्म को कॉलबैक इस्तेमाल करने होते हैं.

disconnect()

प्रॉमिस 
chrome.bluetoothSocket.disconnect(
  socketId: number,
  callback?: function,
)

इससे सॉकेट डिसकनेक्ट हो जाता है. सॉकेट पहचानकर्ता मान् य रहता है.

पैरामीटर

  • socketId

    संख्या

    सॉकेट आइडेंटिफ़ायर.

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

    callback पैरामीटर ऐसा दिखता है: 

    () => void

रिटर्न

  • प्रॉमिस<void>

    Chrome 91 और उसके बाद वाले वर्शन के लिए

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और उसके बाद के वर्शन पर काम करता है. दूसरे प्लैटफ़ॉर्म को कॉलबैक इस्तेमाल करने होते हैं.

getInfo()

प्रॉमिस 
chrome.bluetoothSocket.getInfo(
  socketId: number,
  callback?: function,
)

दिए गए सॉकेट की स्थिति को हासिल करता है.

पैरामीटर

  • socketId

    संख्या

    सॉकेट आइडेंटिफ़ायर.

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

    callback पैरामीटर ऐसा दिखता है: 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      ऑब्जेक्ट में सॉकेट की जानकारी है.

रिटर्न

  • Promise&lt;SocketInfo&gt;

    Chrome 91 और उसके बाद वाले वर्शन के लिए

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और उसके बाद के वर्शन पर काम करता है. दूसरे प्लैटफ़ॉर्म को कॉलबैक इस्तेमाल करने होते हैं.

getSockets()

प्रॉमिस 
chrome.bluetoothSocket.getSockets(
  callback?: function,
)

ऐप्लिकेशन के मालिकाना हक वाले हाल ही में खोले गए सॉकेट की सूची लाता है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

    callback पैरामीटर ऐसा दिखता है: 

    (sockets: SocketInfo[]) => void

रिटर्न

  • Promise&lt;SocketInfo[]&gt;

    Chrome 91 और उसके बाद वाले वर्शन के लिए

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और उसके बाद के वर्शन पर काम करता है. दूसरे प्लैटफ़ॉर्म को कॉलबैक इस्तेमाल करने होते हैं.

listenUsingL2cap()

प्रॉमिस 
chrome.bluetoothSocket.listenUsingL2cap(
  socketId: number,
  uuid: string,
  options?: ListenOptions,
  callback?: function,
)

L2CAP प्रोटोकॉल का इस्तेमाल करके कनेक्शन सुनें.

पैरामीटर

  • socketId

    संख्या

    सॉकेट आइडेंटिफ़ायर.

  • यूयूआईडी

    स्ट्रिंग

    सुनने के लिए सेवा UUID.

  • विकल्प

    ListenOptions वैकल्पिक

    सेवा के लिए दूसरे विकल्प (ज़रूरी नहीं)

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

    callback पैरामीटर ऐसा दिखता है: 

    () => void

रिटर्न

  • प्रॉमिस<void>

    Chrome 91 और उसके बाद वाले वर्शन के लिए

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और उसके बाद के वर्शन पर काम करता है. दूसरे प्लैटफ़ॉर्म को कॉलबैक इस्तेमाल करने होते हैं.

listenUsingRfcomm()

प्रॉमिस 
chrome.bluetoothSocket.listenUsingRfcomm(
  socketId: number,
  uuid: string,
  options?: ListenOptions,
  callback?: function,
)

RFCOMM प्रोटोकॉल का इस्तेमाल करके कनेक्शन सुनें.

पैरामीटर

  • socketId

    संख्या

    सॉकेट आइडेंटिफ़ायर.

  • यूयूआईडी

    स्ट्रिंग

    सुनने के लिए सेवा UUID.

  • विकल्प

    ListenOptions वैकल्पिक

    सेवा के लिए दूसरे विकल्प (ज़रूरी नहीं)

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

    callback पैरामीटर ऐसा दिखता है: 

    () => void

रिटर्न

  • प्रॉमिस<void>

    Chrome 91 और उसके बाद वाले वर्शन के लिए

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और उसके बाद के वर्शन पर काम करता है. दूसरे प्लैटफ़ॉर्म को कॉलबैक इस्तेमाल करने होते हैं.

send()

प्रॉमिस 
chrome.bluetoothSocket.send(
  socketId: number,
  data: ArrayBuffer,
  callback?: function,
)

दिए गए ब्लूटूथ सॉकेट पर डेटा भेजता है.

पैरामीटर

  • socketId

    संख्या

    सॉकेट आइडेंटिफ़ायर.

  • डेटा

    अरेबफ़र

    भेजा जाने वाला डेटा.

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

    callback पैरामीटर ऐसा दिखता है: 

    (bytesSent: number) => void

    • bytesSent

      संख्या

      भेजे गए बाइट की संख्या.

रिटर्न

  • Promise&lt;number&gt;

    Chrome 91 और उसके बाद वाले वर्शन के लिए

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और उसके बाद के वर्शन पर काम करता है. दूसरे प्लैटफ़ॉर्म को कॉलबैक इस्तेमाल करने होते हैं.

setPaused()

प्रॉमिस 
chrome.bluetoothSocket.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
)

कनेक्ट की गई सॉकेट को उसके साथी से मैसेज पाने या सुनने वाले सॉकेट को नए कनेक्शन स्वीकार करने से रोकता है या उसे चालू करता है. डिफ़ॉल्ट वैल्यू "false" है. कनेक्ट किए गए सॉकेट को रोकने का विकल्प, आम तौर पर किसी ऐप्लिकेशन से मिलते-जुलते ऐप्लिकेशन से भेजे गए डेटा को थ्रॉटल करने के लिए इस्तेमाल किया जाता है. कनेक्ट किए गए सॉकेट को रोकने पर, कोई onReceiveइवेंट नहीं उठाया जाता. जब सॉकेट कनेक्ट हो जाता है और रोक हटाई जाती है, तो मैसेज मिलने पर onReceive इवेंट फिर से दिखने लगते हैं. जब लिसनिंग सॉकेट को रोका जाता है, तो नए कनेक्शन तब तक स्वीकार किए जाते हैं, जब तक बैकलॉग पूरा नहीं हो जाता. इसके बाद, अन्य कनेक्शन अनुरोधों को अस्वीकार कर दिया जाता है. onAccept इवेंट सिर्फ़ तब जनरेट होते हैं, जब सॉकेट को चालू किया जाता है.

पैरामीटर

  • socketId

    संख्या

  • रोका गया

    बूलियन

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

    callback पैरामीटर ऐसा दिखता है: 

    () => void

रिटर्न

  • प्रॉमिस<void>

    Chrome 91 और उसके बाद वाले वर्शन के लिए

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और उसके बाद के वर्शन पर काम करता है. दूसरे प्लैटफ़ॉर्म को कॉलबैक इस्तेमाल करने होते हैं.

update()

प्रॉमिस 
chrome.bluetoothSocket.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
)

सॉकेट की प्रॉपर्टी अपडेट करता है.

पैरामीटर

  • socketId

    संख्या

    सॉकेट आइडेंटिफ़ायर.

  • प्रॉपर्टी

    SocketProperties

    अपडेट की जाने वाली प्रॉपर्टी.

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

    callback पैरामीटर ऐसा दिखता है: 

    () => void

रिटर्न

  • प्रॉमिस<void>

    Chrome 91 और उसके बाद वाले वर्शन के लिए

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और उसके बाद के वर्शन पर काम करता है. दूसरे प्लैटफ़ॉर्म को कॉलबैक इस्तेमाल करने होते हैं.

इवेंट

onAccept

chrome.bluetoothSocket.onAccept.addListener(
  callback: function,
)

किसी दिए गए सॉकेट के लिए कनेक्शन बनाए जाने पर इवेंट की जानकारी दी गई.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर ऐसा दिखता है: 

    (info: AcceptInfo) => void

onAcceptError

chrome.bluetoothSocket.onAcceptError.addListener(
  callback: function,
)

दिए गए सॉकेट पर नए कनेक्शन के इंतज़ार के दौरान, नेटवर्क में कोई गड़बड़ी होने पर इवेंट की जानकारी दी गई. यह इवेंट जनरेट होने के बाद, सॉकेट paused पर सेट हो जाता है. साथ ही, इस सॉकेट के लिए और onAccept इवेंट नहीं बनाए जाते.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर ऐसा दिखता है: 

    (info: AcceptErrorInfo) => void

onReceive

chrome.bluetoothSocket.onReceive.addListener(
  callback: function,
)

किसी दिए गए सॉकेट के लिए डेटा मिलने पर इवेंट उठाया जाता है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर ऐसा दिखता है: 

    (info: ReceiveInfo) => void

onReceiveError

chrome.bluetoothSocket.onReceiveError.addListener(
  callback: function,
)

जब रनटाइम, सॉकेट पर डेटा का इंतज़ार कर रहा था, तब नेटवर्क की गड़बड़ी होने पर इवेंट की जानकारी दी गई. यह इवेंट जनरेट होने के बाद, सॉकेट paused पर सेट हो जाता है. साथ ही, इस सॉकेट के लिए और onReceive इवेंट नहीं बनाए जाते.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर ऐसा दिखता है: 

    (info: ReceiveErrorInfo) => void