chrome.bluetooth

説明

chrome.bluetooth API を使用して Bluetooth デバイスに接続します。すべての関数は、chrome.runtime.lastError を介してエラーを報告します。

マニフェスト

この API を使用するには、次のキーをマニフェストで宣言する必要があります。

"bluetooth"

型

AdapterState

プロパティ

  • address

    文字列

    アダプターのアドレス（「XX:XX:XX:XX:XX:XX」形式）。

  • 使用可能

    boolean

    アダプターが使用可能（有効）かどうかを示します。

  • 検出

    boolean

    アダプターが現在検出中かどうかを示します。

  • name

    文字列

    人が読める形式のアダプタ名。

  • 電源

    boolean

    アダプターに電力が供給されているかどうかを示します。

BluetoothFilter

Chrome 67 以降

プロパティ

  • filterType

    FilterType 省略可

    デバイスリストに適用するフィルタの種類。デフォルトはすべてです。

  • 上限

    number（省略可）

    返される bluetoth デバイスの最大数。指定しない場合のデフォルトは 0（制限なし）です。

Device

プロパティ

  • address

    文字列

    デバイスのアドレス（「XX:XX:XX:XX:XX:XX」の形式）。

  • batteryPercentage

    number（省略可）

    Chrome 77 以降

    デバイスのバッテリー残量。

  • 接続しやすい

    ブール値（省略可）

    Chrome 48 以降

    デバイスが接続可能かどうかを示します。

  • 接続済み

    ブール値（省略可）

    デバイスが現在システムに接続されているかどうかを示します。

  • connecting

    ブール値（省略可）

    Chrome 48 以降

    デバイスが現在システムに接続中かどうかを示します。

  • deviceClass

    number（省略可）

    デバイスのクラス。http://www.bluetooth.org/en-us/specification/added-numbers/baseband で定義されたビット フィールド。

  • deviceId

    number（省略可）

  • inquiryRssi

    number（省略可）

    Chrome 44 以降

    受信電波強度（dBm）。このフィールドは検出時にのみ使用可能で、有効です。検出以外では、この値が指定されていません。

  • inquiryTxPower

    number（省略可）

    Chrome 44 以降

    送信電力レベル。このフィールドは、AD にこのフィールドを含む LE デバイスでのみ使用できます。検出時にのみ使用可能で有効です。

  • name

    string（省略可）

    人が読める形式のデバイス名。

  • ペア設定済み

    ブール値（省略可）

    デバイスがシステムとペア設定されているかどうかを示します。

  • productId

    number（省略可）

  • 転送

    トランスポート 省略可

    Chrome 76 以降

    Bluetooth デバイスのトランスポート タイプ。

  • タイプ

    DeviceType 省略可

    デバイスのタイプ（Chrome で認識されている場合）。deviceClass フィールドから取得され、可能なデバイスタイプのごく一部を表します。判断に迷う場合は、deviceClass フィールドを直接使用してください。

  • UID

    string[] 省略可

    デバイスでアドバタイズされたプロトコル、プロファイル、サービスの UUID。従来の Bluetooth デバイスの場合、このリストは EIR データと SDP テーブルから取得されます。Low Energy のデバイスの場合、このリストは AD と GATT の主要サービスから取得されます。デュアルモード デバイスの場合は、両方から取得できます。

  • vendorId

    number（省略可）

  • vendorIdSource

    VendorIdSource 省略可

    デバイスのデバイス ID レコード（利用可能な場合）。

DeviceType

Chrome で認識される一般的なデバイスの種類。

Enum

"modem"

"audio"

"carAudio"

"peripheral"

FilterType

Chrome 67 以降

Bluetooth デバイスのフィルタリングのタイプ。

Enum

Transport

Chrome 76 以降

Bluetooth デバイスのトランスポート タイプ。

Enum

VendorIdSource

ベンダー ID の割り当てオーソリティ。

Enum

Methods

getAdapterState()

Promise 
chrome.bluetooth.getAdapterState(
  callback?: function,
)

Bluetooth アダプターに関する情報を取得します。

パラメータ

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (adapterInfo: AdapterState)=>void

    • adapterInfo

      AdapterState

      アダプタ情報を含むオブジェクト。

戻り値

  • Promise<AdapterState>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

getDevice()

Promise 
chrome.bluetooth.getDevice(
  deviceAddress: string,
  callback?: function,
)

システムで認識されている Bluetooth デバイスに関する情報を取得します。

パラメータ

  • deviceAddress

    文字列

    取得するデバイスのアドレス。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (deviceInfo: Device)=>void

    • deviceInfo

      デバイス

      デバイス情報を含むオブジェクト。

戻り値

  • Promise<Device>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

getDevices()

Promise 
chrome.bluetooth.getDevices(
  filter?: BluetoothFilter,
  callback?: function,
)

システムで認識されている Bluetooth デバイスのリスト（ペア設定済みのデバイスや最近検出されたデバイスを含む）を取得します。

パラメータ

  • フィルタ

    BluetoothFilter 省略可

    Chrome 67 以降

    返された Bluetooth デバイスのリストをフィルタするための条件。フィルタが設定されていないか {} に設定されている場合、返されるデバイスリストにはすべての Bluetooth デバイスが含まれます。現在、これは ChromeOS でのみサポートされています。他のプラットフォームでは、完全なリストが返されます。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (deviceInfos: Device[])=>void

    • deviceInfos

      デバイス[]

      デバイス情報を含むオブジェクトの配列。

戻り値

  • Promise<Device[]>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

startDiscovery()

Promise 
chrome.bluetooth.startDiscovery(
  callback?: function,
)

検出を開始します。新たに検出されたデバイスは、onDeviceAdded イベントを介して返されます。アダプターですでに認識されている以前に検出されたデバイスは、getDevices を使用して取得する必要があります。デバイスの情報が変更された場合にのみ、onDeviceChanged イベントを使用して更新されます。

このアプリケーションがすでに startDiscovery を呼び出している場合、検出を開始できません。検出はリソースを大量に消費する可能性があります。stopDiscovery はできるだけ早く呼び出す必要があります。

パラメータ

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    ()=>void

戻り値

  • Promise<void>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

stopDiscovery()

Promise 
chrome.bluetooth.stopDiscovery(
  callback?: function,
)

検出を停止します。

パラメータ

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    ()=>void

戻り値

  • Promise<void>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

イベント

onAdapterStateChanged

chrome.bluetooth.onAdapterStateChanged.addListener(
  callback: function,
)

Bluetooth アダプターの状態が変更されたときに呼び出されます。

パラメータ

  • callback

    機能

    callback パラメータは次のようになります。 

    (state: AdapterState)=>void

onDeviceAdded

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

新しい Bluetooth デバイスに関する情報が利用可能になると呼び出されます。

パラメータ

  • callback

    機能

    callback パラメータは次のようになります。 

    (device: Device)=>void

onDeviceChanged

chrome.bluetooth.onDeviceChanged.addListener(
  callback: function,
)

既知の Bluetooth デバイスに関する情報が変更されたときに呼び出されます。

パラメータ

  • callback

    機能

    callback パラメータは次のようになります。 

    (device: Device)=>void

onDeviceRemoved

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

以前に検出された Bluetooth デバイスが範囲外に長く続いた状態が続くと再度利用不可になった場合と、ペア設定済みのデバイスが削除された場合に呼び出されます。

パラメータ

  • callback

    機能

    callback パラメータは次のようになります。 

    (device: Device)=>void