chrome.bluetoothSocket

ब्यौरा

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

मेनिफ़ेस्ट

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

"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_connect"
सॉकेट कनेक्ट नहीं किया गया है.

ReceiveErrorInfo

प्रॉपर्टी

  • गड़बड़ी

    ReceiveError

    गड़बड़ी दिखाने वाला गड़बड़ी कोड.

  • errorMessage

    स्ट्रिंग

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

  • socketId

    नंबर

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

ReceiveInfo

प्रॉपर्टी

  • डेटा

    ArrayBuffer

    मिला डेटा, जिसका साइज़ ज़्यादा से ज़्यादा bufferSize है.

  • socketId

    नंबर

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

SocketInfo

प्रॉपर्टी

  • पता

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

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

  • bufferSize

    नंबर ज़रूरी नहीं

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

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

    boolean

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

  • नाम

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

    सॉकेट से संबद्ध ऐप्लिकेशन-तय स्ट्रिंग.

  • रोका गया

    boolean

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

  • अनवरत

    boolean

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

  • socketId

    नंबर

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

  • uuid

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

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

SocketProperties

प्रॉपर्टी

  • bufferSize

    नंबर ज़रूरी नहीं

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

  • नाम

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

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

  • अनवरत

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

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

तरीके

close()

वादा 
chrome.bluetoothSocket.close(
  socketId: number,
  callback?: function,
)

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

पैरामीटर

  • socketId

    नंबर

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

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    ()=>void

रिटर्न

  • Promise<void>

    Chrome 91 और इसके बाद के वर्शन

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

connect()

वादा 
chrome.bluetoothSocket.connect(
  socketId: number,
  address: string,
  uuid: string,
  callback?: function,
)

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

पैरामीटर

  • socketId

    नंबर

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

  • पता

    स्ट्रिंग

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

  • uuid

    स्ट्रिंग

    कनेक्ट करने के लिए सेवा का यूयूआईडी.

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    ()=>void

रिटर्न

  • Promise<void>

    Chrome 91 और इसके बाद के वर्शन

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

create()

वादा 
chrome.bluetoothSocket.create(
  properties?: SocketProperties,
  callback?: function,
)

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

पैरामीटर

  • प्रॉपर्टी

    SocketProperties ज़रूरी नहीं

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

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (createInfo: CreateInfo)=>void

    • createInfo

      CreateInfo

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

रिटर्न

  • Promise<CreateInfo>

    Chrome 91 और इसके बाद के वर्शन

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

disconnect()

वादा 
chrome.bluetoothSocket.disconnect(
  socketId: number,
  callback?: function,
)

सॉकेट डिसकनेक्ट करता है. सॉकेट आइडेंटिफ़ायर मान्य रहता है.

पैरामीटर

  • socketId

    नंबर

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

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    ()=>void

रिटर्न

  • Promise<void>

    Chrome 91 और इसके बाद के वर्शन

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

getInfo()

वादा 
chrome.bluetoothSocket.getInfo(
  socketId: number,
  callback?: function,
)

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

पैरामीटर

  • socketId

    नंबर

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

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (socketInfo: SocketInfo)=>void

    • socketInfo

      SocketInfo

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

रिटर्न

  • Promise<SocketInfo>

    Chrome 91 और इसके बाद के वर्शन

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

getSockets()

वादा 
chrome.bluetoothSocket.getSockets(
  callback?: function,
)

ऐप्लिकेशन के मालिकाना हक वाली फ़िलहाल खुली हुई सॉकेट की सूची वापस लाता है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (sockets: SocketInfo[])=>void

रिटर्न

  • Promise<SocketInfo[]>

    Chrome 91 और इसके बाद के वर्शन

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

listenUsingL2cap()

वादा 
chrome.bluetoothSocket.listenUsingL2cap(
  socketId: number,
  uuid: string,
  options?: ListenOptions,
  callback?: function,
)

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

पैरामीटर

  • socketId

    नंबर

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

  • uuid

    स्ट्रिंग

    सर्विस यूयूआईडी, जिसे सुना जा सकता है.

  • विकल्प

    ListenOptions ज़रूरी नहीं

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

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    ()=>void

रिटर्न

  • Promise<void>

    Chrome 91 और इसके बाद के वर्शन

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

listenUsingRfcomm()

वादा 
chrome.bluetoothSocket.listenUsingRfcomm(
  socketId: number,
  uuid: string,
  options?: ListenOptions,
  callback?: function,
)

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

पैरामीटर

  • socketId

    नंबर

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

  • uuid

    स्ट्रिंग

    सर्विस यूयूआईडी, जिसे सुना जा सकता है.

  • विकल्प

    ListenOptions ज़रूरी नहीं

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

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    ()=>void

रिटर्न

  • Promise<void>

    Chrome 91 और इसके बाद के वर्शन

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

send()

वादा 
chrome.bluetoothSocket.send(
  socketId: number,
  data: ArrayBuffer,
  callback?: function,
)

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

पैरामीटर

  • socketId

    नंबर

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

  • डेटा

    ArrayBuffer

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

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (bytesSent: number)=>void

    • bytesSent

      नंबर

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

रिटर्न

  • वादा<number>

    Chrome 91 और इसके बाद के वर्शन

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

setPaused()

वादा 
chrome.bluetoothSocket.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
)

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

पैरामीटर

  • socketId

    नंबर

  • रोका गया

    boolean

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    ()=>void

रिटर्न

  • Promise<void>

    Chrome 91 और इसके बाद के वर्शन

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

update()

वादा 
chrome.bluetoothSocket.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
)

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

पैरामीटर

  • socketId

    नंबर

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

  • प्रॉपर्टी

    SocketProperties

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

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    ()=>void

रिटर्न

  • Promise<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