Callback Declarations#

Typedefs#

typedef void(*
rsi_bt_on_role_change_t)(uint16_t resp_status, rsi_bt_event_role_change_t *role_change_status)

When role change status event is received from the module this callback will be called.

typedef void(*
rsi_bt_on_connect_t)(uint16_t resp_status, rsi_bt_event_bond_t *bond_response)

When Connect event is raised from the module, this callback will be called. This event will be given by the module when BT PHY Level connection happens from either side.

typedef void(*
rsi_bt_on_unbond_t)(uint16_t resp_status, rsi_bt_event_unbond_t *unbond_status)

When unbond event is raised from the module this callback is called . This event will be given by the module when either slave or master device issues unbond command to the other.

typedef void(*
rsi_bt_on_disconnect_t)(uint16_t resp_status, rsi_bt_event_disconnect_t *bt_disconnect)

When disconnection event is raised from the module this callback will be called . This event will be given by the module when either slave or master device issues disconnect command to the other.

typedef void(*
rsi_bt_on_scan_resp_t)(uint16_t resp_status, rsi_bt_event_inquiry_response_t *single_scan_resp)

When the single scan response is received from the module in response to inquiry command this callback is called .

typedef void(*
rsi_bt_on_remote_name_resp_t)(uint16_t resp_status, rsi_bt_event_remote_device_name_t *name_resp)

When the remote name request command response is received from the module this callback is called.

typedef void(*
rsi_bt_on_passkey_display_t)(uint16_t resp_status, rsi_bt_event_user_passkey_display_t *bt_event_user_passkey_display)

When the passkey display request is received from the module this callback function is called .

typedef void(*
rsi_bt_on_remote_name_request_cancel_t)(uint16_t resp_status, rsi_bt_event_remote_name_request_cancel_t *remote_name_request_cancel)

When the remote name request cancels the command response received from the module this callback function is called .

typedef void(*
rsi_bt_on_confirm_request_t)(uint16_t resp_status, rsi_bt_event_user_confirmation_request_t *user_confirmation_request)

When the user confirmation request is received from the module this callback is called. The user has to give rsi_bt_accept_ssp_confirm or rsi_bt_reject_ssp_confirm command upon reception of this event.

typedef void(*
rsi_bt_on_pincode_request_t)(uint16_t resp_status, rsi_bt_event_user_pincode_request_t *user_pincode_request)

When pincode request is received from the module, this callback is called. User has to give rsi_bt_accept_pincode_request command upon reception of this event.

typedef void(*
rsi_bt_on_passkey_request_t)(uint16_t resp_status, rsi_bt_event_user_passkey_request_t *user_passkey_request)

When the passkey request is received from the module this callback is called. User has to give rsi_bt_passkey command upon reception of this event.

typedef void(*
rsi_bt_on_inquiry_complete_t)(uint16_t resp_status)

When inquiry complete status is received from the module this callback is called . This event will be given by the module when inquiry command is completely executed.

typedef void(*
rsi_bt_on_auth_complete_t)(uint16_t resp_status, rsi_bt_event_auth_complete_t *auth_complete)

When authentication complete indication is received from the module this callback is called .

typedef void(*
rsi_bt_on_linkkey_request_t)(uint16_t resp_status, rsi_bt_event_user_linkkey_request_t *user_linkkey_request)

When linkkey request is received from the module this callback is called. User has to give linkkey reply command upon reception of this event.

typedef void(*
rsi_bt_on_ssp_complete_t)(uint16_t resp_status, rsi_bt_event_ssp_complete_t *ssp_complete)

When SSP complete status is received from the module this callback is called .

typedef void(*
rsi_bt_on_linkkey_save_t)(uint16_t resp_status, rsi_bt_event_user_linkkey_save_t *user_linkkey_save)

When linkkey save is received from the module this callback is called.

typedef void(*
rsi_bt_on_get_services_t)(uint16_t resp_status, rsi_bt_resp_query_services_t *service_list)

When the get services command response is received from the module this callback is called .

typedef void(*
rsi_bt_on_search_service_t)(uint16_t resp_status, uint8_t *status)

When the search service command response is received from the module this calback is called.

typedef void(*
rsi_bt_on_mode_chnage_t)(uint16_t resp_status, rsi_bt_event_mode_change_t *mode_change)

When the local device enters / exits the Sniff mode this callback is called.

typedef void(*
rsi_bt_on_avdtp_stats_t)(uint16_t resp_status, rsi_bt_event_avdtp_stats_t *avdtp_event)

When AVDTP stats event is receicved from module this callback is called.

typedef void(*
rsi_bt_on_ar_stats_t)(uint16_t resp_status, rsi_bt_event_ar_stats_t *ar_event)

When AR stats event is received from module this callback is called.

typedef void(*
rsi_bt_pkt_change_stats_t)(uint16_t resp_status, rsi_bt_event_pkt_change_t *bt_pkt_change_stats)

When HCI packet type change receicved from module this callback is called.

typedef void(*
rsi_bt_on_sniff_subrating_t)(uint16_t resp_status, rsi_bt_event_sniff_subrating_t *mode_change)

When Sniff subrating is enabled or the parameters are negotiated with the remote device this callback is called .

typedef void(*
rsi_bt_on_connection_initiated_t)(uint16_t resp_status, rsi_bt_event_connection_initiated_t *mode_change)

When the headset initiates the connection this callback is called.

typedef void(*
rsi_bt_on_spp_connect_t)(uint16_t resp_status, rsi_bt_event_spp_connect_t *spp_connect)

When SPP connected event is raised from the module,this callback will be called . This event will be given by the module when spp profile level connection happens from either side.

typedef void(*
rsi_bt_on_spp_disconnect_t)(uint16_t resp_status, rsi_bt_event_spp_disconnect_t *spp_disconnect)

When SPP disconnected event is raised from the module,this callback will be called . This event will be given by the module when spp profile level disconnection happens from either side.

typedef void(*
rsi_bt_on_spp_rx_data_t)(uint16_t resp_status, rsi_bt_event_spp_receive_t *bt_event_spp_receive)

When SPP receive event is raised from the module,this callback will be called. This event will be given by the local device when it receives data from the remote device.

typedef void(*
rsi_bt_on_a2dp_connect_t)(uint16_t resp_status, rsi_bt_event_a2dp_connect_t *a2dp_connect)

When A2DP connected event is raised from the module, this callback will be called. This event will be given by the module when A2DP profile level connection happens from either side.

typedef void(*
rsi_bt_on_a2dp_disconnect_t)(uint16_t resp_status, rsi_bt_event_a2dp_disconnect_t *a2dp_disconnect)

When A2DP disconnected event is raised from the module, this callback will be called. This event will be given by the module when a2dp profile level disconnection happens from either side.

