MT2523 API Reference  LinkIt SDK v4
Define

This section defines the HFP events and error codes. More...

Overview

This section defines the HFP events and error codes.

Macros

#define BT_HFP_INVALID_HANDLE   0
 The event report to user. More...
 
#define BT_HFP_PHONE_NUMBER_MAX_LEN   64
 The maximum length of a phone number. More...
 
#define BT_HFP_SLC_CONNECTING_IND   (BT_MODULE_HFP | 0x002)
 The SLC Connecting Indication event is triggered while the SLC is connecting with the bt_hfp_slc_connecting_ind_t payload. More...
 
#define BT_HFP_SLC_CONNECTED_IND   (BT_MODULE_HFP | 0x003)
 The SLC Connected Indication event is triggered once the SLC is connected with the bt_hfp_slc_connected_ind_t payload. More...
 
#define BT_HFP_CONNECT_REQUEST_IND   (BT_MODULE_HFP | 0x004)
 The HFP Connect Request Indication event is triggered when AG attempts to connect with HF with the bt_hfp_connect_request_ind_t payload. More...
 
#define BT_HFP_DISCONNECT_IND   (BT_MODULE_HFP | 0x005)
 The HFP Disconnected Indication is triggered when RFCOMM link is disconnected with the bt_hfp_disconnect_ind_t payload. More...
 
#define BT_HFP_AUDIO_CONNECT_IND   (BT_MODULE_HFP | 0x006)
 The HFP Audio Connected Indication is triggered when the audio connection is connected with the bt_hfp_audio_connect_ind_t payload. More...
 
#define BT_HFP_AUDIO_DISCONNECT_IND   (BT_MODULE_HFP | 0x007)
 The HFP Audio Disconnected Indication is triggered when the audio connection is disconnected with the bt_hfp_audio_disconnect_ind_t payload. More...
 
#define BT_HFP_BRSF_FEATURES_IND   (BT_MODULE_HFP | 0x008)
 The BRSF Feature Indication is triggered when the AG supported features are fetched with the bt_hfp_feature_ind_t payload. More...
 
#define BT_HFP_CALL_HOLD_FEATURES_IND   (BT_MODULE_HFP | 0x009)
 The Call Hold Features Indication is triggered when fetching the call hold actions that AG supports with the bt_hfp_hold_feature_ind_t payload. More...
 
#define BT_HFP_CIEV_CALL_SETUP_IND   (BT_MODULE_HFP | 0x00a)
 The Call Setup Indication is triggered when the call setup status is changed with the bt_hfp_call_setup_ind_t payload. More...
 
#define BT_HFP_CIEV_CALL_IND   (BT_MODULE_HFP | 0x00b)
 The Call Indication is triggered when the call status is changed with the bt_hfp_call_ind_t payload. More...
 
#define BT_HFP_CIEV_CALL_HOLD_IND   (BT_MODULE_HFP | 0x00c)
 The Call Hold Indication is triggered when the call hold status is changed with the bt_hfp_call_hold_ind_t payload. More...
 
#define BT_HFP_CIEV_SERVICE_IND   (BT_MODULE_HFP | 0x00d)
 The Service Indication is triggered when the service status is changed with the bt_hfp_service_ind_t payload. More...
 
#define BT_HFP_CIEV_SIGNAL_IND   (BT_MODULE_HFP | 0x00e)
 The Signal Indication is triggered when the signal value is changed with the bt_hfp_signal_ind_t payload. More...
 
#define BT_HFP_CIEV_ROAMING_IND   (BT_MODULE_HFP | 0x00f)
 The Roaming Indication is triggered when the roaming status is changed with the bt_hfp_roaming_ind_t payload. More...
 
#define BT_HFP_CIEV_BATTCHG_IND   (BT_MODULE_HFP | 0x010)
 The Battery Changed Indication is triggered when the battery level is changed with the bt_hfp_battery_ind_t payload. More...
 
#define BT_HFP_RING_IND   (BT_MODULE_HFP | 0x011)
 The Ring Indication is triggered when the AG is ringing with the bt_hfp_ring_ind_t payload. More...
 
