Public API functions

Public interfaces available to users of libvpb. More...

Collaboration diagram for Public API functions:

Classes
struct	VPB_VOX
Modules
	Queue size
	Port initialisation
	Card information
	Port control
	Event handling
	Audio play and record
	Error handling
	Dialling
	Programmable tone generator
	Programmable tone detector
	More information on the libvpb programmable tone detector is available here.
	Timer functions
	Locale selection
	Wav audio support
	DTMF digit collection
	Caller id
	Call logging and monitoring
	Echo cancelling
	Loop voltage sensing
	ISDN support
Files
file	tonegen.h
	Voicetronix programmable tone generator API.
file	vpbapi.h
	Voicetronix voice processing board public API.
file	vt_deprecated.h
	Deprecated symbol handling.
Defines
#define	VPB_OK   0
#define	VPB_NO_EVENTS   -1
#define	VPB_TIME_OUT   -2
#define	VPB_MAX_STR   256
#define	VPB_CONF_JOIN   1
#define	VPB_CONF_LEAVE   0
Typedefs
typedef int	VPBPortHandle
	Symbolic type for a handle to an open port on some card.
Enumerations
enum	VPB_MODEL {   VPB_V4PCI = 2, VPB_V4LOG = 3, VPB_PRI = 6, VPB_OPCI = 7,   VPB_OSW = 8, VPB_MODEL_UNKNOWN = -1 }
	VPB card model types. More...
enum	VPB_PORT { VPB_PORT_UNKNOWN = 0, VPB_FXO = 1, VPB_FXS = 2 }
	Analogue port types. More...
Functions
	VT_DEPRECATED (int WINAPI vpb_conf(int h1, int resource, int mode))
int WINAPI	vpb_setvox (int handle, VPB_VOX *vox)
int WINAPI	vpb_getvox (int handle, VPB_VOX *vox)
int WINAPI	vpb_adpcm_open (void **adpcm)
void WINAPI	vpb_adpcm_reset (void *adpcm)
void WINAPI	vpb_adpcm_close (void *adpcm)
int WINAPI	vpb_adpcm_encode (void *adpcm, char adpcmbuf[], unsigned short *nadpcmbytes, short linearbuf[], unsigned short nlinear)
int WINAPI	vpb_adpcm_decode (void *adpcm, short linearbuf[], unsigned short *nlinear, char adpcmbuf[], unsigned short nadpcmbytes)
Variables
const VPBPortHandle	VPB_PORTHANDLE_NULL = -1

---

Detailed Description

Public interfaces available to users of libvpb.

---

Enumeration Type Documentation

enum VPB_MODEL

VPB card model types.

Enumerator:

VPB_V4PCI	V4PCI 4 port PCI CT card.
VPB_V4LOG	V4LOG 4 port PCI logging card.
VPB_PRI	Sangoma PRI card.
VPB_OPCI	OpenPCI card.
VPB_OSW	OpenSwitch card using vtcore driver.
VPB_MODEL_UNKNOWN	Placeholder for when card type is not yet known.

enum VPB_PORT

Analogue port types.

Enumerator:

VPB_PORT_UNKNOWN	Placeholder for an unknown port type.
VPB_FXO	Trunk port.
VPB_FXS	Station port.