Wed Jan 8 2020 09:50:23

Asterisk developer's documentation


ast_fax_session_details Struct Reference

The data communicated between the high level applications and the generic fax function. More...

#include <res_fax.h>

Data Fields

struct ast_string_field_mgr __field_mgr
 
struct ast_string_field_pool__field_mgr_pool
 
enum ast_fax_capabilities caps
 
struct ast_fax_documents documents
 
const ast_string_field error
 
const ast_string_field headerinfo
 
unsigned int id
 
const ast_string_field localstationid
 
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
 
const ast_string_field remotestationid
 
const ast_string_field resolution
 
const ast_string_field result
 
const ast_string_field resultstr
 
struct ast_fax_t38_parameters their_t38_parameters
 
const ast_string_field transfer_rate
 

Detailed Description

The data communicated between the high level applications and the generic fax function.

Definition at line 105 of file res_fax.h.

Field Documentation

struct ast_string_field_mgr __field_mgr

Definition at line 137 of file res_fax.h.

struct ast_string_field_pool* __field_mgr_pool

Definition at line 137 of file res_fax.h.

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().

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
uint32_t dontuse

dontuse dummy variable - do not ever use

Definition at line 143 of file res_fax.h.

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().

const ast_string_field error

the error reason of the fax session

Definition at line 137 of file res_fax.h.

Referenced by acf_faxopt_read(), and set_channel_variables().

const ast_string_field headerinfo

headerinfo variable is set from the LOCALHEADERINFO channel variable * before the fax session starts

Definition at line 137 of file res_fax.h.

Referenced by acf_faxopt_read(), acf_faxopt_write(), generic_fax_exec(), and set_local_info().

unsigned int id

session id

Definition at line 112 of file res_fax.h.

Referenced by acf_faxopt_read(), and fax_session_new().

const ast_string_field localstationid

local station identification. This is set from the LOCALSTATIONID * channel variable before the fax session starts

Definition at line 137 of file res_fax.h.

Referenced by acf_faxopt_read(), acf_faxopt_write(), generic_fax_exec(), report_fax_status(), set_channel_variables(), and set_local_info().

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().

struct ast_fax_t38_parameters our_t38_parameters

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().

const ast_string_field remotestationid

remote station identification. This is stored in the REMOTESTATIONID * channel variable after the fax session completes

Definition at line 137 of file res_fax.h.

Referenced by acf_faxopt_read(), and set_channel_variables().

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().

const ast_string_field resolution

resolution negotiated during the fax session. This is stored in the * FAXRESOLUTION channel variable when the fax session completes

Definition at line 137 of file res_fax.h.

Referenced by acf_faxopt_read(), and set_channel_variables().

const ast_string_field result

the result of the fax session

Definition at line 137 of file res_fax.h.

Referenced by acf_faxopt_read(), generic_fax_exec(), set_channel_variables(), and t30_phase_e_handler().

const ast_string_field resultstr

a more descriptive result string of the fax session

Definition at line 137 of file res_fax.h.

Referenced by acf_faxopt_read(), set_channel_variables(), and t30_phase_e_handler().

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

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().

const ast_string_field transfer_rate

transfer rate negotiated during the fax session. This is stored in the * FAXBITRATE channel variable when the fax session completes

Definition at line 137 of file res_fax.h.

Referenced by acf_faxopt_read(), and set_channel_variables().


The documentation for this struct was generated from the following file: