WS63 SDK 文档 7021f4f@fbb_ws63
ws63 和 ws63e 解决方案的 SDK 文档
载入中...
搜索中...
未找到
AVRCP CT API

结构体

struct  avrcp_ct_get_element_attr_para_t
 待获取值的element attribute列表,在结构 avrcp_ct_get_element_attributes 中使用。 更多...
 
struct  avrcp_ct_support_company_para_t
 获取到的TG支持的company,在结构 AvrcpCtSupportedCompaniesCallback 中使用。 更多...
 
struct  avrcp_ct_support_event_para_t
 获取到的TG支持的Event,协议规定 avrcp_notify_event_t 中的0x01和0x02是强制支持的 eventNum取值最小为2在结构 AvrcpCtSupportedCompaniesCallback 中使用。 更多...
 
struct  avrcp_ct_element_attr_value_cb_t
 TG返回的attribute值,参考Audio/Video Remote Control 1.6.2 Section 6.6.1 Table 6.27。 更多...
 
struct  avrcp_ct_element_attr_para_cb_t
 TG返回的GetElementAttributes响应参数,在接口 AvrcpCtGetElementAttributeCallback 中使用。 更多...
 
struct  avrcp_ct_addressed_player_changed_cb_t
 TG返回的Addressed Player Changed notification响应数据,在结构 avrcp_ct_notification_value_cb_t 中使用。 更多...
 
struct  avrcp_ct_play_status_cb_t
 TG返回的播放状态响应数据,在接口 AvrcpCtGetPlayStatusCallback 中使用。 更多...
 
union  avrcp_ct_notification_value_cb_t
 TG发送Notification的值,在接口 AvrcpCtNotificationCallback 中使用。 更多...
 
struct  avrcp_ct_callbacks_t
 Avrcp CT回调函数接口定义。 更多...
 

类型定义

typedef void(* avrcp_ct_conn_state_changed_callback) (const bd_addr_t *bd_addr, profile_connect_state_t state)
 avrcp ct 连接状态更新回调函数。
 
typedef void(* avrcp_ct_press_button_response_callback) (const bd_addr_t *bd_addr, int key_operation)
 收到来自TG的press button响应时回调函数。
 
typedef void(* avrcp_ct_release_button_response_callback) (const bd_addr_t *bd_addr, int key_operation)
 收到来自TG的release button响应时回调函数。
 
typedef void(* avrcp_ct_supported_companies_callback) (const bd_addr_t *bd_addr, avrcp_ct_support_company_para_t *company)
 收到来自TG的支持的company列表时回调函数。
 
typedef void(* avrcp_ct_supported_event_callback) (const bd_addr_t *bd_addr, avrcp_ct_support_event_para_t *event)
 收到来自TG的支持的event列表时回调函数。
 
typedef void(* avrcp_ct_get_element_attribute_callback) (const bd_addr_t *bd_addr, avrcp_ct_element_attr_para_cb_t *attr_cb_para)
 收到来自TG返回的GetElementAttributes响应时回调函数。
 
typedef void(* avrcp_ct_get_play_status_callback) (const bd_addr_t *bd_addr, avrcp_ct_play_status_cb_t *status)
 收到来自TG返回的GetPlayStatus响应时回调函数。
 
typedef void(* avrcp_ct_notification_callback) (const bd_addr_t *bd_addr, avrcp_notify_event_t event_id, avrcp_ct_notification_value_cb_t *notification)
 收到来自TG返回的Notification时回调函数。
 

枚举

enum  avrcp_key_operation_t {
  AVRCP_KEY_VOLUME_UP = 0x41 , AVRCP_KEY_VOLUME_DOWN = 0x42 , AVRCP_KEY_MUTE = 0x43 , AVRCP_KEY_PLAY = 0x44 ,
  AVRCP_KEY_STOP = 0x45 , AVRCP_KEY_PAUSE = 0x46 , AVRCP_KEY_RECORD = 0x47 , AVRCP_KEY_REWIND = 0x48 ,
  AVRCP_KEY_FAST_FORWARD = 0x49 , AVRCP_KEY_FORWARD = 0x4B , AVRCP_KEY_BACKWARD = 0x4C , AVRCP_KEY_INVALID = 0x7F
}
 AVRCP的按键操作,取值的定义来自于规范:1394 Trade Association。 更多...
 