typedef void(*
rsi_bt_on_a2dp_configure_t)(uint16_t resp_status, rsi_bt_event_a2dp_configure_t *a2dp_configure)

When A2DP configured event is raised from the module, this callback will be called. This event will be given by the module when a2dp profile onfiguration happens from either side.

typedef void(*
rsi_bt_on_a2dp_open_t)(uint16_t resp_status, rsi_bt_event_a2dp_open_t *a2dp_open)

When A2DP open event is raised from the module, this callback will be called. This event will be given by the module when a2dp opens in either side.

typedef void(*
rsi_bt_on_a2dp_start_t)(uint16_t resp_status, rsi_bt_event_a2dp_start_t *a2dp_start)

When A2DP start event is raised from the module, this callback is called. This event will be given by the module when a2dp starts from either side.

typedef void(*
rsi_bt_on_a2dp_suspend_t)(uint16_t resp_status, rsi_bt_event_a2dp_suspend_t *a2dp_suspend)

When A2DP suspend event is raised from the module, this callback will be called. This event will be given by the module when a2dp suspend happens from either side.

typedef void(*
rsi_bt_on_a2dp_abort_t)(uint16_t resp_status, rsi_bt_event_a2dp_abort_t *a2dp_abort)

When A2DP abort event is raised from the module, this callback will be called. This event will be given by the module when a2dp abort happens from either side.

typedef void(*
rsi_bt_on_a2dp_close_t)(uint16_t resp_status, rsi_bt_event_a2dp_close_t *a2dp_close)

When A2DP close event is raised from the module, this callback will be called. This event will be given by the module when a2dp closed from either side.

typedef void(*
rsi_bt_on_a2dp_encode_data_t)(uint16_t resp_status, rsi_bt_event_a2dp_encode_data_t *a2dp_encode_data)

Callback function to be called if SBC data received from TA.

typedef void(*
rsi_bt_on_a2dp_pcm_data_t)(uint16_t resp_status, rsi_bt_event_a2dp_pcm_data_t *a2dp_pcm_data)

Callback function to be called if PCM data is received from TA.

typedef void(*
rsi_bt_on_a2dp_data_req_t)(uint16_t resp_status, rsi_bt_event_a2dp_more_data_req_t *a2dp_more_data_req)

Callback function to be called if more data request evenis received.

typedef void(*
rsi_bt_on_a2dp_reconfig_t)(uint16_t resp_status, rsi_bt_event_a2dp_reconfig_t *a2dp_reconfig)

When A2DP Reconfig event is raised from the module, this callback will be called.

typedef void(*
rsi_bt_on_avrcp_connect_t)(uint16_t resp_status, rsi_bt_event_avrcp_connect_t *bt_event_avrcp_connect)

When Avrcp Connect event is raised from the module, this callback will be called. This event will be given by the module when avrcp connection happens from either side.

typedef void(*
rsi_bt_on_avrcp_disconnect_t)(uint16_t resp_status, rsi_bt_event_avrcp_disconnect_t *bt_event_avrcp_disconnect)

When Avrcp Disconnect event is raised from the module, this callback will be called. This event will be given by the module when avrcp connection happens from either side.

typedef void(*
rsi_bt_on_avrcp_play_t)(uint16_t resp_status, rsi_bt_event_avrcp_play_t *bt_event_avrcp_play)

When Avrcp Play event is raised from the module, this callback will be called. This event will be given by the module when avrcp play button pressed/Released from Control Device.

typedef void(*
rsi_bt_on_avrcp_pause_t)(uint16_t resp_status, rsi_bt_event_avrcp_pause_t *bt_event_avrcp_pause)

When Avrcp Pause event is raised from the module, this callback will be called. This event will be given by the module when avrcp pause button pressed/Released from Control Device.

typedef void(*
rsi_bt_on_avrcp_stop_t)(uint16_t resp_status, rsi_bt_event_avrcp_stop_t *bt_event_avrcp_stop)

When Avrcp Stop event is raised from the module, this callback will be called. This event will be given by the module when avrcp stop button pressed/Released from Control Device.

typedef void(*
rsi_bt_on_avrcp_next_t)(uint16_t resp_status, rsi_bt_event_avrcp_next_t *bt_event_avrcp_next)

When Avrcp next event is raised from the module, this callback will be called. This event will be given by the module when avrcp next button pressed/Released from Control Device.

typedef void(*
rsi_bt_on_avrcp_previous_t)(uint16_t resp_status, rsi_bt_event_avrcp_previous_t *bt_event_avrcp_previous)

When Avrcp Previous event is raised from the module, this callback will be called. This event will be given by the module when avrcp Previous button pressed/Released from Control Device.

typedef void(*
rsi_bt_on_avrcp_vol_up_t)(uint16_t resp_status, rsi_bt_event_avrcp_vol_up_t *bt_event_avrcp_vol_up)

When Avrcp volume up event is raised from the module, this callback will be called. This event will be given by the module when avrcp volume up button pressed/Released from Control Device.

typedef void(*
rsi_bt_on_avrcp_vol_down_t)(uint16_t resp_status, rsi_bt_event_avrcp_vol_down_t *bt_event_avrcp_vol_down)

When Avrcp volume Down event is raised from the module, this callback will be called. This event will be given by the module when avrcp volume Down button pressed/Released from Control Device.

typedef void(*
rsi_bt_on_avrcp_get_elem_attr_resp_t)(uint16_t resp_status, rsi_bt_event_avrcp_get_elem_attr_resp_t *avrcp_get_elem_attr_resp)

When Remote Devices Element Attributes is received this callback will be called.

typedef void(*
rsi_bt_on_avrcp_notify_event_t)(uint16_t resp_status, rsi_bt_event_avrcp_notify_t *bt_event_avrcp_notify)

Callback function is invoke when avrcp notification received from Control Device.

typedef void(*
rsi_bt_on_avrcp_get_cap_event_t)(uint8_t *bd_addr, uint8_t cap_type)

Callback function is invoke when we receive get capabilities request from remote device.

