AVRCP Controller API

#include "src/classic/avrcp_controller.h"

typedef enum {
    AVRCP_CONTROLLER_SUPPORTED_FEATURE_CATEGORY_PLAYER_OR_RECORDER = 0,
    AVRCP_CONTROLLER_SUPPORTED_FEATURE_CATEGORY_MONITOR_OR_AMPLIFIER,
    AVRCP_CONTROLLER_SUPPORTED_FEATURE_CATEGORY_TUNER,
    AVRCP_CONTROLLER_SUPPORTED_FEATURE_CATEGORY_MENU,
    AVRCP_CONTROLLER_SUPPORTED_FEATURE_RESERVED_4,
    AVRCP_CONTROLLER_SUPPORTED_FEATURE_RESERVED_5,
    AVRCP_CONTROLLER_SUPPORTED_FEATURE_BROWSING,
    AVRCP_CONTROLLER_SUPPORTED_FEATURE_COVER_ART_GET_IMAGE_PROPERTIES,
    AVRCP_CONTROLLER_SUPPORTED_FEATURE_COVER_ART_GET_IMAGE,
    AVRCP_CONTROLLER_SUPPORTED_FEATURE_COVER_ART_GET_LINKED_THUMBNAIL
} avrcp_controller_supported_feature_t;

avrcp_controller_create_sdp_record

void avrcp_controller_create_sdp_record(uint8_t * service, uint32_t service_record_handle, uint16_t supported_features, const char * service_name, const char * service_provider_name);

AVRCP Controller service record.

Parameters

Source


avrcp_controller_init

void avrcp_controller_init(void);

Set up AVRCP Controller service.

Source


avrcp_controller_register_packet_handler

void avrcp_controller_register_packet_handler(btstack_packet_handler_t callback);

Register callback for the AVRCP Controller client.

Parameters

Source


avrcp_controller_set_max_num_fragments

uint8_t avrcp_controller_set_max_num_fragments(uint16_t avrcp_cid, uint8_t max_num_fragments);

Set max num fragments in whuch message can be transmited.

Parameters

Returns

Source


avrcp_controller_unit_info

uint8_t avrcp_controller_unit_info(uint16_t avrcp_cid);

Unit info.

Parameters

Returns

Source


avrcp_controller_subunit_info

uint8_t avrcp_controller_subunit_info(uint16_t avrcp_cid);

Subunit info.

Parameters

Returns

Source


avrcp_controller_get_supported_company_ids

uint8_t avrcp_controller_get_supported_company_ids(uint16_t avrcp_cid);

Get capabilities.

Parameters

Returns

Source


avrcp_controller_get_supported_events

uint8_t avrcp_controller_get_supported_events(uint16_t avrcp_cid);

Get supported Events.

Parameters

Returns

Source


avrcp_controller_start_press_and_hold_cmd

uint8_t avrcp_controller_start_press_and_hold_cmd(uint16_t avrcp_cid, avrcp_operation_id_t operation_id);

Start continuous cmd (play, pause, volume up, ...). Event AVRCP_SUBEVENT_OPERATION_COMPLETE returns operation id and status.

Parameters

Returns

Source


avrcp_controller_release_press_and_hold_cmd

uint8_t avrcp_controller_release_press_and_hold_cmd(uint16_t avrcp_cid);

Stops continuous cmd (play, pause, volume up, ...). Event AVRCP_SUBEVENT_OPERATION_COMPLETE returns operation id and status.

Parameters

Returns

Source


avrcp_controller_send_pass_through_cmd

uint8_t avrcp_controller_send_pass_through_cmd(uint16_t avrcp_cid, avrcp_operation_id_t operation_id);

Send PASS THROUGH command. Event AVRCP_SUBEVENT_OPERATION_COMPLETE returns operation id and status.

Parameters

Returns

Source


avrcp_controller_play

uint8_t avrcp_controller_play(uint16_t avrcp_cid);

Play. Event AVRCP_SUBEVENT_OPERATION_COMPLETE returns operation id and status.

Parameters

Returns

Source


avrcp_controller_press_and_hold_play