#define BT_HFP_CALL_WAITING_IND   (BT_MODULE_HFP | 0x012)
 The Call Waiting Indication with the waiting call information is triggered when the AG gets the waiting call with the bt_hfp_call_waiting_ind_t payload. More...
 
#define BT_HFP_CALLER_ID_IND   (BT_MODULE_HFP | 0x013)
 The Caller Indication with the caller information is triggered when the AG gets an incoming call with the bt_hfp_caller_id_ind_t payload. More...
 
#define BT_HFP_CURRENT_CALLS_IND   (BT_MODULE_HFP | 0x014)
 The Current Calls Indication with the current call's details is triggered when the HF has queried current calls with the bt_hfp_call_list_ind_t payload. More...
 
#define BT_HFP_VOICE_RECOGNITION_IND   (BT_MODULE_HFP | 0x015)
 The Voice Recognition Indication is triggered when the voice recognition status is changed with the bt_hfp_voice_recognition_ind_t payload. More...
 
#define BT_HFP_VOLUME_SYNC_SPEAKER_GAIN_IND   (BT_MODULE_HFP | 0x016)
 The Volume Sync Speaker Indication is triggered when the value of remote speaker volume is changed with the bt_hfp_volume_sync_speaker_gain_ind_t payload. More...
 
#define BT_HFP_VOLUME_SYNC_MIC_GAIN_IND   (BT_MODULE_HFP | 0x017)
 The Volume Sync Microphone Indication is triggered when the value of remote microphone volume is changed with the bt_hfp_volume_sync_mic_gain_ind_t payload. More...
 
#define BT_HFP_IN_BAND_RING_IND   (BT_MODULE_HFP | 0x018)
 The In Band Ring Indication is triggered when in-band ring feature is changed with the bt_hfp_in_band_ring_status_ind_t payload. More...
 
#define BT_HFP_ACTION_CMD_CNF   (BT_MODULE_HFP | 0x019)
 The HFP Action Command Confirmation is triggered when the AG responds to the command request with the bt_hfp_action_cnf_t payload. More...
 
#define BT_HFP_AUDIO_STATUS_CHANGE_IND   (BT_MODULE_HFP | 0x01a)
 The HFP audio connection status change indication event to indicate the audio connection status has changed with the bt_hfp_audio_status_change_ind_t payload. More...
 
#define BT_HFP_PHONE_NUM_FORMAT_TYPE_UNKNOWN   0x80
 Unknown. More...
 
#define BT_HFP_PHONE_NUM_FORMAT_TYPE_INTERNATIONAL   0x90
 International. More...
 
#define BT_HFP_PHONE_NUM_FORMAT_TYPE_NATIONAL   0xA0
 National. More...
 
#define BT_HFP_PHONE_NUM_FORMAT_TYPE_NETWORK_SPEC   0xB0
 Network specification. More...
 
#define BT_HFP_PHONE_NUM_FORMAT_TYPE_DEDICATED_ACC   0xC0
 Dedicate access, short code. More...
 
#define BT_HFP_PHONE_NUM_FORMAT_PLAN_UNKNOWN   0x00
 Unknown. More...
 
#define BT_HFP_PHONE_NUM_FORMAT_PLAN_ISDN_TELEPHONY   0x01
 ISDN telephony. More...
 
#define BT_HFP_PHONE_NUM_FORMAT_PLAN_DATA_NUMBERING   0x03
 Data numbering. More...
 
#define BT_HFP_PHONE_NUM_FORMAT_PLAN_TELEX_NUMBERING   0x04
 Telex numbering. More...
 
#define BT_HFP_PHONE_NUM_FORMAT_PLAN_NATIONAL   0x08
 National numbering. More...
 
#define BT_HFP_PHONE_NUM_FORMAT_PLAN_PRIVATE   0x09
 Private numbering. More...
 
#define BT_HFP_AUDIO_TO_HF   0x00
 The audio direction to HF. More...
 
#define BT_HFP_AUDIO_TO_AG   0x01
 The audio direction to AG. More...
 
#define BT_HFP_AUDIO_STATUS_INACTIVE   0x00
 Inactive audio connection. More...
 
