mirror/btstack
1
0
Fork 0
mirror of https://github.com/bluekitchen/btstack.git synced 2025-04-10 15:44:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

hfp_hf: fix documentation

Browse Source
This commit is contained in:
Matthias Ringwald 2018-05-11 15:32:26 +02:00
parent d7f6b5cbab
commit 959e3c06d9
1 changed files with 40 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
src/classic/hfp_hf.h
View File

@ -119,7 +119,7 @@ void hfp_hf_establish_service_level_connection(bd_addr_t bd_addr);
* The status of releasing the SLC connection is reported via
* HFP_SUBEVENT_SERVICE_LEVEL_CONNECTION_RELEASED.
*
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_release_service_level_connection(hci_con_handle_t acl_handle);
@ -128,14 +128,14 @@ void hfp_hf_release_service_level_connection(hci_con_handle_t acl_handle);
* The status field of the HFP_SUBEVENT_COMPLETE reports if the command was accepted.
* The status of an AG indicator is reported via HFP_SUBEVENT_AG_INDICATOR_STATUS_CHANGED.
*
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_enable_status_update_for_all_ag_indicators(hci_con_handle_t acl_handle);
/**
* @brief Disable status update for all indicators in the AG.
* The status field of the HFP_SUBEVENT_COMPLETE reports if the command was accepted.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_disable_status_update_for_all_ag_indicators(hci_con_handle_t acl_handle);
@ -144,7 +144,7 @@ void hfp_hf_disable_status_update_for_all_ag_indicators(hci_con_handle_t acl_han
* The status field of the HFP_SUBEVENT_COMPLETE reports if the command was accepted.
* The status of an AG indicator is reported via HFP_SUBEVENT_AG_INDICATOR_STATUS_CHANGED.
*
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
* @param indicators_status_bitmap 32-bit bitmap, 0 - indicator is disabled, 1 - indicator is enabled
*/
void hfp_hf_set_status_update_for_individual_ag_indicators(hci_con_handle_t acl_handle, uint32_t indicators_status_bitmap);
@ -157,7 +157,7 @@ void hfp_hf_set_status_update_for_individual_ag_indicators(hci_con_handle_t acl_
* containing network operator mode, format and name.
* If no operator is selected, format and operator are omitted.
*
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_query_operator_selection(hci_con_handle_t acl_handle);
@ -167,14 +167,14 @@ void hfp_hf_query_operator_selection(hci_con_handle_t acl_handle);
* result of AT command, the AG shall send +CME ERROR. This error is reported via
* HFP_SUBEVENT_EXTENDED_AUDIO_GATEWAY_ERROR, see hfp_cme_error_t in hfp.h
*
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_enable_report_extended_audio_gateway_error_result_code(hci_con_handle_t acl_handle);
/**
* @brief Disable Extended Audio Gateway Error result codes in the AG.
*
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_disable_report_extended_audio_gateway_error_result_code(hci_con_handle_t acl_handle);
@ -182,7 +182,7 @@ void hfp_hf_enable_report_extended_audio_gateway_error_result_code(hci_con_handl
* @brief Establish audio connection.
* The status of audio connection establishment is reported via
* HFP_SUBEVENT_AUDIO_CONNECTION_ESTABLISHED.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_establish_audio_connection(hci_con_handle_t acl_handle);
@ -191,77 +191,77 @@ void hfp_hf_establish_audio_connection(hci_con_handle_t acl_handle);
* The status of releasing of the audio connection is reported via
* HFP_SUBEVENT_AUDIO_CONNECTION_RELEASED.
*
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_release_audio_connection(hci_con_handle_t acl_handle);
/**
* @brief Answer incoming call.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_answer_incoming_call(hci_con_handle_t acl_handle);
/**
* @brief Reject incoming call.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_reject_incoming_call(hci_con_handle_t acl_handle);
/**
* @brief Release all held calls or sets User Determined User Busy (UDUB) for a waiting call.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_user_busy(hci_con_handle_t acl_handle);
/**
* @brief Release all active calls (if any exist) and accepts the other (held or waiting) call.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_end_active_and_accept_other(hci_con_handle_t acl_handle);
/**
* @brief Place all active calls (if any exist) on hold and accepts the other (held or waiting) call.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_swap_calls(hci_con_handle_t acl_handle);
/**
* @brief Add a held call to the conversation.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_join_held_call(hci_con_handle_t acl_handle);
/**
* @brief Connect the two calls and disconnects the subscriber from both calls (Explicit Call
Transfer).
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_connect_calls(hci_con_handle_t acl_handle);
/**
* @brief Terminate an incoming or an outgoing call.
* HFP_SUBEVENT_CALL_TERMINATED is sent upon call termination.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_terminate_call(hci_con_handle_t acl_handle);
/**
* @brief Initiate outgoing voice call by providing the destination phone number to the AG.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
* @param number
*/
void hfp_hf_dial_number(hci_con_handle_t acl_handle, char * number);
/**
* @brief Initiate outgoing voice call using the memory dialing feature of the AG.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
* @param memory_id
*/
void hfp_hf_dial_memory(hci_con_handle_t acl_handle, int memory_id);
/**
* @brief Initiate outgoing voice call by recalling the last number dialed by the AG.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_redial_last_number(hci_con_handle_t acl_handle);
@ -271,13 +271,13 @@ void hfp_hf_redial_last_number(hci_con_handle_t acl_handle);
* an incoming call is waiting during an ongoing call. In that event,
* the HFP_SUBEVENT_CALL_WAITING_NOTIFICATION is emitted.
*
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_activate_call_waiting_notification(hci_con_handle_t acl_handle);
/*
* @brief Disable the “Call Waiting notification” function in the AG.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_deactivate_call_waiting_notification(hci_con_handle_t acl_handle);
@ -286,13 +286,13 @@ void hfp_hf_deactivate_call_waiting_notification(hci_con_handle_t acl_handle);
* The AG shall issue the corresponding result code just after every RING indication,
* when the HF is alerted in an incoming call. In that event,
* the HFP_SUBEVENT_CALLING_LINE_INDETIFICATION_NOTIFICATION is emitted.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_activate_calling_line_notification(hci_con_handle_t acl_handle);
/*
* @brief Disable the “Calling Line Identification notification” function in the AG.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_deactivate_calling_line_notification(hci_con_handle_t acl_handle);
@ -303,7 +303,7 @@ void hfp_hf_deactivate_calling_line_notification(hci_con_handle_t acl_handle);
* functions, it shall have them activated until this function is called.
* If the AG does not support any echo canceling and noise reduction functions,
* it shall respond with the ERROR indicator (TODO)
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_activate_echo_canceling_and_noise_reduction(hci_con_handle_t acl_handle);
@ -314,33 +314,33 @@ void hfp_hf_deactivate_echo_canceling_and_noise_reduction(hci_con_handle_t acl_h
/*
* @brief Activate voice recognition function.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_activate_voice_recognition_notification(hci_con_handle_t acl_handle);
/*
* @brief Dectivate voice recognition function.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_deactivate_voice_recognition_notification(hci_con_handle_t acl_handle);
/*
* @brief Set microphone gain.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
* @param gain Valid range: [0,15]
*/
void hfp_hf_set_microphone_gain(hci_con_handle_t acl_handle, int gain);
/*
* @brief Set speaker gain.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
* @param gain Valid range: [0,15]
*/
void hfp_hf_set_speaker_gain(hci_con_handle_t acl_handle, int gain);
/*
* @brief Instruct the AG to transmit a DTMF code.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
* @param dtmf_code
*/
void hfp_hf_send_dtmf_code(hci_con_handle_t acl_handle, char code);
@ -350,20 +350,20 @@ void hfp_hf_send_dtmf_code(hci_con_handle_t acl_handle, char code);
* a unique voice tag and storing the number and its linked voice
* tag in the HF’s memory.
* The number is reported via HFP_SUBEVENT_NUMBER_FOR_VOICE_TAG.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_request_phone_number_for_voice_tag(hci_con_handle_t acl_handle);
/*
* @brief Query the list of current calls in AG.
* The result is received via HFP_SUBEVENT_ENHANCED_CALL_STATUS.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_query_current_call_status(hci_con_handle_t acl_handle);
/*
* @brief Release a call with index in the AG.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
* @param index
*/
void hfp_hf_release_call_with_index(hci_con_handle_t acl_handle, int index);
@ -371,7 +371,7 @@ void hfp_hf_release_call_with_index(hci_con_handle_t acl_handle, int index);
/*
* @brief Place all parties of a multiparty call on hold with the
* exception of the specified call.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
* @param index
*/
void hfp_hf_private_consultation_with_call(hci_con_handle_t acl_handle, int index);
@ -379,38 +379,38 @@ void hfp_hf_private_consultation_with_call(hci_con_handle_t acl_handle, int inde
/*
* @brief Query the status of the “Response and Hold” state of the AG.
* The result is reported via HFP_SUBEVENT_RESPONSE_AND_HOLD_STATUS.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_rrh_query_status(hci_con_handle_t acl_handle);
/*
* @brief Put an incoming call on hold in the AG.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_rrh_hold_call(hci_con_handle_t acl_handle);
/*
* @brief Accept held incoming call in the AG.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_rrh_accept_held_call(hci_con_handle_t acl_handle);
/*
* @brief Reject held incoming call in the AG.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_rrh_reject_held_call(hci_con_handle_t acl_handle);
/*
* @brief Query the AG subscriber number.
* The result is reported via HFP_SUBEVENT_SUBSCRIBER_NUMBER_INFORMATION.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
*/
void hfp_hf_query_subscriber_number(hci_con_handle_t acl_handle);
/*
* @brief Set HF indicator.
* @param bd_addr Bluetooth address of the AG
* @param acl_handle of the AG
* @param assigned_number
* @param value
*/