chrome.bluetooth

説明

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

マニフェスト

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

"bluetooth"

型

AdapterState

プロパティ

  • 住所

    文字列

    アダプターの住所（「XX:XX:XX:XX:XX:XX」の形式）。

  • 使用可能

    ブール値

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

  • 検出中

    ブール値

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

  • name

    文字列

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

  • パワード

    ブール値

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

BluetoothFilter

Chrome 67 以降

プロパティ

  • filterType

    FilterType 省略可

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

  • limit

    数値（省略可）

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

Device

プロパティ

  • 住所

    文字列

    デバイスの住所（「XX:XX:XX:XX:XX:XX」形式）。

  • batteryPercentage

    数値（省略可）

    Chrome 77 以降

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

  • 接続可能

    ブール値（省略可）

    Chrome 48 以降

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

  • 接続済み

    ブール値（省略可）

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

  • connecting

    ブール値（省略可）

    Chrome 48 以降

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

  • deviceClass

    数値（省略可）

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

  • deviceId

    数値（省略可）

  • inquiryRssi

    数値（省略可）

    Chrome 44 以降

    受信信号強度（dBm）。このフィールドは、検出時にのみ利用可能かつ有効です。検出以外では、この値は指定されません。

  • inquiryTxPower

    数値（省略可）

    Chrome 44 以降

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

  • name

    文字列（省略可）

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

  • ペア設定済み

    ブール値（省略可）

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

  • productId

    数値（省略可）

  • transport

    トランスポート （省略可）

    Chrome 76 以降

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

  • type

    DeviceType（省略可）

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

  • uuids

    文字列 [] 省略可

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

  • vendorId

    数値（省略可）

  • vendorIdSource

    VendorIdSource（省略可）

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

DeviceType

Chrome で認識される一般的なデバイスタイプ。

列挙型

"パソコン"

"電話"

"モデム"

"audio"

"carAudio"

「動画」

"peripheral"

"ジョイスティック"

"ゲームパッド"

"キーボード"

"mouse"

"タブレット"

"keyboardMouseCombo"

FilterType

Chrome 67 以降

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

列挙型

"all"

「既知」

Transport

Chrome 76 以降

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

列挙型

"invalid"

"クラシック"

"le"

「デュアル」

VendorIdSource

ベンダー ID の割り当て機関。

列挙型

「Bluetooth」

"usb"

メソッド

getAdapterState()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.bluetooth.getAdapterState(
  callback?: function,
)

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

パラメータ

  • callback

    関数（省略可）

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

    (adapterInfo: AdapterState) => void

    • adapterInfo

      AdapterState

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

戻り値

  • Promise&lt;AdapterState&gt;

    Chrome 91 以降

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

getDevice()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.bluetooth.getDevice(
  deviceAddress: string,
  callback?: function,
)

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

パラメータ

  • deviceAddress

    文字列

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

  • callback

    関数（省略可）

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

    (deviceInfo: Device) => void

    • deviceInfo

      デバイス

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

戻り値

  • Promise&lt;Device&gt;

    Chrome 91 以降

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

getDevices()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.bluetooth.getDevices(
  filter?: BluetoothFilter,
  callback?: function,
)

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

パラメータ

  • フィルタ

    BluetoothFilter（オプション）

    Chrome 67 以降

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

  • callback

    関数（省略可）

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

    (deviceInfos: Device[]) => void

    • deviceInfos

      デバイス[]

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

戻り値

  • Promise<デバイス[]>

    Chrome 91 以降

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

startDiscovery()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.bluetooth.startDiscovery(
  callback?: function,
)

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

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

パラメータ

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 91 以降

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

stopDiscovery()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.bluetooth.stopDiscovery(
  callback?: function,
)

検出を停止します。

パラメータ

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <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