chrome.hid

ब्यौरा

कनेक्ट किए गए एचआईडी डिवाइसों से इंटरैक्ट करने के लिए, chrome.hid एपीआई का इस्तेमाल करें. यह एपीआई, किसी ऐप्लिकेशन में एचआईडी कार्रवाइयों को ऐक्सेस करने की सुविधा देता है. इस एपीआई का इस्तेमाल करके, ऐप्लिकेशन हार्डवेयर डिवाइसों के ड्राइवर के तौर पर काम कर सकते हैं. इस एपीआई से जनरेट हुई गड़बड़ियों को runtime.lastError को सेट करके और फ़ंक्शन के सामान्य कॉलबैक को एक्ज़ीक्यूट करके रिपोर्ट किया जाता है. इस मामले में, कॉलबैक के रेगुलर पैरामीटर तय नहीं किए जाएंगे.

अनुमतियां

hid

टाइप

DeviceFilter

प्रॉपर्टी

  • productId

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

    डिवाइस प्रॉडक्ट आईडी को सिर्फ़ तब ही जांचा जाता है, जब वेंडर आईडी मेल खाता हो.

  • इस्तेमाल

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

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

  • usagePage

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

    एचआईडी के इस्तेमाल से जुड़े पेज का आइडेंटिफ़ायर.

  • vendorId

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

    डिवाइस वेंडर आईडी.

GetDevicesOptions

प्रॉपर्टी

  • फ़िल्टर

    DeviceFilter[] ज़रूरी नहीं

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

  • productId

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

    अब काम नहीं करता

    DeviceFilter.productId सेटिंग के बराबर.

  • vendorId

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

    अब काम नहीं करता

    DeviceFilter.vendorId सेटिंग के बराबर.

HidCollectionInfo

प्रॉपर्टी

  • reportIds

    नंबर[]

    कलेक्शन और उसके चाइल्ड आईडी से जुड़े रिपोर्ट आईडी.

  • इस्तेमाल

    संख्या

    पेज के मुताबिक इस्तेमाल किया जाने वाला आइडेंटिफ़ायर.

  • usagePage

    संख्या

    एचआईडी के इस्तेमाल से जुड़े पेज का आइडेंटिफ़ायर.

HidConnectInfo

प्रॉपर्टी

  • connectionId

    संख्या

    अन्य सभी फ़ंक्शन में इस कनेक्शन की पहचान करने के लिए इस्तेमाल किया जाने वाला ओपेक आईडी.

HidDeviceInfo

प्रॉपर्टी

  • संग्रह

    HidCollectionInfo[]

    इस डिवाइस की रिपोर्ट डिस्क्रिप्टर से लिए गए टॉप लेवल कलेक्शन.

  • deviceId

    संख्या

    ओपेक डिवाइस आईडी.

  • maxFeatureReportSize

    संख्या

    टॉप लेवल कलेक्शन के लिए, सुविधा की रिपोर्ट का ज़्यादा से ज़्यादा साइज़.

  • maxInputReportSize

    संख्या

    टॉप लेवल कलेक्शन के लिए, इनपुट रिपोर्ट का ज़्यादा से ज़्यादा साइज़.

  • maxOutputReportSize

    संख्या

    टॉप-लेवल कलेक्शन के लिए आउटपुट रिपोर्ट का ज़्यादा से ज़्यादा साइज़.

  • productId

    संख्या

    प्रॉडक्ट आईडी.

  • productName

    स्ट्रिंग

    Chrome 46 और उसके बाद के वर्शन

    अगर उपलब्ध हो, तो डिवाइस से पढ़ा गया प्रॉडक्ट का नाम.

  • reportDescriptor

    अरेबफ़र

    डिवाइस की रॉ रिपोर्ट डिस्क्रिप्टर (Windows पर उपलब्ध नहीं है).

  • serialNumber

    स्ट्रिंग

    Chrome 46 और उसके बाद के वर्शन

    डिवाइस से पढ़ा गया सीरियल नंबर, अगर उपलब्ध हो.

  • vendorId

    संख्या

    वेंडर आईडी.

तरीके

connect()

प्रॉमिस 
chrome.hid.connect(
  deviceId: number,
  callback?: function,
)

बातचीत करने के लिए, किसी एचआईडी डिवाइस से कनेक्शन खोलें.

पैरामीटर

  • deviceId

    संख्या

    खोले जाने वाले डिवाइस का HidDeviceInfo.deviceId.

  • कॉलबैक

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

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

    (connection: HidConnectInfo) => void

रिटर्न

  • Promise<HidConnectInfo>

    Chrome 117 और उसके बाद वाले वर्शन

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

disconnect()

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

डिवाइस से डिसकनेक्ट करें. इसे कॉल करने के बाद डिवाइस पर ऑपरेशन शुरू करना सुरक्षित है, लेकिन इसका कोई असर नहीं पड़ता है.

पैरामीटर

  • connectionId

    संख्या

    connect ने connectionId लौटाया है.

  • कॉलबैक

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

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

    () => void

