vpbapi.h File Reference

Go to the source code of this file.

Classes

struct  VPB_EVENT
struct  VPB_PLAY
struct  VPB_RECORD
class  VpbException
struct  VPB_TONE_MAP
struct  VPB_CALL
struct  VPB_TONE
struct  VPB_STRAN
struct  VPB_DETECT
struct  VPB_VOX
struct  VPB_AGC
struct  VPB_DIGITS
struct  VPB_PIP

Defines

#define WINAPI
#define VPB_OK   0
#define VPB_NO_EVENTS   -1
#define VPB_TIME_OUT   -2
#define VPB_MAX_STR   256
#define VPB_ONHOOK   0
#define VPB_OFFHOOK   1
#define VPB_RING   0
#define VPB_DIGIT   1
#define VPB_TONEDETECT   2
#define VPB_TIMEREXP   3
#define VPB_VOXON   4
#define VPB_VOXOFF   5
#define VPB_PLAY_UNDERFLOW   6
#define VPB_RECORD_OVERFLOW   7
#define VPB_DTMF   8
#define VPB_PLAYEND   100
#define VPB_RECORDEND   101
#define VPB_DIALEND   102
#define VPB_TONE_DEBUG_END   103
#define VPB_CALLEND   104
#define VPB_MRING   (1<<VPB_RING)
#define VPB_MDIGIT   (1<<VPB_DIGIT)
#define VPB_MDTMF   (1<<VPB_DTMF)
#define VPB_MTONEDETECT   (1<<VPB_TONEDETECT)
#define VPB_MTIMEREXP   (1<<VPB_TIMEREXP)
#define VPB_MVOXON   (1<<VPB_VOXON)
#define VPB_MVOXOFF   (1<<VPB_VOXOFF)
#define VPB_MPLAY_UNDERFLOW   (1<<VPB_PLAY_UNDERFLOW)
#define VPB_MRECORD_OVERFLOW   (1<<VPB_RECORD_OVERFLOW)
#define VPB_FINISH   1
#define VPB_LINEAR   0
#define VPB_ALAW   1
#define VPB_MULAW   2
#define VPB_OKIADPCM   3
#define VPB_OKIADPCM24   4
#define VPB_RECORD_DIGIT   1
#define VPB_RECORD_TIMEOUT   2
#define VPB_RECORD_ENDOFDATA   3
#define VPB_RECORD_MAXDIGIT   4
#define VPB_DEVELOPMENT   0
#define VPB_ERROR_CODE   1
#define VPB_EXCEPTION   2
#define VPB_CALL_DISCONNECT   0
#define VPB_CALL_DIALTONE   1
#define VPB_CALL_RINGBACK   2
#define VPB_CALL_BUSY   3
#define VPB_CALL_GRUNT   4
#define VPB_MAX_TONE_MAP   10
#define VPB_CALL_CONNECTED   0
#define VPB_CALL_NO_DIAL_TONE   1
#define VPB_CALL_NO_RING_BACK   2
#define VPB_CALL_BUSY   3
#define VPB_CALL_NO_ANSWER   4
#define VPB_CALL_DISCONNECTED   5
#define VPB_DIAL   0
#define VPB_RINGBACK   1
#define VPB_BUSY   2
#define VPB_GRUNT   3
#define VPB_MD   10
#define VPB_MS   10
#define VPB_TIMER   0
#define VPB_RISING   1
#define VPB_FALLING   2
#define VPB_DELAY   3
#define VPB_DIGIT_TERM   0
#define VPB_DIGIT_MAX   1
#define VPB_DIGIT_TIME_OUT   2
#define VPB_DIGIT_INTER_DIGIT_TIME_OUT   3
#define VPB_DIGIT_BUFFER_FULL   4

Functions

