chrome.bluetoothSocket

说明

使用 chrome.bluetoothSocket API 通过 RFCOMM 和 L2CAP 连接向蓝牙设备发送和接收数据。

清单

必须在清单中声明以下键才能使用此 API。

"bluetooth"

类型

AcceptError

枚举

"system_error"
发生系统错误，连接可能无法恢复。

"not_listening"
套接字未监听。

AcceptErrorInfo

属性

  • error

    AcceptError

    指明出了什么问题的错误代码。

  • errorMessage

    string

    错误消息。

  • socketId

    number

    服务器套接字标识符。

AcceptInfo

属性

  • clientSocketId

    number

    客户端套接字标识符，即新建立的连接的套接字标识符。此套接字标识符只能与 chrome.bluetoothSocket 命名空间中的函数一起使用。请注意，客户端套接字最初处于暂停状态，必须由应用明确取消暂停，才能开始接收数据。

  • socketId

    number

    服务器套接字标识符。

CreateInfo

属性

  • socketId

    number

    新创建的套接字的 ID。请注意，通过此 API 创建的套接字 ID 与通过其他 API（如 [sockets.tcp](../sockets_tcp/) API）创建的套接字 ID 不兼容。

ListenOptions

属性

  • 积压

    数字可选

    套接字监听队列的长度。默认值取决于操作系统的主机子系统。

  • 频道

    数字可选

    listenUsingRfcomm 使用的 RFCOMM 通道。如果指定，则该渠道之前不得处于使用状态，否则方法调用将会失败。如果未指定，则自动分配未使用的渠道。

  • PSM

    数字可选

    listenUsingL2cap 使用的 L2CAP PSM。如果指定，则此 PSM 不得先前处于使用状态，或方法调用失败。如果未指定，则系统会自动分配未使用的 PSM。

ReceiveError

枚举

"disconnection"
连接已断开。

"system_error"
发生系统错误，连接可能无法恢复。

"not_Connected"
套接字尚未连接。

ReceiveErrorInfo

属性

  • error

    ReceiveError

    指明出了什么问题的错误代码。

  • errorMessage

    string

    错误消息。

  • socketId

    number

    套接字标识符。

ReceiveInfo

属性

  • data

    ArrayBuffer

    已接收的数据，大小上限为 bufferSize。

  • socketId

    number

    套接字标识符。

SocketInfo

属性

  • 地址

    字符串（可选）

    如果底层套接字已连接，则包含它所连接的设备的蓝牙地址。

  • bufferSize

    数字可选

    用于接收数据的缓冲区大小。如果未明确指定缓冲区大小，则不提供值。

  • 已连接

    boolean

    此标记指示套接字是否已连接到远程对等方。

  • name

    字符串（可选）

    与套接字关联的应用定义字符串。

  • 已暂停

    boolean

    此标记指示已连接的套接字是阻止其对等方发送更多数据，还是对监听套接字的连接请求是通过 onAccept 事件分派，还是在监听队列积压中排队。请参阅 setPaused。默认值为 “False”。

  • 持久性

    boolean

    此标记指示在应用的事件页面卸载时套接字是否保持打开状态（请参阅 SocketProperties.persistent）。默认值为“false”。

  • socketId

    number

    套接字标识符。

  • uuid

    字符串（可选）

    如果底层套接字已连接，则包含它所连接的服务 UUID 的相关信息；否则，如果底层套接字正在监听，则包含它正在监听的服务 UUID 的相关信息。

SocketProperties

属性

  • bufferSize

    数字可选

    用于接收数据的缓冲区大小。默认值为 4096。

  • name

    字符串（可选）

    与套接字关联的应用定义的字符串。

  • 持久性

    布尔值 选填

    此标记指示在应用的事件页面卸载时套接字是否保持打开状态（请参阅管理应用生命周期）。默认值为 false.。加载应用时，可通过 getSockets 提取之前使用 persistent=true 打开的任何套接字。

方法

close()

Promise 
chrome.bluetoothSocket.close(
  socketId: number,
  callback?: function,
)

断开并销毁套接字。创建的每个套接字应在使用后关闭。调用该函数时，套接字 ID 会立即失效。不过，套接字只有在调用回调时才会关闭。

参数

  • socketId

    number

    套接字标识符。

  • callback

    函数（可选）

    callback 参数如下所示：

    ()=>void

返回

  • Promise<void>

    Chrome 91 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

connect()

Promise 
chrome.bluetoothSocket.connect(
  socketId: number,
  address: string,
  uuid: string,
  callback?: function,
)

将套接字连接到远程蓝牙设备。如果 connect 操作成功完成，则从对等方接收数据时，将引发 onReceive 事件。如果运行时接收数据包时发生网络错误，则会引发 onReceiveError 事件，此时不会再针对此套接字引发 onReceive 事件，直到调用 setPaused(false) 方法。

参数

  • socketId

    number

    套接字标识符。

  • 地址

    string

    蓝牙设备的地址。

  • uuid

    string

    要连接的服务的 UUID。

  • callback

    函数（可选）

    callback 参数如下所示：

    ()=>void

返回

  • Promise<void>

    Chrome 91 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

create()