रिटर्न

  • प्रॉमिस<void>

    Chrome 117 और उसके बाद वाले वर्शन

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

getDevices()

प्रॉमिस 
chrome.hid.getDevices(
  options: GetDevicesOptions,
  callback?: function,
)

कनेक्ट किए गए एचआईडी डिवाइसों की गिनती करें.

पैरामीटर

  • विकल्प

    GetDevicesOptions

    टारगेट किए गए डिवाइसों पर खोजी जाने वाली प्रॉपर्टी.

  • कॉलबैक

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

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

    (devices: HidDeviceInfo[]) => void

रिटर्न

  • Promise&lt;HidDeviceInfo[]&gt;

    Chrome 117 और उसके बाद वाले वर्शन

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

receive()

chrome.hid.receive(
  connectionId: number,
  callback: function,
)

डिवाइस से अगली इनपुट रिपोर्ट पाएं.

पैरामीटर

  • connectionId

    संख्या

    connect ने connectionId लौटाया है.

  • कॉलबैक

    फ़ंक्शन

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

    (reportId: number, data: ArrayBuffer) => void

    • reportId

      संख्या

      रिपोर्ट आईडी या अगर कोई नहीं है, तो 0.

    • डेटा

      अरेबफ़र

      रिपोर्ट के डेटा और रिपोर्ट आईडी प्रीफ़िक्स (अगर मौजूद है) को हटा दिया जाता है.

receiveFeatureReport()

प्रॉमिस 
chrome.hid.receiveFeatureReport(
  connectionId: number,
  reportId: number,
  callback?: function,
)

डिवाइस से सुविधा रिपोर्ट का अनुरोध करें.

पैरामीटर

  • connectionId

    संख्या

    connect ने connectionId लौटाया है.

  • reportId

    संख्या

    रिपोर्ट आईडी या अगर कोई नहीं है, तो 0.

  • कॉलबैक

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

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

    (data: ArrayBuffer) => void

    • डेटा

      अरेबफ़र

      रिपोर्ट का डेटा, जिसमें डिवाइस से भेजा गया रिपोर्ट आईडी प्रीफ़िक्स भी शामिल होता है.

रिटर्न

  • प्रॉमिस<ArrayBuffer>

    Chrome 117 और उसके बाद वाले वर्शन

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

send()

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

डिवाइस पर आउटपुट रिपोर्ट भेजें.

ध्यान दें: data में रिपोर्ट आईडी प्रीफ़िक्स शामिल न करें. ज़रूरत पड़ने पर इसे जोड़ा जाएगा.

पैरामीटर

  • connectionId

    संख्या

    connect ने connectionId लौटाया है.

  • reportId

    संख्या

    इस्तेमाल करने के लिए रिपोर्ट आईडी या अगर कोई रिपोर्ट नहीं है, तो 0.

  • डेटा

    अरेबफ़र

    रिपोर्ट का डेटा.

  • कॉलबैक

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

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

    () => void

रिटर्न

  • प्रॉमिस<void>

    Chrome 117 और उसके बाद वाले वर्शन

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

sendFeatureReport()

प्रॉमिस 
chrome.hid.sendFeatureReport(
  connectionId: number,
  reportId: number,
  data: ArrayBuffer,
  callback?: function,
)

डिवाइस पर सुविधा की रिपोर्ट भेजें.

ध्यान दें: data में रिपोर्ट आईडी प्रीफ़िक्स शामिल न करें. ज़रूरत पड़ने पर इसे जोड़ा जाएगा.

पैरामीटर

  • connectionId

    संख्या

    connect ने connectionId लौटाया है.

  • reportId

    संख्या

    इस्तेमाल करने के लिए रिपोर्ट आईडी या अगर कोई रिपोर्ट नहीं है, तो 0.

  • डेटा

    अरेबफ़र

    रिपोर्ट का डेटा.

  • कॉलबैक

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

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

    () => void

रिटर्न

  • प्रॉमिस<void>

    Chrome 117 और उसके बाद वाले वर्शन

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

इवेंट

onDeviceAdded

chrome.hid.onDeviceAdded.addListener(
  callback: function,
)

इवेंट तब जनरेट होता है, जब किसी डिवाइस को सिस्टम में जोड़ा जाता है. इवेंट सिर्फ़ उन ऐप्लिकेशन और एक्सटेंशन पर ब्रॉडकास्ट किए जाते हैं जिनके पास डिवाइस को ऐक्सेस करने की अनुमति है. ऐसा हो सकता है कि इंस्टॉल करते समय या जब उपयोगकर्ता ने वैकल्पिक अनुमति स्वीकार की हो, तब यह अनुमति दी गई हो. (permissions.request देखें).

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (device: HidDeviceInfo) => void

onDeviceRemoved

chrome.hid.onDeviceRemoved.addListener(
  callback: function,
)

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

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (deviceId: number) => void

    • deviceId

      संख्या