Symbols

Files

loading (2/5)...

Summary Syntax Arguments Examples References Call Tree Data Use

SourceVuESP-IDF Framework and ExamplesESP-IDFesp_hf_client_volume_update()

esp_hf_client_volume_update() function

Volume synchronization with AG. As a precondition to use this API, Service Level Connection shall exist with AG.

Syntax

Show:

Summary

Declaration

from esp_hf_client_api.h:456

esp_err_t esp_hf_client_volume_update(esp_hf_volume_control_target_t type, int volume);

Arguments

Argument

Description

type

volume control target, speaker or microphone

volume

gain of the speaker of microphone, ranges 0 to 15

Return value

- ESP_OK: volume update is sent to lower layer - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled - ESP_FAIL: others

Examples

esp_hf_client_volume_update() is referenced by 1 libraries and example projects:

hfp_hf sample

References

from 0/1 examples

Code

Location

esp_err_t esp_hf_client_volume_update(esp_hf_volume_control_target_t type, int volume)

esp_hf_client_api.c:189

esp_err_t esp_hf_client_volume_update(esp_hf_volume_control_target_t type, int volume);

esp_hf_client_api.h:456

Call Tree

from 0/1 examples

esp_hf_client_volume_update() calls 2 functions:

esp_hf_client_volume_update()

btc_transfer_context()

esp_bluedroid_get_status()

Data Use

from 0/1 examples

esp_hf_client_volume_update() reads 6 variables and writes 5 variables:

btc_sig_t::BTC_SIG_API_CALL

btc_pid_t::BTC_PID_HF_CLIENT

esp_bluedroid_status_t::ESP_BLUEDROID_STATUS_ENABLED

bt_status_t::BT_STATUS_SUCCESS

btc_hf_client_act_t::BTC_HF_CLIENT_VOLUME_UPDATE_EVT

btc_hf_client_args_t::volume_update

esp_hf_client_volume_update()

btc_msg::sig

btc_msg::pid

btc_msg::act

volume_update_args::type

volume_update_args::volume

Class Tree

from 0/1 examples

All items filtered out

Override Tree

from 0/1 examples

All items filtered out

Implementations

from 0/1 examples

All items filtered out

Instances

from 0/1 examples

Lifecycle

from 0/1 examples

All items filtered out