AVRCP#

Functions#

int32_t
rsi_bt_avrcp_init(uint8_t *avrcp_feature)

Set the AVRCP profile mode and also enables the Media Player Selection Feature, if required. This is a blocking API.

int32_t
rsi_bt_avrcp_conn(uint8_t *remote_dev_addr)

Initiate avrcp connection This is a blocking API. A received event rsi_bt_on_avrcp_connect_t indicates that the avrcp connection response.

int32_t
rsi_bt_avrcp_disconn(uint8_t *remote_dev_addr)

Initiate avrcp disconnection. This is a blocking API. A received event rsi_bt_on_avrcp_disconnect_t indicates that the avrcp disconnection response.

int32_t
rsi_bt_avrcp_play(uint8_t *remote_dev_addr)

To play a track, call this API. This is a blocking API. A received event rsi_bt_on_avrcp_play_t indicates that the avrcp play(Button Pressed/Button Released) response.

int32_t
rsi_bt_avrcp_pause(uint8_t *remote_dev_addr)

To Pause a track, call this API. This is a blocking API. A received event rsi_bt_on_avrcp_pause_t indicates that the avrcp pause(Button Pressed/Button Released) response.

int32_t
rsi_bt_avrcp_stop(uint8_t *remote_dev_addr)

To Stop a track, call this API. This is a blocking API.

int32_t
rsi_bt_avrcp_next(uint8_t *remote_dev_addr)

To Play the next track, call this API. This is a blocking API. A received event rsi_bt_on_avrcp_next_t indicates that the avrcp next(Button Pressed/Button Released) response.

int32_t
rsi_bt_avrcp_previous(uint8_t *remote_dev_addr)

To move to previous track, call this API. This is a blocking API. A received event rsi_bt_on_avrcp_previous_t indicates that the avrcp previous(Button Pressed/Button Released) response.

int32_t
rsi_bt_avrcp_vol_up(uint8_t *remote_dev_addr)

To Increase the volume of a track, call this API. This is a blocking API. A received event rsi_bt_on_avrcp_vol_up_t indicates that the avrcp volume(Button Pressed/Button Released) response.

int32_t
rsi_bt_avrcp_vol_down(uint8_t *remote_dev_addr)

To Decrease the volume a track, call this API. This is a blocking API. A received event rsi_bt_on_avrcp_vol_down_t indicates that the avrcp volume(Button Pressed/Button Released) response.

int32_t
rsi_bt_avrcp_get_capabilities(uint8_t *remote_dev_addr, uint8_t capability_type, rsi_bt_rsp_avrcp_get_capabilities_t *cap_list)

Gets the capabilities supported by remote device. This is a blocking API.

int32_t
rsi_bt_avrcp_get_att_list(uint8_t *remote_dev_addr, rsi_bt_rsp_avrcp_get_atts_list_t *att_list)

Requests the TG to provide target supported player application setting attributes. This is a blocking API.

int32_t
rsi_bt_avrcp_get_att_vals_list(uint8_t *remote_dev_addr, uint8_t att_id, rsi_bt_rsp_avrcp_get_att_vals_list_t *att_vals_list)

Requests the TG to list the set of possible values for the requested player application setting attribute. This is a blocking API.

int32_t
rsi_bt_avrcp_get_cur_att_val(uint8_t *remote_dev_addr, uint8_t *att_list, uint8_t nbr_atts, rsi_bt_rsp_avrcp_get_cur_att_val_t *att_vals_list)

Requests the TG to provide the current set values on the target for the provided player application setting attributes list. This is a blocking API.

int32_t
rsi_bt_avrcp_set_cur_att_val(uint8_t *remote_dev_addr, att_val_t *val_list, uint8_t nbr_atts)

requests to set the player application setting list of player application setting values on the TG for the corresponding defined list of PlayerApplicationSettingAttributes. This is a blocking API.

