chrome.usb

شرح

از chrome.usb API برای تعامل با دستگاه‌های USB متصل‌شده استفاده کنید. این میانای برنامه‌سازی کاربردی امکان دسترسی به عملیات USB را از درون بافت برنامه فراهم می‌کند. بااستفاده از این میانای برنامه‌سازی کاربردی، برنامه‌ها می‌توانند به‌عنوان درایور برای دستگاه‌های سخت‌افزاری عمل کنند. خطاهای تولیدشده توسط این میانای برنامه‌سازی کاربردی با تنظیم runtime.lastError و اجرای فراخوانی برگشتی معمول تابع گزارش می‌شود. در این حالت، پارامترهای عادی فراخوانی برگشتی تعریف‌نشده خواهند بود.

اجازه‌ها

usb

دردسترس بودن

فقط ChromeOS

انواع

ConfigDescriptor

مشخصات

  • فعال

    بولی

    Chrome نسخه ۴۷ و بالاتر

    آیا این پیکربندی فعال است؟

  • configurationValue

    شماره

    شماره پیکربندی.

  • description

    رشته اختیاری

    شرح پیکربندی.

  • extra_data

    ArrayBuffer

    داده‌های توصیف‌گر اضافی مرتبط با این پیکربندی.

  • میاناهای

    InterfaceDescriptor[]

    رابط‌های دردسترس.

  • maxPower

    شماره

    حداکثر توان موردنیاز این دستگاه برحسب میلی‌آمپر (mA).

  • remoteWakeup

    بولی

    دستگاه از بیدار شدن ازراه‌دور پشتیبانی می‌کند.

  • selfPowered

    بولی

    دستگاه منبع تغذیه خودش را دارد.

ConnectionHandle

مشخصات

  • دستگیره

    شماره

    دستگیره ماتی که این اتصال به دستگاه USB و همه میاناهای ادعاشده مرتبط و انتقال‌های معلقه را نشان می‌دهد. هربار که دستگاه باز می‌شود، دسته جدیدی ایجاد می‌شود. نام کاربری اتصال با Device.device متفاوت است.

  • productId

    شماره

    شناسه محصول.

  • vendorId

    شماره

    شناسه ارائه‌دهنده دستگاه.

ControlTransferInfo

مشخصات

  • داده

    ArrayBuffer اختیاری

    داده‌هایی که باید منتقل شود (فقط برای انتقال‌های خروجی لازم است).

  • جهت

    مسیر

    جهت انتقال ("in" یا "out").

  • شاخص

    شماره

    فیلد wIndex، همانجا را ببینید.

  • طول

    شماره اختیاری

    حداکثر تعداد بایت‌های دریافتی (فقط برای انتقال‌های ورودی لازم است).

  • گیرنده

    گیرنده

    هدف انتقال. اگر "interface" یا "endpoint" باشد، هدف ارائه‌شده توسط index باید ادعا شود.

  • درخواست کردن

    شماره

    فیلد bRequest، به Universal Serial Bus Specification Revision 1.1 § 9.3 مراجعه کنید.

  • requestType

    RequestType

    نوع درخواست.

  • زمان استراحت

    شماره اختیاری

    Chrome نسخه ۴۳ و بالاتر

    زمان درخواست تمام شد (به میلی‌ثانیه). مقدار پیش‌فرض 0 نشان‌دهنده عدم وجود مهلت است.

  • مقدار

    شماره

    فیلد wValue، همانجا را ببینید.

Device

مشخصات

  • دستگاه

    شماره

    شناسه مبهم برای دستگاه USB. تا زمانی که دستگاه از برق جدا نشود، این وضعیت تغییر نمی‌کند.

  • manufacturerName

    رشته

    Chrome نسخه ۴۶ و بالاتر

    رشته iManufacturer خوانده‌شده از دستگاه، درصورت وجود.

  • productId

    شماره

    شناسه محصول.

  • productName

    رشته

    Chrome نسخه ۴۶ و بالاتر

    رشته iProduct خوانده‌شده از دستگاه، درصورت وجود.

  • serialNumber

    رشته

    Chrome نسخه ۴۶ و بالاتر

    رشته iSerialNumber خوانده‌شده از دستگاه، درصورت دردسترس بودن.

  • vendorId

    شماره

    شناسه ارائه‌دهنده دستگاه.

  • نسخه

    شماره

    Chrome نسخه ۵۱ به بالا

    نسخه دستگاه (فیلد bcdDevice).

DeviceFilter