enum  avrcp_ct_element_attr_id_t {
  AVRCP_CT_ELEMENT_ATTR_TITLE = 0x01 , AVRCP_CT_ELEMENT_ATTR_ARTIST_NAME , AVRCP_CT_ELEMENT_ATTR_ALBUM_NAME = 0x03 , AVRCP_CT_ELEMENT_ATTR_TRACK_NUMBER = 0x04 ,
  AVRCP_CT_ELEMENT_ATTR_TOTAL_NUMBER_OF_TRACKS = 0x05 , AVRCP_CT_ELEMENT_ATTR_TRACK_GENRE = 0x06 , AVRCP_CT_ELEMENT_ATTR_TRACK_PLAYING_TIME = 0x07
}
 AVRCP元素属性ID,在 avrcp_ct_get_element_attr_para_t 更多...
 
enum  avrcp_notify_event_t {
  AVRCP_NOTIFY_EVENT_PLAYBACK_STATUS_CHANGED = 0x01 , AVRCP_NOTIFY_EVENT_TRACK_CHANGED = 0x02 , AVRCP_NOTIFY_EVENT_TRACK_REACHED_END = 0x03 , AVRCP_NOTIFY_EVENT_TRACK_REACHED_START = 0x04 ,
  AVRCP_NOTIFY_EVENT_PLAYBACK_POS_CHANGED = 0x05 , AVRCP_NOTIFY_EVENT_BATT_STATUS_CHANGED , AVRCP_NOTIFY_EVENT_SYSTEM_STATUS_CHANGED , AVRCP_NOTIFY_EVENT_PLAYER_APPLICATION_SETTING_CHANGED = 0x08 ,
  AVRCP_NOTIFY_EVENT_NOW_PLAYING_CONTENT_CHANGED = 0x09 , AVRCP_NOTIFY_EVENT_AVAILABLE_PLAYERS_CHANGED = 0x0A , AVRCP_NOTIFY_EVENT_ADDRESSED_PLAYER_CHANGED = 0x0B , AVRCP_NOTIFY_EVENT_UIDS_CHANGED = 0x0C ,
  AVRCP_NOTIFY_EVENT_VOLUME_CHANGED = 0x0D , AVRCP_NOTIFY_EVENT_RESERVED = 0x0E
}
 定义notification事件对应的"EventIDs", 在接口 avrcp_ct_register_notification 中使用,参考Audio/Video Remote Control 1.6.2 Section 28 Appendix 更多...
 
enum  avrcp_absolute_volume_t { AVRCP_ABSOLUTE_VOLUME_PERCENTAGE_0 = 0x00 , AVRCP_ABSOLUTE_VOLUME_PERCENTAGE_100 = 0x7F , AVRCP_ABSOLUTE_VOLUME_INVALID = 0x80 }
 定义绝对音量范围,有效的取值范围[0x00, 0x7F],表示0%~100。 参考Audio/Video Remote Control 1.6.2 Section 6.13.1 Absolute Volume。 更多...
 
enum  avrcp_play_status_t {
  AVRCP_PLAY_STATUS_STOPPED = 0x00 , AVRCP_PLAY_STATUS_PLAYING = 0x01 , AVRCP_PLAY_STATUS_PAUSED = 0x02 , AVRCP_PLAY_STATUS_FWD_SEEK = 0x03 ,
  AVRCP_PLAY_STATUS_REV_SEEK = 0x04 , AVRCP_PLAY_STATUS_ERROR = 0xFF
}
 AVRCP媒体播放状态。 更多...
 
enum  avrcp_battery_status_t {
  AVRCP_BATTERY_STATUS_NORMAL = 0x00 , AVRCP_BATTERY_STATUS_WARNING = 0x01 , AVRCP_BATTERY_STATUS_CRITICAL = 0x02 , AVRCP_BATTERY_STATUS_EXTERNAL = 0x03 ,
  AVRCP_BATTERY_STATUS_FULL_CHARGE = 0x04
}
 AVRCP电量状态,在结构 avrcp_ct_notification_value_cb_t 中使用。 与 AVRCP_NOTIFY_EVENT_BATT_STATUS_CHANGED 对应。 更多...
 