typedef void(*

Callback function is invoke when we receive get application support attribute list request from remote device.

typedef void(*
rsi_bt_on_avrcp_get_app_suup_att_vals_event_t)(uint8_t *bd_addr, uint8_t att_id)

Callback function is invoke when we receive get application support attribute values request from remote device.

typedef void(*
rsi_bt_on_avrcp_get_app_cur_att_val_event_t)(rsi_bt_event_avrcp_get_cur_att_val_t *p_att_list)

Callback function is invoke when we receive get application current attributes value request from remote device.

typedef void(*
rsi_bt_on_avrcp_set_app_cur_att_val_event_t)(rsi_bt_event_avrcp_set_att_val_t *p_att_list)

Callback function is invoke when we receive set application curent attributes value request from remote device.

typedef void(*
rsi_bt_on_avrcp_get_app_att_text_event_t)(rsi_bt_event_avrcp_get_cur_att_val_t *p_att_list)

Callback function is invoke when we receive get application attributes text request from remote device.

typedef void(*
rsi_bt_on_avrcp_get_app_att_vals_text_event_t)(rsi_bt_event_avrcp_vals_text_req_t *p_vals_list)

Callback function is invoke when we receive get application attribute values text request from remote device.

typedef void(*
rsi_bt_on_avrcp_supp_char_sets_event_t)(rsi_bt_event_avrcp_char_sets_t *p_char_sets)

Callback function is invoke when we receive inform character sets request from remote device.

typedef void(*
rsi_bt_on_avrcp_batt_status_event_t)(uint8_t *bd_addr, uint8_t batt_status)

Callback function is invoke when we receive battery status from remote device.

typedef void(*
rsi_bt_on_avrcp_get_song_atts_event_t)(rsi_bt_event_avrcp_ele_att_t *p_song_atts)

Callback function is invoke when we receive element/song attribute request from remote device.

typedef void(*

Callback function is invoke when we receive player status from remote device.

typedef void(*
rsi_bt_on_avrcp_reg_notify_event_t)(uint8_t *bd_addr, uint8_t event_id)

Callback function is invoke when we receive register notify event from remote device.

typedef void(*
rsi_bt_on_avrcp_set_abs_vol_event_t)(uint16_t resp_status, rsi_bt_event_avrcp_set_abs_vol_t *p_abs_vol)

Callback function is invoke when we receive set absolute volume event from remote device.

typedef void(*
rsi_bt_on_avrcp_set_addr_player_event_t)(rsi_bt_event_avrcp_set_addr_player_t *p_set_addr_player)

Callback function is invoke when we receive set address player event from remote device.

typedef void(*
rsi_bt_on_avrcp_get_folder_items_event_t)(rsi_bt_event_avrcp_get_folder_items_t *p_get_folder_items)

Callback function is invoke when we receive get folder items event from remote device.

typedef void(*
rsi_bt_on_avrcp_get_tot_num_items_event_t)(rsi_bt_event_avrcp_get_tot_num_items_t *p_get_tot_num_items)

Callback function is invoke when we receive get total number of items event from remote device.

Typedef Documentation#

rsi_bt_on_role_change_t#

void(* rsi_bt_on_role_change_t)(uint16_t resp_status, rsi_bt_event_role_change_t *role_change_status) )(uint16_t resp_status, rsi_bt_event_role_change_t *role_change_status)

When role change status event is received from the module this callback will be called.

Parameters
[out]resp_statuscontains

the role_change_status information , please refer rsi_bt_event_role_change_s structure for more information.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes.

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 665 of file include/rsi_bt_apis.h

rsi_bt_on_connect_t#

void(* rsi_bt_on_connect_t)(uint16_t resp_status, rsi_bt_event_bond_t *bond_response) )(uint16_t resp_status, rsi_bt_event_bond_t *bond_response)

When Connect event is raised from the module, this callback will be called. This event will be given by the module when BT PHY Level connection happens from either side.

Parameters
[out]resp_statuscontains

the connect/bond response information , please refer rsi_bt_event_bond_response_s structure for more information.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 679 of file include/rsi_bt_apis.h

rsi_bt_on_unbond_t#

void(* rsi_bt_on_unbond_t)(uint16_t resp_status, rsi_bt_event_unbond_t *unbond_status) )(uint16_t resp_status, rsi_bt_event_unbond_t *unbond_status)

When unbond event is raised from the module this callback is called . This event will be given by the module when either slave or master device issues unbond command to the other.

Parameters
[out]resp_statuscontains

the disconnection information , please refer rsi_bt_event_unbond_s structure for more information.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 693 of file include/rsi_bt_apis.h

rsi_bt_on_disconnect_t#

void(* rsi_bt_on_disconnect_t)(uint16_t resp_status, rsi_bt_event_disconnect_t *bt_disconnect) )(uint16_t resp_status, rsi_bt_event_disconnect_t *bt_disconnect)

When disconnection event is raised from the module this callback will be called . This event will be given by the module when either slave or master device issues disconnect command to the other.

Parameters
[out]resp_statuscontains

the disconnection information , please refer rsi_bt_event_disconnect_s structure for more information.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 707 of file include/rsi_bt_apis.h

rsi_bt_on_scan_resp_t#

void(* rsi_bt_on_scan_resp_t)(uint16_t resp_status, rsi_bt_event_inquiry_response_t *single_scan_resp) )(uint16_t resp_status, rsi_bt_event_inquiry_response_t *single_scan_resp)

When the single scan response is received from the module in response to inquiry command this callback is called .

Parameters
[out]resp_statuscontains

the inquiry response information , please refer rsi_bt_event_inquiry_response_s structure for more information.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 720 of file include/rsi_bt_apis.h

rsi_bt_on_remote_name_resp_t#

void(* rsi_bt_on_remote_name_resp_t)(uint16_t resp_status, rsi_bt_event_remote_device_name_t *name_resp) )(uint16_t resp_status, rsi_bt_event_remote_device_name_t *name_resp)

When the remote name request command response is received from the module this callback is called.

Parameters
[out]resp_statuscontains

the remote device name information, please refer rsi_bt_event_remote_device_name_s structure for more information.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 733 of file include/rsi_bt_apis.h

rsi_bt_on_passkey_display_t#

typedef void(* rsi_bt_on_passkey_display_t)(uint16_t resp_status, rsi_bt_event_user_passkey_display_t *bt_event_user_passkey_display) )(uint16_t resp_status, rsi_bt_event_user_passkey_display_t *bt_event_user_passkey_display)

When the passkey display request is received from the module this callback function is called .

Parameters
[out]resp_statuscontains

the passkey information , please refer rsi_bt_event_user_passkey_display_s structure for more information.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 747 of file include/rsi_bt_apis.h

rsi_bt_on_remote_name_request_cancel_t#

typedef void(* rsi_bt_on_remote_name_request_cancel_t)(uint16_t resp_status, rsi_bt_event_remote_name_request_cancel_t *remote_name_request_cancel) )(uint16_t resp_status, rsi_bt_event_remote_name_request_cancel_t *remote_name_request_cancel)

When the remote name request cancels the command response received from the module this callback function is called .

Parameters
[out]resp_statuscontains

the response to remote name request cancel cmd , please refer rsi_bt_event_remote_name_request_cancel_s structure for more information.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 762 of file include/rsi_bt_apis.h

rsi_bt_on_confirm_request_t#