int WINAPI vpb_open (unsigned int board, unsigned int channel)
int WINAPI vpb_close (int handle)
void WINAPI vpb_sleep (long time_ms)
int WINAPI vpb_sethook_async (int handle, int hookstate)
int WINAPI vpb_sethook_sync (int handle, int hookstate)
int WINAPI vpb_get_model (char *s)
int WINAPI vpb_reset_play_fifo_alarm (int handle)
int WINAPI vpb_reset_record_fifo_alarm (int handle)
int WINAPI vpb_enable_event (int handle, unsigned short mask)
int WINAPI vpb_disable_event (int handle, unsigned short mask)
int WINAPI vpb_get_event_mask (int handle)
int WINAPI vpb_set_event_mask (int handle, unsigned short mask)
int WINAPI vpb_get_event_async (VPB_EVENT *event)
int WINAPI vpb_get_event_sync (VPB_EVENT *event, unsigned int time_out)
int WINAPI vpb_get_event_ch_async (int handle, VPB_EVENT *e)
int WINAPI vpb_get_event_ch_sync (int handle, VPB_EVENT *e, unsigned int time_out)
int WINAPI vpb_put_event (VPB_EVENT *event)
void WINAPI vpb_translate_event (VPB_EVENT *e, char s[])
int WINAPI vpb_set_event_callback (int handle, void(WINAPI *event_callback)(VPB_EVENT *e, void *context), void *context)
int WINAPI vpb_play_file_sync (int handle, char file_name[])
int WINAPI vpb_play_file_async (int handle, char file_name[], int data)
int WINAPI vpb_play_voxfile_sync (int handle, char file_name[], unsigned short mode)
int WINAPI vpb_play_voxfile_async (int handle, char file_name[], unsigned short mode, int data)
int WINAPI vpb_play_buf_start (int handle, unsigned short mode)
int WINAPI vpb_play_buf_sync (int handle, char *buf, unsigned short length)
int WINAPI vpb_play_buf_finish (int handle)
int WINAPI vpb_play_terminate (int handle)
int WINAPI vpb_play_set (int handle, VPB_PLAY *vpb_play)
int WINAPI vpb_play_set_gain (int handle, float gain)
int WINAPI vpb_play_get_gain (int handle, float *gain)
int WINAPI vpb_record_file_sync (int handle, char file_name[], unsigned short mode)
int WINAPI vpb_record_file_async (int handle, char file_name[], unsigned short mode)
int WINAPI vpb_record_voxfile_sync (int handle, char file_name[], unsigned short mode)
int WINAPI vpb_record_voxfile_async (int handle, char file_name[], unsigned short mode)
int WINAPI vpb_record_buf_start (int handle, unsigned short mode)
int WINAPI vpb_record_buf_sync (int handle, char *buf, unsigned short length)
int WINAPI vpb_record_buf_finish (int handle)
int WINAPI vpb_record_terminate (int handle)
int WINAPI vpb_record_set (int handle, VPB_RECORD *vpb_record)
int WINAPI vpb_record_set_gain (int handle, float gain)
int WINAPI vpb_record_get_gain (int handle, float *gain)
int WINAPI vpb_record_buf_async (int handle, unsigned short mode, char *mbuf, unsigned long size)
int WINAPI vpb_seterrormode (int mode)
void WINAPI vpb_throw_exception (int c, char trans[], char api_function[])
int WINAPI vpb_dial_sync (int handle, char *dialstr)
int WINAPI vpb_dial_async (int handle, char *dialstr)
int WINAPI vpb_get_call (int handle, VPB_CALL *vpb_call)
int WINAPI vpb_set_call (int handle, VPB_CALL *vpb_call)
int WINAPI vpb_call_sync (int handle, char *dialstr)
int WINAPI vpb_call_async (int handle, char *dialstr)
int WINAPI vpb_settone (char ident, VPB_TONE *vpb_tone)
int WINAPI vpb_gettone (char ident, VPB_TONE *vpb_tone)
int WINAPI vpb_playtone_async (int handle, VPB_TONE *vpb_tone)
int WINAPI vpb_playtone_sync (int handle, VPB_TONE *vpb_tone)
int WINAPI vpb_settonedet (int handle, VPB_DETECT *d)
int WINAPI vpb_gettonedet (int handle, int id, VPB_DETECT *d)
int WINAPI vpb_debug_tonedet (int handle, int id, char file_name[], int sec)
int WINAPI vpb_tonedet_make_default (VPB_DETECT *d)
int WINAPI vpb_timer_open (void **timer, int handle, int id, unsigned long period)
int WINAPI vpb_timer_close (void *timer)
int WINAPI vpb_timer_start (void *timer)
int WINAPI vpb_timer_stop (void *timer)
int WINAPI vpb_timer_restart (void *timer)
int WINAPI vpb_timer_get_unique_timer_id ()
int WINAPI vpb_timer_change_period (void *timer, unsigned long newperiod)
int WINAPI vpb_setvox (int handle, VPB_VOX *vox)
int WINAPI vpb_getvox (int handle, VPB_VOX *vox)
int WINAPI vpb_setagc (int handle, VPB_AGC *agc)
int WINAPI vpb_getagc (int handle, VPB_AGC *agc)
int WINAPI vpb_adpcm_open (void **adpcm)
void WINAPI vpb_adpcm_close (void *adpcm)
int WINAPI vpb_adpcm_decode (void *adpcm, short linearbuf[], unsigned short *nlinear, char adpcmbuf[], unsigned short nadpcmbytes)
int WINAPI vpb_wave_open_write (void **ppv, char filename[], int mode)
int WINAPI vpb_wave_write (void *wv, char buf[], long n)
void WINAPI vpb_wave_close_write (void *wv)
int WINAPI vpb_wave_open_read (void **ppv, char filename[])
int WINAPI vpb_wave_read (void *wv, char buf[], long n)
void WINAPI vpb_wave_close_read (void *wv)
void WINAPI vpb_wave_set_sample_rate (void *wv, unsigned short rate)
int WINAPI vpb_wave_seek (void *wv, long offset)
int WINAPI vpb_wave_get_mode (void *wv, unsigned short *mode)
int WINAPI vpb_set_ring (int handle, unsigned int rings_to_fire, unsigned int time_out)
int WINAPI vpb_get_ring (int handle, unsigned int *rings_to_fire, unsigned int *time_out)
int WINAPI vpb_flush_digits (int handle)
int WINAPI vpb_get_digits_async (int handle, VPB_DIGITS *digits, char *digbuf)
int WINAPI vpb_get_digits_sync (int handle, VPB_DIGITS *digits, char *digbuf)
int WINAPI get_digits_async (int handle, VPB_DIGITS *newdig, char *buf, unsigned short size)
int WINAPI get_digits_record_async (int handle, VPB_DIGITS *newdig, char *buf)
int WINAPI vpb_set_pip (VPB_PIP *vpb_pip)
int WINAPI vpb_get_pip (VPB_PIP *vpb_pip)
int WINAPI vpb_pip_on (int handle)
int WINAPI vpb_pip_off (int handle)

