chrome.bluetoothSocket

ब्यौरा

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

उपलब्धता

सिर्फ़ ChromeOS के लिए

मेनिफ़ेस्ट

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

"bluetooth"

टाइप

AcceptError

Enum

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

"not_listening"
सॉकेट, कनेक्शन के अनुरोधों को नहीं सुन रहा है.

AcceptErrorInfo

प्रॉपर्टी

  • गड़बड़ी

    AcceptError

    गड़बड़ी का कोड, जिससे पता चलता है कि क्या गड़बड़ी हुई.

  • errorMessage

    स्ट्रिंग

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

  • socketId

    संख्या

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

AcceptInfo

प्रॉपर्टी

  • clientSocketId

    संख्या

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

  • socketId

    संख्या

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

CreateInfo

प्रॉपर्टी

  • socketId

    संख्या

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

ListenOptions

प्रॉपर्टी

  • बैकलॉग

    number ज़रूरी नहीं

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

  • चैनल

    number ज़रूरी नहीं

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

  • पीएसएम

    number ज़रूरी नहीं

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

ReceiveError

Enum

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

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

"not_connected"
सॉकेट कनेक्ट नहीं किया गया है.

ReceiveErrorInfo

प्रॉपर्टी

  • गड़बड़ी

    ReceiveError

    गड़बड़ी का कोड, जिससे पता चलता है कि क्या गड़बड़ी हुई.

  • errorMessage

    स्ट्रिंग

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

  • socketId

    संख्या

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

ReceiveInfo

प्रॉपर्टी

  • डेटा

    ArrayBuffer

    रिसीव किया गया डेटा, जिसका साइज़ ज़्यादा से ज़्यादा bufferSize हो.

  • socketId

    संख्या

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

SocketInfo

प्रॉपर्टी

  • पता

    string ज़रूरी नहीं

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

  • bufferSize

    number ज़रूरी नहीं

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

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

    बूलियन

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

  • नाम

    string ज़रूरी नहीं

    सॉकेट से जुड़ी, ऐप्लिकेशन के हिसाब से तय की गई स्ट्रिंग.

  • रोका गया

    बूलियन

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

  • अनवरत

    बूलियन

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

  • socketId

    संख्या

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

  • uuid

    string ज़रूरी नहीं

    अगर अंडरलाइंग सॉकेट कनेक्ट है, तो इसमें उस सेवा के यूयूआईडी की जानकारी होती है जिससे वह कनेक्ट है. अगर अंडरलाइंग सॉकेट सुन रहा है, तो इसमें उस सेवा के यूयूआईडी की जानकारी होती है जिसे वह सुन रहा है.

SocketProperties

प्रॉपर्टी

  • bufferSize

    number ज़रूरी नहीं

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

  • नाम

    string ज़रूरी नहीं

    सॉकेट से जुड़ी, ऐप्लिकेशन के हिसाब से तय की गई स्ट्रिंग.

  • अनवरत

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

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

तरीके

close()

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

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

पैरामीटर

  • socketId

    संख्या

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

  • कॉलबैक

    function ज़रूरी नहीं

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

    () => void

रिटर्न

  • वादा<शून्य>

    Chrome 91+

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

connect()

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

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

पैरामीटर

  • socketId

    संख्या

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

  • पता

    स्ट्रिंग

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

  • uuid

    स्ट्रिंग

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

  • कॉलबैक

    function ज़रूरी नहीं

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

    () => void

रिटर्न

  • वादा<शून्य>

    Chrome 91+

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

create()

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

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

पैरामीटर

  • प्रॉपर्टी

    SocketProperties ज़रूरी नहीं

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

  • कॉलबैक

    function ज़रूरी नहीं

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

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

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

रिटर्न

  • Promise<CreateInfo>

    Chrome 91+

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

disconnect()

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

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

पैरामीटर

  • socketId

    संख्या

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

  • कॉलबैक

    function ज़रूरी नहीं

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

    () => void

रिटर्न

  • वादा<शून्य>

    Chrome 91+

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

getInfo()

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

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

पैरामीटर

  • socketId

    संख्या

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

  • कॉलबैक

    function ज़रूरी नहीं

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

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      सॉकेट की जानकारी वाला ऑब्जेक्ट.

रिटर्न

  • Promise<SocketInfo>

    Chrome 91+

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

getSockets()

वादा 
chrome.bluetoothSocket.getSockets(
  callback?: function,
): Promise<SocketInfo[]>

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

पैरामीटर

  • कॉलबैक

    function ज़रूरी नहीं

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

    (sockets: SocketInfo[]) => void

    • सॉकेट

      SocketInfo[]

      सॉकेट की जानकारी वाले ऑब्जेक्ट का कलेक्शन.

रिटर्न

  • Promise<SocketInfo[]>

    Chrome 91+

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

listenUsingL2cap()

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

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

पैरामीटर

  • socketId

    संख्या

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

  • uuid

    स्ट्रिंग

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

  • विकल्प

    ListenOptions ज़रूरी नहीं

    सेवा के लिए अन्य विकल्प.

  • कॉलबैक

    function ज़रूरी नहीं

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

    () => void

रिटर्न

  • वादा<शून्य>

    Chrome 91+

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

listenUsingRfcomm()

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

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

पैरामीटर

  • socketId

    संख्या

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

  • uuid

    स्ट्रिंग

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

  • विकल्प

    ListenOptions ज़रूरी नहीं

    सेवा के लिए अन्य विकल्प.

  • कॉलबैक

    function ज़रूरी नहीं

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

    () => void

रिटर्न

  • वादा<शून्य>

    Chrome 91+

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

send()

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

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

पैरामीटर

  • socketId

    संख्या

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

  • डेटा

    ArrayBuffer

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

  • कॉलबैक

    function ज़रूरी नहीं

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

    (bytesSent: number) => void

    • bytesSent

      संख्या

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

रिटर्न

  • Promise<number>

    Chrome 91+

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

setPaused()

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

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

पैरामीटर

  • socketId

    संख्या

  • रोका गया

    बूलियन

  • कॉलबैक

    function ज़रूरी नहीं

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

    () => void

रिटर्न

  • वादा<शून्य>

    Chrome 91+

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

update()

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

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

पैरामीटर

  • socketId

    संख्या

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

  • प्रॉपर्टी

    SocketProperties

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

  • कॉलबैक

    function ज़रूरी नहीं

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

    () => void

रिटर्न

  • वादा<शून्य>

    Chrome 91+

    प्रॉमिस सिर्फ़ Manifest 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