#define BT_HFP_AUDIO_STATUS_ACTIVE   0x01
 Active audio connection. More...
 
#define BT_HFP_INIT_SUPPORT_3_WAY   0x0010
 Three way calling. More...
 
#define BT_HFP_INIT_SUPPORT_CODEC_NEG   0x0020
 Codec negotiation. More...
 
#define BT_HFP_INIT_SUPPORT_ALL   0x0030
 Both three way calling and codec negotiation. More...
 
#define BT_HFP_INDICATOR_OFF   0x00
 Off. More...
 
#define BT_HFP_INDICATOR_ON   0x01
 On, the default value. More...
 
#define BT_HFP_INDICATOR_IGNORE   0x02
 Ignore. More...
 
#define BT_HFP_CODEC_TYPE_NONE   0x00
 None. More...
 
#define BT_HFP_CODEC_TYPE_CVSD   0x01
 CVSD. More...
 
#define BT_HFP_CODEC_TYPE_MSBC   0X02
 MSBC. More...
 
#define BT_HFP_VERSION_V15   0x01
 The HFP profile version is 1.5. More...
 
#define BT_HFP_VERSION_V16   0x02
 The HFP profile version is 1.6. More...
 
#define BT_HFP_AG_FEATURE_3_WAY   0x0001
 3-way calling. More...
 
#define BT_HFP_AG_FEATURE_ECHO_NOISE   0x0002
 Echo canceling and noise reduction function. More...
 
#define BT_HFP_AG_FEATURE_VOICE_RECOGNITION   0x0004
 Voice recognition function. More...
 
#define BT_HFP_AG_FEATURE_IN_BAND_RING   0x0008
 In-band ring tone. More...
 
#define BT_HFP_AG_FEATURE_VOICE_TAG   0x0010
 Voice tag. More...
 
#define BT_HFP_AG_FEATURE_CALL_REJECT   0x0020
 Reject a call. More...
 
#define BT_HFP_AG_FEATURE_ENHANCED_CALL_STATUS   0x0040
 Enhanced call status. More...
 
#define BT_HFP_AG_FEATURE_ENHANCED_CALL_CTRL   0x0080
 Enhanced call control. More...
 
#define BT_HFP_AG_FEATURE_EXTENDED_ERROR   0x0100
 Extended error. More...
 
#define BT_HFP_AG_FEATURE_CODEC_NEGOTIATION   0x0200
 Codec negotiation. More...
 
#define BT_HFP_AG_HOLD_FEATURE_RELEASE_HELD_CALL   0x01
 Releases all held calls or sets User Determined User Busy for a waiting call. More...
 
#define BT_HFP_AG_HOLD_FEATURE_RELEASE_ACTIVE_CALL   0x02
 Releases all active calls and accepts the other held or waiting call. More...
 
#define BT_HFP_AG_HOLD_FEATURE_RELEASE_SPECIFIC_CALL   0x04
 Releases a specific call. More...
 
#define BT_HFP_AG_HOLD_FEATURE_HOLD_ACTIVE_CALL   0x08
 Places all active calls on hold and accepts the other held or waiting call. More...
 
#define BT_HFP_AG_HOLD_FEATURE_HOLD_SPECIFIC_CALL   0x10
 Places a specific call on hold. More...
 
#define BT_HFP_AG_HOLD_FEATURE_ADD_HELD_CALL   0x20
 Adds a held call to the conversation. More...
 
#define BT_HFP_AG_HOLD_FEATURE_CALL_TRANSFER   0x40
 Connects the two calls and disconnects the AG from both calls. More...
 
#define BT_HFP_CIEV_CALL_STATE_NONE   0x00
 No existing call on the AG. More...
 
#define BT_HFP_CIEV_CALL_STATE_CALL   0x01
 At least one call is active on the AG. More...
 
#define BT_HFP_CIEV_CALL_SETUP_STATE_NONE   0x00
 No outgoing or incoming call is present on the AG. More...
 
#define BT_HFP_CIEV_CALL_SETUP_STATE_INCOMING   0x01
 An incoming call is present on the AG. More...
 
#define BT_HFP_CIEV_CALL_SETUP_STATE_OUTGOING   0x02
 An outgoing call is present on the AG. More...
 
