mirror/btstack
1
0
Fork 0
mirror of https://github.com/bluekitchen/btstack.git synced 2025-03-27 14:37:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

hfp: update docu

Browse Source
This commit is contained in:
Milanka Ringwald 2021-08-23 17:21:58 +02:00
parent 89e7c136e3
commit b321b6092d
3 changed files with 8 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/manual/docs-template/profiles.md
View File

@ -344,7 +344,7 @@ It can be activated or deactivated on both sides by calling:
uint8_t hfp_hf_activate_voice_recognition(hci_con_handle_t acl_handle);
uint8_t hfp_hf_deactivate_voice_recognition(hci_con_handle_t acl_handle);
On either activation change, the HFP_SUBEVENT_VOICE_RECOGNITION_STATUS event will be emitted with status field set to ERROR_CODE_SUCCESS on success. The state field of this event indicates the current voice recognition state : 0 - if deactivated, 1 - if activated.
On activation change, the HFP_SUBEVENT_VOICE_RECOGNITION_(DE)ACTIVATED event will be emitted with status field set to ERROR_CODE_SUCCESS on success.
Voice recognition will stay active until either the deactivation command is called, or until the current Service Level Connection between the AG and the HF is dropped for any reason.
@ -371,15 +371,7 @@ In addition, to allow textual representation of audio that is parsed by eAVR (no
- AG: HFP_AGSF_VOICE_RECOGNITION_TEXT.
eAVR implements the same use cases as AVR (see previous section). It can be activated or deactivated on both sides by calling:
// AG
uint8_t hfp_ag_enhanced_voice_recognition_activate(hci_con_handle_t acl_handle);
uint8_t hfp_ag_enhanced_voice_recognition_deactivate(hci_con_handle_t acl_handle);
// HF
uint8_t hfp_hf_enhanced_voice_recognition_activate(hci_con_handle_t acl_handle);
uint8_t hfp_hf_enhanced_voice_recognition_deactivate(hci_con_handle_t acl_handle);
eAVR implements the same use cases as AVR (see previous section) and it can be activated or deactivated using the same API as for AVR, see above.
When eAVR and audio channel are established there are several additional commands that can be sent:

10
src/classic/hfp_ag.h
View File

@ -261,9 +261,8 @@ uint8_t hfp_ag_notify_incoming_call_waiting(hci_con_handle_t acl_handle);
// Voice Recognition
/*
* @brief Activate voice recognition and emit HFP_SUBEVENT_VOICE_RECOGNITION_STATUS event with status ERROR_CODE_SUCCESS
* if successful. The state field of this event is set to current voice recognition state: 1 for activated, 0 otherwise.
* Prerequisite is established SLC.
* @brief Activate voice recognition and emit HFP_SUBEVENT_VOICE_RECOGNITION_ACTIVATED event with status ERROR_CODE_SUCCESS
* if successful. Prerequisite is established SLC.
*
* @param acl_handle
* @return status ERROR_CODE_SUCCESS if successful, otherwise:
@ -273,9 +272,8 @@ uint8_t hfp_ag_notify_incoming_call_waiting(hci_con_handle_t acl_handle);
uint8_t hfp_ag_activate_voice_recognition(hci_con_handle_t acl_handle);
/*
* @brief Deactivate voice recognition and emit HFP_SUBEVENT_VOICE_RECOGNITION_STATUS event with status ERROR_CODE_SUCCESS
* if successful. The state field of this event is set to current voice recognition state: 1 for activated, 0 otherwise.
* Prerequisite is established SLC.
* @brief Deactivate voice recognition and emit HFP_SUBEVENT_VOICE_RECOGNITION_DEACTIVATED event with status ERROR_CODE_SUCCESS
* if successful. Prerequisite is established SLC.
*
* @param acl_handle
* @return status ERROR_CODE_SUCCESS if successful, otherwise:

4
src/classic/hfp_hf.h
View File

@ -357,7 +357,7 @@ uint8_t hfp_hf_deactivate_calling_line_notification(hci_con_handle_t acl_handle)
uint8_t hfp_hf_deactivate_echo_canceling_and_noise_reduction(hci_con_handle_t acl_handle);
/**
* @brief Activate voice recognition and emit HFP_SUBEVENT_VOICE_RECOGNITION_ENABLED event with status ERROR_CODE_SUCCESS
* @brief Activate voice recognition and emit HFP_SUBEVENT_VOICE_RECOGNITION_ACTIVATED event with status ERROR_CODE_SUCCESS
* if successful, otherwise ERROR_CODE_COMMAND_DISALLOWED. Prerequisite is established SLC.
*
* @param acl_handle
@ -368,7 +368,7 @@ uint8_t hfp_hf_deactivate_echo_canceling_and_noise_reduction(hci_con_handle_t ac
uint8_t hfp_hf_activate_voice_recognition(hci_con_handle_t acl_handle);
/**
* @brief Dectivate voice recognition and emit HFP_SUBEVENT_VOICE_RECOGNITION_DISABLED event with status ERROR_CODE_SUCCESS
* @brief Dectivate voice recognition and emit HFP_SUBEVENT_VOICE_RECOGNITION_DEACTIVATED event with status ERROR_CODE_SUCCESS
* if successful, otherwise ERROR_CODE_COMMAND_DISALLOWED. Prerequisite is established SLC.
*
* @param acl_handle