int32_t
rsi_bt_avrcp_get_element_att(uint8_t *remote_dev_addr, uint8_t *att_ids, uint8_t nbr_atts, rsi_bt_rsp_avrcp_elem_attr_t *att_vals)

Requests the TG to provide the attributes of the element specified in the parameter. This shall only be used to retrieve Metadata for the currently playing track from the Addressed Player on the Control channel when GetItemAttributes is not supported. This is a blocking API.

int32_t
rsi_bt_avrcp_get_play_status(uint8_t *remote_dev_addr, rsi_bt_rsp_avrcp_get_player_status_t *play_status)

CT to get the status of the currently playing media at the TG. This is a blocking API.

int32_t
rsi_bt_avrcp_reg_notification(uint8_t *remote_dev_addr, uint8_t event_id, uint8_t *p_resp_val)

Registers with the TG to receive notifications asynchronously based on specific events occurring. This is a blocking API.

int32_t
rsi_bt_avrcp_get_remote_version(uint8_t *remote_dev_addr, rsi_bt_rsp_avrcp_remote_version_t *version)

Get the AVRCP profile version from remote device. This is a blocking API.

int32_t
rsi_bt_avrcp_get_att_text(uint8_t *remote_dev_addr, uint8_t nbr_atts, uint8_t *p_atts, player_att_text_t *p_att_text_resp)

Requests the TG to provide supported player application setting attribute displayable text for the provided PlayerApplicationSettingAttributeID. This is a blocking API.

int32_t
rsi_bt_avrcp_get_att_val_text(uint8_t *remote_dev_addr, uint8_t att_id, uint8_t nbr_vals, uint8_t *p_vals, player_att_text_t *p_att_text_resp)

Get the AVRCP profile player attribute values text from remote device. This is a blocking API.

int32_t
rsi_bt_avrcp_batt_status(uint8_t *remote_dev_addr, uint8_t batt_level)

Send the device battery status to remote device. This is a blocking API.

int32_t
rsi_bt_avrcp_supp_char_sets(uint8_t *remote_dev_addr, uint8_t nbr_sets, uint16_t *p_sets)

Provides the list of character sets supported by CT to the TG. This shall allow the TG to send responses with strings in any of the character sets supported by CT. This is a blocking API.

int32_t
rsi_bt_avrcp_set_abs_vol(uint8_t *remote_dev_addr, uint8_t abs_vol, uint8_t *p_resp_abs_vol)

Send absolute volume information to remote device. This is a blocking API.

int32_t
rsi_bt_avrcp_cap_resp(uint8_t *remote_dev_addr, uint8_t cap_type, uint8_t nbr_caps, uint32_t *p_caps)

Sends the device capabilites Supported by TG to CT. This is a blocking API.

int32_t
rsi_bt_avrcp_att_list_resp(uint8_t *remote_dev_addr, uint8_t nbr_atts, uint8_t *p_atts)

Sends the supported attribute lists from TG to CT. This is a blocking API.

int32_t
rsi_bt_avrcp_att_val_list_resp(uint8_t *remote_dev_addr, uint8_t nbr_vals, uint8_t *p_vals)

Sends the attributes value list response from TG to CT. This is a blocking API.

int32_t
rsi_bt_avrcp_cur_att_val_resp(uint8_t *remote_dev_addr, uint8_t nbr_atts, att_val_t *p_att_vals)

Sends the current attributes values from TG to CT. This is a blocking API.

int32_t
rsi_bt_avrcp_set_cur_att_val_resp(uint8_t *remote_dev_addr, uint8_t status)

Sends the current attributes value status response from TG to CT. This is a blocking API.

int32_t
rsi_bt_avrcp_ele_att_resp(uint8_t *remote_dev_addr, uint8_t num_attrs, attr_list_t *p_attr_list)

Sends the Current Playing Track attributes from TG to CT. This is a blocking API.

int32_t
rsi_bt_avrcp_play_status_resp(uint8_t *remote_dev_addr, uint8_t play_status, uint32_t song_len, uint32_t song_pos)