uint8_t avrcp_controller_press_and_hold_play(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_stop

uint8_t avrcp_controller_stop(uint16_t avrcp_cid);

Stop. Event AVRCP_SUBEVENT_OPERATION_COMPLETE returns operation id and status.

Parameters

Returns

Source


avrcp_controller_press_and_hold_stop

uint8_t avrcp_controller_press_and_hold_stop(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_pause

uint8_t avrcp_controller_pause(uint16_t avrcp_cid);

Pause. Event AVRCP_SUBEVENT_OPERATION_COMPLETE returns operation id and status.

Parameters

Returns

Source


avrcp_controller_press_and_hold_pause

uint8_t avrcp_controller_press_and_hold_pause(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_fast_forward

uint8_t avrcp_controller_fast_forward(uint16_t avrcp_cid);

Single step - fast forward. Event AVRCP_SUBEVENT_OPERATION_COMPLETE returns operation id and status.

Parameters

Returns

Source


avrcp_controller_press_and_hold_fast_forward

uint8_t avrcp_controller_press_and_hold_fast_forward(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_rewind

uint8_t avrcp_controller_rewind(uint16_t avrcp_cid);

Single step rewind. Event AVRCP_SUBEVENT_OPERATION_COMPLETE returns operation id and status.

Parameters

Returns

Source


avrcp_controller_press_and_hold_rewind

uint8_t avrcp_controller_press_and_hold_rewind(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_forward

uint8_t avrcp_controller_forward(uint16_t avrcp_cid);

Forward. Event AVRCP_SUBEVENT_OPERATION_COMPLETE returns operation id and status.

Parameters

Returns

Source


avrcp_controller_press_and_hold_forward

uint8_t avrcp_controller_press_and_hold_forward(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_backward

uint8_t avrcp_controller_backward(uint16_t avrcp_cid);

Backward. Event AVRCP_SUBEVENT_OPERATION_COMPLETE returns operation id and status.

Parameters

Returns

Source


avrcp_controller_press_and_hold_backward

uint8_t avrcp_controller_press_and_hold_backward(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_volume_up

uint8_t avrcp_controller_volume_up(uint16_t avrcp_cid);

Turn up volume. Event AVRCP_SUBEVENT_OPERATION_COMPLETE returns operation id and status.

Parameters

Returns

Source


avrcp_controller_press_and_hold_volume_up

uint8_t avrcp_controller_press_and_hold_volume_up(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_volume_down

uint8_t avrcp_controller_volume_down(uint16_t avrcp_cid);

Turn down volume. Event AVRCP_SUBEVENT_OPERATION_COMPLETE returns operation id and status.

Parameters

Returns

Source


avrcp_controller_press_and_hold_volume_down

uint8_t avrcp_controller_press_and_hold_volume_down(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_mute

uint8_t avrcp_controller_mute(uint16_t avrcp_cid);

Mute sound. Event AVRCP_SUBEVENT_OPERATION_COMPLETE returns operation id and status.

Parameters

Returns

Source


avrcp_controller_press_and_hold_mute

uint8_t avrcp_controller_press_and_hold_mute(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_record

uint8_t avrcp_controller_record(uint16_t avrcp_cid);

Record. Event AVRCP_SUBEVENT_OPERATION_COMPLETE returns operation id and status.

Parameters

Returns

Source


avrcp_controller_eject

uint8_t avrcp_controller_eject(uint16_t avrcp_cid);

Eject. Event AVRCP_SUBEVENT_OPERATION_COMPLETE returns operation id and status.

Parameters

Returns

Source


// Basic Group Navigation

avrcp_controller_next_group

uint8_t avrcp_controller_next_group(uint16_t avrcp_cid);

Move to the first song in the next group.

Parameters

Returns

Source


avrcp_controller_previous_group

uint8_t avrcp_controller_previous_group(uint16_t avrcp_cid);

Move to the first song in the previous group.

Parameters

Returns

Source


// Category 3

avrcp_controller_0

uint8_t avrcp_controller_0(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_1

uint8_t avrcp_controller_1(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_2

uint8_t avrcp_controller_2(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_3

uint8_t avrcp_controller_3(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_4

uint8_t avrcp_controller_4(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_5

uint8_t avrcp_controller_5(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_6

uint8_t avrcp_controller_6(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_7

uint8_t avrcp_controller_7(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_8

uint8_t avrcp_controller_8(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_9

uint8_t avrcp_controller_9(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_dot

uint8_t avrcp_controller_dot(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_enter

uint8_t avrcp_controller_enter(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_clear

uint8_t avrcp_controller_clear(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_channel_up

uint8_t avrcp_controller_channel_up(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_channel_down

uint8_t avrcp_controller_channel_down(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_previous_channel

uint8_t avrcp_controller_previous_channel(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_sound_select

uint8_t avrcp_controller_sound_select(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_input_select

uint8_t avrcp_controller_input_select(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_display_information

uint8_t avrcp_controller_display_information(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_help

uint8_t avrcp_controller_help(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_power

uint8_t avrcp_controller_power(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_angle

uint8_t avrcp_controller_angle(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_subpicture

uint8_t avrcp_controller_subpicture(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_F1

uint8_t avrcp_controller_F1(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_F2

uint8_t avrcp_controller_F2(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_F3

uint8_t avrcp_controller_F3(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_F4

uint8_t avrcp_controller_F4(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_F5

uint8_t avrcp_controller_F5(uint16_t avrcp_cid);

Returns

Source


// Category 4

avrcp_controller_select

uint8_t avrcp_controller_select(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_up

uint8_t avrcp_controller_up(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_down

uint8_t avrcp_controller_down(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_left

uint8_t avrcp_controller_left(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_right

uint8_t avrcp_controller_right(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_right_up

uint8_t avrcp_controller_right_up(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_right_down

uint8_t avrcp_controller_right_down(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_left_up

uint8_t avrcp_controller_left_up(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_left_down

uint8_t avrcp_controller_left_down(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_root_menu

uint8_t avrcp_controller_root_menu(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_setup_menu

uint8_t avrcp_controller_setup_menu(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_contents_menu

uint8_t avrcp_controller_contents_menu(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_favorite_menu

uint8_t avrcp_controller_favorite_menu(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_exit

uint8_t avrcp_controller_exit(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_page_up

uint8_t avrcp_controller_page_up(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_page_down

uint8_t avrcp_controller_page_down(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_get_play_status

uint8_t avrcp_controller_get_play_status(uint16_t avrcp_cid);

Get play status. Returns event of type AVRCP_SUBEVENT_PLAY_STATUS (length, position, play_status). If TG does not support SongLength And SongPosition on TG, then TG shall return 0xFFFFFFFF.

Parameters

Returns

Source


avrcp_controller_enable_notification

uint8_t avrcp_controller_enable_notification(uint16_t avrcp_cid, avrcp_notification_event_id_t event_id);

Enable notification. Response via AVRCP_SUBEVENT_NOTIFICATION_STATE.

Parameters

Returns

Source


avrcp_controller_disable_notification

uint8_t avrcp_controller_disable_notification(uint16_t avrcp_cid, avrcp_notification_event_id_t event_id);

Disable notification. Response via AVRCP_SUBEVENT_NOTIFICATION_STATE.

Parameters

Returns

Source


avrcp_controller_get_element_attributes

uint8_t avrcp_controller_get_element_attributes(uint16_t avrcp_cid, uint8_t num_attributes, avrcp_media_attribute_id_t * attributes);

Get info on now playing media using subset of attribute IDs

Parameters

Returns

Source


avrcp_controller_get_now_playing_info

uint8_t avrcp_controller_get_now_playing_info(uint16_t avrcp_cid);

Get info on now playing media using all IDs.

Parameters

Returns

Source


avrcp_controller_get_now_playing_info_for_media_attribute_id

uint8_t avrcp_controller_get_now_playing_info_for_media_attribute_id(uint16_t avrcp_cid, avrcp_media_attribute_id_t media_attribute_id);

Get info on now playing media using specific media attribute ID.

Parameters

Returns

Source


avrcp_controller_set_absolute_volume

uint8_t avrcp_controller_set_absolute_volume(uint16_t avrcp_cid, uint8_t volume);

Set absolute volume 0-127 (corresponds to 0-100%). Response via AVRCP_SUBEVENT_SET_ABSOLUTE_VOLUME_RESPONSE

Parameters

Returns

Source


avrcp_controller_skip

uint8_t avrcp_controller_skip(uint16_t avrcp_cid);

Skip to next playing media. Event AVRCP_SUBEVENT_OPERATION_COMPLETE returns operation id and status.

Parameters

Returns

Source


avrcp_controller_query_player_application_setting_attributes

uint8_t avrcp_controller_query_player_application_setting_attributes(uint16_t avrcp_cid);

Returns

Source


avrcp_controller_query_player_application_setting_values

uint8_t avrcp_controller_query_player_application_setting_values(uint16_t avrcp_cid, avrcp_player_application_setting_attribute_id_t attribute_id);

Returns

Source


/** `attr_ids` must be non-NULL when `attr_ids_num` is nonzero. */

avrcp_controller_query_player_application_setting_attribute_text

uint8_t avrcp_controller_query_player_application_setting_attribute_text(uint16_t avrcp_cid, uint8_t attr_ids_num, avrcp_player_application_setting_attribute_id_t * attr_ids);

Returns

Source


/** `attr_id_values` must be non-NULL when `attr_id_values_num` is nonzero. */

avrcp_controller_query_player_application_setting_value_text

uint8_t avrcp_controller_query_player_application_setting_value_text(uint16_t avrcp_cid, avrcp_player_application_setting_attribute_id_t attr_id, uint8_t attr_id_values_num, uint8_t * attr_id_values);

Returns

Source


avrcp_controller_inform_displayable_characterset

uint8_t avrcp_controller_inform_displayable_characterset(uint16_t avrcp_cid, uint8_t character_set_num, uint16_t * character_set);

Inform the target about displayable character sets.

Parameters

Returns

Source


avrcp_controller_inform_battery_status

uint8_t avrcp_controller_inform_battery_status(uint16_t avrcp_cid, avrcp_battery_status_t battery_status);

Returns

Source


avrcp_controller_query_shuffle_and_repeat_modes

uint8_t avrcp_controller_query_shuffle_and_repeat_modes(uint16_t avrcp_cid);

Query repeat and shuffle mode. Response via AVRCP_SUBEVENT_SHUFFLE_AND_REPEAT_MODE.

Parameters

Returns

Source


avrcp_controller_set_shuffle_mode

uint8_t avrcp_controller_set_shuffle_mode(uint16_t avrcp_cid, avrcp_shuffle_mode_t mode);

Set shuffle mode. Event AVRCP_SUBEVENT_OPERATION_COMPLETE returns operation id and status.

Parameters

Returns

Source


avrcp_controller_set_repeat_mode

uint8_t avrcp_controller_set_repeat_mode(uint16_t avrcp_cid, avrcp_repeat_mode_t mode);

Set repeat mode. Event AVRCP_SUBEVENT_OPERATION_COMPLETE returns operation id and status.

Parameters

Returns

Source


avrcp_controller_play_item_for_scope

uint8_t avrcp_controller_play_item_for_scope(uint16_t avrcp_cid, uint8_t * uid, uint16_t uid_counter, avrcp_browsing_scope_t scope);

The PlayItem command starts playing an item indicated by the UID. It is routed to the Addressed Player.

Parameters

Returns

Source


avrcp_controller_add_item_from_scope_to_now_playing_list

uint8_t avrcp_controller_add_item_from_scope_to_now_playing_list(uint16_t avrcp_cid, uint8_t * uid, uint16_t uid_counter, avrcp_browsing_scope_t scope);

Adds an item indicated by the UID to the Now Playing queue.

Parameters

Returns

Source


avrcp_controller_set_addressed_player

uint8_t avrcp_controller_set_addressed_player(uint16_t avrcp_cid, uint16_t addressed_player_id);

Set addressed player.

Parameters

Returns

Source


avrcp_controller_send_custom_command

uint8_t avrcp_controller_send_custom_command(uint16_t avrcp_cid,
avrcp_command_type_t command_type,
avrcp_subunit_type_t subunit_type, avrcp_subunit_id_t subunit_id,
avrcp_pdu_id_t pdu_id, uint32_t company_id,
const uint8_t * data, uint16_t data_len);

Send custom command

Parameters

Returns

Source


avrcp_controller_deinit

void avrcp_controller_deinit(void);

De-Init AVRCP Controller

Source