#define BT_HFP_CIEV_CALL_SETUP_STATE_REMOTE_ALERT   0x03
 An outgoing call is being alerted on the AG. More...
 
#define BT_HFP_CIEV_CALL_HOLD_STATE_NONE   0x00
 No call is on hold state. More...
 
#define BT_HFP_CIEV_CALL_HOLD_STATE_SOME   0x01
 Some calls are on hold state. More...
 
#define BT_HFP_CIEV_CALL_HOLD_STATE_ALL   0x02
 All calls are on hold state. More...
 
#define BT_HFP_CALL_STATUS_ACTIVE   0x00
 An existing active call. More...
 
#define BT_HFP_CALL_STATUS_HOLD   0x01
 The call is on hold. More...
 
#define BT_HFP_CALL_STATUS_DIALING   0x02
 An outgoing call. More...
 
#define BT_HFP_CALL_STATUS_ALERTING   0x03
 The remote party is being alerted. More...
 
#define BT_HFP_CALL_STATUS_INCOMING   0x04
 An incoming call. More...
 
#define BT_HFP_CALL_STATUS_WAITING   0x05
 The call is waiting. More...
 
#define BT_HFP_CALL_STATUS_NONE   0x06
 There is no active call. More...
 
#define BT_HFP_CALL_STATUS_UNKNOWN   0x07
 Unknown call state. More...
 
#define BT_HFP_CALL_MODE_VOICE   0x00
 Voice call. More...
 
#define BT_HFP_CALL_MODE_DATA   0x01
 Data call. More...
 
#define BT_HFP_CALL_MODE_FAX   0x02
 FAX call. More...
 

Typedefs

typedef uint8_t bt_hfp_phone_num_format_t
 This structure defines the phone number format.
 
typedef uint8_t bt_hfp_audio_direction_t
 This structure defines the audio direction.
 
typedef uint8_t bt_hfp_audio_status_t
 This structure defines the audio connection status.
 
typedef uint16_t bt_hfp_init_support_feature_t
 This structure defines the supported features to initialize.
 
typedef uint8_t bt_hfp_indicator_status_t
 This structure defines the indicator status.
 
typedef uint8_t bt_hfp_audio_codec_type_t
 This structure defines the HFP codec type.
 
typedef uint8_t bt_hfp_version_t
 This structure defines the HFP profile version.
 
typedef uint16_t bt_hfp_ag_feature_t
 The structure defines the HFP audio gateway features.
 
typedef uint8_t bt_hfp_ag_hold_feature_t
 The structure defines the audio gateway's 3-way calling (hold) feature set.
 
typedef uint8_t bt_hfp_ciev_call_state_t
 The structure defines the current call state indicated by the AG.
 
typedef uint8_t bt_hfp_ciev_call_setup_state_t
 The structure defines the current call setup state indicated by the AG.
 
typedef uint8_t bt_hfp_ciev_call_hold_state_t
 The structure defines the current call hold state indicated by the AG.
 
typedef uint8_t bt_hfp_call_status_t
 This structure defines the current state of a call. More...
 
typedef uint8_t bt_hfp_call_mode_t
 This structure defines the call mode.
 

Macro Definition Documentation

#define BT_HFP_ACTION_CMD_CNF   (BT_MODULE_HFP | 0x019)

The HFP Action Command Confirmation is triggered when the AG responds to the command request with the bt_hfp_action_cnf_t payload.

#define BT_HFP_AG_FEATURE_3_WAY   0x0001

3-way calling.

#define BT_HFP_AG_FEATURE_CALL_REJECT   0x0020

Reject a call.

#define BT_HFP_AG_FEATURE_CODEC_NEGOTIATION   0x0200

Codec negotiation.

#define BT_HFP_AG_FEATURE_ECHO_NOISE   0x0002

Echo canceling and noise reduction function.

#define BT_HFP_AG_FEATURE_ENHANCED_CALL_CTRL   0x0080

Enhanced call control.

#define BT_HFP_AG_FEATURE_ENHANCED_CALL_STATUS   0x0040

Enhanced call status.

