The data communicated between the high level applications and the generic fax function. More...
#include <res_fax.h>
Public Member Functions | |
AST_DECLARE_STRING_FIELDS (AST_STRING_FIELD(resolution);AST_STRING_FIELD(transfer_rate);AST_STRING_FIELD(localstationid);AST_STRING_FIELD(remotestationid);AST_STRING_FIELD(headerinfo);AST_STRING_FIELD(result);AST_STRING_FIELD(resultstr);AST_STRING_FIELD(error);) | |
Data Fields | |
enum ast_fax_capabilities | caps |
struct ast_fax_documents | documents |
unsigned int | id |
unsigned int | maxrate |
unsigned int | minrate |
enum ast_fax_modems | modems |
union { | |
struct { | |
uint32_t allow_audio:2 | |
uint32_t debug:2 | |
uint32_t ecm:1 | |
uint32_t request_t38:1 | |
uint32_t send_ced:1 | |
uint32_t send_cng:1 | |
uint32_t statusevents:2 | |
uint32_t switch_to_t38:1 | |
} | |
uint32_t dontuse | |
} | option |
struct ast_fax_t38_parameters | our_t38_parameters |
unsigned int | pages_transferred |
struct ast_fax_t38_parameters | their_t38_parameters |
The data communicated between the high level applications and the generic fax function.
Definition at line 105 of file res_fax.h.
AST_DECLARE_STRING_FIELDS | ( | AST_STRING_FIELD(resolution);AST_STRING_FIELD(transfer_rate);AST_STRING_FIELD(localstationid);AST_STRING_FIELD(remotestationid);AST_STRING_FIELD(headerinfo);AST_STRING_FIELD(result);AST_STRING_FIELD(resultstr);AST_STRING_FIELD(error); | ) |
uint32_t allow_audio |
allow audio mode FAX on T.38-capable channels
Definition at line 152 of file res_fax.h.
Referenced by receivefax_exec(), receivefax_t38_init(), sendfax_exec(), and sendfax_t38_init().
enum ast_fax_capabilities caps |
fax session capability requirements. The caps field is used to select the proper fax technology module before the session starts
Definition at line 108 of file res_fax.h.
Referenced by cli_fax_show_sessions(), fax_session_new(), fax_session_reserve(), generic_fax_exec(), receivefax_exec(), receivefax_t38_init(), report_fax_status(), sendfax_exec(), sendfax_t38_init(), set_fax_t38_caps(), set_file(), spandsp_fax_cli_show_session(), spandsp_fax_new(), and t30_phase_e_handler().
uint32_t debug |
flag to send debug manager events
Definition at line 146 of file res_fax.h.
Referenced by fax_session_new(), receivefax_exec(), sendfax_exec(), and set_logging().
struct ast_fax_documents documents [read] |
document(s) to be sent/received
Definition at line 114 of file res_fax.h.
Referenced by acf_faxopt_read(), destroy_session_details(), generate_filenames_string(), receivefax_exec(), sendfax_exec(), session_details_new(), and set_file().
uint32_t ecm |
flag indicating the use of Error Correction Mode (ECM)
Definition at line 148 of file res_fax.h.
Referenced by acf_faxopt_read(), acf_faxopt_write(), session_details_new(), and set_ecm().
unsigned int id |
session id
Definition at line 112 of file res_fax.h.
Referenced by acf_faxopt_read(), and fax_session_new().
unsigned int maxrate |
override the maximum transmission rate with a channel varialbe
Definition at line 166 of file res_fax.h.
Referenced by acf_faxopt_read(), acf_faxopt_write(), receivefax_exec(), sendfax_exec(), and session_details_new().
unsigned int minrate |
override the minimum transmission rate with a channel variable
Definition at line 164 of file res_fax.h.
Referenced by acf_faxopt_read(), acf_faxopt_write(), receivefax_exec(), sendfax_exec(), and session_details_new().
enum ast_fax_modems modems |
modem requirement for the session
Definition at line 110 of file res_fax.h.
Referenced by acf_faxopt_read(), acf_faxopt_write(), receivefax_exec(), sendfax_exec(), session_details_new(), and spandsp_modems().
union { ... } option |
session details flags for options
Referenced by acf_faxopt_read(), acf_faxopt_write(), fax_session_new(), receivefax_exec(), receivefax_t38_init(), report_fax_status(), sendfax_exec(), sendfax_t38_init(), session_details_new(), set_ecm(), set_logging(), and spandsp_fax_switch_to_t38().
struct ast_fax_t38_parameters our_t38_parameters [read] |
our T.38 session parameters, if any
Definition at line 168 of file res_fax.h.
Referenced by generic_fax_exec(), receivefax_t38_init(), and sendfax_t38_init().
unsigned int pages_transferred |
the number of pages sent/received during a fax session
Definition at line 139 of file res_fax.h.
Referenced by acf_faxopt_read(), set_channel_variables(), and t30_phase_e_handler().
uint32_t request_t38 |
send a T.38 reinvite
Definition at line 160 of file res_fax.h.
Referenced by sendfax_exec(), sendfax_t38_init(), and session_details_new().
uint32_t send_ced |
flag indicating whether CED should be sent (for receive mode)
Definition at line 156 of file res_fax.h.
Referenced by receivefax_exec(), and session_details_new().
uint32_t send_cng |
flag indicating whether CNG should be sent (for send mode)
Definition at line 158 of file res_fax.h.
Referenced by sendfax_exec(), and session_details_new().
uint32_t statusevents |
flag indicating the sending of status manager events
Definition at line 150 of file res_fax.h.
Referenced by receivefax_exec(), report_fax_status(), sendfax_exec(), and session_details_new().
uint32_t switch_to_t38 |
indicating the session switched to T38
Definition at line 154 of file res_fax.h.
Referenced by spandsp_fax_switch_to_t38().
struct ast_fax_t38_parameters their_t38_parameters [read] |
the other endpoint's T.38 session parameters, if any
Definition at line 170 of file res_fax.h.
Referenced by generic_fax_exec(), receivefax_t38_init(), sendfax_t38_init(), and spandsp_fax_start().