مشخصات

  • interfaceClass

    شماره اختیاری

    کلاس میانای USB، با هر میانایی در دستگاه مطابقت دارد.

  • interfaceProtocol

    شماره اختیاری

    پروتکل میانای USB، فقط درصورتی علامت زده می‌شود که زیرکلاس میانای USB مطابقت داشته باشد.

  • interfaceSubclass

    شماره اختیاری

    زیرکلاس میانای USB، فقط درصورتی بررسی می‌شود که کلاس میانا مطابقت داشته باشد.

  • productId

    شماره اختیاری

    شناسه محصول دستگاه، فقط درصورتی بررسی می‌شود که شناسه ارائه‌دهنده مطابقت داشته باشد.

  • vendorId

    شماره اختیاری

    شناسه فروشنده دستگاه.

DevicePromptOptions

مشخصات

  • فیلترها

    DeviceFilter[] اختیاری

    فهرست دستگاه‌های ارائه‌شده به کاربر را فیلتر کنید. اگر چند فیلتر ارائه شده باشد، دستگاه‌های منطبق با هر فیلتر نمایش داده خواهد شد.

  • متعدد

    بولی اختیاری

    به کاربر اجازه دهید چند دستگاه را انتخاب کند.

Direction

Direction،‏ Recipient،‏ RequestType، و TransferType همگی به هم‌نام‌های خود در مشخصات USB نگاشت می‌شوند.

شمارشی

«در»

"out"

EndpointDescriptor

مشخصات

  • نشانی

    شماره

    نشانی نقطه پایان.

  • جهت

    مسیر

    جهت انتقال.

  • extra_data

    ArrayBuffer

    داده‌های توصیف‌گر اضافی مرتبط با این نقطه پایان.

  • maximumPacketSize

    شماره

    حداکثر اندازه بسته.

  • pollingInterval

    شماره اختیاری

    فاصله نظرسنجی (فقط وقفه و هم‌زمان).

  • همگام‌سازی

    SynchronizationType اختیاری

    حالت همگام‌سازی انتقال (فقط هم‌زمان).

  • نوع

    TransferType

    نوع انتقال.

  • مصرف

    UsageType اختیاری

    راهنمای استفاده از نقطه پایان.

EnumerateDevicesAndRequestAccessOptions

مشخصات

  • interfaceId

    شماره اختیاری

    شناسه میانایی که می‌خواهید به آن دسترسی داشته باشید. فقط در Chrome OS دردسترس است. این کار بر پلاتفرم‌های دیگر تأثیری ندارد.

  • productId

    شماره

    شناسه محصول.

  • vendorId

    شماره

    شناسه ارائه‌دهنده دستگاه.

EnumerateDevicesOptions

مشخصات

  • فیلترها

    DeviceFilter[] اختیاری

    دستگاهی که با هریک از فیلترهای ارائه‌شده مطابقت داشته باشد برگردانده خواهد شد. فهرست فیلتر خالی همه دستگاه‌هایی را که برنامه برای آن‌ها اجازه دارد برمی‌گرداند.

  • productId

    شماره اختیاری

    منسوخ‌شده

    معادل تنظیم DeviceFilter.productId.

  • vendorId

    شماره اختیاری

    منسوخ‌شده

    معادل تنظیم DeviceFilter.vendorId.

GenericTransferInfo

مشخصات

  • داده

    ArrayBuffer اختیاری

    داده‌هایی که باید منتقل شود (فقط برای انتقال‌های خروجی لازم است).

  • جهت

    مسیر

    جهت انتقال ("in" یا "out").

  • نقطه پایانی

    شماره

    نشانی نقطه پایانی هدف. میانای حاوی این نقطه پایانی باید ادعا شود.

  • طول

    شماره اختیاری

    حداکثر تعداد بایت‌های دریافتی (فقط برای انتقال‌های ورودی لازم است).

  • زمان استراحت

    شماره اختیاری

    Chrome نسخه ۴۳ و بالاتر

    زمان درخواست تمام شد (به میلی‌ثانیه). مقدار پیش‌فرض 0 نشان‌دهنده عدم وجود مهلت است.

InterfaceDescriptor

