Main Page | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

fax.h File Reference

Go to the source code of this file.

Typedefs

typedef fax_state_s fax_state_t

Functions

 SPAN_DECLARE (int) fax_rx(fax_state_t *s
 Release a V.8 context.
 SPAN_DECLARE (void) fax_set_transmit_on_idle(fax_state_t *s
 Cleanup a T.30 context if the call terminates.
 SPAN_DECLARE (t30_state_t *) fax_get_t30_state(fax_state_t *s)
 Get a pointer to the T.30 engine associated with a FAX context.
 SPAN_DECLARE (logging_state_t *) fax_get_logging_state(fax_state_t *s)
 Get a pointer to the logging context associated with a FAX context.
 SPAN_DECLARE (fax_state_t *) fax_init(fax_state_t *s
 Initialise a FAX context.

Variables

int16_t * amp
int16_t int len
int16_t int max_len
int transmit_on_idle
int use_tep
int calling_party


Detailed Description


Function Documentation

SPAN_DECLARE fax_state_t  ) 
 

Initialise a FAX context.

Initialise a FAX context.

Parameters:
s The FAX context.
calling_party TRUE if the context is for a calling party. FALSE if the context is for an answering party.
Returns:
A pointer to the FAX context, or NULL if there was a problem.

SPAN_DECLARE logging_state_t  ) 
 

Get a pointer to the logging context associated with a FAX context.

Get a pointer to the logging context associated with a FAX context.

Parameters:
s The FAX context.
Returns:
A pointer to the logging context, or NULL.

SPAN_DECLARE t30_state_t  ) 
 

Get a pointer to the T.30 engine associated with a FAX context.

Initialise a T.30 context.

Parameters:
s The T.30 context.
calling_party TRUE if the context is for a calling party. FALSE if the context is for an answering party.
set_rx_type_handler 
set_rx_type_user_data 
set_tx_type_handler 
set_tx_type_user_data 
send_hdlc_handler 
send_hdlc_user_data 
Returns:
A pointer to the context, or NULL if there was a problem.

SPAN_DECLARE void   ) 
 

Cleanup a T.30 context if the call terminates.

Select whether silent audio will be sent when FAX transmit is idle.

Parameters:
s The FAX context.
transmit_on_idle TRUE if silent audio should be output when the FAX transmitter is idle. FALSE to transmit zero length audio when the FAX transmitter is idle. The default behaviour is FALSE.

SPAN_DECLARE int   ) 
 

Release a V.8 context.

Apply T.30 receive processing to a block of audio samples.

Parameters:
s The FAX context.
amp The audio sample buffer.
len The number of samples in the buffer.
Returns:
The number of samples unprocessed. This should only be non-zero if the software has reached the end of the FAX call.


Generated on Fri Aug 28 20:12:28 2009 for spandsp by  doxygen 1.3.9.1