![]() |
nRF Connect SDK API 3.3.99
|
| void(* bt_fast_pair_fhn_ring_cb::start_request) (enum bt_fast_pair_fhn_ring_src src, const struct bt_fast_pair_fhn_ring_req_param *param) |
Request the user to start the ringing action.
This callback is called to start the ringing action. The FHN module requests this action in response to the command from the connected peer. Eventually, the action times out, which is indicated by the timeout_expired callback. This action can also be cancelled by the connected peer (see the stop_request callback) or stopped manually by the user action (see the bt_fast_pair_fhn_ring_state_update API and the BT_FAST_PAIR_FHN_RING_TRIGGER_UI_STOPPED trigger).
The input parameters determine how the ringing actions should be executed. See bt_fast_pair_fhn_ring_req_param for more details.
If the action is accepted for at least one requested component, you shall indicate it using the bt_fast_pair_fhn_ring_state_update API and set the BT_FAST_PAIR_FHN_RING_TRIGGER_STARTED as a trigger for the ringing state change. If all components are out of range, you shall set the BT_FAST_PAIR_FHN_RING_TRIGGER_FAILED as a trigger.
This callback can be called again when the ringing action has already started. In this case, you shall update the ringing activity to match the newest set of parameters.
If you cannot start the ringing action on all requested components (for example, one of them is out of range), you shall still declare success for this request. Once an unavailable component becomes reachable, you can start the ringing action on it and indicate it using the bt_fast_pair_fhn_ring_state_update API.
This callback is executed in the cooperative thread context. You can learn about the exact thread context by analyzing the
CONFIG_BT_RECV_CONTEXT
configuration choice. By default, this callback is executed in the Bluetooth-specific workqueue thread (
CONFIG_BT_RECV_WORKQ_BT
).
| src | Source of the ringing activity. |
| param | Requested ringing parameters. |