مشخصات

  • alternateSetting

    شماره

    شماره تنظیم جایگزین میانای (پیش‌فرض 0 است

  • description

    رشته اختیاری

    شرح میانای کاربری.

  • نقطه‌های پایانی

    EndpointDescriptor[]

    نقاط پایانی دردسترس.

  • extra_data

    ArrayBuffer

    داده‌های توصیف‌گر اضافی مرتبط با این میانای کاربری.

  • interfaceClass

    شماره

    کلاس میانای USB.

  • interfaceNumber

    شماره

    شماره میانجی.

  • interfaceProtocol

    شماره

    پروتکل میانای USB.

  • interfaceSubclass

    شماره

    زیرکلاس میانای USB.

IsochronousTransferInfo

مشخصات

  • packetLength

    شماره

    طول هر بسته در این انتقال.

  • بسته‌ها

    شماره

    تعداد کل بسته‌ها در این انتقال.

  • transferInfo

    GenericTransferInfo

    پارامترهای انتقال. طول انتقال یا میان‌گیر داده مشخص‌شده در این بلوک پارامتر درطول مرزهای packetLength تقسیم می‌شود تا بسته‌های مجزای انتقال را تشکیل دهد.

Recipient

شمارشی

«دستگاه»

"interface"

«نقطه پایانی»

«دیگر»

RequestType

شمارشی

"standard"

«کلاس»

«فروشنده»

«رزروشده»

SynchronizationType

برای حالت‌های وقفه و هم‌زمان، SynchronizationType و UsageType به هم‌نام‌های خود در مشخصات USB نگاشت می‌شوند.

شمارشی

«asynchronous»

«تطبیقی»

«همگام»

TransferResultInfo

مشخصات

  • داده

    ArrayBuffer اختیاری

    داده‌های برگردانده‌شده توسط انتقال ورودی. undefined برای انتقال‌های خروجی.

  • resultCode

    شماره اختیاری

    مقدار 0 نشان می‌دهد که انتقال موفقیت‌آمیز بوده است. مقادیر دیگر نشان‌دهنده شکست است.

TransferType

شمارشی

"control"

«interrupt»

«isochronous»

«انبوه»

UsageType

شمارشی

"data"

"feedback"

"explicitFeedback"

«دوره‌ای»

«اعلان»

روش‌ها

bulkTransfer()

قول 
chrome.usb.bulkTransfer(
  handle: ConnectionHandle,
  transferInfo: GenericTransferInfo,
  callback?: function,
): Promise<TransferResultInfo>

انتقال انبوه را در دستگاه مشخص‌شده انجام می‌دهد.

پارامترها

بازگشتی‌ها

  • Chrome نسخه ۱۱۶ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

claimInterface()

قول 
chrome.usb.claimInterface(
  handle: ConnectionHandle,
  interfaceNumber: number,
  callback?: function,
): Promise<void>

رابطی را در دستگاه USB ادعا می‌کند. پیش‌از اینکه داده‌ها بتوانند به میانای کاربری یا نقاط پایانی مرتبط منتقل شوند، میانای کاربری باید ادعا شود. در هر زمان، فقط یک دسته اتصال می‌تواند یک رابط را ادعا کند. اگر واسط قبلاً ادعا شده باشد، این فراخوانی ناموفق خواهد بود.

وقتی دیگر به میانجی نیازی نیست، باید releaseInterface فراخوانی شود.

پارامترها

  • دستگیره

    ConnectionHandle

    اتصال باز به دستگاه.

  • interfaceNumber

    شماره

    میانایی که باید ادعا شود.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۱۱۶ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

closeDevice()

قول 
chrome.usb.closeDevice(
  handle: ConnectionHandle,
  callback?: function,
): Promise<void>

یک دسته اتصال را می‌بندد. فراخوانی عملیات روی دسته پس‌از بسته شدن آن عملیاتی ایمن است اما باعث انجام هیچ کنشی نمی‌شود.

پارامترها

  • دستگیره

    ConnectionHandle

    ConnectionHandle برای بستن.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۱۱۶ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

controlTransfer()

قول 
chrome.usb.controlTransfer(
  handle: ConnectionHandle,
  transferInfo: ControlTransferInfo,
  callback?: function,
): Promise<TransferResultInfo>

انتقال کنترل را در دستگاه مشخص‌شده انجام می‌دهد.

انتقال‌های کنترل به دستگاه، میانجی، یا نقطه پایان اشاره دارد. انتقال به میانا یا نقطه پایانی مستلزم این است که میانا ادعا شده باشد.

پارامترها

بازگشتی‌ها

  • Chrome نسخه ۱۱۶ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

findDevices()

قول 
chrome.usb.findDevices(
  options: EnumerateDevicesAndRequestAccessOptions,
  callback?: function,
): Promise<ConnectionHandle[]>

دستگاه‌های USB مشخص‌شده توسط فروشنده، محصول، و (اختیاری) شناسه‌های میانجی را پیدا می‌کند و اگر اجازه‌ها اجازه دهند، آن‌ها را برای استفاده باز می‌کند.

اگر درخواست دسترسی رد شود یا دستگاه باز نشود، دسته اتصال ایجاد یا برگردانده نخواهد شد.

فراخوانی این روش معادل فراخوانی getDevices و سپس openDevice برای هر دستگاه است.

پارامترها

بازگشتی‌ها

  • Promise<ConnectionHandle[]>

    Chrome نسخه ۱۱۶ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getConfiguration()

قول 
chrome.usb.getConfiguration(
  handle: ConnectionHandle,
  callback?: function,
): Promise<ConfigDescriptor>

توصیف‌کننده پیکربندی را برای پیکربندی‌ای که درحال‌حاضر انتخاب شده است دریافت می‌کند.

پارامترها

  • دستگیره

    ConnectionHandle

    اتصال باز به دستگاه.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (config: ConfigDescriptor) => void

بازگشتی‌ها

  • Chrome نسخه ۱۱۶ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getConfigurations()

Promise Chrome 47+ 
chrome.usb.getConfigurations(
  device: Device,
  callback?: function,
): Promise<ConfigDescriptor[]>

مجموعه کامل توصیف‌کننده‌های پیکربندی دستگاه را برمی‌گرداند.

پارامترها

  • دستگاه

    دستگاه

    Device برای واکشی توصیف‌کننده‌ها.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (configs: ConfigDescriptor[]) => void

بازگشتی‌ها

  • Promise<ConfigDescriptor[]>

    Chrome نسخه ۱۱۶ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getDevices()

قول 
chrome.usb.getDevices(
  options: EnumerateDevicesOptions,
  callback?: function,
): Promise<Device[]>

دستگاه‌های USB متصل را برمی‌شمارد.

پارامترها

  • گزینه‌ها

    EnumerateDevicesOptions

    ویژگی‌هایی که باید در دستگاه‌های هدف جستجو شود.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (devices: Device[]) => void

بازگشتی‌ها

  • Promise<Device[]>

    Chrome نسخه ۱۱۶ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getUserSelectedDevices()

قول 
chrome.usb.getUserSelectedDevices(
  options: DevicePromptOptions,
  callback?: function,
): Promise<Device[]>

انتخاب‌گر دستگاه را به کاربر ارائه می‌دهد و Device انتخاب‌شده را برمی‌گرداند. اگر کاربر لغو کند، دستگاه‌های انتخابگر خالی خواهد بود. برای نمایش کادر گفتگو، اشاره کاربر لازم است. بدون اشاره کاربر، فراخوانی به‌گونه‌ای اجرا می‌شود که گویی کاربر لغو کرده است.

پارامترها

  • گزینه‌ها

    DevicePromptOptions

    پیکربندی چارگوش گفتگوی انتخاب‌گر دستگاه.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (devices: Device[]) => void

بازگشتی‌ها

  • Promise<Device[]>

    Chrome نسخه ۱۱۶ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

interruptTransfer()

قول 
chrome.usb.interruptTransfer(
  handle: ConnectionHandle,
  transferInfo: GenericTransferInfo,
  callback?: function,
): Promise<TransferResultInfo>

انتقال وقفه را در دستگاه مشخص‌شده انجام می‌دهد.

پارامترها

بازگشتی‌ها

  • Chrome نسخه ۱۱۶ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

isochronousTransfer()

قول 
chrome.usb.isochronousTransfer(
  handle: ConnectionHandle,
  transferInfo: IsochronousTransferInfo,
  callback?: function,
): Promise<TransferResultInfo>

انتقال هم‌زمان را در دستگاه خاصی انجام می‌دهد.

پارامترها

بازگشتی‌ها

  • Chrome نسخه ۱۱۶ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

listInterfaces()

قول 
chrome.usb.listInterfaces(
  handle: ConnectionHandle,
  callback?: function,
): Promise<InterfaceDescriptor[]>

همه میاناهای موجود در دستگاه USB را فهرست می‌کند.

پارامترها

  • دستگیره

    ConnectionHandle

    اتصال باز به دستگاه.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (descriptors: InterfaceDescriptor[]) => void

بازگشتی‌ها

  • Chrome نسخه ۱۱۶ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

openDevice()

قول 
chrome.usb.openDevice(
  device: Device,
  callback?: function,
): Promise<ConnectionHandle>

دستگاه USB برگردانده‌شده توسط getDevices را باز می‌کند.

پارامترها

بازگشتی‌ها

  • Chrome نسخه ۱۱۶ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

releaseInterface()

قول 
chrome.usb.releaseInterface(
  handle: ConnectionHandle,
  interfaceNumber: number,
  callback?: function,
): Promise<void>

میانای ادعاشده را آزاد می‌کند.

پارامترها

  • دستگیره

    ConnectionHandle

    اتصال باز به دستگاه.

  • interfaceNumber

    شماره

    میانایی که باید منتشر شود.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۱۱۶ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

requestAccess()

Promise منسوخ‌شده
chrome.usb.requestAccess(
  device: Device,
  interfaceId: number,
  callback?: function,
): Promise<boolean>

این عملکرد مختص Chrome OS بود و فراخوانی آن در پلاتفرم‌های دیگر ناموفق بود. این عملیات اکنون به‌طور ضمنی به‌عنوان بخشی از openDevice انجام می‌شود و این تابع true را در همه پلاتفرم‌ها برمی‌گرداند.

اگر میانای ارائه‌شده در دستگاه ادعا نشده باشد، دسترسی به دستگاه ادعاشده توسط Chrome OS را از واسطه اجازه درخواست می‌کند.

پارامترها

  • دستگاه

    دستگاه

    Device برای درخواست دسترسی به آن.

  • interfaceId

    شماره

    میانای خاص درخواست‌شده.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (success: boolean) => void

    • موفقیت‌آمیز

      بولی

بازگشتی‌ها

  • Promise<boolean>

    Chrome نسخه ۱۱۶ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

resetDevice()

قول 
chrome.usb.resetDevice(
  handle: ConnectionHandle,
  callback?: function,
): Promise<boolean>

تلاش می‌کند دستگاه USB را بازنشانی کند. اگر بازنشانی ناموفق باشد، دسته اتصال داده‌شده بسته خواهد شد و دستگاه USB به‌نظر می‌رسد که قطع شده و سپس دوباره متصل شده است. دراین‌صورت، برای به‌دست آوردن دستگاه، getDevices یا findDevices باید دوباره فراخوانی شود.

پارامترها

  • دستگیره

    ConnectionHandle

    دستگیره اتصال برای بازنشانی.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (success: boolean) => void

    • موفقیت‌آمیز

      بولی

بازگشتی‌ها

  • Promise<boolean>

    Chrome نسخه ۱۱۶ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

setConfiguration()

قول 
chrome.usb.setConfiguration(
  handle: ConnectionHandle,
  configurationValue: number,
  callback?: function,
): Promise<void>

پیکربندی دستگاه را انتخاب کنید.

این عملکرد با انتخاب یکی از پیکربندی‌های دردسترس دستگاه، دستگاه را به‌طور مؤثر بازنشانی می‌کند. فقط مقادیر پیکربندی بزرگ‌تر از 0 معتبر هستند، اما برخی‌از دستگاه‌های دارای اشکال پیکربندی فعال 0 دارند و بنابراین این مقدار مجاز است.

پارامترها

  • دستگیره

    ConnectionHandle

    اتصال باز به دستگاه.

  • configurationValue

    شماره

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۱۱۶ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

setInterfaceAlternateSetting()

قول 
chrome.usb.setInterfaceAlternateSetting(
  handle: ConnectionHandle,
  interfaceNumber: number,
  alternateSetting: number,
  callback?: function,
): Promise<void>

تنظیم جایگزینی را در میانای قبلاً ادعاشده انتخاب می‌کند.

پارامترها

  • دستگیره

    ConnectionHandle

    اتصال باز به دستگاهی که این میانای آن ادعا شده است.

  • interfaceNumber

    شماره

    میانای کاربری برای پیکربندی.

  • alternateSetting

    شماره

    تنظیم جایگزین برای پیکربندی.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۱۱۶ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

رویدادها

onDeviceAdded

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

رویداد ایجادشده هنگام افزودن دستگاه به سیستم. رویدادها فقط برای برنامه‌ها و افزونه‌هایی پخش می‌شوند که اجازه دسترسی به دستگاه را دارند. ممکن است اجازه در زمان نصب، وقتی کاربر اجازه اختیاری را پذیرفته است (به permissions.request مراجعه کنید)، یا ازطریق getUserSelectedDevices اعطا شده باشد.

پارامترها

  • تماس برگشتی

    عملکرد

    پارامتر callback به‌صورت زیر است: 

    (device: Device) => void

onDeviceRemoved

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

رویدادی که هنگام برداشته شدن دستگاه از سیستم ایجاد می‌شود. برای اطلاع از اینکه کدام رویدادها ارسال می‌شوند، به onDeviceAdded مراجعه کنید.

پارامترها

  • تماس برگشتی

    عملکرد

    پارامتر callback به‌صورت زیر است: 

    (device: Device) => void