enum  avrcp_ct_system_status_t { AVRCP_CT_SYSTEM_STATUS_POWER_ON = 0x00 , AVRCP_CT_SYSTEM_STATUS_POWER_OFF = 0x01 , AVRCP_CT_SYSTEM_STATUS_UNPLUGGED = 0x02 }
 AVRCP系统状态,在结构 avrcp_ct_notification_value_cb_t 中使用。 与 AVRCP_NOTIFY_EVENT_SYSTEM_STATUS_CHANGED 对应。 更多...
 

函数

int avrcp_ct_get_device_connect_state (const bd_addr_t *bd_addr)
 通过设备地址查询设备avrcp连接状态。
 
int avrcp_ct_connect (const bd_addr_t *bd_addr)
 与对端设备建立avrcp连接。
 
int avrcp_ct_disconnect (const bd_addr_t *bd_addr)
 断开与TG的连接。
 
int avrcp_ct_press_button (const bd_addr_t *bd_addr, int key_operation)
 通知TG端CT已经按下button。
 
int avrcp_ct_release_button (const bd_addr_t *bd_addr, int key_operation)
 通知TG端CT已经释放button。
 
int avrcp_ct_get_supported_companies (const bd_addr_t *bd_addr)
 获取TG端支持的公司列表。
 
int avrcp_ct_get_supported_events (const bd_addr_t *bd_addr)
 获取TG端支持的事件列表。
 
int avrcp_ct_get_element_attributes (const bd_addr_t *bd_addr, const avrcp_ct_get_element_attr_para_t *param)
 获取TG端支持的属性列表,比如歌曲标题,专辑、艺术风格,年份和作曲家等。
 
int avrcp_ct_get_play_status (const bd_addr_t *bd_addr)
 获取TG端媒体的播放状态信息。
 
int avrcp_ct_register_notification (const bd_addr_t *bd_addr, unsigned char event_id, unsigned int interval)
 将TG端支持的事件注册成功后,如果该事件改变会自动通知到CT端。
 
int avrcp_ct_set_absolute_volume (const bd_addr_t *bd_addr, unsigned char volume)
 设置TG端的绝对音量。
 
int avrcp_ct_register_callbacks (avrcp_ct_callbacks_t *func)
 注册Avrcp CT回调函数。
 

详细描述

类型定义说明

◆ avrcp_ct_conn_state_changed_callback

typedef void(* avrcp_ct_conn_state_changed_callback) (const bd_addr_t *bd_addr, profile_connect_state_t state)

avrcp ct 连接状态更新回调函数。

◆ avrcp_ct_get_element_attribute_callback

typedef void(* avrcp_ct_get_element_attribute_callback) (const bd_addr_t *bd_addr, avrcp_ct_element_attr_para_cb_t *attr_cb_para)

收到来自TG返回的GetElementAttributes响应时回调函数。

◆ avrcp_ct_get_play_status_callback

typedef void(* avrcp_ct_get_play_status_callback) (const bd_addr_t *bd_addr, avrcp_ct_play_status_cb_t *status)

收到来自TG返回的GetPlayStatus响应时回调函数。

◆ avrcp_ct_notification_callback

typedef void(* avrcp_ct_notification_callback) (const bd_addr_t *bd_addr, avrcp_notify_event_t event_id, avrcp_ct_notification_value_cb_t *notification)

收到来自TG返回的Notification时回调函数。

◆ avrcp_ct_press_button_response_callback

typedef void(* avrcp_ct_press_button_response_callback) (const bd_addr_t *bd_addr, int key_operation)

收到来自TG的press button响应时回调函数。

◆ avrcp_ct_release_button_response_callback

typedef void(* avrcp_ct_release_button_response_callback) (const bd_addr_t *bd_addr, int key_operation)

收到来自TG的release button响应时回调函数。

◆ avrcp_ct_supported_companies_callback

typedef void(* avrcp_ct_supported_companies_callback) (const bd_addr_t *bd_addr, avrcp_ct_support_company_para_t *company)

收到来自TG的支持的company列表时回调函数。

◆ avrcp_ct_supported_event_callback