Sends the Current Playing Track status from TG to CT. This is a blocking API.

int32_t
rsi_bt_avrcp_reg_notify_resp(uint8_t *remote_dev_addr, uint8_t event_id, uint8_t event_data_len, uint8_t *event_data)

Register notify Interim response from TG to CT. This is a blocking API.

int32_t
rsi_bt_avrcp_att_text_resp(uint8_t *remote_dev_addr, uint8_t nbr_atts, att_text_t *p_att_text)

Send supporting attribute text response to remote device. This is a blocking API.

int32_t
rsi_bt_avrcp_att_vals_text_resp(uint8_t *remote_dev_addr, uint8_t nbr_vals, att_text_t *p_vals_text)

Send supporting attribute values text response to remote device. This is a blocking API.

int32_t
rsi_bt_avrcp_batt_status_resp(uint8_t *remote_dev_addr, uint8_t status)

Sends battery status response from TG to CT. This is a blocking API.

int32_t
rsi_bt_avrcp_char_set_status_resp(uint8_t *remote_dev_addr, uint8_t status)

Sends character set repsonse from TG to CT. This is a blocking API.

int32_t
rsi_bt_avrcp_notify(uint8_t *remote_dev_addr, uint8_t event_id, notify_val_t *p_notify_val)

Register notify CHANGED response from TG to CT. This is a blocking API.

int32_t
rsi_bt_avrcp_cmd_reject(uint8_t *remote_dev_addr, uint8_t pdu_id, uint8_t status)

Rejects the received request from CT. This is a blocking API.

int32_t
rsi_bt_avrcp_set_abs_vol_resp(uint8_t *remote_dev_addr, uint8_t abs_vol)

Sends absolute volume response from TG to CT. This is a blocking API.

int32_t
rsi_bt_avrcp_set_addr_player_resp(uint8_t *remote_dev_addr, uint8_t status)

Sends Addressed player response from TG to CT. This is a blocking API.

int32_t
rsi_bt_avrcp_get_folder_items_resp(uint8_t *remote_dev_addr, uint8_t status, folder_items_resp_t folder_items_resp)

Sends folder items response from TG to CT. This is a blocking API.

int32_t
rsi_bt_avrcp_get_tot_num_items_resp(uint8_t *remote_dev_addr, uint8_t status, uint16_t uidcntr, uint32_t numofitems)

Sends the response for the total number of items from TG to CT. This is a blocking API.

Function Documentation#

rsi_bt_avrcp_init#

int32_t rsi_bt_avrcp_init (uint8_t *avrcp_feature)

Set the AVRCP profile mode and also enables the Media Player Selection Feature, if required. This is a blocking API.

Parameters
[in]avrcp_feature

- used for enabling avrcp features NULL - Default features used 1 - MediaPlayerSelection Feature Enable

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • if NULL is passed, AVRCP profile initialize with default stack features.


Definition at line 40 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_conn#

int32_t rsi_bt_avrcp_conn (uint8_t *remote_dev_addr)

Initiate avrcp connection This is a blocking API. A received event rsi_bt_on_avrcp_connect_t indicates that the avrcp connection response.

Parameters
[in]remote_dev_addr

- remote device address

  • Call rsi_bt_avrcp_init() before calling this API. Call this API after BT PHY level conn is completed.

Returns

  • 0 - Success Non-Zero Value - Failure 0x4540 ERR_BT_AVRCP_NOT_INITIALISED

Note

  • Refer Error Codes section for common error codes Error Codes .

  • If A2DP Profile is Initialized, then before calling this API the a2dp connection should be established using this rsi_bt_a2dp_conn() API and once rsi_bt_on_a2dp_open_t callback is received start the streaming using rsi_bt_stream_start() API. This is applicable for all AVRCP related API's.


Definition at line 66 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_disconn#