void(* rsi_bt_on_confirm_request_t)(uint16_t resp_status, rsi_bt_event_user_confirmation_request_t *user_confirmation_request) )(uint16_t resp_status, rsi_bt_event_user_confirmation_request_t *user_confirmation_request)

When the user confirmation request is received from the module this callback is called. The user has to give rsi_bt_accept_ssp_confirm or rsi_bt_reject_ssp_confirm command upon reception of this event.

Parameters
[out]resp_statuscontains

the confirmation request information ,please refer rsi_bt_event_user_confirmation_request_s structure for more information .

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 780 of file include/rsi_bt_apis.h

rsi_bt_on_pincode_request_t#

void(* rsi_bt_on_pincode_request_t)(uint16_t resp_status, rsi_bt_event_user_pincode_request_t *user_pincode_request) )(uint16_t resp_status, rsi_bt_event_user_pincode_request_t *user_pincode_request)

When pincode request is received from the module, this callback is called. User has to give rsi_bt_accept_pincode_request command upon reception of this event.

Parameters
[out]resp_statuscontains

the pincode request information ,please refer rsi_bt_event_user_pincode_request_s structure for more information.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 796 of file include/rsi_bt_apis.h

rsi_bt_on_passkey_request_t#

void(* rsi_bt_on_passkey_request_t)(uint16_t resp_status, rsi_bt_event_user_passkey_request_t *user_passkey_request) )(uint16_t resp_status, rsi_bt_event_user_passkey_request_t *user_passkey_request)

When the passkey request is received from the module this callback is called. User has to give rsi_bt_passkey command upon reception of this event.

Parameters
[out]resp_statuscontains

the passkey request information ,please refer rsi_bt_event_user_passkey_request_s structure for more information.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 812 of file include/rsi_bt_apis.h

rsi_bt_on_inquiry_complete_t#

void(* rsi_bt_on_inquiry_complete_t)(uint16_t resp_status) )(uint16_t resp_status)

When inquiry complete status is received from the module this callback is called . This event will be given by the module when inquiry command is completely executed.

Parameters
[out]resp_statuscontains

the response status (Success or Error code) 0 - SUCCESS Non-Zero Value - ErrorCodes

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 826 of file include/rsi_bt_apis.h

rsi_bt_on_auth_complete_t#

void(* rsi_bt_on_auth_complete_t)(uint16_t resp_status, rsi_bt_event_auth_complete_t *auth_complete) )(uint16_t resp_status, rsi_bt_event_auth_complete_t *auth_complete)

When authentication complete indication is received from the module this callback is called .

Parameters
[out]resp_statuscontains

the authentication complete information , please refer rsi_bt_event_auth_complete_s structure for more information.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 839 of file include/rsi_bt_apis.h

rsi_bt_on_linkkey_request_t#

void(* rsi_bt_on_linkkey_request_t)(uint16_t resp_status, rsi_bt_event_user_linkkey_request_t *user_linkkey_request) )(uint16_t resp_status, rsi_bt_event_user_linkkey_request_t *user_linkkey_request)

When linkkey request is received from the module this callback is called. User has to give linkkey reply command upon reception of this event.

Parameters
[out]resp_statuscontains

the linkkey request information , please refer rsi_bt_event_user_linkkey_request_s structure for mre information .

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 854 of file include/rsi_bt_apis.h

rsi_bt_on_ssp_complete_t#

void(* rsi_bt_on_ssp_complete_t)(uint16_t resp_status, rsi_bt_event_ssp_complete_t *ssp_complete) )(uint16_t resp_status, rsi_bt_event_ssp_complete_t *ssp_complete)

When SSP complete status is received from the module this callback is called .

Parameters
[out]resp_statuscontains

the ssp complete status, please refer rsi_bt_event_ssp_complete_s structure for more information .

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 868 of file include/rsi_bt_apis.h

rsi_bt_on_linkkey_save_t#

void(* rsi_bt_on_linkkey_save_t)(uint16_t resp_status, rsi_bt_event_user_linkkey_save_t *user_linkkey_save) )(uint16_t resp_status, rsi_bt_event_user_linkkey_save_t *user_linkkey_save)

When linkkey save is received from the module this callback is called.

Parameters
[out]resp_statuscontains

the linkkey save information , plesae refer rsi_bt_event_user_linkkey_save_s structure for more information.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 881 of file include/rsi_bt_apis.h

rsi_bt_on_get_services_t#

void(* rsi_bt_on_get_services_t)(uint16_t resp_status, rsi_bt_resp_query_services_t *service_list) )(uint16_t resp_status, rsi_bt_resp_query_services_t *service_list)

When the get services command response is received from the module this callback is called .

Parameters
[out]resp_statuscontains

the response information to get services cmd ,please refer rsi_bt_resp_query_services_s structure for more information.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback is Reserved for Future.

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 895 of file include/rsi_bt_apis.h

rsi_bt_on_search_service_t#

void(* rsi_bt_on_search_service_t)(uint16_t resp_status, uint8_t *status) )(uint16_t resp_status, uint8_t *status)

When the search service command response is received from the module this calback is called.

Parameters
[out]resp_statuscontains

the status response to search service cmd.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback is Reserved for Future.

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 909 of file include/rsi_bt_apis.h

rsi_bt_on_mode_chnage_t#

void(* rsi_bt_on_mode_chnage_t)(uint16_t resp_status, rsi_bt_event_mode_change_t *mode_change) )(uint16_t resp_status, rsi_bt_event_mode_change_t *mode_change)

When the local device enters / exits the Sniff mode this callback is called.

Parameters
[out]resp_statuscontains

the response payload for the mode change response , please refer rsi_bt_event_mode_change_s structure for more information .

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 922 of file include/rsi_bt_apis.h

rsi_bt_on_avdtp_stats_t#

void(* rsi_bt_on_avdtp_stats_t)(uint16_t resp_status, rsi_bt_event_avdtp_stats_t *avdtp_event) )(uint16_t resp_status, rsi_bt_event_avdtp_stats_t *avdtp_event)

When AVDTP stats event is receicved from module this callback is called.

Parameters
[out]resp_statuscontains

the response status (Success or Error code) 0 - SUCCESS Non-Zero Value - ErrorCodes

[out]avdtp_eventcontains

the avdtp stats parameters , please refer rsi_bt_event_avdtp_stats_s structure for more information .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avdtp_events_register_callbacks API


Definition at line 934 of file include/rsi_bt_apis.h

rsi_bt_on_ar_stats_t#

void(* rsi_bt_on_ar_stats_t)(uint16_t resp_status, rsi_bt_event_ar_stats_t *ar_event) )(uint16_t resp_status, rsi_bt_event_ar_stats_t *ar_event)

When AR stats event is received from module this callback is called.

Parameters
[out]resp_statuscontains