Define Documentation

#define VPB_ALAW   1

#define VPB_BUSY   2

#define VPB_CALL_BUSY   3

#define VPB_CALL_BUSY   3

#define VPB_CALL_CONNECTED   0

#define VPB_CALL_DIALTONE   1

#define VPB_CALL_DISCONNECT   0

#define VPB_CALL_DISCONNECTED   5

#define VPB_CALL_GRUNT   4

#define VPB_CALL_NO_ANSWER   4

#define VPB_CALL_NO_DIAL_TONE   1

#define VPB_CALL_NO_RING_BACK   2

#define VPB_CALL_RINGBACK   2

#define VPB_CALLEND   104

#define VPB_DELAY   3

#define VPB_DEVELOPMENT   0

#define VPB_DIAL   0

#define VPB_DIALEND   102

#define VPB_DIGIT   1

#define VPB_DIGIT_BUFFER_FULL   4

#define VPB_DIGIT_INTER_DIGIT_TIME_OUT   3

#define VPB_DIGIT_MAX   1

#define VPB_DIGIT_TERM   0

#define VPB_DIGIT_TIME_OUT   2

#define VPB_DTMF   8

#define VPB_ERROR_CODE   1

#define VPB_EXCEPTION   2

#define VPB_FALLING   2

#define VPB_FINISH   1

#define VPB_GRUNT   3

#define VPB_LINEAR   0

#define VPB_MAX_STR   256

#define VPB_MAX_TONE_MAP   10

#define VPB_MD   10

#define VPB_MDIGIT   (1<<VPB_DIGIT)

#define VPB_MDTMF   (1<<VPB_DTMF)

#define VPB_MPLAY_UNDERFLOW   (1<<VPB_PLAY_UNDERFLOW)

#define VPB_MRECORD_OVERFLOW   (1<<VPB_RECORD_OVERFLOW)

#define VPB_MRING   (1<<VPB_RING)

#define VPB_MS   10

#define VPB_MTIMEREXP   (1<<VPB_TIMEREXP)

#define VPB_MTONEDETECT   (1<<VPB_TONEDETECT)

#define VPB_MULAW   2

#define VPB_MVOXOFF   (1<<VPB_VOXOFF)

#define VPB_MVOXON   (1<<VPB_VOXON)

#define VPB_NO_EVENTS   -1

#define VPB_OFFHOOK   1

#define VPB_OK   0

#define VPB_OKIADPCM   3

#define VPB_OKIADPCM24   4

#define VPB_ONHOOK   0

#define VPB_PLAY_UNDERFLOW   6

#define VPB_PLAYEND   100

#define VPB_RECORD_DIGIT   1

#define VPB_RECORD_ENDOFDATA   3

#define VPB_RECORD_MAXDIGIT   4

#define VPB_RECORD_OVERFLOW   7

#define VPB_RECORD_TIMEOUT   2