int32_t rsi_bt_avrcp_disconn (uint8_t *remote_dev_addr)

Initiate avrcp disconnection. This is a blocking API. A received event rsi_bt_on_avrcp_disconnect_t indicates that the avrcp disconnection response.

Parameters
[in]remote_dev_addr

- remote device address

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .


Definition at line 88 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_play#

int32_t rsi_bt_avrcp_play (uint8_t *remote_dev_addr)

To play a track, call this API. This is a blocking API. A received event rsi_bt_on_avrcp_play_t indicates that the avrcp play(Button Pressed/Button Released) response.

Parameters
[in]remote_dev_addr

- remote device address

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .


Definition at line 110 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_pause#

int32_t rsi_bt_avrcp_pause (uint8_t *remote_dev_addr)

To Pause a track, call this API. This is a blocking API. A received event rsi_bt_on_avrcp_pause_t indicates that the avrcp pause(Button Pressed/Button Released) response.

Parameters
[in]remote_dev_addr

- remote device address

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .


Definition at line 132 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_stop#

int32_t rsi_bt_avrcp_stop (uint8_t *remote_dev_addr)

To Stop a track, call this API. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .


Definition at line 153 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_next#

int32_t rsi_bt_avrcp_next (uint8_t *remote_dev_addr)

To Play the next track, call this API. This is a blocking API. A received event rsi_bt_on_avrcp_next_t indicates that the avrcp next(Button Pressed/Button Released) response.

Parameters
[in]remote_dev_addr

- remote device address

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .


Definition at line 175 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_previous#

int32_t rsi_bt_avrcp_previous (uint8_t *remote_dev_addr)

To move to previous track, call this API. This is a blocking API. A received event rsi_bt_on_avrcp_previous_t indicates that the avrcp previous(Button Pressed/Button Released) response.

Parameters
[in]remote_dev_addr

- remote device address

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .


Definition at line 197 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_vol_up#

int32_t rsi_bt_avrcp_vol_up (uint8_t *remote_dev_addr)

To Increase the volume of a track, call this API. This is a blocking API. A received event rsi_bt_on_avrcp_vol_up_t indicates that the avrcp volume(Button Pressed/Button Released) response.

Parameters
[in]remote_dev_addr

- remote device address

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .


Definition at line 219 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_vol_down#

int32_t rsi_bt_avrcp_vol_down (uint8_t *remote_dev_addr)

To Decrease the volume a track, call this API. This is a blocking API. A received event rsi_bt_on_avrcp_vol_down_t indicates that the avrcp volume(Button Pressed/Button Released) response.

Parameters
[in]remote_dev_addr

- remote device address

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .


Definition at line 241 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_get_capabilities#

int32_t rsi_bt_avrcp_get_capabilities (uint8_t *remote_dev_addr, uint8_t capability_type, rsi_bt_rsp_avrcp_get_capabilities_t *cap_list)

Gets the capabilities supported by remote device. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address

[in]capability_type

- capability type (either 2 or 3) 2 - Company ID 3 - Events Supported

[out]cap_list

- get remote capability list. Please refer rsi_bt_rsp_avrcp_get_capabilities_s structure for more info.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .


Definition at line 269 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_get_att_list#

int32_t rsi_bt_avrcp_get_att_list (uint8_t *remote_dev_addr, rsi_bt_rsp_avrcp_get_atts_list_t *att_list)

Requests the TG to provide target supported player application setting attributes. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address

[out]att_list

- attribute list, Please refer rsi_bt_rsp_avrcp_get_atts_list_s structure for more info.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 297 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_get_att_vals_list#

int32_t rsi_bt_avrcp_get_att_vals_list (uint8_t *remote_dev_addr, uint8_t att_id, rsi_bt_rsp_avrcp_get_att_vals_list_t *att_vals_list)

Requests the TG to list the set of possible values for the requested player application setting attribute. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address

[in]att_id

- attribute ID

[out]att_vals_list