the response status (Success or Error code) 0 - SUCCESS Non-Zero Value - ErrorCodes

[out]ar_eventcontains

the ar stats parameters , please refer rsi_bt_event_ar_stats_s structure for more information.

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_ar_events_register_callbacks API


Definition at line 946 of file include/rsi_bt_apis.h

rsi_bt_pkt_change_stats_t#

void(* rsi_bt_pkt_change_stats_t)(uint16_t resp_status, rsi_bt_event_pkt_change_t *bt_pkt_change_stats) )(uint16_t resp_status, rsi_bt_event_pkt_change_t *bt_pkt_change_stats)

When HCI packet type change receicved from module this callback is called.

Parameters
[out]resp_statuscontains

the response status (Success or Error code) 0 - SUCCESS Non-Zero Value - ErrorCodes

[out]avdtp_eventcontains

the packet type , please refer rsi_bt_event_pkt_change_s structure for more information.

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_pkt_change_events_register_callbacks API


Definition at line 959 of file include/rsi_bt_apis.h

rsi_bt_on_sniff_subrating_t#

void(* rsi_bt_on_sniff_subrating_t)(uint16_t resp_status, rsi_bt_event_sniff_subrating_t *mode_change) )(uint16_t resp_status, rsi_bt_event_sniff_subrating_t *mode_change)

When Sniff subrating is enabled or the parameters are negotiated with the remote device this callback is called .

Parameters
[out]resp_statuscontains

parameters related to sniff subrating , please refer rsi_bt_event_sniff_subrating_s structure for more information.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 972 of file include/rsi_bt_apis.h

rsi_bt_on_connection_initiated_t#

void(* rsi_bt_on_connection_initiated_t)(uint16_t resp_status, rsi_bt_event_connection_initiated_t *mode_change) )(uint16_t resp_status, rsi_bt_event_connection_initiated_t *mode_change)

When the headset initiates the connection this callback is called.

Parameters
[out]resp_statuscontains

the value is 1 implies connection initiated by remote device , please refer rsi_bt_event_connection_initiated_s structure for more information.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_register_gap_callbacks API


Definition at line 985 of file include/rsi_bt_apis.h

rsi_bt_on_spp_connect_t#

void(* rsi_bt_on_spp_connect_t)(uint16_t resp_status, rsi_bt_event_spp_connect_t *spp_connect) )(uint16_t resp_status, rsi_bt_event_spp_connect_t *spp_connect)

When SPP connected event is raised from the module,this callback will be called . This event will be given by the module when spp profile level connection happens from either side.

Parameters
[out]resp_statuscontains

the spp connect information, please refer rsi_bt_event_spp_connect_s for more information.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_spp_register_callbacks API


Definition at line 1047 of file include/rsi_bt_apis.h

rsi_bt_on_spp_disconnect_t#

void(* rsi_bt_on_spp_disconnect_t)(uint16_t resp_status, rsi_bt_event_spp_disconnect_t *spp_disconnect) )(uint16_t resp_status, rsi_bt_event_spp_disconnect_t *spp_disconnect)

When SPP disconnected event is raised from the module,this callback will be called . This event will be given by the module when spp profile level disconnection happens from either side.

Parameters
[out]resp_statuscontains

the spp disconnect information, please refer rsi_bt_event_spp_disconnect_s structure for more information.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_spp_register_callbacks API.


Definition at line 1061 of file include/rsi_bt_apis.h

rsi_bt_on_spp_rx_data_t#

void(* rsi_bt_on_spp_rx_data_t)(uint16_t resp_status, rsi_bt_event_spp_receive_t *bt_event_spp_receive) )(uint16_t resp_status, rsi_bt_event_spp_receive_t *bt_event_spp_receive)

When SPP receive event is raised from the module,this callback will be called. This event will be given by the local device when it receives data from the remote device.

Parameters
[out]resp_statuscontains

the spp rcvd data information, please refer rsi_bt_event_spp_receive_s structure for more information.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_spp_register_callbacks API


Definition at line 1075 of file include/rsi_bt_apis.h

rsi_bt_on_a2dp_connect_t#

void(* rsi_bt_on_a2dp_connect_t)(uint16_t resp_status, rsi_bt_event_a2dp_connect_t *a2dp_connect) )(uint16_t resp_status, rsi_bt_event_a2dp_connect_t *a2dp_connect)

When A2DP connected event is raised from the module, this callback will be called. This event will be given by the module when A2DP profile level connection happens from either side.

Parameters
[out]resp_statuscontains

the a2dp connect information, please refer rsi_bt_event_a2dp_connect_s structure for more info.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_a2dp_register_callbacks API


Definition at line 1638 of file include/rsi_bt_apis.h

rsi_bt_on_a2dp_disconnect_t#

void(* rsi_bt_on_a2dp_disconnect_t)(uint16_t resp_status, rsi_bt_event_a2dp_disconnect_t *a2dp_disconnect) )(uint16_t resp_status, rsi_bt_event_a2dp_disconnect_t *a2dp_disconnect)

When A2DP disconnected event is raised from the module, this callback will be called. This event will be given by the module when a2dp profile level disconnection happens from either side.

Parameters
[out]resp_statuscontains

the a2dp disconnect information, please refer rsi_bt_event_a2dp_disconnect_s structure for more info.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_a2dp_register_callbacks API


Definition at line 1653 of file include/rsi_bt_apis.h

rsi_bt_on_a2dp_configure_t#

void(* rsi_bt_on_a2dp_configure_t)(uint16_t resp_status, rsi_bt_event_a2dp_configure_t *a2dp_configure) )(uint16_t resp_status, rsi_bt_event_a2dp_configure_t *a2dp_configure)

When A2DP configured event is raised from the module, this callback will be called. This event will be given by the module when a2dp profile onfiguration happens from either side.

Parameters
[out]resp_statuscontains

the a2dp configure information, please refer rsi_bt_event_a2dp_configure_s structure for more info.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_a2dp_register_callbacks API


Definition at line 1668 of file include/rsi_bt_apis.h

rsi_bt_on_a2dp_open_t#

void(* rsi_bt_on_a2dp_open_t)(uint16_t resp_status, rsi_bt_event_a2dp_open_t *a2dp_open) )(uint16_t resp_status, rsi_bt_event_a2dp_open_t *a2dp_open)

When A2DP open event is raised from the module, this callback will be called. This event will be given by the module when a2dp opens in either side.

Parameters
[out]resp_statuscontains

the a2dp open information, please refer rsi_bt_event_a2dp_open_s structure for more info.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_a2dp_register_callbacks API


Definition at line 1683 of file include/rsi_bt_apis.h

rsi_bt_on_a2dp_start_t#