typedef void(* avrcp_ct_supported_event_callback) (const bd_addr_t *bd_addr, avrcp_ct_support_event_para_t *event)

收到来自TG的支持的event列表时回调函数。

枚举类型说明

◆ avrcp_absolute_volume_t

定义绝对音量范围,有效的取值范围[0x00, 0x7F],表示0%~100。 参考Audio/Video Remote Control 1.6.2 Section 6.13.1 Absolute Volume。

枚举值
AVRCP_ABSOLUTE_VOLUME_PERCENTAGE_0 

绝对音量0% 绝对音量0%

AVRCP_ABSOLUTE_VOLUME_PERCENTAGE_100 

绝对音量100% 绝对音量0%

AVRCP_ABSOLUTE_VOLUME_INVALID 

无效值 无效值

◆ avrcp_battery_status_t

AVRCP电量状态,在结构 avrcp_ct_notification_value_cb_t 中使用。 与 AVRCP_NOTIFY_EVENT_BATT_STATUS_CHANGED 对应。

枚举值
AVRCP_BATTERY_STATUS_NORMAL 

电池的电量处于正常状态

AVRCP_BATTERY_STATUS_WARNING 

电池的电量处于告警状态

AVRCP_BATTERY_STATUS_CRITICAL 

电池的电量处于红色告警状态,不能在使用

AVRCP_BATTERY_STATUS_EXTERNAL 

插接外部电源

AVRCP_BATTERY_STATUS_FULL_CHARGE 

电池已充满电

◆ avrcp_ct_element_attr_id_t

AVRCP元素属性ID,在 avrcp_ct_get_element_attr_para_t

枚举值
AVRCP_CT_ELEMENT_ATTR_TITLE 

标题,歌曲名或者内容描述

AVRCP_CT_ELEMENT_ATTR_ARTIST_NAME 

艺人、表演者或团体

AVRCP_CT_ELEMENT_ATTR_ALBUM_NAME 

唱片,专辑

AVRCP_CT_ELEMENT_ATTR_TRACK_NUMBER 

音频文件的原始编号

AVRCP_CT_ELEMENT_ATTR_TOTAL_NUMBER_OF_TRACKS 

tracks/elements的总个数

AVRCP_CT_ELEMENT_ATTR_TRACK_GENRE 

风格,流派

AVRCP_CT_ELEMENT_ATTR_TRACK_PLAYING_TIME 

音频文件的播放时间

◆ avrcp_ct_system_status_t

AVRCP系统状态,在结构 avrcp_ct_notification_value_cb_t 中使用。 与 AVRCP_NOTIFY_EVENT_SYSTEM_STATUS_CHANGED 对应。

枚举值
AVRCP_CT_SYSTEM_STATUS_POWER_ON 

AVRCP开机事件

AVRCP_CT_SYSTEM_STATUS_POWER_OFF 

AVRCP关机事件

AVRCP_CT_SYSTEM_STATUS_UNPLUGGED 

AVRCP未充电状态

◆ avrcp_key_operation_t

AVRCP的按键操作,取值的定义来自于规范:1394 Trade Association。

枚举值
AVRCP_KEY_VOLUME_UP 

音量调大操作

AVRCP_KEY_VOLUME_DOWN 

音量调小操作

AVRCP_KEY_MUTE 

静音操作

AVRCP_KEY_PLAY 

play操作

AVRCP_KEY_STOP 

stop操作

AVRCP_KEY_PAUSE 

pause操作

AVRCP_KEY_RECORD 

record操作

AVRCP_KEY_REWIND 

将媒体设置为从起始位置开始

AVRCP_KEY_FAST_FORWARD 

设置媒体快进

AVRCP_KEY_FORWARD 

下一首

AVRCP_KEY_BACKWARD 

上一首

AVRCP_KEY_INVALID 

未知操作

◆ avrcp_notify_event_t

定义notification事件对应的"EventIDs", 在接口 avrcp_ct_register_notification 中使用,参考Audio/Video Remote Control 1.6.2 Section 28 Appendix

枚举值
AVRCP_NOTIFY_EVENT_PLAYBACK_STATUS_CHANGED 

播放状态变更事件

AVRCP_NOTIFY_EVENT_TRACK_CHANGED 

track状态变更事件