- attribute value list, Please refer rsi_bt_rsp_avrcp_get_att_vals_list_s structure for more info.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 323 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_get_cur_att_val#

int32_t rsi_bt_avrcp_get_cur_att_val (uint8_t *remote_dev_addr, uint8_t *att_list, uint8_t nbr_atts, rsi_bt_rsp_avrcp_get_cur_att_val_t *att_vals_list)

Requests the TG to provide the current set values on the target for the provided player application setting attributes list. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address

[in]att_list

- attribute ID

[in]nbr_atts

- number of attributes

[out]att_vals_list

- attribute value list, Please refer rsi_bt_rsp_avrcp_get_cur_att_val_s structure for more info.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 357 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_set_cur_att_val#

int32_t rsi_bt_avrcp_set_cur_att_val (uint8_t *remote_dev_addr, att_val_t *val_list, uint8_t nbr_atts)

requests to set the player application setting list of player application setting values on the TG for the corresponding defined list of PlayerApplicationSettingAttributes. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address

[in]val_list

- value list

[in]nbr_atts

- number of attributes

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 394 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_get_element_att#

int32_t rsi_bt_avrcp_get_element_att (uint8_t *remote_dev_addr, uint8_t *att_ids, uint8_t nbr_atts, rsi_bt_rsp_avrcp_elem_attr_t *att_vals)

Requests the TG to provide the attributes of the element specified in the parameter. This shall only be used to retrieve Metadata for the currently playing track from the Addressed Player on the Control channel when GetItemAttributes is not supported. This is a blocking API.

Parameters
[in]remote_dev_addr

- Address of remote device

[in]att_ids

- attributes ids

[in]nbr_atts

- number of attributes

[out]att_vals

- attribute values in the list. Please refer rsi_bt_rsp_avrcp_elem_attr_s structure for more info.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 432 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_get_play_status#

int32_t rsi_bt_avrcp_get_play_status (uint8_t *remote_dev_addr, rsi_bt_rsp_avrcp_get_player_status_t *play_status)

CT to get the status of the currently playing media at the TG. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address

[out]play_status

- to capture the player status Please refer rsi_bt_rsp_avrcp_get_player_status_s structure for more info.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 466 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_reg_notification#

int32_t rsi_bt_avrcp_reg_notification (uint8_t *remote_dev_addr, uint8_t event_id, uint8_t *p_resp_val)

Registers with the TG to receive notifications asynchronously based on specific events occurring. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]event_id

- event ID.

[out]p_resp_val

- used to capture response for the event which is registered.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 490 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_get_remote_version#

int32_t rsi_bt_avrcp_get_remote_version (uint8_t *remote_dev_addr, rsi_bt_rsp_avrcp_remote_version_t *version)

Get the AVRCP profile version from remote device. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[out]version

- version info. Please refer rsi_bt_rsp_avrcp_remote_version_s structure for more info

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .


Definition at line 520 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_get_att_text#

int32_t rsi_bt_avrcp_get_att_text (uint8_t *remote_dev_addr, uint8_t nbr_atts, uint8_t *p_atts, player_att_text_t *p_att_text_resp)

Requests the TG to provide supported player application setting attribute displayable text for the provided PlayerApplicationSettingAttributeID. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]nbr_atts

- number of attributes.

[in]p_atts

- pointer to attributes.

[out]p_att_text_resp

- to capture response from this API. Please refer player_att_text_s structure for more info.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 550 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_get_att_val_text#

int32_t rsi_bt_avrcp_get_att_val_text (uint8_t *remote_dev_addr, uint8_t att_id, uint8_t nbr_vals, uint8_t *p_vals, player_att_text_t *p_att_text_resp)

Get the AVRCP profile player attribute values text from remote device. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]att_id

- attribute ID.

[in]nbr_vals

- number of attribute values.

[in]p_vals

- pointer to attribute values.

[out]p_att_text_resp

- to capture response from this API. Please refer player_att_text_s structure for more info.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .


