alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-09-21 06:56:11 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

fix(bt/bluedroid): corrected the API documents of profile HFP and A2DP

Browse Source
This commit is contained in:
Jin Cheng 2023-11-15 11:13:20 +08:00
parent e4ab4499b0
commit b9a0ca6feb
3 changed files with 98 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
components/bt/host/bluedroid/api/include/api/esp_a2dp_api.h
View File

@ -1,5 +1,5 @@
/* /*
* SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD * SPDX-FileCopyrightText: 2015-2023 Espressif Systems (Shanghai) CO LTD
* *
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
*/ */
@ -241,7 +241,7 @@ typedef int32_t (* esp_a2d_source_data_cb_t)(uint8_t *buf, int32_t len);
* *
* @return * @return
* - ESP_OK: success * - ESP_OK: success
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: if callback is a NULL function pointer * - ESP_FAIL: if callback is a NULL function pointer
* *
*/ */
@ -258,7 +258,7 @@ esp_err_t esp_a2d_register_callback(esp_a2d_cb_t callback);
* *
* @return * @return
* - ESP_OK: success * - ESP_OK: success
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: if callback is a NULL function pointer * - ESP_FAIL: if callback is a NULL function pointer
* *
*/ */
@ -275,7 +275,7 @@ esp_err_t esp_a2d_sink_register_data_callback(esp_a2d_sink_data_cb_t callback);
* *
* @return * @return
* - ESP_OK: if the initialization request is sent successfully * - ESP_OK: if the initialization request is sent successfully
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -290,7 +290,7 @@ esp_err_t esp_a2d_sink_init(void);
* *
* @return * @return
* - ESP_OK: if the deinitialization request is sent successfully * - ESP_OK: if the deinitialization request is sent successfully
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -306,7 +306,7 @@ esp_err_t esp_a2d_sink_deinit(void);
* *
* @return * @return
* - ESP_OK: connect request is sent to lower layer successfully * - ESP_OK: connect request is sent to lower layer successfully
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -322,7 +322,7 @@ esp_err_t esp_a2d_sink_connect(esp_bd_addr_t remote_bda);
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer successfully * - ESP_OK: disconnect request is sent to lower layer successfully
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -339,7 +339,7 @@ esp_err_t esp_a2d_sink_disconnect(esp_bd_addr_t remote_bda);
* *
* @return * @return
* - ESP_OK: delay value is sent to lower layer successfully * - ESP_OK: delay value is sent to lower layer successfully
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -352,7 +352,7 @@ esp_err_t esp_a2d_sink_set_delay_value(uint16_t delay_value);
* *
* @return * @return
* - ESP_OK: if the request is sent successfully * - ESP_OK: if the request is sent successfully
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -368,7 +368,7 @@ esp_err_t esp_a2d_sink_get_delay_value(void);
* *
* @return * @return
* - ESP_OK: control command is sent to lower layer successfully * - ESP_OK: control command is sent to lower layer successfully
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -385,7 +385,7 @@ esp_err_t esp_a2d_media_ctrl(esp_a2d_media_ctrl_t ctrl);
* *
* @return * @return
* - ESP_OK: if the initialization request is sent to lower layer successfully * - ESP_OK: if the initialization request is sent to lower layer successfully
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -400,7 +400,7 @@ esp_err_t esp_a2d_source_init(void);
* *
* @return * @return
* - ESP_OK: success * - ESP_OK: success
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -417,7 +417,7 @@ esp_err_t esp_a2d_source_deinit(void);
* *
* @return * @return
* - ESP_OK: success * - ESP_OK: success
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: if callback is a NULL function pointer * - ESP_FAIL: if callback is a NULL function pointer
* *
*/ */
@ -433,7 +433,7 @@ esp_err_t esp_a2d_source_register_data_callback(esp_a2d_source_data_cb_t callbac
* *
* @return * @return
* - ESP_OK: connect request is sent to lower layer successfully * - ESP_OK: connect request is sent to lower layer successfully
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -448,7 +448,7 @@ esp_err_t esp_a2d_source_connect(esp_bd_addr_t remote_bda);
* @param[in] remote_bda: remote bluetooth device address * @param[in] remote_bda: remote bluetooth device address
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: disconnect request is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */

82
components/bt/host/bluedroid/api/include/api/esp_hf_ag_api.h
View File

@ -274,7 +274,7 @@ typedef void (* esp_hf_cb_t) (esp_hf_cb_event_t event, esp_hf_cb_param_t *param)
* *
* @return * @return
* - ESP_OK: success * - ESP_OK: success
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: if callback is a NULL function pointer * - ESP_FAIL: if callback is a NULL function pointer
* *
*/ */
@ -287,7 +287,7 @@ esp_err_t esp_hf_ag_register_callback(esp_hf_cb_t callback);
* *
* @return * @return
* - ESP_OK: if the initialization request is sent successfully * - ESP_OK: if the initialization request is sent successfully
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -300,7 +300,7 @@ esp_err_t esp_hf_ag_init(void);
* *
* @return * @return
* - ESP_OK: success * - ESP_OK: success
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -315,7 +315,7 @@ esp_err_t esp_hf_ag_deinit(void);
* *
* @return * @return
* - ESP_OK: connect request is sent to lower layer * - ESP_OK: connect request is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -330,7 +330,7 @@ esp_err_t esp_hf_ag_slc_connect(esp_bd_addr_t remote_bda);
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: disconnect request is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -344,8 +344,8 @@ esp_err_t esp_hf_ag_slc_disconnect(esp_bd_addr_t remote_bda);
* @param[in] remote_bda: remote bluetooth device address * @param[in] remote_bda: remote bluetooth device address
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: audio connect request is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -359,8 +359,8 @@ esp_err_t esp_hf_ag_audio_connect(esp_bd_addr_t remote_bda);
* @param[in] remote_bda: remote bluetooth device address * @param[in] remote_bda: remote bluetooth device address
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: audio disconnect request is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -376,8 +376,8 @@ esp_err_t esp_hf_ag_audio_disconnect(esp_bd_addr_t remote_bda);
* @param[in] value: 0 - voice recognition disabled, 1- voice recognition enabled * @param[in] value: 0 - voice recognition disabled, 1- voice recognition enabled
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: response of volume recognition is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -395,8 +395,8 @@ esp_err_t esp_hf_ag_vra_control(esp_bd_addr_t remote_bda, esp_hf_vr_state_t valu
* @param[in] volume: gain of the speaker of microphone, ranges 0 to 15 * @param[in] volume: gain of the speaker of microphone, ranges 0 to 15
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: volume synchronization control is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_ERR_INVALID_ARG: if arguments are invalid * - ESP_ERR_INVALID_ARG: if arguments are invalid
* - ESP_FAIL: others * - ESP_FAIL: others
* *
@ -413,8 +413,8 @@ esp_err_t esp_hf_ag_volume_control(esp_bd_addr_t remote_bda, esp_hf_volume_contr
* @param[in] unat: User AT command response to HF Client. * @param[in] unat: User AT command response to HF Client.
* It will response "ERROR" by default if unat is NULL. * It will response "ERROR" by default if unat is NULL.
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: response of unknown AT command is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -429,8 +429,8 @@ esp_err_t esp_hf_ag_unknown_at_send(esp_bd_addr_t remote_addr, char *unat);
* @param[in] response_code: AT command response code * @param[in] response_code: AT command response code
* @param[in] error_code: CME error code * @param[in] error_code: CME error code
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: extend error code is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -447,8 +447,8 @@ esp_err_t esp_hf_ag_cmee_send(esp_bd_addr_t remote_bda, esp_hf_at_response_code_
* @param[in] ntk_state: network service state * @param[in] ntk_state: network service state
* @param[in] signal: signal strength from 0 to 5 * @param[in] signal: signal strength from 0 to 5
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: device status notification is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_ERR_INVALID_ARG: if arguments are invalid * - ESP_ERR_INVALID_ARG: if arguments are invalid
* - ESP_FAIL: others * - ESP_FAIL: others
* *
@ -469,8 +469,8 @@ esp_err_t esp_hf_ag_devices_status_indchange(esp_bd_addr_t remote_addr, esp_hf_c
* @param[in] ind_type: indicator type * @param[in] ind_type: indicator type
* @param[in] value: indicator value * @param[in] value: indicator value
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: indicator report is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -490,8 +490,8 @@ esp_err_t esp_hf_ag_ciev_report(esp_bd_addr_t remote_addr, esp_hf_ciev_report_ty
* @param[in] batt_lev: battery level from 0 to 5 * @param[in] batt_lev: battery level from 0 to 5
* @param[in] call_held_status: call held status * @param[in] call_held_status: call held status
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: response to device individual indicators is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_ERR_INVALID_ARG: if the arguments are invalid * - ESP_ERR_INVALID_ARG: if the arguments are invalid
* - ESP_FAIL: others * - ESP_FAIL: others
* *
@ -510,8 +510,8 @@ esp_err_t esp_hf_ag_cind_response(esp_bd_addr_t remote_addr,
* @param[in] remote_addr: remote bluetooth device address * @param[in] remote_addr: remote bluetooth device address
* @param[in] name: current operator name * @param[in] name: current operator name
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: reponse for AT+COPS command is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -531,8 +531,8 @@ esp_err_t esp_hf_ag_cops_response(esp_bd_addr_t remote_addr, char *name);
* @param[in] number: current call number * @param[in] number: current call number
* @param[in] type: international type or unknow * @param[in] type: international type or unknow
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: response to AT+CLCC command is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -553,8 +553,8 @@ esp_err_t esp_hf_ag_clcc_response(esp_bd_addr_t remote_addr, int index, esp_hf_c
* 160-175: national, but no prefix nor escape digits * 160-175: national, but no prefix nor escape digits
* @param[in] service_type: service type (unknown/voice/fax) * @param[in] service_type: service type (unknown/voice/fax)
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: response for AT+CNUM command is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -568,8 +568,8 @@ esp_err_t esp_hf_ag_cnum_response(esp_bd_addr_t remote_addr, char *number, int n
* @param[in] remote_addr: remote bluetooth device address * @param[in] remote_addr: remote bluetooth device address
* @param[in] state: in-band ring tone state * @param[in] state: in-band ring tone state
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: information of in-band ring tone is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_ERR_INVALID_ARG: if arguments are invalid * - ESP_ERR_INVALID_ARG: if arguments are invalid
* - ESP_FAIL: others * - ESP_FAIL: others
* *
@ -589,8 +589,8 @@ esp_err_t esp_hf_ag_bsir(esp_bd_addr_t remote_addr, esp_hf_in_band_ring_state_t
* @param[in] number: number of the incoming call * @param[in] number: number of the incoming call
* @param[in] call_addr_type: call address type * @param[in] call_addr_type: call address type
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: answer incoming call is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -611,8 +611,8 @@ esp_err_t esp_hf_ag_answer_call(esp_bd_addr_t remote_addr, int num_active, int n
* @param[in] number: number of the incoming call * @param[in] number: number of the incoming call
* @param[in] call_addr_type: call address type * @param[in] call_addr_type: call address type
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: reject incoming call is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -636,8 +636,8 @@ esp_err_t esp_hf_ag_reject_call(esp_bd_addr_t remote_addr, int num_active, int n
* @param[in] number: number of the outgoing call * @param[in] number: number of the outgoing call
* @param[in] call_addr_type: call address type * @param[in] call_addr_type: call address type
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: a call initiation is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -658,8 +658,8 @@ esp_err_t esp_hf_ag_out_call(esp_bd_addr_t remote_addr, int num_active, int num_
* @param[in] number: number of the call * @param[in] number: number of the call
* @param[in] call_addr_type: call address type * @param[in] call_addr_type: call address type
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: end an ongoing call is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -676,7 +676,7 @@ esp_err_t esp_hf_ag_end_call(esp_bd_addr_t remote_addr, int num_active, int num_
* *
* @return * @return
* - ESP_OK: success * - ESP_OK: success
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: if callback is a NULL function pointer * - ESP_FAIL: if callback is a NULL function pointer
* *
*/ */
@ -693,7 +693,7 @@ esp_err_t esp_hf_ag_register_data_callback(esp_hf_incoming_data_cb_t recv, esp_h
* *
* @return * @return
* - ESP_OK: if the request is sent successfully * - ESP_OK: if the request is sent successfully
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */

84
components/bt/host/bluedroid/api/include/api/esp_hf_client_api.h
View File

@ -313,7 +313,7 @@ typedef void (* esp_hf_client_cb_t)(esp_hf_client_cb_event_t event, esp_hf_clien
* *
* @return * @return
* - ESP_OK: success * - ESP_OK: success
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: if callback is a NULL function pointer * - ESP_FAIL: if callback is a NULL function pointer
* *
*/ */
@ -326,7 +326,7 @@ esp_err_t esp_hf_client_register_callback(esp_hf_client_cb_t callback);
* *
* @return * @return
* - ESP_OK: if the initialization request is sent successfully * - ESP_OK: if the initialization request is sent successfully
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -339,7 +339,7 @@ esp_err_t esp_hf_client_init(void);
* *
* @return * @return
* - ESP_OK: success * - ESP_OK: success
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -354,7 +354,7 @@ esp_err_t esp_hf_client_deinit(void);
* *
* @return * @return
* - ESP_OK: connect request is sent to lower layer * - ESP_OK: connect request is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -369,7 +369,7 @@ esp_err_t esp_hf_client_connect(esp_bd_addr_t remote_bda);
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: disconnect request is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -382,8 +382,8 @@ esp_err_t esp_hf_client_disconnect(esp_bd_addr_t remote_bda);
* *
* @param[in] remote_bda: remote bluetooth device address * @param[in] remote_bda: remote bluetooth device address
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: connect audio request is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -396,8 +396,8 @@ esp_err_t esp_hf_client_connect_audio(esp_bd_addr_t remote_bda);
* *
* @param[in] remote_bda: remote bluetooth device address * @param[in] remote_bda: remote bluetooth device address
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: disconnect audio request is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -409,8 +409,8 @@ esp_err_t esp_hf_client_disconnect_audio(esp_bd_addr_t remote_bda);
* As a precondition to use this API, Service Level Connection shall exist with AG. * As a precondition to use this API, Service Level Connection shall exist with AG.
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: starting voice recognition is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -422,8 +422,8 @@ esp_err_t esp_hf_client_start_voice_recognition(void);
* As a precondition to use this API, Service Level Connection shall exist with AG. * As a precondition to use this API, Service Level Connection shall exist with AG.
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: stoping voice recognition is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -438,8 +438,8 @@ esp_err_t esp_hf_client_stop_voice_recognition(void);
* @param[in] volume: gain of the speaker of microphone, ranges 0 to 15 * @param[in] volume: gain of the speaker of microphone, ranges 0 to 15
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: volume update is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -453,8 +453,8 @@ esp_err_t esp_hf_client_volume_update(esp_hf_volume_control_target_t type, int v
* @param[in] number: number string of the call. If NULL, the last number is called(aka re-dial) * @param[in] number: number string of the call. If NULL, the last number is called(aka re-dial)
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: a call placing is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -468,8 +468,8 @@ esp_err_t esp_hf_client_dial(const char *number);
* @param[in] location: location of the number in the memory * @param[in] location: location of the number in the memory
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: a memory call placing is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -486,8 +486,8 @@ esp_err_t esp_hf_client_dial_memory(int location);
* ESP_HF_CHLD_TYPE_REL_X or ESP_HF_CHLD_TYPE_PRIV_X * ESP_HF_CHLD_TYPE_REL_X or ESP_HF_CHLD_TYPE_PRIV_X
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: command AT+CHLD is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -501,8 +501,8 @@ esp_err_t esp_hf_client_send_chld_cmd(esp_hf_chld_type_t chld, int idx);
* @param[in] btrh: response and hold action to send * @param[in] btrh: response and hold action to send
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: command AT+BTRH is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -514,8 +514,8 @@ esp_err_t esp_hf_client_send_btrh_cmd(esp_hf_btrh_cmd_t btrh);
* As a precondition to use this API, Service Level Connection shall exist with AG. * As a precondition to use this API, Service Level Connection shall exist with AG.
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: a call answering is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -527,8 +527,8 @@ esp_err_t esp_hf_client_answer_call(void);
* As a precondition to use this API, Service Level Connection shall exist with AG. * As a precondition to use this API, Service Level Connection shall exist with AG.
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: the call rejecting is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -540,8 +540,8 @@ esp_err_t esp_hf_client_reject_call(void);
* As a precondition to use this API, Service Level Connection shall exist with AG. * As a precondition to use this API, Service Level Connection shall exist with AG.
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: query of current calls is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -553,8 +553,8 @@ esp_err_t esp_hf_client_query_current_calls(void);
* As a precondition to use this API, Service Level Connection shall exist with AG. * As a precondition to use this API, Service Level Connection shall exist with AG.
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: query of current operator name is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -566,8 +566,8 @@ esp_err_t esp_hf_client_query_current_operator_name(void);
* As a precondition to use this API, Service Level Connection shall exist with AG * As a precondition to use this API, Service Level Connection shall exist with AG
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: the retrieving of subscriber information is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -581,8 +581,8 @@ esp_err_t esp_hf_client_retrieve_subscriber_info(void);
* @param[in] code: dtmf code, single ascii character in the set 0-9, #, *, A-D * @param[in] code: dtmf code, single ascii character in the set 0-9, #, *, A-D
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: the DTMF codes are sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -602,7 +602,7 @@ esp_err_t esp_hf_client_send_dtmf(char code);
* *
* @return * @return
* - ESP_OK: Feature enable request is sent to lower layer * - ESP_OK: Feature enable request is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -620,7 +620,7 @@ esp_err_t esp_hf_client_send_xapl(char *information, uint32_t features);
* *
* @return * @return
* - ESP_OK: battery level is sent to lower layer * - ESP_OK: battery level is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -632,8 +632,8 @@ esp_err_t esp_hf_client_send_iphoneaccev(uint32_t bat_level, bool docked);
* As a precondition to use this API, Service Level Connection shall exist with AG. * As a precondition to use this API, Service Level Connection shall exist with AG.
* *
* @return * @return
* - ESP_OK: disconnect request is sent to lower layer * - ESP_OK: the phone number request corresponding to last voice tag recorded is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -646,7 +646,7 @@ esp_err_t esp_hf_client_request_last_voice_tag_number(void);
* *
* @return * @return
* - ESP_OK: NREC=0 request is sent to lower layer * - ESP_OK: NREC=0 request is sent to lower layer
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */
@ -663,7 +663,7 @@ esp_err_t esp_hf_client_send_nrec(void);
* *
* @return * @return
* - ESP_OK: success * - ESP_OK: success
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: if callback is a NULL function pointer * - ESP_FAIL: if callback is a NULL function pointer
* *
*/ */
@ -680,7 +680,7 @@ esp_err_t esp_hf_client_register_data_callback(esp_hf_client_incoming_data_cb_t
* *
* @return * @return
* - ESP_OK: if the request is sent successfully * - ESP_OK: if the request is sent successfully
* - ESP_INVALID_STATE: if bluetooth stack is not yet enabled * - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled
* - ESP_FAIL: others * - ESP_FAIL: others
* *
*/ */