• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.bluetooth.hfp (蓝牙hfp模块)
2
3<!--Kit: Connectivity Kit-->
4<!--Subsystem: Communication-->
5<!--Owner: @enjoy_sunshine-->
6<!--Designer: @chengguohong; @tangjia15-->
7<!--Tester: @wangfeng517-->
8<!--Adviser: @zhang_yixin13-->
9
10本模块提供基于免提协议（Hands-Free Profile， [HFP](../../connectivity/terminology.md#hfp)）的蓝牙通话音频能力，支持获取连接状态等方法。
11
12> **说明：**
13>
14> 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
15
16## 导入模块
17
18```js
19import { hfp } from '@kit.ConnectivityKit';
20```
21
22## BaseProfile
23
24type BaseProfile = baseProfile.BaseProfile
25
26基础Profile接口定义，提供订阅和获取连接状态等公共能力。
27
28**系统能力**：SystemCapability.Communication.Bluetooth.Core
29
30| 类型                            | 说明         |
31| ----------------------------- | ---------- |
32| [baseProfile.BaseProfile](js-apis-bluetooth-baseProfile.md#baseprofile) | 基础Profile接口定义。 |
33
34## hfp.createHfpAgProfile
35
36createHfpAgProfile(): HandsFreeAudioGatewayProfile
37
38创建蓝牙通话音频中的[HFP AG](../../connectivity/terminology.md#hfp-ag)实例。通过该实例可使用本端作为HFP AG设备的接口，如：获取和其他设备间的蓝牙通话音频连接状态。
39
40**系统能力**：SystemCapability.Communication.Bluetooth.Core
41
42**返回值：**
43
44| 类型                            | 说明         |
45| ----------------------------- | ---------- |
46| [HandsFreeAudioGatewayProfile](#handsfreeaudiogatewayprofile) | 返回HFP AG实例。 |
47
48**错误码**：
49
50以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
51
52| 错误码ID | 错误信息 |
53| -------- | ---------------------------- |
54|401 | Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.                 |
55|801 | Capability not supported.          |
56
57**示例：**
58
59```js
60import { BusinessError } from '@kit.BasicServicesKit';
61
62try {
63    let hfpAgProfile = hfp.createHfpAgProfile();
64    console.info('hfpAg success');
65} catch (err) {
66    console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
67}
68```
69
70## HandsFreeAudioGatewayProfile
71
72该实例表示蓝牙通话音频中的[HFP AG](../../connectivity/terminology.md#hfp-ag)角色‌。
73- 该类继承于[BaseProfile](#baseprofile)，因此可以使用其父类中的方法。
74- 使用该类的接口前，需通过[createHfpAgProfile](#hfpcreatehfpagprofile)接口构造该类的实例。
75- 和该实例角色相对应的是[HF](../../connectivity/terminology.md#hf)角色。
76