void(* rsi_bt_on_a2dp_start_t)(uint16_t resp_status, rsi_bt_event_a2dp_start_t *a2dp_start) )(uint16_t resp_status, rsi_bt_event_a2dp_start_t *a2dp_start)

When A2DP start event is raised from the module, this callback is called. This event will be given by the module when a2dp starts from either side.

Parameters
[out]resp_statuscontains

the a2dp start information, please refer rsi_bt_event_a2dp_start_s structure for more info.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_a2dp_register_callbacks API


Definition at line 1698 of file include/rsi_bt_apis.h

rsi_bt_on_a2dp_suspend_t#

void(* rsi_bt_on_a2dp_suspend_t)(uint16_t resp_status, rsi_bt_event_a2dp_suspend_t *a2dp_suspend) )(uint16_t resp_status, rsi_bt_event_a2dp_suspend_t *a2dp_suspend)

When A2DP suspend event is raised from the module, this callback will be called. This event will be given by the module when a2dp suspend happens from either side.

Parameters
[out]resp_statuscontains

suspend, contains the a2dp suspend information, please refer rsi_bt_event_a2dp_suspend_s structure for more info.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_a2dp_register_callbacks API


Definition at line 1713 of file include/rsi_bt_apis.h

rsi_bt_on_a2dp_abort_t#

void(* rsi_bt_on_a2dp_abort_t)(uint16_t resp_status, rsi_bt_event_a2dp_abort_t *a2dp_abort) )(uint16_t resp_status, rsi_bt_event_a2dp_abort_t *a2dp_abort)

When A2DP abort event is raised from the module, this callback will be called. This event will be given by the module when a2dp abort happens from either side.

Parameters
[out]resp_statuscontains

the a2dp abort information, please refer rsi_bt_event_a2dp_abort_s structure for more info.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_a2dp_register_callbacks API


Definition at line 1728 of file include/rsi_bt_apis.h

rsi_bt_on_a2dp_close_t#

void(* rsi_bt_on_a2dp_close_t)(uint16_t resp_status, rsi_bt_event_a2dp_close_t *a2dp_close) )(uint16_t resp_status, rsi_bt_event_a2dp_close_t *a2dp_close)

When A2DP close event is raised from the module, this callback will be called. This event will be given by the module when a2dp closed from either side.

Parameters
[out]resp_statuscontains

the a2dp close information, please refer rsi_bt_event_a2dp_close_s structure for more info.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_a2dp_register_callbacks API


Definition at line 1743 of file include/rsi_bt_apis.h

rsi_bt_on_a2dp_encode_data_t#

void(* rsi_bt_on_a2dp_encode_data_t)(uint16_t resp_status, rsi_bt_event_a2dp_encode_data_t *a2dp_encode_data) )(uint16_t resp_status, rsi_bt_event_a2dp_encode_data_t *a2dp_encode_data)

Callback function to be called if SBC data received from TA.

Parameters
[out]resp_statuscontains

the SBC encoded packet information, please refer rsi_bt_event_a2dp_encode_data_s structure for more info.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_a2dp_register_callbacks API


Definition at line 1757 of file include/rsi_bt_apis.h

rsi_bt_on_a2dp_pcm_data_t#

void(* rsi_bt_on_a2dp_pcm_data_t)(uint16_t resp_status, rsi_bt_event_a2dp_pcm_data_t *a2dp_pcm_data) )(uint16_t resp_status, rsi_bt_event_a2dp_pcm_data_t *a2dp_pcm_data)

Callback function to be called if PCM data is received from TA.

Parameters
[out]resp_statuscontains

the PCM audio data information

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_a2dp_register_callbacks API


Definition at line 1770 of file include/rsi_bt_apis.h

rsi_bt_on_a2dp_data_req_t#

void(* rsi_bt_on_a2dp_data_req_t)(uint16_t resp_status, rsi_bt_event_a2dp_more_data_req_t *a2dp_more_data_req) )(uint16_t resp_status, rsi_bt_event_a2dp_more_data_req_t *a2dp_more_data_req)

Callback function to be called if more data request evenis received.

Parameters
[out]resp_statuscontains

the a2dp_more_data_req information

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_a2dp_register_callbacks API


Definition at line 1783 of file include/rsi_bt_apis.h

rsi_bt_on_a2dp_reconfig_t#

void(* rsi_bt_on_a2dp_reconfig_t)(uint16_t resp_status, rsi_bt_event_a2dp_reconfig_t *a2dp_reconfig) )(uint16_t resp_status, rsi_bt_event_a2dp_reconfig_t *a2dp_reconfig)

When A2DP Reconfig event is raised from the module, this callback will be called.

Parameters
[out]resp_statuscontains

the a2dp reconfig information, please refer rsi_bt_event_a2dp_reconfig_s structure for more info

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_a2dp_register_callbacks API


Definition at line 1796 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_connect_t#

void(* rsi_bt_on_avrcp_connect_t)(uint16_t resp_status, rsi_bt_event_avrcp_connect_t *bt_event_avrcp_connect) )(uint16_t resp_status, rsi_bt_event_avrcp_connect_t *bt_event_avrcp_connect)

When Avrcp Connect event is raised from the module, this callback will be called. This event will be given by the module when avrcp connection happens from either side.

Parameters
[out]resp_statuscontains

the avrcp connected information, please refer rsi_bt_event_avrcp_connect_s structure for more info.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_register_callbacks API


Definition at line 2065 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_disconnect_t#

void(* rsi_bt_on_avrcp_disconnect_t)(uint16_t resp_status, rsi_bt_event_avrcp_disconnect_t *bt_event_avrcp_disconnect) )(uint16_t resp_status, rsi_bt_event_avrcp_disconnect_t *bt_event_avrcp_disconnect)

When Avrcp Disconnect event is raised from the module, this callback will be called. This event will be given by the module when avrcp connection happens from either side.

Parameters
[out]resp_statuscontains

the avrcp disconnected information, please refer rsi_bt_event_avrcp_disconnect_s structure for more info.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_register_callbacks API


Definition at line 2081 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_play_t#

void(* rsi_bt_on_avrcp_play_t)(uint16_t resp_status, rsi_bt_event_avrcp_play_t *bt_event_avrcp_play) )(uint16_t resp_status, rsi_bt_event_avrcp_play_t *bt_event_avrcp_play)

When Avrcp Play event is raised from the module, this callback will be called. This event will be given by the module when avrcp play button pressed/Released from Control Device.

Parameters
[out]resp_statuscontains

the avrcp play information, please refer rsi_bt_event_avrcp_play_s structure for more info.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_register_callbacks API


Definition at line 2097 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_pause_t#

void(* rsi_bt_on_avrcp_pause_t)(uint16_t resp_status, rsi_bt_event_avrcp_pause_t *bt_event_avrcp_pause) )(uint16_t resp_status, rsi_bt_event_avrcp_pause_t *bt_event_avrcp_pause)