#define BT_HFP_AG_FEATURE_EXTENDED_ERROR   0x0100

Extended error.

#define BT_HFP_AG_FEATURE_IN_BAND_RING   0x0008

In-band ring tone.

#define BT_HFP_AG_FEATURE_VOICE_RECOGNITION   0x0004

Voice recognition function.

#define BT_HFP_AG_FEATURE_VOICE_TAG   0x0010

Voice tag.

#define BT_HFP_AG_HOLD_FEATURE_ADD_HELD_CALL   0x20

Adds a held call to the conversation.

#define BT_HFP_AG_HOLD_FEATURE_CALL_TRANSFER   0x40

Connects the two calls and disconnects the AG from both calls.

#define BT_HFP_AG_HOLD_FEATURE_HOLD_ACTIVE_CALL   0x08

Places all active calls on hold and accepts the other held or waiting call.

#define BT_HFP_AG_HOLD_FEATURE_HOLD_SPECIFIC_CALL   0x10

Places a specific call on hold.

#define BT_HFP_AG_HOLD_FEATURE_RELEASE_ACTIVE_CALL   0x02

Releases all active calls and accepts the other held or waiting call.

#define BT_HFP_AG_HOLD_FEATURE_RELEASE_HELD_CALL   0x01

Releases all held calls or sets User Determined User Busy for a waiting call.

#define BT_HFP_AG_HOLD_FEATURE_RELEASE_SPECIFIC_CALL   0x04

Releases a specific call.

#define BT_HFP_AUDIO_CONNECT_IND   (BT_MODULE_HFP | 0x006)

The HFP Audio Connected Indication is triggered when the audio connection is connected with the bt_hfp_audio_connect_ind_t payload.

#define BT_HFP_AUDIO_DISCONNECT_IND   (BT_MODULE_HFP | 0x007)

The HFP Audio Disconnected Indication is triggered when the audio connection is disconnected with the bt_hfp_audio_disconnect_ind_t payload.

#define BT_HFP_AUDIO_STATUS_ACTIVE   0x01

Active audio connection.

#define BT_HFP_AUDIO_STATUS_CHANGE_IND   (BT_MODULE_HFP | 0x01a)

The HFP audio connection status change indication event to indicate the audio connection status has changed with the bt_hfp_audio_status_change_ind_t payload.

#define BT_HFP_AUDIO_STATUS_INACTIVE   0x00

Inactive audio connection.

#define BT_HFP_AUDIO_TO_AG   0x01

The audio direction to AG.

#define BT_HFP_AUDIO_TO_HF   0x00

The audio direction to HF.

#define BT_HFP_BRSF_FEATURES_IND   (BT_MODULE_HFP | 0x008)

The BRSF Feature Indication is triggered when the AG supported features are fetched with the bt_hfp_feature_ind_t payload.

#define BT_HFP_CALL_HOLD_FEATURES_IND   (BT_MODULE_HFP | 0x009)

The Call Hold Features Indication is triggered when fetching the call hold actions that AG supports with the bt_hfp_hold_feature_ind_t payload.

#define BT_HFP_CALL_MODE_DATA   0x01

Data call.

#define BT_HFP_CALL_MODE_FAX   0x02

FAX call.

#define BT_HFP_CALL_MODE_VOICE   0x00

Voice call.

#define BT_HFP_CALL_STATUS_ACTIVE   0x00

An existing active call.

#define BT_HFP_CALL_STATUS_ALERTING   0x03

The remote party is being alerted.

#define BT_HFP_CALL_STATUS_DIALING   0x02

An outgoing call.

Attempting to call using any of the dialing commands.

#define BT_HFP_CALL_STATUS_HOLD   0x01

The call is on hold.

#define BT_HFP_CALL_STATUS_INCOMING   0x04

An incoming call.

#define BT_HFP_CALL_STATUS_NONE   0x06

There is no active call.

#define BT_HFP_CALL_STATUS_UNKNOWN   0x07

Unknown call state.

#define BT_HFP_CALL_STATUS_WAITING   0x05

The call is waiting.

This state occurs only when the AG supports 3-Way calling.