AVRCP_NOTIFY_EVENT_TRACK_REACHED_END 

track结束事件

AVRCP_NOTIFY_EVENT_TRACK_REACHED_START 

track开始事件

AVRCP_NOTIFY_EVENT_PLAYBACK_POS_CHANGED 

播放位置改变事件

AVRCP_NOTIFY_EVENT_BATT_STATUS_CHANGED 

电池状态变更事件

AVRCP_NOTIFY_EVENT_SYSTEM_STATUS_CHANGED 

系统状态变更事件

AVRCP_NOTIFY_EVENT_PLAYER_APPLICATION_SETTING_CHANGED 

播放器配置变更事件

AVRCP_NOTIFY_EVENT_NOW_PLAYING_CONTENT_CHANGED 

播放内容变更事件

AVRCP_NOTIFY_EVENT_AVAILABLE_PLAYERS_CHANGED 

可使用的播放器变更事件

AVRCP_NOTIFY_EVENT_ADDRESSED_PLAYER_CHANGED 

播放地址变更事件

AVRCP_NOTIFY_EVENT_UIDS_CHANGED 

UID变更事件

AVRCP_NOTIFY_EVENT_VOLUME_CHANGED 

TG端音量变更事件

AVRCP_NOTIFY_EVENT_RESERVED 

保留

◆ avrcp_play_status_t

AVRCP媒体播放状态。

枚举值
AVRCP_PLAY_STATUS_STOPPED 

AVRCP媒体stopped状态

AVRCP_PLAY_STATUS_PLAYING 

AVRCP媒体playing状态

AVRCP_PLAY_STATUS_PAUSED 

AVRCP媒体Paused状态

AVRCP_PLAY_STATUS_FWD_SEEK 

AVRCP媒体切换下一首

AVRCP_PLAY_STATUS_REV_SEEK 

AVRCP媒体切换上一首

AVRCP_PLAY_STATUS_ERROR 

AVRCP媒体未知状态

函数说明

◆ avrcp_ct_connect()

int avrcp_ct_connect ( const bd_addr_t bd_addr)

与对端设备建立avrcp连接。

◆ avrcp_ct_disconnect()

int avrcp_ct_disconnect ( const bd_addr_t bd_addr)

断开与TG的连接。

◆ avrcp_ct_get_device_connect_state()

int avrcp_ct_get_device_connect_state ( const bd_addr_t bd_addr)

通过设备地址查询设备avrcp连接状态。

◆ avrcp_ct_get_element_attributes()

int avrcp_ct_get_element_attributes ( const bd_addr_t bd_addr,
const avrcp_ct_get_element_attr_para_t param 
)

获取TG端支持的属性列表,比如歌曲标题,专辑、艺术风格,年份和作曲家等。

◆ avrcp_ct_get_play_status()

int avrcp_ct_get_play_status ( const bd_addr_t bd_addr)

获取TG端媒体的播放状态信息。

◆ avrcp_ct_get_supported_companies()

int avrcp_ct_get_supported_companies ( const bd_addr_t bd_addr)

获取TG端支持的公司列表。

◆ avrcp_ct_get_supported_events()

int avrcp_ct_get_supported_events ( const bd_addr_t bd_addr)

获取TG端支持的事件列表。

◆ avrcp_ct_press_button()

int avrcp_ct_press_button ( const bd_addr_t bd_addr,
int  key_operation 
)

通知TG端CT已经按下button。

◆ avrcp_ct_register_callbacks()

int avrcp_ct_register_callbacks ( avrcp_ct_callbacks_t func)

注册Avrcp CT回调函数。

◆ avrcp_ct_register_notification()

int avrcp_ct_register_notification ( const bd_addr_t bd_addr,
unsigned char  event_id,
unsigned int  interval 
)

将TG端支持的事件注册成功后,如果该事件改变会自动通知到CT端。

◆ avrcp_ct_release_button()

int avrcp_ct_release_button ( const bd_addr_t bd_addr,
int  key_operation 
)

通知TG端CT已经释放button。

◆ avrcp_ct_set_absolute_volume()

int avrcp_ct_set_absolute_volume ( const bd_addr_t bd_addr,
unsigned char  volume 
)

设置TG端的绝对音量。