@ohos.bluetooth.hfp (Bluetooth HFP Module)

The hfp module provides APIs for using the Bluetooth Hands-Free Profile (HFP).

NOTE

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.

Modules to Import

import { hfp } from '@kit.ConnectivityKit';

BaseProfile

type BaseProfile = baseProfile.BaseProfile

BaseProfile API definition.

System capability: SystemCapability.Communication.Bluetooth.Core

Type	Description
baseProfile.BaseProfile	BaseProfile API definition.

hfp.createHfpAgProfile

createHfpAgProfile(): HandsFreeAudioGatewayProfile

Creates an HfpAgProfile instance.

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Type	Description
HandsFreeAudioGatewayProfile	HfpAgProfile instance created.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
801	Capability not supported.

Example

import { AsyncCallback, BusinessError } from '@kit.BasicServicesKit';
try {
    let hfpAgProfile = hfp.createHfpAgProfile();
    console.info('hfpAg success');
} catch (err) {
    console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
}