When Avrcp Pause event is raised from the module, this callback will be called. This event will be given by the module when avrcp pause button pressed/Released from Control Device.

Parameters
[out]resp_statuscontains

the avrcp pause information, please refer rsi_bt_event_avrcp_pause_s structure for more info.

Note

  • Refer Bluetooth Generic Error Codes section upto 0x4FF8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_register_callbacks API


Definition at line 2112 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_stop_t#

void(* rsi_bt_on_avrcp_stop_t)(uint16_t resp_status, rsi_bt_event_avrcp_stop_t *bt_event_avrcp_stop) )(uint16_t resp_status, rsi_bt_event_avrcp_stop_t *bt_event_avrcp_stop)

When Avrcp Stop event is raised from the module, this callback will be called. This event will be given by the module when avrcp stop button pressed/Released from Control Device.

Parameters
[out]resp_statuscontains

the avrcp pause information, please refer rsi_bt_event_avrcp_stop_s structure for more info.

Note

  • refer bluetooth generic error codes section upto 0x4ff8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_register_callbacks API


Definition at line 2127 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_next_t#

void(* rsi_bt_on_avrcp_next_t)(uint16_t resp_status, rsi_bt_event_avrcp_next_t *bt_event_avrcp_next) )(uint16_t resp_status, rsi_bt_event_avrcp_next_t *bt_event_avrcp_next)

When Avrcp next event is raised from the module, this callback will be called. This event will be given by the module when avrcp next button pressed/Released from Control Device.

Parameters
[out]resp_statuscontains

the avrcp next information, please refer rsi_bt_event_avrcp_next_s structure for more info.

Note

  • refer bluetooth generic error codes section upto 0x4ff8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_register_callbacks API


Definition at line 2142 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_previous_t#

void(* rsi_bt_on_avrcp_previous_t)(uint16_t resp_status, rsi_bt_event_avrcp_previous_t *bt_event_avrcp_previous) )(uint16_t resp_status, rsi_bt_event_avrcp_previous_t *bt_event_avrcp_previous)

When Avrcp Previous event is raised from the module, this callback will be called. This event will be given by the module when avrcp Previous button pressed/Released from Control Device.

Parameters
[out]resp_statuscontains

the avrcp previous information, please refer rsi_bt_event_avrcp_previous_s structure for more info.

Note

  • refer bluetooth generic error codes section upto 0x4ff8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_register_callbacks API


Definition at line 2158 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_vol_up_t#

void(* rsi_bt_on_avrcp_vol_up_t)(uint16_t resp_status, rsi_bt_event_avrcp_vol_up_t *bt_event_avrcp_vol_up) )(uint16_t resp_status, rsi_bt_event_avrcp_vol_up_t *bt_event_avrcp_vol_up)

When Avrcp volume up event is raised from the module, this callback will be called. This event will be given by the module when avrcp volume up button pressed/Released from Control Device.

Parameters
[out]resp_statuscontains

avrcp vol up info, please refer rsi_bt_event_avrcp_vol_up_s structure for more info.

Note

  • refer bluetooth generic error codes section upto 0x4ff8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_register_callbacks API


Definition at line 2174 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_vol_down_t#

void(* rsi_bt_on_avrcp_vol_down_t)(uint16_t resp_status, rsi_bt_event_avrcp_vol_down_t *bt_event_avrcp_vol_down) )(uint16_t resp_status, rsi_bt_event_avrcp_vol_down_t *bt_event_avrcp_vol_down)

When Avrcp volume Down event is raised from the module, this callback will be called. This event will be given by the module when avrcp volume Down button pressed/Released from Control Device.

Parameters
[out]resp_statuscontains

the avrcp vol down info, please refer rsi_bt_event_avrcp_vol_down_s structure for more info.

Note

  • refer bluetooth generic error codes section upto 0x4ff8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_register_callbacks API


Definition at line 2190 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_get_elem_attr_resp_t#

void(* rsi_bt_on_avrcp_get_elem_attr_resp_t)(uint16_t resp_status, rsi_bt_event_avrcp_get_elem_attr_resp_t *avrcp_get_elem_attr_resp) )(uint16_t resp_status, rsi_bt_event_avrcp_get_elem_attr_resp_t *avrcp_get_elem_attr_resp)

When Remote Devices Element Attributes is received this callback will be called.

Parameters
[out]resp_statuscontains

the avrcp get elem attr resp info.

Note

  • refer bluetooth generic error codes section upto 0x4ff8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_register_callbacks API


Definition at line 2205 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_notify_event_t#

void(* rsi_bt_on_avrcp_notify_event_t)(uint16_t resp_status, rsi_bt_event_avrcp_notify_t *bt_event_avrcp_notify) )(uint16_t resp_status, rsi_bt_event_avrcp_notify_t *bt_event_avrcp_notify)

Callback function is invoke when avrcp notification received from Control Device.

Parameters
[out]resp_statuscontains

the avrcp registered notifications information, please refer rsi_bt_event_avrcp_notify_s structure for more info.

Note

  • refer bluetooth generic error codes section upto 0x4ff8 from Error Codes .

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_register_callbacks API


Definition at line 2221 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_get_cap_event_t#

void(* rsi_bt_on_avrcp_get_cap_event_t)(uint8_t *bd_addr, uint8_t cap_type) )(uint8_t *bd_addr, uint8_t cap_type)

Callback function is invoke when we receive get capabilities request from remote device.

Parameters
[out]bd_addrRemote

bd address.

[out]cap_typeavrcp

capabilities type.

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_target_register_callbacks API


Definition at line 2409 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_get_app_supp_atts_event_t#

void(* rsi_bt_on_avrcp_get_app_supp_atts_event_t)(uint8_t *bd_addr) )(uint8_t *bd_addr)

Callback function is invoke when we receive get application support attribute list request from remote device.

Parameters
[out]bd_addrRemote

bd address.

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_target_register_callbacks API


Definition at line 2418 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_get_app_suup_att_vals_event_t#

void(* rsi_bt_on_avrcp_get_app_suup_att_vals_event_t)(uint8_t *bd_addr, uint8_t att_id) )(uint8_t *bd_addr, uint8_t att_id)

Callback function is invoke when we receive get application support attribute values request from remote device.

Parameters
[out]bd_addrRemote

bd address.

[out]att_idapplication

attribute id.

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_target_register_callbacks API


Definition at line 2428 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_get_app_cur_att_val_event_t#

void(* rsi_bt_on_avrcp_get_app_cur_att_val_event_t)(rsi_bt_event_avrcp_get_cur_att_val_t *p_att_list) )(rsi_bt_event_avrcp_get_cur_att_val_t *p_att_list)