Promise 
chrome.bluetoothSocket.create(
  properties?: SocketProperties,
  callback?: function,
)

创建蓝牙套接字。

参数

  • 媒体资源

    SocketProperties 可选

    套接字属性（可选）。

  • callback

    函数（可选）

    callback 参数如下所示：

    (createInfo: CreateInfo)=>void

    • createInfo

      CreateInfo

      套接字创建的结果。

返回

  • Promise<CreateInfo>

    Chrome 91 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

disconnect()

Promise 
chrome.bluetoothSocket.disconnect(
  socketId: number,
  callback?: function,
)

断开套接字。套接字标识符仍然有效。

参数

  • socketId

    number

    套接字标识符。

  • callback

    函数（可选）

    callback 参数如下所示：

    ()=>void

返回

  • Promise<void>

    Chrome 91 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

getInfo()

Promise 
chrome.bluetoothSocket.getInfo(
  socketId: number,
  callback?: function,
)

检索指定套接字的状态。

参数

  • socketId

    number

    套接字标识符。

  • callback

    函数（可选）

    callback 参数如下所示：

    (socketInfo: SocketInfo)=>void

    • socketInfo

      SocketInfo

      包含套接字信息的对象。

返回

  • Promise<SocketInfo>

    Chrome 91 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

getSockets()

Promise 
chrome.bluetoothSocket.getSockets(
  callback?: function,
)

检索应用拥有的当前已打开套接字的列表。

参数

  • callback

    函数（可选）

    callback 参数如下所示：

    (sockets: SocketInfo[])=>void

返回

  • Promise<SocketInfo[]>

    Chrome 91 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

listenUsingL2cap()

Promise 
chrome.bluetoothSocket.listenUsingL2cap(
  socketId: number,
  uuid: string,
  options?: ListenOptions,
  callback?: function,
)

监听使用 L2CAP 协议的连接。

参数

  • socketId

    number

    套接字标识符。

  • uuid

    string

    要监听的服务 UUID。

  • 选项

    ListenOptions 可选

    服务的其他可选选项。

  • callback

    函数（可选）

    callback 参数如下所示：

    ()=>void

返回

  • Promise<void>

    Chrome 91 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

listenUsingRfcomm()

Promise 
chrome.bluetoothSocket.listenUsingRfcomm(
  socketId: number,
  uuid: string,
  options?: ListenOptions,
  callback?: function,
)

监听使用 RFCOMM 协议的连接。

参数

  • socketId

    number

    套接字标识符。

  • uuid

    string

    要监听的服务 UUID。

  • 选项

    ListenOptions 可选

    服务的其他可选选项。

  • callback

    函数（可选）

    callback 参数如下所示：

    ()=>void

返回

  • Promise<void>

    Chrome 91 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

send()

Promise 
chrome.bluetoothSocket.send(
  socketId: number,
  data: ArrayBuffer,
  callback?: function,
)

在指定的蓝牙套接字上发送数据。

参数

  • socketId

    number

    套接字标识符。

  • data

    ArrayBuffer

    要发送的数据。

  • callback

    函数（可选）

    callback 参数如下所示：

    (bytesSent: number)=>void

    • bytesSent

      number

      已发送的字节数。

返回

  • Promise<数字>

    Chrome 91 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

setPaused()

Promise 
chrome.bluetoothSocket.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
)

允许或禁止已连接的套接字从其对等端接收消息，或允许监听套接字接受新连接。默认值为“false”。应用通常使用暂停已连接的套接字来限制其对等方发送的数据。已连接的套接字暂停时，不会引发任何 onReceive 事件。在连接和取消暂停套接字后，系统会在收到消息时再次引发 onReceive 事件。当监听套接字暂停时，系统会接受新连接，直到其积压填满后，其他连接请求将被拒绝。仅当套接字取消暂停时，才会引发 onAccept 事件。

参数

  • socketId

    number

  • 已暂停

    boolean

  • callback

    函数（可选）

    callback 参数如下所示：

    ()=>void

返回

  • Promise<void>

    Chrome 91 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

update()

Promise 
chrome.bluetoothSocket.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
)

更新套接字属性。

参数

  • socketId

    number

    套接字标识符。

  • 媒体资源

    SocketProperties

    要更新的属性。

  • callback

    函数（可选）

    callback 参数如下所示：

    ()=>void

返回

  • Promise<void>

    Chrome 91 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

活动

onAccept

chrome.bluetoothSocket.onAccept.addListener(
  callback: function,
)

为指定套接字建立连接时触发的事件。

参数

onAcceptError

chrome.bluetoothSocket.onAcceptError.addListener(
  callback: function,
)

运行时在等待给定套接字上的新连接时发生网络错误时引发的事件。引发此事件后，套接字会设置为 paused，并且不会再针对此套接字引发 onAccept 事件。

参数

onReceive

chrome.bluetoothSocket.onReceive.addListener(
  callback: function,
)

在收到指定套接字的数据时引发的事件。

参数

onReceiveError

chrome.bluetoothSocket.onReceiveError.addListener(
  callback: function,
)

运行时等待套接字上的数据时发生网络错误时引发的事件。引发此事件后，套接字会设置为 paused，并且不会再针对此套接字引发 onReceive 事件。

参数