Definition at line 590 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_batt_status#

int32_t rsi_bt_avrcp_batt_status (uint8_t *remote_dev_addr, uint8_t batt_level)

Send the device battery status to remote device. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]batt_level

- to update battery level.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .


Definition at line 624 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_supp_char_sets#

int32_t rsi_bt_avrcp_supp_char_sets (uint8_t *remote_dev_addr, uint8_t nbr_sets, uint16_t *p_sets)

Provides the list of character sets supported by CT to the TG. This shall allow the TG to send responses with strings in any of the character sets supported by CT. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]nbr_sets

- Number of displayable character sets provided

[in]p_sets

- Supported Character Set

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 652 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_set_abs_vol#

int32_t rsi_bt_avrcp_set_abs_vol (uint8_t *remote_dev_addr, uint8_t abs_vol, uint8_t *p_resp_abs_vol)

Send absolute volume information to remote device. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]abs_vol

- absolute volume.

[out]p_resp_abs_vol

- to capture the response from this API.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .


Definition at line 682 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_cap_resp#

int32_t rsi_bt_avrcp_cap_resp (uint8_t *remote_dev_addr, uint8_t cap_type, uint8_t nbr_caps, uint32_t *p_caps)

Sends the device capabilites Supported by TG to CT. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]cap_type

- capability type.

[in]nbr_caps

- number of capabilities

[in]p_caps

- capability ID's list.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 710 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_att_list_resp#

int32_t rsi_bt_avrcp_att_list_resp (uint8_t *remote_dev_addr, uint8_t nbr_atts, uint8_t *p_atts)

Sends the supported attribute lists from TG to CT. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]nbr_atts

- number of attributes.

[in]p_atts

- pointer to attributes list.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 743 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_att_val_list_resp#

int32_t rsi_bt_avrcp_att_val_list_resp (uint8_t *remote_dev_addr, uint8_t nbr_vals, uint8_t *p_vals)

Sends the attributes value list response from TG to CT. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]nbr_vals

- number of values.

[in]p_vals

- pointer to values list.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 775 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_cur_att_val_resp#

int32_t rsi_bt_avrcp_cur_att_val_resp (uint8_t *remote_dev_addr, uint8_t nbr_atts, att_val_t *p_att_vals)

Sends the current attributes values from TG to CT. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]nbr_atts

- number of attributes.

[in]p_att_vals

- pointer to attributes values list. Please refer attr_list_s structure for more info.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 808 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_set_cur_att_val_resp#

int32_t rsi_bt_avrcp_set_cur_att_val_resp (uint8_t *remote_dev_addr, uint8_t status)

Sends the current attributes value status response from TG to CT. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]status

- status to be sent.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 839 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_ele_att_resp#

int32_t rsi_bt_avrcp_ele_att_resp (uint8_t *remote_dev_addr, uint8_t num_attrs, attr_list_t *p_attr_list)

Sends the Current Playing Track attributes from TG to CT. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]num_attrs

- number of attributes.

[in]p_attr_list

- pointer to attributes list. Please refer attr_list_s structure for more info.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 869 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_play_status_resp#

int32_t rsi_bt_avrcp_play_status_resp (uint8_t *remote_dev_addr, uint8_t play_status, uint32_t song_len, uint32_t song_pos)

Sends the Current Playing Track status from TG to CT. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]play_status

- player status.

[in]song_len

- song length.

[in]song_pos

- song position.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 907 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_reg_notify_resp#

int32_t rsi_bt_avrcp_reg_notify_resp (uint8_t *remote_dev_addr, uint8_t event_id, uint8_t event_data_len, uint8_t *event_data)

Register notify Interim response from TG to CT. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]event_id

- event ID.

[in]event_data_len

- length of event_data buffer.

[in]event_data

- event data.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 943 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_att_text_resp#

int32_t rsi_bt_avrcp_att_text_resp (uint8_t *remote_dev_addr, uint8_t nbr_atts, att_text_t *p_att_text)

