Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 aa045e6b 编写于 作者: Z zengyawen
浏览文件
操作

update docs 

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 879b9926
显示空白变更内容
内联 并排
Showing with 633 addition and 636 deletion
zh-cn/application-dev/reference/apis/js-apis-appAccount.md
浏览文件 @ aa045e6b
......@@ -102,8 +102,8 @@ addAccount(name: string, extraInfo?: string): Promise&lt;void&gt;
**返回值：**
| 类型 | 说明 |
| ------------------- | ---------------------------------- |
| Promise&lt;void&gt; | romise实例，用于获取异步返回结果。 |
| ------------------- | ----------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-bluetooth.md
浏览文件 @ aa045e6b
......@@ -39,7 +39,7 @@ enableBluetooth(): boolean
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------- | --------------------------------------- |
| boolean | 打开蓝牙，成功返回true，否则返回false。 |
**示例：**
......@@ -62,7 +62,7 @@ disableBluetooth(): boolean
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------- | --------------------------------------- |
| boolean | 关闭蓝牙，成功返回true，否则返回false。 |
**示例：**
......@@ -85,7 +85,7 @@ getLocalName(): string
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------ | ------------------ |
| string | 蓝牙本地设备名称。 |
**示例：**
......@@ -108,7 +108,7 @@ getState(): BluetoothState
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| --------------------------------- | ------------------ |
| [BluetoothState](#bluetoothstate) | 表示蓝牙开关状态。 |
**示例：**
......@@ -131,7 +131,7 @@ getBtConnectionState(): ProfileConnectionState
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------------------------------------------------- | ------------------------------- |
| [ProfileConnectionState](#profileconnectionstate) | 表示蓝牙设备的Profile连接状态。 |
**示例：**
......@@ -154,13 +154,13 @@ setLocalName(name: string): boolean
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 要设置的蓝牙名称，最大长度为248。 |
| ------ | ------ | ---- | --------------------------------------- |
| name | string | 是 | 要设置的蓝牙名称，最大长度为248字节数。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------- | --------------------------------------------------- |
| boolean | 设置蓝牙本地设备名称，成功返回true，否则返回false。 |
**示例：**
......@@ -183,13 +183,13 @@ pairDevice(deviceId: string): boolean
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------ | ---- | --------------------------------------------------- |
| deviceId | string | 是 | 表示配对的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------- | ------------------------------------------- |
| boolean | 发起蓝牙配对，成功返回true，否则返回false。 |
**示例：**
......@@ -213,13 +213,13 @@ getProfileConnState(profileId: ProfileId): ProfileConnectionState
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| --------- | --------- | ---- | ------------------------------------------------ |
| ProfileId | profileId | 是 | 表示profile的枚举值，例如：PROFILE_A2DP_SOURCE。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------------------------------------------------- | ------------------- |
| [ProfileConnectionState](#ProfileConnectionState) | profile的连接状态。 |
**示例：**
......@@ -242,13 +242,13 @@ cancelPairedDevice(deviceId: string): boolean
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------ | ---- | ------------------------------------------------------- |
| deviceId | string | 是 | 表示要删除的远程设备的地址，例如："XX:XX:XX:XX:XX:XX"。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------- | ------------------------------------------- |
| boolean | 启动取消配对，成功返回true，否则返回false。 |
**示例：**
......@@ -271,13 +271,13 @@ getRemoteDeviceName(deviceId: string): string
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------ | ---- | ----------------------------------------------- |
| deviceId | string | 是 | 表示远程设备的地址，例如："XX:XX:XX:XX:XX:XX"。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------ | -------------------------- |
| string | 以字符串格式返回设备名称。 |
**示例：**
......@@ -300,13 +300,13 @@ getRemoteDeviceClass(deviceId: string): DeviceClass
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------ | ---- | ----------------------------------------------- |
| deviceId | string | 是 | 表示远程设备的地址，例如："XX:XX:XX:XX:XX:XX"。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| --------------------------- | ---------------- |
| [DeviceClass](#deviceclass) | 远程设备的类别。 |
**示例：**
......@@ -329,7 +329,7 @@ getPairedDevices(): Array&lt;string&gt;
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------------------- | -------------------------- |
| Array&lt;string&gt; | 已配对蓝牙设备的地址列表。 |
**示例：**
......@@ -352,14 +352,14 @@ setBluetoothScanMode(mode: ScanMode, duration: number): boolean
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | --------------------- | ---- | ------------------------------------------------------- |
| mode | [ScanMode](#scanmode) | 是 | 蓝牙扫描模式。 |
| duration | number | 是 | 设备可被发现的持续时间，单位为秒；设置为0则持续可发现。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------- | ------------------------------------------- |
| boolean | 设置蓝牙扫描，成功返回true，否则返回false。 |
**示例：**
......@@ -383,7 +383,7 @@ getBluetoothScanMode(): ScanMode
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| --------------------- | -------------- |
| [ScanMode](#scanmode) | 蓝牙扫描模式。 |
**示例：**
......@@ -406,7 +406,7 @@ startBluetoothDiscovery(): boolean
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------- | ------------------------------------------- |
| boolean | 开启蓝牙扫描，成功返回true，否则返回false。 |
**示例：**
......@@ -434,7 +434,7 @@ stopBluetoothDiscovery(): boolean
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------- | ------------------------------------------- |
| boolean | 关闭蓝牙扫描，成功返回true，否则返回false。 |
**示例：**
......@@ -457,14 +457,14 @@ setDevicePairingConfirmation(device: string, accept: boolean): boolean
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------ | ------- | ---- | --------------------------------------------- |
| device | string | 是 | 表示远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| accept | boolean | 是 | 接受配对请求设置为true，否则设置为false。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------- | ----------------------------------------------- |
| boolean | 设置设备配对确认，成功返回true，否则返回false。 |
**示例：**
......@@ -492,7 +492,7 @@ on(type: "bluetoothDeviceFind", callback: Callback&lt;Array&lt;string&gt;&gt;):
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 填写"bluetoothDeviceFind"字符串，表示蓝牙设备发现事件。 |
| callback | Callback&lt;Array&lt;string&gt;&gt; | 是 | 表示回调函数的入参，发现的设备集合。回调函数由用户创建通过该接口注册。 |
......@@ -523,7 +523,7 @@ off(type: "bluetoothDeviceFind", callback?: Callback&lt;Array&lt;string&gt;&gt;)
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 填写"bluetoothDeviceFind"字符串，表示蓝牙设备发现事件。 |
| callback | Callback&lt;Array&lt;string&gt;&gt; | 否 | 表示取消订阅蓝牙设备发现事件上报。不填该参数则取消订阅该type对应的所有回调。 |
......@@ -555,7 +555,7 @@ on(type: "pinRequired", callback: Callback&lt;PinRequiredParam&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 填写"pinRequired"字符串，表示配对请求事件。 |
| callback | Callback&lt;[PinRequiredParam](#pinrequiredparam)&gt; | 是 | 表示回调函数的入参，配对请求。回调函数由用户创建通过该接口注册。 |
......@@ -586,7 +586,7 @@ off(type: "pinRequired", callback?: Callback&lt;PinRequiredParam&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 填写"pinRequired"字符串，表示配对请求事件。 |
| callback | Callback&lt;[PinRequiredParam](#pinrequiredparam)&gt; | 否 | 表示取消订阅蓝牙配对请求事件上报，入参为配对请求参数。不填该参数则取消订阅该type对应的所有回调。 |
......@@ -618,7 +618,7 @@ on(type: "bondStateChange", callback: Callback&lt;BondStateParam&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 填写"bondStateChange"字符串，表示蓝牙配对状态改变事件。 |
| callback | Callback&lt;[BondStateParam](#bondstate)&gt; | 是 | 表示回调函数的入参，配对的状态。回调函数由用户创建通过该接口注册。 |
......@@ -649,7 +649,7 @@ off(type: "bondStateChange", callback?: Callback&lt;BondStateParam&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 填写"bondStateChange"字符串，表示蓝牙配对状态改变事件。 |
| callback | Callback&lt;[BondStateParam](#bondstate)&gt; | 否 | 表示取消订阅蓝牙配对状态改变事件上报。不填该参数则取消订阅该type对应的所有回调。 |
......@@ -681,7 +681,7 @@ on(type: "stateChange", callback: Callback&lt;BluetoothState&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 填写"stateChange"字符串，表示蓝牙状态改变事件。 |
| callback | Callback&lt;[BluetoothState](#bluetoothstate)&gt; | 是 | 表示回调函数的入参，蓝牙状态。回调函数由用户创建通过该接口注册。 |
......@@ -712,7 +712,7 @@ off(type: "stateChange", callback?: Callback&lt;BluetoothState&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 填写"stateChange"字符串，表示蓝牙状态改变事件。 |
| callback | Callback&lt;[BluetoothState](#bluetoothstate)&gt; | 否 | 表示取消订阅蓝牙状态改变事件上报。不填该参数则取消订阅该type对应的所有回调。 |
......@@ -744,7 +744,7 @@ sppListen(name: string, option: SppOption, callback: AsyncCallback&lt;number&gt;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | --------------------------- | ---- | -------------------------------------- |
| name | string | 是 | 服务的名称。 |
| option | [SppOption](#sppoption) | 是 | spp监听配置参数。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 表示回调函数的入参，服务端Socket的id。 |
......@@ -777,7 +777,7 @@ sppAccept(serverSocket: number, callback: AsyncCallback&lt;number&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------------ | --------------------------- | ---- | -------------------------------------- |
| serverSocket | number | 是 | 服务端socket的id。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 表示回调函数的入参，客户端socket的id。 |
......@@ -810,7 +810,7 @@ sppConnect(device: string, option: SppOption, callback: AsyncCallback&lt;number&
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | --------------------------- | ---- | ----------------------------------------- |
| device | string | 是 | 对端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| option | [SppOption](#sppoption) | 是 | spp客户端连接配置参数。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 表示回调函数的入参，客户端socket的id。 |
......@@ -843,7 +843,7 @@ sppCloseServerSocket(socket: number): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------ | ------ | ---- | ---------------------- |
| socket | number | 是 | 服务端监听socket的id。 |
**示例：**
......@@ -864,7 +864,7 @@ sppCloseClientSocket(socket: number): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------ | ------ | ---- | ------------------ |
| 参数名 | 类型 | 必填 | 说明 |
| socket | number | 是 | 客户端socket的id。 |
......@@ -886,15 +886,14 @@ sppWrite(clientSocket: number, data: ArrayBuffer): boolean
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------------ | ----------- | ---- | ------------------ |
| clientSocket | number | 是 | 客户端socket的id。 |
| data | ArrayBuffer | 是 | 写入的数据。 |
**返回值：**
| | |
| -------- | -------- |
| 类型 | 说明 |
| ------- | ----------------------------------------- |
| boolean | 写数据操作，成功返回true，否则返回false。 |
**示例：**
......@@ -923,7 +922,7 @@ on(type: "sppRead", clientSocket: number, callback: Callback&lt;ArrayBuffer&gt;)
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------------ | --------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"sppRead"字符串，表示spp读请求事件。 |
| clientSocket | number | 是 | 客户端socket的id。 |
| callback | Callback&lt;ArrayBuffer&gt; | 是 | 表示回调函数的入参，读取到的数据。 |
......@@ -954,7 +953,7 @@ off(type: "sppRead", clientSocket: number, callback?: Callback&lt;ArrayBuffer&gt
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------------ | --------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 填写"sppRead"字符串，表示spp读请求事件。 |
| clientSocket | number | 是 | 客户端Socket的id。 |
| callback | Callback&lt;ArrayBuffer&gt; | 否 | 表示取消订阅spp读请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
......@@ -981,14 +980,13 @@ getProfile(profileId: ProfileId): A2dpSourceProfile | HandsFreeAudioGatewayProfi
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| --------- | --------- | ---- | ------------------------------------------------ |
| ProfileId | profileId | 是 | 表示profile的枚举值，例如：PROFILE_A2DP_SOURCE。 |
**返回值：**
| | |
| -------- | -------- |
| 类型 | 说明 |
| --------------------------------------------------- | ------------------------------------------------------------ |
| A2dpSourceProfile 或者 HandsFreeAudioGatewayProfile | 对应的profile的对象实例，当前支持A2dpSourceProfile， HandsFreeAudioGatewayProfile。 |
**示例：**
......@@ -1011,7 +1009,7 @@ createGattServer(): GattServer
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------------------------- | ------------------------------------------------------------ |
| [GattServer](#gattserver) | server端类，使用server端方法之前需要创建该类的实例进行操作。 |
**示例：**
......@@ -1032,13 +1030,13 @@ createGattClientDevice(deviceId: string): GattClientDevice
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------ | ---- | ----------------------------------------------- |
| deviceId | string | 是 | 对端设备地址，&nbsp;例如："XX:XX:XX:XX:XX:XX"。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------------------------------------- | ------------------------------------------------------------ |
| [GattClientDevice](#gattclientdevice) | client端类，使用client端方法之前需要创建该类的实例进行操作。 |
**示例：**
......@@ -1061,7 +1059,7 @@ getConnectedBLEDevices(): Array&lt;string&gt;
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------------------- | ----------------------------------- |
| Array&lt;string&gt; | 返回和当前设备连接BLE设备地址集合。 |
**示例：**
......@@ -1084,7 +1082,7 @@ startBLEScan(filters: Array&lt;ScanFilter&gt;, options?: ScanOptions): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------- | -------------------------------------- | ---- | ------------------------------------------------------------ |
| filters | Array&lt;[ScanFilter](#scanfilter)&gt; | 是 | 表示扫描结果过滤策略集合，如果不使用过滤的方式，该参数设置为null。 |
| options | [ScanOptions](#scanoptions) | 否 | 表示扫描的参数配置，可选参数。 |
......@@ -1148,7 +1146,7 @@ on(type: "BLEDeviceFind", callback: Callback&lt;Array&lt;ScanResult&gt;&gt;): vo
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 填写"BLEDeviceFind"字符串，表示BLE设备发现事件。 |
| callback | Callback&lt;Array&lt;[ScanResult](#scanresult)&gt;&gt; | 是 | 表示回调函数的入参，发现的设备集合。回调函数由用户创建通过该接口注册。 |
......@@ -1179,7 +1177,7 @@ off(type: "BLEDeviceFind", callback?: Callback&lt;Array&lt;ScanResult&gt;&gt;):
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 填写"BLEDeviceFind"字符串，表示BLE设备发现事件。 |
| callback | Callback&lt;Array&lt;[ScanResult](#scanresult)&gt;&gt; | 否 | 表示取消订阅BLE设备发现事件上报。不填该参数则取消订阅该type对应的所有回调。 |
......@@ -1220,7 +1218,7 @@ getConnectionDevices(): Array&lt;string&gt;
**返回值：**
| | |
| -------- | -------- |
| ------------------- | -------------------------- |
| 类型 | 说明 |
| Array&lt;string&gt; | 返回已连接设备的地址列表。 |
......@@ -1238,14 +1236,14 @@ getDeviceState(device: string): ProfileConnectionState
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------ | ------ | ---- | -------------- |
| device | string | 是 | 远端设备地址。 |
|
**返回值：**
| | |
| -------- | -------- |
| ------------------------------------------------- | ----------------------- |
| 类型 | 说明 |
| [ProfileConnectionState](#profileconnectionState) | 返回profile的连接状态。 |
......@@ -1268,14 +1266,14 @@ connect(device: string): boolean
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------ | ------ | ---- | -------------- |
| device | string | 是 | 远端设备地址。 |
|
**返回值：**
| | |
| -------- | -------- |
| ------- | ----------------------------- |
| 类型 | 说明 |
| boolean | 成功返回true，失败返回false。 |
......@@ -1300,14 +1298,14 @@ disconnect(device: string): boolean
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------ | ------ | ---- | -------------- |
| device | string | 是 | 远端设备地址。 |
|
**返回值：**
| | |
| -------- | -------- |
| ------- | ----------------------------- |
| 类型 | 说明 |
| boolean | 成功返回true，失败返回false。 |
......@@ -1330,7 +1328,7 @@ on(type: "connectionStateChange", callback: Callback&lt;[StateChangeParam](#Stat
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ----------------------------------------------------- | ---- | --------------------------------------------------------- |
| type | string | 是 | 填写"connectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback&lt;[StateChangeParam](#StateChangeParam)&gt; | 是 | 表示回调函数的入参。 |
......@@ -1359,7 +1357,7 @@ off(type: "connectionStateChange", callback: Callback&lt;[StateChangeParam](#Sta
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ----------------------------------------------------- | ---- | --------------------------------------------------------- |
| type | string | 是 | 填写"connectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback&lt;[StateChangeParam](#StateChangeParam)&gt; | 是 | 表示回调函数的入参。 |
......@@ -1388,13 +1386,13 @@ getPlayingState(device: string): PlayingState
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------ | ------ | ---- | -------------- |
| device | string | 是 | 远端设备地址。 |
**返回值：**
| | |
| -------- | -------- |
| ----------------------------- | -------------------- |
| 类型 | 说明 |
| [PlayingState](#PlayingState) | 远端设备的播放状态。 |
......@@ -1424,14 +1422,14 @@ connect(device: string): boolean
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------ | ------ | ---- | -------------- |
| device | string | 是 | 远端设备地址。 |
|
**返回值：**
| | |
| -------- | -------- |
| ------- | ----------------------------- |
| 类型 | 说明 |
| boolean | 成功返回true，失败返回false。 |
......@@ -1447,7 +1445,7 @@ boolean ret = hfpAg.connect('XX:XX:XX:XX:XX:XX');
disconnect(device: string): boolean
连接设备的HFP服务。
断开连接设备的HFP服务。
**需要权限**：ohos.permission.DISCOVER_BLUETOOTH
......@@ -1456,15 +1454,14 @@ disconnect(device: string): boolean
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------ | ------ | ---- | -------------- |
| device | string | 是 | 远端设备地址。 |
|
**返回值：**
| | |
| -------- | -------- |
| 类型 | 说明 |
| ------- | ----------------------------- |
| boolean | 成功返回true，失败返回false。 |
**示例：**
......@@ -1486,7 +1483,7 @@ on(type: "connectionStateChange", callback: Callback&lt;[StateChangeParam](#Stat
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ----------------------------------------------------- | ---- | --------------------------------------------------------- |
| type | string | 是 | 填写"connectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback&lt;[StateChangeParam](#StateChangeParam)&gt; | 是 | 表示回调函数的入参。 |
......@@ -1515,7 +1512,7 @@ off(type: "connectionStateChange", callback: Callback&lt;[StateChangeParam](#Sta
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ----------------------------------------------------- | ---- | --------------------------------------------------------- |
| type | string | 是 | 填写"connectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback&lt;[StateChangeParam](#StateChangeParam)&gt; | 是 | 表示回调函数的入参。 |
......@@ -1551,7 +1548,7 @@ startAdvertising(setting: AdvertiseSetting, advData: AdvertiseData, advResponse?
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ----------- | ------------------------------------- | ---- | ------------------------- |
| setting | [AdvertiseSetting](#advertisesetting) | 是 | BLE广播的相关参数。 |
| advData | [AdvertiseData](#advertisedata) | 是 | BLE广播包内容。 |
| advResponse | [AdvertiseData](#advertisedata) | 否 | BLE回复扫描请求回复响应。 |
......@@ -1640,13 +1637,13 @@ server端添加服务。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------- | --------------------------- | ---- | -------------------------------------- |
| service | [GattService](#gattservice) | 是 | 服务端的service数据。BLE广播的相关参数 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------- | ------------------------------------------- |
| boolean | 添加服务操作，成功返回true，否则返回false。 |
**示例：**
......@@ -1699,13 +1696,13 @@ removeService(serviceUuid: string): boolean
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ----------- | ------ | ---- | ----------------------------------------------------------- |
| serviceUuid | string | 是 | service的UUID，例如“00001810-0000-1000-8000-00805F9B34FB”。 |
**返回值：**
| | |
| -------- | -------- |
| ------- | ------------------------------------------- |
| 类型 | 说明 |
| boolean | 删除服务操作，成功返回true，否则返回false。 |
......@@ -1748,14 +1745,14 @@ server端特征值发生变化时，主动通知已连接的client设备。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------------------- | --------------------------------------------- | ---- | ----------------------------------------------------- |
| deviceId | string | 是 | 接收通知的client端设备地址，例如“XX:XX:XX:XX:XX:XX”。 |
| notifyCharacteristic | [NotifyCharacteristic](#notifycharacteristic) | 是 | 通知的特征值数据。 |
**返回值：**
| | |
| -------- | -------- |
| ------- | --------------------------------------- |
| 类型 | 说明 |
| boolean | 通知操作，成功返回true，否则返回false。 |
......@@ -1782,13 +1779,13 @@ server端回复client端的读写请求。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------------- | --------------------------------- | ---- | ------------------------ |
| serverResponse | [ServerResponse](#serverresponse) | 是 | server端回复的响应数据。 |
**返回值：**
| | |
| -------- | -------- |
| ------- | ------------------------------------------- |
| 类型 | 说明 |
| boolean | 回复响应操作，成功返回true，否则返回false。 |
......@@ -1830,7 +1827,7 @@ server端订阅特征值读请求事件。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------ |
| type | string | 是 | 填写"characteristicRead"字符串，表示特征值读请求事件。 |
| callback | Callback&lt;[CharacteristicReadReq](#characteristicreadreq)&gt; | 是 | 表示回调函数的入参，client端发送的读请求数据。 |
......@@ -1878,7 +1875,7 @@ server端取消订阅特征值读请求事件。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 填写"characteristicRead"字符串，表示特征值读请求事件。 |
| callback | Callback&lt;[CharacteristicReadReq](#characteristicreadreq)&gt; | 否 | 表示取消订阅特征值读请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
......@@ -1907,7 +1904,7 @@ server端订阅特征值写请求事件。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------- |
| type | string | 是 | 填写"characteristicWrite"字符串，表示特征值写请求事件。 |
| callback | Callback&lt;[DescriptorWriteReq](#descriptorwritereq)&gt; | 是 | 表示回调函数的入参，client端发送的写请求数据。 |
......@@ -1958,7 +1955,7 @@ server端取消订阅特征值写请求事件。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 填写"characteristicWrite"字符串，表示特征值写请求事件。 |
| callback | Callback&lt;[CharacteristicWriteReq](#characteristicwritereq)&gt; | 否 | 表示取消订阅特征值写请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
......@@ -1987,7 +1984,7 @@ server端订阅描述符读请求事件。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------------------------------------------------------- | ---- | -------------------------------------------------- |
| type | string | 是 | 填写"descriptorRead"字符串，表示描述符读请求事件。 |
| callback | Callback&lt;[DescriptorReadReq](#descriptorreadreq)&gt; | 是 | 表示回调函数的入参，client端发送的读请求数据。 |
......@@ -2035,7 +2032,7 @@ server端取消订阅描述符读请求事件。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 填写"descriptorRead"字符串，表示描述符读请求事件。 |
| callback | Callback&lt;[DescriptorReadReq](#descriptorreadreq)&gt; | 否 | 表示取消订阅描述符读请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
......@@ -2064,7 +2061,7 @@ server端订阅描述符写请求事件。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | --------------------------------------------------------- | ---- | --------------------------------------------------- |
| type | string | 是 | 填写"descriptorWrite"字符串，表示描述符写请求事件。 |
| callback | Callback&lt;[DescriptorWriteReq](#descriptorwritereq)&gt; | 是 | 表示回调函数的入参，client端发送的写请求数据。 |
......@@ -2115,9 +2112,9 @@ server端取消订阅描述符写请求事件。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 填写"descriptorWrite"字符串，表示描述符写请求事件。 |
| callback | Callback&lt;[DescriptorWriteReq](#descriptorwritereq)&gt; | 否 | 表示取消订阅描述符读请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
| callback | Callback&lt;[DescriptorWriteReq](#descriptorwritereq)&gt; | 否 | 表示取消订阅描述符写请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
**返回值：**
......@@ -2144,7 +2141,7 @@ server端订阅BLE连接状态变化事件。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------------------------------------------------------------ | ---- | --------------------------------------------------------- |
| type | string | 是 | 填写"connectStateChange"字符串，表示BLE连接状态变化事件。 |
| callback | Callback&lt;[BLEConnectChangedState](#bleconnectchangedstate)&gt; | 是 | 表示回调函数的入参，连接状态。 |
......@@ -2178,7 +2175,7 @@ server端取消订阅BLE连接状态变化事件。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 填写"connectStateChange"字符串，表示BLE连接状态变化事件。 |
| callback | Callback&lt;[BLEConnectChangedState](#bleconnectchangedstate)&gt; | 否 | 表示取消订阅BLE连接状态变化事件。不填该参数则取消订阅该type对应的所有回调。 |
......@@ -2212,7 +2209,7 @@ client端发起连接远端蓝牙低功耗设备。
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------- | ----------------------------------------- |
| boolean | 连接操作成功返回true，操作失败返回false。 |
**示例：**
......@@ -2236,8 +2233,8 @@ client端断开与远端蓝牙低功耗设备的连接。
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 连接操作，成功返回true，操作失败返回false。 |
| ------- | ----------------------------------------------- |
| boolean | 断开连接操作，成功返回true，操作失败返回false。 |
**示例：**
......@@ -2260,7 +2257,7 @@ close(): boolean
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------- | ------------------------------------------- |
| boolean | 关闭操作，成功返回true，操作失败返回false。 |
**示例：**
......@@ -2286,7 +2283,7 @@ client端获取蓝牙低功耗设备的所有服务，即服务发现 。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------ |
| callback | AsyncCallback&lt;Array&lt;[GattService](#gattservice)&gt;&gt; | 是 | client进行服务发现，通过注册回调函数获取。 |
**返回值：**
......@@ -2330,7 +2327,7 @@ client端获取蓝牙低功耗设备的所有服务，即服务发现。
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------------------------------------------------------- | ----------------------------------------- |
| Promise&lt;Array&lt;[GattService](#gattservice)&gt;&gt; | client进行服务发现，通过promise形式获取。 |
**示例：**
......@@ -2361,7 +2358,7 @@ client端读取蓝牙低功耗设备特定服务的特征值。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------------- | ------------------------------------------------------------ | ---- | ---------------------------------------- |
| characteristic | [BLECharacteristic](#blecharacteristic) | 是 | 待读取的特征值。 |
| callback | AsyncCallback&lt;[BLECharacteristic](#blecharacteristic)&gt; | 是 | client读取特征值，通过注册回调函数获取。 |
......@@ -2415,13 +2412,13 @@ client端读取蓝牙低功耗设备特定服务的特征值。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------------- | --------------------------------------- | ---- | ---------------- |
| characteristic | [BLECharacteristic](#blecharacteristic) | 是 | 待读取的特征值。 |
**返回值：**
| | |
| -------- | -------- |
| ------------------------------------------------------ | --------------------------------------- |
| 类型 | 说明 |
| Promise&lt;[BLECharacteristic](#blecharacteristic)&gt; | client读取特征值，通过promise形式获取。 |
......@@ -2462,7 +2459,7 @@ client端读取蓝牙低功耗设备特定的特征包含的描述符。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ---------- | ------------------------------------------------------------ | ---- | ---------------------------------------- |
| descriptor | [BLEDescriptor](#bledescriptor) | 是 | 待读取的描述符。 |
| callback | AsyncCallback&lt;[BLECharacteristic](#blecharacteristic)&gt; | 是 | client读取描述符，通过注册回调函数获取。 |
......@@ -2506,13 +2503,13 @@ client端读取蓝牙低功耗设备特定的特征包含的描述符。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ---------- | ------------------------------- | ---- | ---------------- |
| descriptor | [BLEDescriptor](#bledescriptor) | 是 | 待读取的描述符。 |
**返回值：**
| | |
| -------- | -------- |
| ---------------------------------------------- | --------------------------------------- |
| 类型 | 说明 |
| Promise&lt;[BLEDescriptor](#bledescriptor)&gt; | client读取描述符，通过promise形式获取。 |
......@@ -2543,13 +2540,13 @@ client端向低功耗蓝牙设备写入特定的特征值。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------------- | --------------------------------------- | ---- | -------------------------------------- |
| characteristic | [BLECharacteristic](#blecharacteristic) | 是 | 蓝牙设备特征对应的二进制值及其它参数。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------- | --------------------------------------------- |
| boolean | 写特征值操作成功返回true，操作失败返回false。 |
**示例：**
......@@ -2593,13 +2590,13 @@ client端向低功耗蓝牙设备特定的描述符写入二进制数据。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ---------- | ------------------------------- | ---- | ------------------------------------ |
| descriptor | [BLEDescriptor](#bledescriptor) | 是 | 蓝牙设备描述符的二进制值及其它参数。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------- | --------------------------------------------- |
| boolean | 写描述符操作成功返回true，操作失败返回false。 |
**示例：**
......@@ -2634,13 +2631,13 @@ client协商远端蓝牙低功耗设备的最大传输单元（Maximum Transmiss
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------ | ------ | ---- | ---------------------- |
| mtu | number | 是 | 设置范围为22~512字节。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------- | -------------------------------------------- |
| boolean | MTU协商操作成功返回true，操作失败返回false。 |
**示例：**
......@@ -2664,14 +2661,14 @@ setNotifyCharacteristicChanged(characteristic: BLECharacteristic, enable: boolea
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------------- | --------------------------------------- | ---- | ------------------------------------------- |
| characteristic | [BLECharacteristic](#blecharacteristic) | 是 | 蓝牙低功耗特征。 |
| enable | boolean | 是 | 启用接收notify设置为true，否则设置为false。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------- | ----------------------------------------- |
| boolean | 设置操作成功返回true，操作失败返回false。 |
**示例：**
......@@ -2695,7 +2692,7 @@ on(type: "BLECharacteristicChange", callback: Callback&lt;BLECharacteristic&gt;)
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------------------------------------------------------- | ---- | --------------------------------------------------------- |
| type | string | 是 | 填写"BLECharacteristicChange"字符串，表示特征值变化事件。 |
| callback | Callback&lt;[BLECharacteristic](#blecharacteristic)&gt; | 是 | 表示蓝牙低功耗设备的特征值变化事件的回调函数。 |
......@@ -2729,7 +2726,7 @@ off(type: "BLECharacteristicChange", callback?: Callback&lt;BLECharacteristic&gt
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 填写"BLECharacteristicChange"字符串，表示特征值变化事件。 |
| callback | Callback&lt;[BLECharacteristic](#blecharacteristic)&gt; | 否 | 表示取消订阅蓝牙低功耗设备的特征值变化事件。不填该参数则取消订阅该type对应的所有回调。 |
......@@ -2758,7 +2755,7 @@ client端订阅蓝牙低功耗设备的连接状态变化事件。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 填写"BLEConnectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback&lt;[BLEConnectChangedState](#bleconnectchangedstate)&gt; | 是 | 表示连接状态，已连接或断开。 |
......@@ -2791,7 +2788,7 @@ off(type: "BLEConnectionStateChange", callback?: Callback&lt;BLEConnectChangedSt
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 填写"BLEConnectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback&lt;[BLEConnectChangedState](#bleconnectchangedstate)&gt; | 否 | 表示取消订阅蓝牙低功耗设备的连接状态变化事件。不填该参数则取消订阅该type对应的所有回调。 |
......@@ -2820,7 +2817,7 @@ client获取远端蓝牙低功耗设备名。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | --------------------------- | ---- | -------------------------------------------------- |
| callback | AsyncCallback&lt;string&gt; | 是 | client获取对端server设备名，通过注册回调函数获取。 |
**返回值：**
......@@ -2852,7 +2849,7 @@ client获取远端蓝牙低功耗设备名。
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| --------------------- | ------------------------------------------------- |
| Promise&lt;string&gt; | client获取对端server设备名，通过promise形式获取。 |
**示例：**
......@@ -2880,7 +2877,7 @@ client获取远端蓝牙低功耗设备的信号强度 (Received Signal Strength
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | --------------------------- | ---- | --------------------------------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 返回信号强度，单位&nbsp;dBm，通过注册回调函数获取。 |
**返回值：**
......@@ -2913,7 +2910,7 @@ client获取远端蓝牙低功耗设备的信号强度 (Received Signal Strength
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| --------------------- | -------------------------------------------------- |
| Promise&lt;number&gt; | 返回信号强度，单位&nbsp;dBm，通过promise形式获取。 |
**示例：**
......@@ -2933,7 +2930,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| ------------------------------------------ | ------ | ----------------------- |
| SCAN_MODE_NONE | 0 | 没有扫描模式。 |
| SCAN_MODE_CONNECTABLE | 1 | 可连接扫描模式。 |
| SCAN_MODE_GENERAL_DISCOVERABLE | 2 | general发现模式。 |
......@@ -2948,7 +2945,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| ------------------ | ------ | ------------ |
| BOND_STATE_INVALID | 0 | 无效的配对。 |
| BOND_STATE_BONDING | 1 | 正在配对。 |
| BOND_STATE_BONDED | 2 | 已配对。 |
......@@ -2961,7 +2958,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ------ | ------------------- | ---- | ---- | ---------------- |
| uuid | string | 是 | 是 | spp单据的uuid。 |
| secure | boolean | 是 | 是 | 是否是安全通道。 |
| type | [SppType](#spptype) | 是 | 是 | Spp链路类型。 |
......@@ -2974,7 +2971,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| ---------- | ------ | -------------------- |
| SPP_RFCOMM | 0 | 表示rfcomm链路类型。 |
......@@ -2985,7 +2982,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| --------------- | ---------------------------------------------------- | ---- | ---- | ------------------------------------------------------------ |
| serviceUuid | string | 是 | 是 | 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| isPrimary | boolean | 是 | 是 | 如果是主服务设置为true，否则设置为false。 |
| characteristics | Array&lt;[BLECharacteristic](#blecharacteristic)&gt; | 是 | 是 | 当前服务包含的特征列表。 |
......@@ -2999,7 +2996,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ------------------- | -------------------------------------------- | ---- | ---- | ------------------------------------------------------------ |
| serviceUuid | string | 是 | 是 | 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| characteristicUuid | string | 是 | 是 | 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| characteristicValue | ArrayBuffer | 是 | 是 | 特征对应的二进制值。 |
......@@ -3013,7 +3010,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ------------------ | ----------- | ---- | ---- | ------------------------------------------------------------ |
| serviceUuid | string | 是 | 是 | 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| characteristicUuid | string | 是 | 是 | 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| descriptorUuid | string | 是 | 是 | 描述符（descriptor）的UUID，例如：00002902-0000-1000-8000-00805f9b34fb。 |
......@@ -3027,7 +3024,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ------------------- | ----------- | ---- | ---- | ------------------------------------------------------------ |
| serviceUuid | string | 是 | 是 | 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| characteristicUuid | string | 是 | 是 | 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| characteristicValue | ArrayBuffer | 是 | 是 | 特征对应的二进制值。 |
......@@ -3041,7 +3038,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ------------------ | -------- | ---- | ---- | ------------------------------------------------------------ |
| deviceId | string | 是 | 否 | 表示发送特征值读请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| transId | number | 是 | 否 | 表示读请求的传输ID，server端回复响应时需填写相同的传输ID。 |
| offset | number | 是 | 否 | 表示读特征值数据的起始位置。例如：k表示从第k个字节开始读，server端回复响应时需填写相同的offset。 |
......@@ -3056,7 +3053,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ------------------ | -------- | ---- | ---- | ------------------------------------------------------------ |
| deviceId | string | 是 | 否 | 表示发送特征值写请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| transId | number | 是 | 否 | 表示写请求的传输ID，server端回复响应时需填写相同的传输ID。 |
| offset | number | 是 | 否 | 表示写特征值数据的起始位置。例如：k表示从第k个字节开始写，server端回复响应时需填写相同的offset。 |
......@@ -3072,7 +3069,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ------------------ | -------- | ---- | ---- | ------------------------------------------------------------ |
| deviceId | string | 是 | 否 | 表示发送描述符读请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| transId | number | 是 | 否 | 表示读请求的传输ID，server端回复响应时需填写相同的传输ID。 |
| offset | number | 是 | 否 | 表示读描述符数据的起始位置。例如：k表示从第k个字节开始读，server端回复响应时需填写相同的offset。 |
......@@ -3088,7 +3085,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ------------------ | ----------- | ---- | ---- | ------------------------------------------------------------ |
| deviceId | string | 是 | 否 | 表示发送描述符写请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| transId | number | 是 | 否 | 表示写请求的传输ID，server端回复响应时需填写相同的传输ID。 |
| offset | number | 是 | 否 | 表示写描述符数据的起始位置。例如：k表示从第k个字节开始写，server端回复响应时需填写相同的offset。 |
......@@ -3107,7 +3104,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| -------- | ----------- | ---- | ---- | ------------------------------------------------------------ |
| deviceId | string | 是 | 否 | 表示远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| transId | number | 是 | 否 | 表示请求的传输ID，与订阅的读/写请求事件携带的ID保持一致。 |
| status | number | 是 | 否 | 表示响应的状态，设置为0即可，表示正常。 |
......@@ -3122,7 +3119,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| -------- | ------------------------------------------------- | ---- | ---- | --------------------------------------------- |
| deviceId | string | 是 | 否 | 表示远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| state | [ProfileConnectionState](#profileconnectionState) | 是 | 是 | 表示BLE连接状态的枚举。 |
......@@ -3134,7 +3131,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| ------------------- | ------ | --------------------- |
| STATE_DISCONNECTED | 0 | 表示profile已断连。 |
| STATE_CONNECTING | 1 | 表示profile正在连接。 |
| STATE_CONNECTED | 2 | 表示profile已连接。 |
......@@ -3148,7 +3145,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ----------- | -------- | ---- | ---- | ------------------------------------------------------------ |
| deviceId | string | 是 | 是 | 表示过滤的BLE设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| name | string | 是 | 是 | 表示过滤的BLE设备名。 |
| serviceUuid | string | 是 | 是 | 表示过滤包含该UUID服务的设备，例如：00001888-0000-1000-8000-00805f9b34fb。 |
......@@ -3161,7 +3158,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| --------- | ----------------------- | ---- | ---- | ------------------------------------------------------- |
| interval | number | 是 | 是 | 表示扫描结果上报延迟时间，默认值为0。 |
| dutyMode | [ScanDuty](#scanduty) | 是 | 是 | 表示扫描模式，默认值为SCAN_MODE_LOW_POWER。 |
| matchMode | [MatchMode](#matchmode) | 是 | 是 | 表示硬件的过滤匹配模式，默认值为MATCH_MODE_AGGRESSIVE。 |
......@@ -3174,7 +3171,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| --------------------- | ------ | ------------------------ |
| SCAN_MODE_LOW_POWER | 0 | 表示低功耗模式，默认值。 |
| SCAN_MODE_BALANCED | 1 | 表示均衡模式。 |
| SCAN_MODE_LOW_LATENCY | 2 | 表示低延迟模式。 |
......@@ -3187,7 +3184,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| --------------------- | ------ | ------------------------------------------------------------ |
| MATCH_MODE_AGGRESSIVE | 1 | 表示硬件上报扫描结果门限较低，比如扫描到的功率较低或者一段时间扫描到的次数较少也触发上报，默认值。 |
| MATCH_MODE_STICKY | 2 | 表示硬件上报扫描结果门限较高，更高的功率门限以及扫描到多次才会上报。 |
......@@ -3199,7 +3196,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| -------- | ----------- | ---- | ---- | ------------------------------------------------- |
| deviceId | string | 是 | 否 | 表示扫描到的设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| rssi | number | 是 | 否 | 表示扫描到的设备的rssi值。 |
| data | ArrayBuffer | 是 | 否 | 表示扫描到的设备发送的广播包。 |
......@@ -3212,7 +3209,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| --------------------- | ------ | ----------------------------- |
| STATE_OFF | 0 | 表示蓝牙已关闭。 |
| STATE_TURNING_ON | 1 | 表示蓝牙正在打开。 |
| STATE_ON | 2 | 表示蓝牙已打开。 |
......@@ -3229,7 +3226,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ----------- | -------- | ---- | ---- | ------------------------------------------------------------ |
| interval | number | 是 | 是 | 表示广播间隔，最小值设置32个slot表示20ms，最大值设置16777215个slot，默认值设置为1600个slot表示1s。 |
| txPower | number | 是 | 是 | 表示发送功率，最小值设置-127，最大值设置1，默认值设置-7，单位dbm。 |
| connectable | boolean | 是 | 是 | 表示是否是可连接广播，默认值设置为true。 |
......@@ -3242,7 +3239,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| --------------- | ------------------------------------------------ | ---- | ---- | -------------------------------------- |
| serviceUuids | Array&lt;string&gt; | 是 | 是 | 表示要广播的服务&nbsp;UUID&nbsp;列表。 |
| manufactureData | Array&lt;[ManufactureData](#manufacturedata)&gt; | 是 | 是 | 表示要广播的广播的制造商信息列表。 |
| serviceData | Array&lt;[ServiceData](#servicedata)&gt; | 是 | 是 | 表示要广播的服务数据列表。 |
......@@ -3255,7 +3252,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ---------------- | ------------------- | ---- | ---- | ------------------------------- |
| manufactureId | Array&lt;string&gt; | 是 | 是 | 表示制造商的ID，由蓝牙SIG分配。 |
| manufactureValue | ArrayBuffer | 是 | 是 | 表示制造商发送的制造商数据。 |
......@@ -3267,7 +3264,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ------------ | ----------- | ---- | ---- | ---------------- |
| serviceUuid | string | 是 | 是 | 表示服务的UUID。 |
| serviceValue | ArrayBuffer | 是 | 是 | 表示服务数据。 |
......@@ -3279,7 +3276,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | ---- | ---- | -------------------- |
| deviceId | string | 是 | 否 | 表示要配对的设备ID。 |
| pinCode | string | 是 | 否 | 表示要配对的密钥。 |
......@@ -3291,7 +3288,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| -------- | ------------------------------------------------- | ---- | ---- | ------------------------------- |
| deviceId | string | 是 | 否 | 表示蓝牙设备地址。 |
| state | [ProfileConnectionState](#ProfileConnectionState) | 是 | 否 | 表示蓝牙设备的profile连接状态。 |
......@@ -3303,7 +3300,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| --------------- | ----------------------------------- | ---- | ---- | -------------------------------- |
| majorClass | [MajorClass](#majorclass) | 是 | 否 | 表示蓝牙设备主要类别的枚举。 |
| majorMinorClass | [MajorMinorClass](#majorminorclass) | 是 | 否 | 表示主要次要蓝牙设备类别的枚举。 |
| classOfDevice | number | 是 | 否 | 表示设备类别。 |
......@@ -3317,7 +3314,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| ------------------- | ------ | -------------------- |
| MAJOR_MISC | 0x0000 | 表示杂项设备。 |
| MAJOR_COMPUTER | 0x0100 | 表示计算机设备。 |
| MAJOR_PHONE | 0x0200 | 表示手机设备。 |
......@@ -3338,7 +3335,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| ----------------------------------------- | ------ | ------------------------------ |
| COMPUTER_UNCATEGORIZED | 0x0100 | 表示未分类计算机设备。 |
| COMPUTER_DESKTOP | 0x0104 | 表示台式计算机设备。 |
| COMPUTER_SERVER | 0x0108 | 表示服务器设备。 |
......@@ -3360,7 +3357,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
| NETWORK_60_TO_67_UTILIZED | 0x0380 | 表示使用网络60到67设备。 |
| NETWORK_67_TO_83_UTILIZED | 0x03A0 | 表示使用网络67到83设备。 |
| NETWORK_83_TO_99_UTILIZED | 0x03C0 | 表示使用网络83到99设备。 |
| NETWORK_NO_SERVICE | 0x03E0 | 表示网络无服务设备。
| NETWORK_NO_SERVICE | 0x03E0 | 表示网络无服务设备。 |
| AUDIO_VIDEO_UNCATEGORIZED | 0x0400 | 表示未分类音频视频设备。 |
| AUDIO_VIDEO_WEARABLE_HEADSET | 0x0404 | 表示可穿戴式音频视频设备。 |
| AUDIO_VIDEO_HANDSFREE | 0x0408 | 表示免提音频视频设备。 |
......@@ -3371,7 +3368,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
| AUDIO_VIDEO_CAR_AUDIO | 0x0420 | 表示汽车音频视频设备。 |
| AUDIO_VIDEO_SET_TOP_BOX | 0x0424 | 表示机顶盒音频视频设备。 |
| AUDIO_VIDEO_HIFI_AUDIO | 0x0428 | 表示高保真音响设备。 |
| AUDIO_VIDEO_VCR| 0x042C | 表示录像机音频视频设备。 |
| AUDIO_VIDEO_VCR | 0x042C | 表示录像机音频视频设备。 |
| AUDIO_VIDEO_VIDEO_CAMERA | 0x0430 | 表示照相机音频视频设备。 |
| AUDIO_VIDEO_CAMCORDER | 0x0434 | 表示摄像机音频视频设备。 |
| AUDIO_VIDEO_VIDEO_MONITOR | 0x0438 | 表示监视器音频视频设备。 |
......@@ -3381,7 +3378,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
| PERIPHERAL_NON_KEYBOARD_NON_POINTING | 0x0500 | 表示非键盘非指向外围设备。 |
| PERIPHERAL_KEYBOARD | 0x0540 | 表示外设键盘设备。 |
| PERIPHERAL_POINTING_DEVICE | 0x0580 | 表示定点装置外围设备。 |
| PERIPHERAL_KEYBOARD_POINTING| 0x05C0 | 表示键盘指向外围设备。 |
| PERIPHERAL_KEYBOARD_POINTING | 0x05C0 | 表示键盘指向外围设备。 |
| PERIPHERAL_UNCATEGORIZED | 0x0500 | 表示未分类外围设备。 |
| PERIPHERAL_JOYSTICK | 0x0504 | 表示周边操纵杆设备。 |
| PERIPHERAL_GAMEPAD | 0x0508 | 表示周边游戏板设备。 |
......@@ -3404,7 +3401,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
| WEARABLE_HELMET | 0x0710 | 表示可穿戴头盔设备。 |
| WEARABLE_GLASSES | 0x0714 | 表示可穿戴眼镜设备。 |
| TOY_UNCATEGORIZED | 0x0800 | 表示未分类的玩具设备。 |
| TOY_ROBOT| 0x0804 | 表示玩具机器人设备。 |
| TOY_ROBOT | 0x0804 | 表示玩具机器人设备。 |
| TOY_VEHICLE | 0x0808 | 表示玩具车设备。 |
| TOY_DOLL_ACTION_FIGURE | 0x080C | 表示人形娃娃玩具设备。 |
| TOY_CONTROLLER | 0x0810 | 表示玩具控制器设备。 |
......@@ -3434,7 +3431,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| ----------------- | ------ | -------------- |
| STATE_NOT_PLAYING | 0x0000 | 表示未播放。 |
| STATE_PLAYING | 0x0001 | 表示正在播放。 |
......@@ -3446,6 +3443,6 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| -------------------------------- | ------ | ------------------ |
| PROFILE_A2DP_SOURCE | 0x0001 | 表示A2DP profile。 |
| PROFILE_HANDS_FREE_AUDIO_GATEWAY | 0x0004 | 表示HFP profile。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-osAccount.md
浏览文件 @ aa045e6b
......@@ -483,7 +483,7 @@ removeOsAccount(localId: number): Promise&lt;void&gt;
setOsAccountConstraints(localId: number, constraints: Array&lt;string&gt;, enable: boolean,callback: AsyncCallback&lt;void&gt;): void
为指定系统帐号设置/删除约束返回结果。
为指定系统帐号设置/删除约束，使用callback回调异步返回结果。
此接口为系统接口，三方应用不支持调用。
......@@ -514,7 +514,7 @@ setOsAccountConstraints(localId: number, constraints: Array&lt;string&gt;, enabl
setOsAccountConstraints(localId: number, constraints: Array&lt;string&gt;, enable: boolean): Promise&lt;void&gt;
为指定系统帐号设置/删除约束回结果。
为指定系统帐号设置/删除约束，使用Promise方式异步返回结果。
此接口为系统接口，三方应用不支持调用。
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或