#define VPB_RECORDEND   101

#define VPB_RING   0

#define VPB_RINGBACK   1

#define VPB_RISING   1

#define VPB_TIME_OUT   -2

#define VPB_TIMER   0

#define VPB_TIMEREXP   3

#define VPB_TONE_DEBUG_END   103

#define VPB_TONEDETECT   2

#define VPB_VOXOFF   5

#define VPB_VOXON   4

#define WINAPI

Function Documentation

int WINAPI get_digits_async ( int  handle,
VPB_DIGITS *  newdig,
char *  buf,
unsigned short  size 
)

int WINAPI get_digits_record_async ( int  handle,
VPB_DIGITS *  newdig,
char *  buf 
)

void WINAPI vpb_adpcm_close ( void *  adpcm  ) 

int WINAPI vpb_adpcm_decode ( void *  adpcm,
short  linearbuf[],
unsigned short *  nlinear,
char  adpcmbuf[],
unsigned short  nadpcmbytes 
)

int WINAPI vpb_adpcm_open ( void **  adpcm  ) 

int WINAPI vpb_call_async ( int  handle,
char *  dialstr 
)

int WINAPI vpb_call_sync ( int  handle,
char *  dialstr 
)

int WINAPI vpb_close ( int  handle  ) 

int WINAPI vpb_debug_tonedet ( int  handle,
int  id,
char  file_name[],
int  sec 
)

int WINAPI vpb_dial_async ( int  handle,
char *  dialstr 
)

int WINAPI vpb_dial_sync ( int  handle,
char *  dialstr 
)

int WINAPI vpb_disable_event ( int  handle,
unsigned short  mask 
)

int WINAPI vpb_enable_event ( int  handle,
unsigned short  mask 
)

int WINAPI vpb_flush_digits ( int  handle  ) 

int WINAPI vpb_get_call ( int  handle,
VPB_CALL *  vpb_call 
)

int WINAPI vpb_get_digits_async ( int  handle,
VPB_DIGITS *  digits,
char *  digbuf 
)

int WINAPI vpb_get_digits_sync ( int  handle,
VPB_DIGITS *  digits,
char *  digbuf 
)

int WINAPI vpb_get_event_async ( VPB_EVENT *  event  ) 

int WINAPI vpb_get_event_ch_async ( int  handle,
VPB_EVENT *  e 
)

int WINAPI vpb_get_event_ch_sync ( int  handle,
VPB_EVENT *  e,
unsigned int  time_out 
)

int WINAPI vpb_get_event_mask ( int  handle  ) 

int WINAPI vpb_get_event_sync ( VPB_EVENT *  event,
unsigned int  time_out 
)

int WINAPI vpb_get_model ( char *  s  ) 

int WINAPI vpb_get_pip ( VPB_PIP *  vpb_pip  ) 

int WINAPI vpb_get_ring ( int  handle,
unsigned int *  rings_to_fire,
unsigned int *  time_out 
)

int WINAPI vpb_getagc ( int  handle,
VPB_AGC *  agc 
)

int WINAPI vpb_gettone ( char  ident,
VPB_TONE *  vpb_tone 
)

int WINAPI vpb_gettonedet ( int  handle,
int  id,
VPB_DETECT *  d 
)

int WINAPI vpb_getvox ( int  handle,
VPB_VOX *  vox 
)

int WINAPI vpb_open ( unsigned int  board,
unsigned int  channel 
)

int WINAPI vpb_pip_off ( int  handle  ) 

int WINAPI vpb_pip_on ( int  handle  ) 

int WINAPI vpb_play_buf_finish ( int  handle  ) 

int WINAPI vpb_play_buf_start ( int  handle,
unsigned short  mode 
)

int WINAPI vpb_play_buf_sync ( int  handle,
char *  buf,
unsigned short  length 
)

int WINAPI vpb_play_file_async ( int  handle,
char  file_name[],
int  data 
)

int WINAPI vpb_play_file_sync ( int  handle,
char  file_name[] 
)

int WINAPI vpb_play_get_gain ( int  handle,
float *  gain 
)

int WINAPI vpb_play_set ( int  handle,
VPB_PLAY *  vpb_play 
)

int WINAPI vpb_play_set_gain ( int  handle,
float  gain 
)

int WINAPI vpb_play_terminate ( int  handle  ) 

int WINAPI vpb_play_voxfile_async ( int  handle,
char  file_name[],
unsigned short  mode,
int  data 
)

int WINAPI vpb_play_voxfile_sync ( int  handle,
char  file_name[],
unsigned short  mode 
)