Send supporting attribute text response to remote device. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]nbr_atts

- number of attributes.

[in]p_att_text

- pointer to attribute text. Please refer att_text_s structure for more info.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .


Definition at line 988 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_att_vals_text_resp#

int32_t rsi_bt_avrcp_att_vals_text_resp (uint8_t *remote_dev_addr, uint8_t nbr_vals, att_text_t *p_vals_text)

Send supporting attribute values text response to remote device. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]nbr_vals

- number of values.

[in]p_vals_text

- pointer to values list. Please refer att_text_s structure for more info.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .


Definition at line 1021 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_batt_status_resp#

int32_t rsi_bt_avrcp_batt_status_resp (uint8_t *remote_dev_addr, uint8_t status)

Sends battery status response from TG to CT. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]status

- status to be sent.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 1052 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_char_set_status_resp#

int32_t rsi_bt_avrcp_char_set_status_resp (uint8_t *remote_dev_addr, uint8_t status)

Sends character set repsonse from TG to CT. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]status

- status to be sent.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 1079 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_notify#

int32_t rsi_bt_avrcp_notify (uint8_t *remote_dev_addr, uint8_t event_id, notify_val_t *p_notify_val)

Register notify CHANGED response from TG to CT. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]event_id

- event ID.

[in]p_notify_val

- pointer to notofication values. please refer notify_val_s structure for more info.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 1107 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_cmd_reject#

int32_t rsi_bt_avrcp_cmd_reject (uint8_t *remote_dev_addr, uint8_t pdu_id, uint8_t status)

Rejects the received request from CT. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]pdu_id

- PDU ID.

[in]status

- status to be sent.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 1135 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_set_abs_vol_resp#

int32_t rsi_bt_avrcp_set_abs_vol_resp (uint8_t *remote_dev_addr, uint8_t abs_vol)

Sends absolute volume response from TG to CT. This is a blocking API.

Parameters
[in]remote_dev_addr

- remote device address.

[in]abs_vol

- absolute volume.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 1162 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_set_addr_player_resp#

int32_t rsi_bt_avrcp_set_addr_player_resp (uint8_t *remote_dev_addr, uint8_t status)

Sends Addressed player response from TG to CT. This is a blocking API.

Parameters
[in]remote_dev_addr

- Remote device Address

[in]status

- Status

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • This funtion can be accessed only if Media Player Selection Feature is enabled via bt_avrcp_init().

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 1189 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_get_folder_items_resp#

int32_t rsi_bt_avrcp_get_folder_items_resp (uint8_t *remote_dev_addr, uint8_t status, folder_items_resp_t folder_items_resp)

Sends folder items response from TG to CT. This is a blocking API.

Parameters
[in]remote_dev_addr

- Remote device Address

[in]status

- Status

[in]folder_items_resp

- Folder items, Please refer folder_items_resp_s structure for more info.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • The folder_items_resp flag holds the details of Media Player Items. This funtion can be accessed only if Media Player Selection Feature is enabled via bt_avrcp_init().

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 1219 of file bluetooth/rsi_bt_avrcp_apis.c

rsi_bt_avrcp_get_tot_num_items_resp#

int32_t rsi_bt_avrcp_get_tot_num_items_resp (uint8_t *remote_dev_addr, uint8_t status, uint16_t uidcntr, uint32_t numofitems)

Sends the response for the total number of items from TG to CT. This is a blocking API.

Parameters
[in]remote_dev_addr

- Remote device Address

[in]status

- Status

[in]uidcntr

- uid counter

[in]numofitems

- Number of items

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes Error Codes .

  • This funtion can be accessed only if Media Player Selection Feature is enabled via bt_avrcp_init().

  • CT and TG specifies Controller and Target respectively as per BT AVRCP Specification.


Definition at line 1252 of file bluetooth/rsi_bt_avrcp_apis.c