Detailed Description

A C client library for the player server

libplayerc is a client library for the player server. It is written in C to maximize portability, and in the expectation that users will write bindings for other languages (such as Python and Java) against this library; Python bindings are already available.

Be sure to check out the example.

The data modes section is important reading for all client writers.

libplayerc was originally written by Andrew Howard and is maintained by the Player Project. Subsequent contributors include Brian Gerkey, Geoffrey Biggs, Richard Vaughan.

Topics

 libplayerc example
 
 
 Client Data Modes
 
 
 Utility and error-handling
 
 
 Multi-Client object
 
 
 Client API
 
 
 Device API
 
 
 Device proxies
 
 

Macros

#define MIN(a, b)
 
#define MAX(a, b)
 
#define PLAYERC_EXPORT
 
#define PLAYERC_OPEN_MODE   PLAYER_OPEN_MODE
 The device access modes.
 
#define PLAYERC_CLOSE_MODE   PLAYER_CLOSE_MODE
 
#define PLAYERC_ERROR_MODE   PLAYER_ERROR_MODE
 
#define PLAYERC_DATAMODE_PUSH   PLAYER_DATAMODE_PUSH
 The valid data delivery modes.
 
#define PLAYERC_DATAMODE_PULL   PLAYER_DATAMODE_PULL
 
#define PLAYERC_TRANSPORT_TCP   1
 The valid transports.
 
#define PLAYERC_TRANSPORT_UDP   2
 
#define PLAYERC_QUEUE_RING_SIZE   512
 

Macro Definition Documentation

◆ MAX

#define MAX ( a,
b )
Value:
((a > b) ? a : b)

◆ MIN

#define MIN ( a,
b )
Value:
((a < b) ? a : b)