Callback function is invoke when we receive get application current attributes value request from remote device.

Parameters
[out]p_att_listattribute

list, please refer rsi_bt_event_avrcp_get_cur_att_val_s structure for more info.

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_target_register_callbacks API


Definition at line 2438 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_set_app_cur_att_val_event_t#

void(* rsi_bt_on_avrcp_set_app_cur_att_val_event_t)(rsi_bt_event_avrcp_set_att_val_t *p_att_list) )(rsi_bt_event_avrcp_set_att_val_t *p_att_list)

Callback function is invoke when we receive set application curent attributes value request from remote device.

Parameters
[out]p_att_listattribute

list, please refer rsi_bt_event_avrcp_set_att_val_s structure for more info.

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_target_register_callbacks API


Definition at line 2448 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_get_app_att_text_event_t#

void(* rsi_bt_on_avrcp_get_app_att_text_event_t)(rsi_bt_event_avrcp_get_cur_att_val_t *p_att_list) )(rsi_bt_event_avrcp_get_cur_att_val_t *p_att_list)

Callback function is invoke when we receive get application attributes text request from remote device.

Parameters
[out]p_att_listattribute

list, please refer rsi_bt_event_avrcp_get_cur_att_val_s structure for more info.

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_target_register_callbacks API


Definition at line 2458 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_get_app_att_vals_text_event_t#

void(* rsi_bt_on_avrcp_get_app_att_vals_text_event_t)(rsi_bt_event_avrcp_vals_text_req_t *p_vals_list) )(rsi_bt_event_avrcp_vals_text_req_t *p_vals_list)

Callback function is invoke when we receive get application attribute values text request from remote device.

Parameters
[out]p_vals_listattribute

values list, please refer rsi_bt_event_avrcp_vals_text_req_s structure for more info.

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_target_register_callbacks API


Definition at line 2468 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_supp_char_sets_event_t#

void(* rsi_bt_on_avrcp_supp_char_sets_event_t)(rsi_bt_event_avrcp_char_sets_t *p_char_sets) )(rsi_bt_event_avrcp_char_sets_t *p_char_sets)

Callback function is invoke when we receive inform character sets request from remote device.

Parameters
[out]p_char_setssupport

character sets list, please refer rsi_bt_event_avrcp_char_sets_s structure for more info.

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_target_register_callbacks API


Definition at line 2478 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_batt_status_event_t#

void(* rsi_bt_on_avrcp_batt_status_event_t)(uint8_t *bd_addr, uint8_t batt_status) )(uint8_t *bd_addr, uint8_t batt_status)

Callback function is invoke when we receive battery status from remote device.

Parameters
[out]bd_addrRemote

bd address.

[out]batt_statusbattery

status.

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_target_register_callbacks API


Definition at line 2488 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_get_song_atts_event_t#

void(* rsi_bt_on_avrcp_get_song_atts_event_t)(rsi_bt_event_avrcp_ele_att_t *p_song_atts) )(rsi_bt_event_avrcp_ele_att_t *p_song_atts)

Callback function is invoke when we receive element/song attribute request from remote device.

Parameters
[out]p_song_attsrequested

song attribute list, please refer rsi_bt_event_avrcp_ele_att_s structure for more info.

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_target_register_callbacks API


Definition at line 2498 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_get_play_status_event_t#

void(* rsi_bt_on_avrcp_get_play_status_event_t)(uint8_t *bd_addr) )(uint8_t *bd_addr)

Callback function is invoke when we receive player status from remote device.

Parameters
[out]bd_addrRemote

bd address.

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_target_register_callbacks API


Definition at line 2507 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_reg_notify_event_t#

void(* rsi_bt_on_avrcp_reg_notify_event_t)(uint8_t *bd_addr, uint8_t event_id) )(uint8_t *bd_addr, uint8_t event_id)

Callback function is invoke when we receive register notify event from remote device.

Parameters
[out]bd_addrRemote

bd address.

[out]event_idEvent

for which the Control Device requires notifications

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_target_register_callbacks API


Definition at line 2517 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_set_abs_vol_event_t#

void(* rsi_bt_on_avrcp_set_abs_vol_event_t)(rsi_bt_event_avrcp_set_abs_vol_t *p_abs_vol) )(uint16_t resp_status, rsi_bt_event_avrcp_set_abs_vol_t *p_abs_vol)

Callback function is invoke when we receive set absolute volume event from remote device.

Parameters
[out]bd_addrRemote

bd address.

[out]p_abs_volavrcp

absolute vol, please refer rsi_bt_event_avrcp_set_abs_vol_s structure for more info.

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_target_register_callbacks API


Definition at line 2528 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_set_addr_player_event_t#

void(* rsi_bt_on_avrcp_set_addr_player_event_t)(rsi_bt_event_avrcp_set_addr_player_t *p_set_addr_player) )(rsi_bt_event_avrcp_set_addr_player_t *p_set_addr_player)

Callback function is invoke when we receive set address player event from remote device.

Parameters
[out]bd_addrRemote

bd address.

[out]p_set_addr_playerinform

the Target Device of which media player the Control Device wishes to control, please refer rsi_bt_event_avrcp_set_addr_player_s structure for more info.

Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_target_register_callbacks API


Definition at line 2539 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_get_folder_items_event_t#

typedef void(* rsi_bt_on_avrcp_get_folder_items_event_t) (rsi_bt_event_avrcp_get_folder_items_t *p_get_folder_items) )(rsi_bt_event_avrcp_get_folder_items_t *p_get_folder_items)

Callback function is invoke when we receive get folder items event from remote device.

Parameters
[out]bd_addrRemote

bd address.

[out]p_get_folder_itemsto

get the media player items list in a folder, please refer rsi_bt_event_avrcp_get_folder_items_s structure for more info.

@callback rsi_bt_on_avrcp_get_folder_items_event_t Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_target_register_callbacks API


Definition at line 2550 of file include/rsi_bt_apis.h

rsi_bt_on_avrcp_get_tot_num_items_event_t#

typedef void(* rsi_bt_on_avrcp_get_tot_num_items_event_t) (rsi_bt_event_avrcp_get_tot_num_items_t *p_get_tot_num_items) )(rsi_bt_event_avrcp_get_tot_num_items_t *p_get_tot_num_items)

Callback function is invoke when we receive get total number of items event from remote device.

Parameters
[out]bd_addrRemote

bd address.

[out]p_get_tot_num_itemstotal

number of items present in a folder, please refer rsi_bt_event_avrcp_get_tot_num_items_s structure for more info.

@callback rsi_bt_on_avrcp_get_tot_num_items_event_t Returns

  • void

Note

  • This callback has to be registered using rsi_bt_avrcp_target_register_callbacks API


Definition at line 2561 of file include/rsi_bt_apis.h