#define BT_HFP_CALL_WAITING_IND   (BT_MODULE_HFP | 0x012)

The Call Waiting Indication with the waiting call information is triggered when the AG gets the waiting call with the bt_hfp_call_waiting_ind_t payload.

#define BT_HFP_CALLER_ID_IND   (BT_MODULE_HFP | 0x013)

The Caller Indication with the caller information is triggered when the AG gets an incoming call with the bt_hfp_caller_id_ind_t payload.

#define BT_HFP_CIEV_BATTCHG_IND   (BT_MODULE_HFP | 0x010)

The Battery Changed Indication is triggered when the battery level is changed with the bt_hfp_battery_ind_t payload.

#define BT_HFP_CIEV_CALL_HOLD_IND   (BT_MODULE_HFP | 0x00c)

The Call Hold Indication is triggered when the call hold status is changed with the bt_hfp_call_hold_ind_t payload.

#define BT_HFP_CIEV_CALL_HOLD_STATE_ALL   0x02

All calls are on hold state.

#define BT_HFP_CIEV_CALL_HOLD_STATE_NONE   0x00

No call is on hold state.

#define BT_HFP_CIEV_CALL_HOLD_STATE_SOME   0x01

Some calls are on hold state.

#define BT_HFP_CIEV_CALL_IND   (BT_MODULE_HFP | 0x00b)

The Call Indication is triggered when the call status is changed with the bt_hfp_call_ind_t payload.

#define BT_HFP_CIEV_CALL_SETUP_IND   (BT_MODULE_HFP | 0x00a)

The Call Setup Indication is triggered when the call setup status is changed with the bt_hfp_call_setup_ind_t payload.

#define BT_HFP_CIEV_CALL_SETUP_STATE_INCOMING   0x01

An incoming call is present on the AG.

#define BT_HFP_CIEV_CALL_SETUP_STATE_NONE   0x00

No outgoing or incoming call is present on the AG.

#define BT_HFP_CIEV_CALL_SETUP_STATE_OUTGOING   0x02

An outgoing call is present on the AG.

#define BT_HFP_CIEV_CALL_SETUP_STATE_REMOTE_ALERT   0x03

An outgoing call is being alerted on the AG.

#define BT_HFP_CIEV_CALL_STATE_CALL   0x01

At least one call is active on the AG.

#define BT_HFP_CIEV_CALL_STATE_NONE   0x00

No existing call on the AG.

#define BT_HFP_CIEV_ROAMING_IND   (BT_MODULE_HFP | 0x00f)

The Roaming Indication is triggered when the roaming status is changed with the bt_hfp_roaming_ind_t payload.

#define BT_HFP_CIEV_SERVICE_IND   (BT_MODULE_HFP | 0x00d)

The Service Indication is triggered when the service status is changed with the bt_hfp_service_ind_t payload.

#define BT_HFP_CIEV_SIGNAL_IND   (BT_MODULE_HFP | 0x00e)

The Signal Indication is triggered when the signal value is changed with the bt_hfp_signal_ind_t payload.

#define BT_HFP_CODEC_TYPE_CVSD   0x01

CVSD.

#define BT_HFP_CODEC_TYPE_MSBC   0X02

MSBC.

#define BT_HFP_CODEC_TYPE_NONE   0x00

None.

#define BT_HFP_CONNECT_REQUEST_IND   (BT_MODULE_HFP | 0x004)

The HFP Connect Request Indication event is triggered when AG attempts to connect with HF with the bt_hfp_connect_request_ind_t payload.

#define BT_HFP_CURRENT_CALLS_IND   (BT_MODULE_HFP | 0x014)

The Current Calls Indication with the current call's details is triggered when the HF has queried current calls with the bt_hfp_call_list_ind_t payload.

#define BT_HFP_DISCONNECT_IND   (BT_MODULE_HFP | 0x005)

The HFP Disconnected Indication is triggered when RFCOMM link is disconnected with the bt_hfp_disconnect_ind_t payload.

#define BT_HFP_IN_BAND_RING_IND   (BT_MODULE_HFP | 0x018)

The In Band Ring Indication is triggered when in-band ring feature is changed with the bt_hfp_in_band_ring_status_ind_t payload.

