dotstack API Reference  1.10.37
Macros

This module describes parameters used to configure AVRCP layer. More...

Macros

#define AVRCP_MAX_CHANNELS
 Maximum number of remote devices a local device can be connected to. More...
 
#define AVRCP_MAX_CMD_BUFFERS   1
 Maximum number of command buffers. More...
 
#define AVRCP_MAX_CMD_PARAM_LEN   512
 Maximum length of command parameters. More...
 
#define AVRCP_MAX_SEARCH_RESULTS   7
 Maximum number of devices to find. More...
 
#define AVRCP_MAX_DEVICE_NAME_LEN   20
 Maximum length of device name. More...
 
#define AVRCP_CMD_TIMEOUT   10000
 Command timeout. More...
 

Detailed Description

This module describes parameters used to configure AVRCP layer.

dotstack is customized using a configuration file. The configuration file tailors the dotstack to the application being built. It has to have the structure shown below.

#include "cdbt/bt/bt_std.h"
// HCI, L2CAP and SDP must always be present
// HCI configuration parameters
#define HCI_MAX_CMD_BUFFERS ...
#define HCI_MAX_DATA_BUFFERS ...
#define HCI_MAX_ACL_CONNECTIONS ...
#define HCI_RX_BUFFER_LEN ...
#define HCI_TX_BUFFER_LEN ...
#define HCI_L2CAP_BUFFER_LEN ...
#define HCI_MAX_CMD_PARAM_LEN ...
// L2CAP configuration parameters
#define L2CAP_MAX_CMD_BUFFERS ...
#define L2CAP_MAX_FRAME_BUFFERS ...
#define L2CAP_MAX_PSMS ...
#define L2CAP_MAX_CHANNELS ...
// SDP configuration parameters
#define SDP_MAX_SEARCH_RESULT_LEN ...
#define SDP_MAX_ATTRIBUTE_RESULT_LEN ...
// Depending on protocols and profiles used below goes configuration parameters
// for each used module. E.g., to use and configure AVRCP,
// the following values must be defined:
#define BT_INCLUDE_AVCTP // tells dotstack to compile in AVCTP support
#define AVCTP_MAX_CHANNELS ...
#define AVCTP_MAX_TRANSPORT_CHANNELS ...
#define AVCTP_MAX_RX_MESSAGE_LEN ...
#define AVCTP_MAX_MESSAGE_BUFFERS ...
#define BT_INCLUDE_AVRCP // tells dotstack to compile in AVRCP support
#define AVRCP_MAX_CHANNELS ...
#define AVRCP_MAX_CMD_BUFFERS ...
#define AVRCP_MAX_CMD_PARAM_LEN ...
#define AVRCP_MAX_SEARCH_RESULTS ...
#define AVRCP_MAX_DEVICE_NAME_LEN ...
#define AVRCP_CMD_TIMEOUT ...
#include "cdbt/bt/bt_oem_config.h"

Macro Definition Documentation

#define AVRCP_CMD_TIMEOUT   10000

Command timeout.

This parameter defines the amount of time in milliseconds AVRCP waits for a response to a request. If not defined the default value of 10000 (10 secconds) is used.

#define AVRCP_MAX_CHANNELS

Maximum number of remote devices a local device can be connected to.

This parameter defines the number of remote devices a local device can have simultaneous connections to (i.e. channels). This value should not exceed AVCTP_MAX_CHANNELS.

#define AVRCP_MAX_CMD_BUFFERS   1

Maximum number of command buffers.

This parameter defines the number of buffers reserved for sending commands to a remote device over its control channel. Each channel uses its own buffers so the total number of buffers is AVRCP_MAX_CHANNELS * AVRCP_MAX_CMD_BUFFERS. The minimum value is 1. The maximum value is 255. If not define one buffer for each channel is reserved.

#define AVRCP_MAX_CMD_PARAM_LEN   512

Maximum length of command parameters.

This parameter defines the maximum length of all command parameters. If not defined the default value of 512 is used.

#define AVRCP_MAX_DEVICE_NAME_LEN   20

Maximum length of device name.

This parameter defines the size of the buffer used to store device's name while searching for nearby targets with bt_avrcp_find_targets. If the name of the device is longer than AVRCP_MAX_DEVICE_NAME_LEN it is truncated to AVRCP_MAX_DEVICE_NAME_LEN. If not defined the default value of 20 is used.

#define AVRCP_MAX_SEARCH_RESULTS   7

Maximum number of devices to find.

This parameter defines the maximum number of devices bt_avrcp_find_targets can find. If not defined the default value of 7 is used.