int WINAPI vpb_playtone_async ( int  handle,
VPB_TONE *  vpb_tone 
)

int WINAPI vpb_playtone_sync ( int  handle,
VPB_TONE *  vpb_tone 
)

int WINAPI vpb_put_event ( VPB_EVENT *  event  ) 

int WINAPI vpb_record_buf_async ( int  handle,
unsigned short  mode,
char *  mbuf,
unsigned long  size 
)

int WINAPI vpb_record_buf_finish ( int  handle  ) 

int WINAPI vpb_record_buf_start ( int  handle,
unsigned short  mode 
)

int WINAPI vpb_record_buf_sync ( int  handle,
char *  buf,
unsigned short  length 
)

int WINAPI vpb_record_file_async ( int  handle,
char  file_name[],
unsigned short  mode 
)

int WINAPI vpb_record_file_sync ( int  handle,
char  file_name[],
unsigned short  mode 
)

int WINAPI vpb_record_get_gain ( int  handle,
float *  gain 
)

int WINAPI vpb_record_set ( int  handle,
VPB_RECORD *  vpb_record 
)

int WINAPI vpb_record_set_gain ( int  handle,
float  gain 
)

int WINAPI vpb_record_terminate ( int  handle  ) 

int WINAPI vpb_record_voxfile_async ( int  handle,
char  file_name[],
unsigned short  mode 
)

int WINAPI vpb_record_voxfile_sync ( int  handle,
char  file_name[],
unsigned short  mode 
)

int WINAPI vpb_reset_play_fifo_alarm ( int  handle  ) 

int WINAPI vpb_reset_record_fifo_alarm ( int  handle  ) 

int WINAPI vpb_set_call ( int  handle,
VPB_CALL *  vpb_call 
)

int WINAPI vpb_set_event_callback ( int  handle,
void(WINAPI *event_callback)(VPB_EVENT *e, void *context)  ,
void *  context 
)

int WINAPI vpb_set_event_mask ( int  handle,
unsigned short  mask 
)

int WINAPI vpb_set_pip ( VPB_PIP *  vpb_pip  ) 

int WINAPI vpb_set_ring ( int  handle,
unsigned int  rings_to_fire,
unsigned int  time_out 
)

int WINAPI vpb_setagc ( int  handle,
VPB_AGC *  agc 
)

int WINAPI vpb_seterrormode ( int  mode  ) 

int WINAPI vpb_sethook_async ( int  handle,
int  hookstate 
)

int WINAPI vpb_sethook_sync ( int  handle,
int  hookstate 
)

int WINAPI vpb_settone ( char  ident,
VPB_TONE *  vpb_tone 
)

int WINAPI vpb_settonedet ( int  handle,
VPB_DETECT *  d 
)

int WINAPI vpb_setvox ( int  handle,
VPB_VOX *  vox 
)

void WINAPI vpb_sleep ( long  time_ms  ) 

void WINAPI vpb_throw_exception ( int  c,
char  trans[],
char  api_function[] 
)

int WINAPI vpb_timer_change_period ( void *  timer,
unsigned long  newperiod 
)

int WINAPI vpb_timer_close ( void *  timer  ) 

int WINAPI vpb_timer_get_unique_timer_id (  ) 

int WINAPI vpb_timer_open ( void **  timer,
int  handle,
int  id,
unsigned long  period 
)

int WINAPI vpb_timer_restart ( void *  timer  ) 

int WINAPI vpb_timer_start ( void *  timer  ) 

int WINAPI vpb_timer_stop ( void *  timer  ) 

int WINAPI vpb_tonedet_make_default ( VPB_DETECT *  d  ) 

void WINAPI vpb_translate_event ( VPB_EVENT *  e,
char  s[] 
)

void WINAPI vpb_wave_close_read ( void *  wv  ) 

void WINAPI vpb_wave_close_write ( void *  wv  ) 

int WINAPI vpb_wave_get_mode ( void *  wv,
unsigned short *  mode 
)

int WINAPI vpb_wave_open_read ( void **  ppv,
char  filename[] 
)

int WINAPI vpb_wave_open_write ( void **  ppv,
char  filename[],
int  mode 
)

int WINAPI vpb_wave_read ( void *  wv,
char  buf[],
long  n 
)

int WINAPI vpb_wave_seek ( void *  wv,
long  offset 
)

void WINAPI vpb_wave_set_sample_rate ( void *  wv,
unsigned short  rate 
)

int WINAPI vpb_wave_write ( void *  wv,
char  buf[],
long  n 
)

Generated on Wed Dec 5 08:34:47 2007 for OPAL by  doxygen 1.5.1