#define BT_HFP_INDICATOR_IGNORE   0x02

Ignore.

#define BT_HFP_INDICATOR_OFF   0x00

Off.

#define BT_HFP_INDICATOR_ON   0x01

On, the default value.

#define BT_HFP_INIT_SUPPORT_3_WAY   0x0010

Three way calling.

#define BT_HFP_INIT_SUPPORT_ALL   0x0030

Both three way calling and codec negotiation.

#define BT_HFP_INIT_SUPPORT_CODEC_NEG   0x0020

Codec negotiation.

#define BT_HFP_INVALID_HANDLE   0

The event report to user.

Invalid handle.

#define BT_HFP_PHONE_NUM_FORMAT_PLAN_DATA_NUMBERING   0x03

Data numbering.

#define BT_HFP_PHONE_NUM_FORMAT_PLAN_ISDN_TELEPHONY   0x01

ISDN telephony.

#define BT_HFP_PHONE_NUM_FORMAT_PLAN_NATIONAL   0x08

National numbering.

#define BT_HFP_PHONE_NUM_FORMAT_PLAN_PRIVATE   0x09

Private numbering.

#define BT_HFP_PHONE_NUM_FORMAT_PLAN_TELEX_NUMBERING   0x04

Telex numbering.

#define BT_HFP_PHONE_NUM_FORMAT_PLAN_UNKNOWN   0x00

Unknown.

#define BT_HFP_PHONE_NUM_FORMAT_TYPE_DEDICATED_ACC   0xC0

Dedicate access, short code.

#define BT_HFP_PHONE_NUM_FORMAT_TYPE_INTERNATIONAL   0x90

International.

#define BT_HFP_PHONE_NUM_FORMAT_TYPE_NATIONAL   0xA0

National.

#define BT_HFP_PHONE_NUM_FORMAT_TYPE_NETWORK_SPEC   0xB0

Network specification.

#define BT_HFP_PHONE_NUM_FORMAT_TYPE_UNKNOWN   0x80

Unknown.

#define BT_HFP_PHONE_NUMBER_MAX_LEN   64

The maximum length of a phone number.

#define BT_HFP_RING_IND   (BT_MODULE_HFP | 0x011)

The Ring Indication is triggered when the AG is ringing with the bt_hfp_ring_ind_t payload.

#define BT_HFP_SLC_CONNECTED_IND   (BT_MODULE_HFP | 0x003)

The SLC Connected Indication event is triggered once the SLC is connected with the bt_hfp_slc_connected_ind_t payload.

#define BT_HFP_SLC_CONNECTING_IND   (BT_MODULE_HFP | 0x002)

The SLC Connecting Indication event is triggered while the SLC is connecting with the bt_hfp_slc_connecting_ind_t payload.

#define BT_HFP_VERSION_V15   0x01

The HFP profile version is 1.5.

#define BT_HFP_VERSION_V16   0x02

The HFP profile version is 1.6.

#define BT_HFP_VOICE_RECOGNITION_IND   (BT_MODULE_HFP | 0x015)

The Voice Recognition Indication is triggered when the voice recognition status is changed with the bt_hfp_voice_recognition_ind_t payload.

#define BT_HFP_VOLUME_SYNC_MIC_GAIN_IND   (BT_MODULE_HFP | 0x017)

The Volume Sync Microphone Indication is triggered when the value of remote microphone volume is changed with the bt_hfp_volume_sync_mic_gain_ind_t payload.

#define BT_HFP_VOLUME_SYNC_SPEAKER_GAIN_IND   (BT_MODULE_HFP | 0x016)

The Volume Sync Speaker Indication is triggered when the value of remote speaker volume is changed with the bt_hfp_volume_sync_speaker_gain_ind_t payload.

Typedef Documentation

typedef uint8_t bt_hfp_call_status_t

This structure defines the current state of a call.

Not all states are supported by all audio gateways. At the very minimum, BT_HFP_CALL_STATUS_NONE, BT_HFP_CALL_STATUS_DIALING, BT_HFP_CALL_STATUS_INCOMING and BT_HFP_CALL_STATUS_ACTIVE are supported.