nRF Connect SDK API 0.1.0
Loading...
Searching...
No Matches

◆ bt_fast_pair_fmdn_ring_state_update()

int bt_fast_pair_fmdn_ring_state_update ( enum bt_fast_pair_fmdn_ring_src  src,
const struct bt_fast_pair_fmdn_ring_state_param param 
)

#include <include/bluetooth/services/fast_pair/fmdn.h>

Update the ringing state in the FMDN module.

This function updates the ringing state in the FMDN module and notifies connected peers about the change. The application user is responsible for setting the correct state that reflects the actual state of their ringing components.

You shall use this API to respond to the callbacks defined by the bt_fast_pair_fmdn_ring_cb structure. It is also possible to use this function to change the ringing state asynchronously. For example, you shall call this API when the user stops the ringing action manually (see the BT_FAST_PAIR_FMDN_RING_TRIGGER_UI_STOPPED trigger). In other cases, you may need to update the ringing state asynchronously to recover from the failure. For example, you can indicate the state change once you stop the ringing action on a previously unavailable component.

Parameters
srcSource of the ringing activity that triggered state update.
paramRinging state parameters. See the bt_fast_pair_fmdn_ring_state_param for the detailed description.
Returns
0 if the operation was successful. Otherwise, a (negative) error code is returned.