• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.bluetooth.hfp (Bluetooth HFP Module)
2
3The **hfp** module provides APIs for using the Bluetooth Hands-Free Profile (HFP).
4
5> **NOTE**
6>
7> The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.
8
9
10
11## Modules to Import
12
13```js
14import { hfp } from '@kit.ConnectivityKit';
15```
16
17
18## BaseProfile
19
20type BaseProfile = baseProfile.BaseProfile
21
22**BaseProfile** API definition.
23
24**System capability**: SystemCapability.Communication.Bluetooth.Core
25
26| Type                           | Description        |
27| ----------------------------- | ---------- |
28| [baseProfile.BaseProfile](js-apis-bluetooth-baseProfile.md#baseprofile) | **BaseProfile** API definition.|
29
30
31## hfp.createHfpAgProfile
32
33createHfpAgProfile(): HandsFreeAudioGatewayProfile
34
35Creates an **HfpAgProfile** instance.
36
37**System capability**: SystemCapability.Communication.Bluetooth.Core
38
39**Return value**
40
41| Type                           | Description        |
42| ----------------------------- | ---------- |
43| HandsFreeAudioGatewayProfile | **HfpAgProfile** instance created.|
44
45**Error codes**
46
47For details about the error codes, see [Universal Error Codes](../errorcode-universal.md).
48
49| ID| Error Message|
50| -------- | ---------------------------- |
51|401 | Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.                 |
52|801 | Capability not supported.          |
53
54**Example**
55
56```js
57import { AsyncCallback, BusinessError } from '@kit.BasicServicesKit';
58try {
59    let hfpAgProfile = hfp.createHfpAgProfile();
60    console.info('hfpAg success');
61} catch (err) {
62    console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
63}
64```
65
66
67## HandsFreeAudioGatewayProfile
68
69Before using any API of **HandsFreeAudioGatewayProfile**, you need to create an instance of this class by using [createHfpAgProfile()](#hfpcreatehfpagprofile).
70