|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
Defines the Symbols that name the Fax parameters. Considering the combinations of outgoing and incoming calls, which call party initiates the fax dialog, and which one is sending or receiving page(s) ends up with the three use cases below :
|
|
|
| play();//send 1100Hz CNG | record();//listen to 2100Hz CED |
| send page(s) | receive page(s) thru FaxEvent |
p_Role = FaxConstants.v_Caller
p_CapabilityToReceive = Boolean.FALSE
p_EnablePolling = Boolean.FALSE
|
p_Role = FaxConstants.v_Answerer
p_CapabilityToReceive = Boolean.TRUE
p_EnablePolling = Boolean.FALSE
|
|
|
|
| play();//send 1100Hz CNG | record();//listen to 2100Hz CED |
| receive page(s) thru FaxEvent | send page(s) |
p_Role = FaxConstants.v_Caller
p_CapabilityToReceive = Boolean.TRUE
p_EnablePolling = Boolean.TRUE
|
p_Role = FaxConstants.v_Answerer
p_CapabilityToReceive = Boolean.FALSE
p_EnablePolling = Boolean.TRUE
|
|
|
|
| play();//send 1100Hz CNG | record();//listen to 2100Hz CED |
| send some page(s) and receive other page(s) thru FaxEvent | receive and send page(s) |
p_Role = FaxConstants.v_Caller
p_EnablePolling = Boolean.TRUE
|
p_Role = FaxConstants.v_Answerer
p_CapabilityToReceive = Boolean.TRUE
p_EnablePolling = Boolean.TRUE
|
| Field Detail |
public static final Symbol ev_Fax
getQualifier() returns null, then use getError(), else
it can be one of ResourceConstants.q_Standard, q_Duration,
q_RTC, q_Stop, q_Page or q_Document.
public static final Symbol p_AnswerCED
v_Answerer behavior. Specifies CED (answering tone, 2100Hz) reply.
v_AfterCNG |
DEFAULT ; no SignalConstants.v_CNG event needed ; relies on fax stack built-in CNG detection |
v_RightNow |
replies CED immediately |
v_UponRTC |
SignalDetector needed to resume fax stack with rtca_AssumeCNG |
public static final Symbol v_RightNow
p_AnswerCED.
public static final Symbol v_UponRTC
p_AnswerCED.
public static final Symbol v_AfterCNG
p_AnswerCED.
public static final Symbol rtca_AssumeCNG
Hashtable::put(SignalDetector.p_Pattern[0], " CNG "), new RTC(SignalDetector.p_Pattern[0],FaxConstants.rtca_AssumeCNG).
public static final Symbol rtca_Cancel
public static final Symbol q_Page
public static final Symbol q_Document
public static final Symbol q_Count
public static final String v_Prefix
streamID, followed by the right justified fax ID String.
20 characters, 7 bits printable, allowed, maybe limited to space, digits, and plus sign.
public static final Symbol v_NotSet
public static final Symbol p_PagesPaths
String array of file paths of fax pages to be sent.
public static final Symbol p_StorePath
String path where received fax pages will be stored.
Actual files will have numbers 1, 2, ...m , N and so forth. Their names will look like p_StorePath i p_Suffix.
p_StorePath has to be an existing directory, and it is the Oclet's responsibility to clean this place up.
Property FAX_TIFFIFY_SHELL specifies the path to a script which uses received page file names to make a TIFF-F container.
Property TIFFIFY_CMD used to specify the path to the convert command, has been replaced by FAX_TIFFIFY_SHELL.
public static final Symbol p_Suffix
String which makes up the right part of each page file name.
Common value is ".fax". The leftmost starts with p_StorePath.
public static final Symbol p_EnablePolling
Boolean valued.
Indicate a Document for Polling (that can be sent) on record() side.
Indicate a Polling Request (ask to receive a Document) on play() side.
polling can stay TRUE on record() side, FALSE on play() side,
in the case two documents are exchanged, one in either direction.
public static final Symbol p_CapabilityToReceive
Boolean valued.
Usually TRUE for record(), FALSE for play(), unless reversed mode (polling).
public static final Symbol p_Role
| value | default role for | in reversed mode |
v_Caller | an outgoing call, sending with play() |
this is called polling, receiving with record() |
v_Answerer | an incoming cal, receiving with record() |
that is to be polled, being requested to send with play() |
public static final Symbol v_Caller
p_Role.
public static final Symbol v_Answerer
p_Role.
public static final Symbol p_VerticalResolution
p_PageResolution
v_Normal_98lpi | 3.85 per mm |
v_Fine_196lpi | 7.7 per mm |
public static final Symbol v_Normal_98lpi
p_VerticalResolution.
public static final Symbol v_Fine_196lpi
p_VerticalResolution.
public static final Symbol p_PageResolution
v_Normal_98lpi (3.85 per mm), SDSP2 supports v_Fine_196lpi
and no other.
Space separated property FAX_PAGE_RESOLUTIONS specifies this supported list.
v_PageResolution_0200_0100 | 200 ppi * 100 lpi - default |
v_PageResolution_0200_0200 | 200 ppi * 200 lpi - supported by SDSP2 |
v_PageResolution_0300_0300 | 300 ppi * 300 lpi |
v_PageResolution_0400_0400 | 400 ppi * 400 lpi |
v_PageResolution_0600_0600 | 600 ppi * 600 lpi |
v_PageResolution_1200_1200 | 1200 ppi * 1200 lpi |
v_PageResolution_0200_0400 | 200 ppi * 400 lpi (B&W only) |
v_PageResolution_0300_0600 | 300 ppi * 600 lpi (B&W only) |
v_PageResolution_0400_0800 | 400 ppi * 800 lpi (B&W only) |
v_PageResolution_0600_1200 | 600 ppi * 1200 lpi (B&W only) |
v_PageResolution_0100_0100 | 100 ppi * 100 lpi (JPEG only) |
public static final Symbol v_PageResolution_0200_0100
p_PageResolution.
public static final Symbol v_PageResolution_0200_0200
p_PageResolution.
public static final Symbol v_PageResolution_0300_0300
p_PageResolution.
public static final Symbol v_PageResolution_0400_0400
p_PageResolution.
public static final Symbol v_PageResolution_0600_0600
p_PageResolution.
public static final Symbol v_PageResolution_1200_1200
p_PageResolution.
public static final Symbol v_PageResolution_0200_0400
p_PageResolution.
public static final Symbol v_PageResolution_0300_0600
p_PageResolution.
public static final Symbol v_PageResolution_0400_0800
p_PageResolution.
public static final Symbol v_PageResolution_0600_1200
p_PageResolution.
public static final Symbol v_PageResolution_0100_0100
p_PageResolution.
public static final Symbol p_FileType
| File Compression Format used by files as parameters | |
v_T4_1D_ModifiedHuffman | Native, always available, translation free, one-dimensionnal MH, always supported |
v_T4_2D_ModifiedRead | Native, eventually incompatible, two-dimensionnal MR |
v_T6_ModifiedModifiedRead | Native, eventually incompatible, two-dimensionnal MMR, requires ECM |
v_BMP | the famous PC bitmap image, can be tranlated as needed by fax engine |
v_GIF | to be tranlated by java.awt, i.e., by Oclet for instance |
v_PNG | to be tranlated by java.awt, i.e., by Oclet for instance |
v_JPEG | to be tranlated by java.awt, i.e., by Oclet for instance |
public static final Symbol v_BMP
p_FileType.
public static final Symbol v_JPEG
p_FileType.
public static final Symbol v_GIF
p_FileType.
public static final Symbol v_PNG
p_FileType.
public static final Symbol p_BitRate
v_2400bps (V.27ter) |
v_4800bps (V.27ter) |
v_7200bps (V.29) |
v_9600bps (V.29) |
v_12000bps (V.17 or V.33) |
v_14400bps (V.17 or V.33) |
v_33600bps (V.34) |
public static final Symbol p_MinSpeed
p_BitRate.
public static final Symbol p_MaxSpeed
p_BitRate.
public static final Symbol p_FaxTimeOut
Integer valued.
Limits overall operation.
public static final Symbol p_MaxPageToReceive
Integer valued.
public static final Symbol p_MaxLineToReceive
p_PageLength is v_UnlimitedLength, Integer valued.
public static final Symbol p_LegalSupport
Boolean valued.
public static final Symbol p_LetterSupport
Boolean valued.
public static final Symbol p_SubaddressingSupport
Boolean valued.
public static final Symbol p_PasswordSupport
Boolean valued.
public static final Symbol p_SelectivePollingSupport
Boolean valued.
public static final Symbol p_SelectivePollingWithSubaddressingSupport
Boolean valued.
public static final Symbol p_T37Support
Boolean valued.
public static final Symbol p_T38Support
Boolean valued.
public static final Symbol p_InternetRoutingSupport
Boolean valued.
public static final Symbol p_InternetSelectivePollingSupport
Boolean valued.
public static final Symbol p_KeepDataOrder
Boolean valued.
Bit order of the exchanged data, with respect to the bit order of the transferred data on the PSTN.
public static final Symbol p_ByteAlignedEol
Boolean valued.
public static final Symbol v_2400bps
p_BitRate.
public static final Symbol v_4800bps
p_BitRate.
public static final Symbol v_7200bps
p_BitRate.
public static final Symbol v_9600bps
p_BitRate.
public static final Symbol v_12000bps
p_BitRate.
public static final Symbol v_14400bps
p_BitRate.
public static final Symbol v_33600bps
p_BitRate.
public static final Symbol p_PageWidth
Symbol describing the pages width (the same for all pages !).
When receiving, the value is also a single Symbol describing the maximum page width.
v_1728pixelsIn215mm | 1728 pixels in 215 mm |
v_2048pixelsIn255mm | 2048 pixels in 255 mm |
v_2432pixelsIn303mm | 2432 pixels in 303 mm |
v_1216pixelsIn151mm | 1216 pixels in 151 mm |
v_864pixelsIn107mm | 864 pixels in 107 mm |
public static final Symbol v_1728pixelsIn215mm
p_PageWidth.
public static final Symbol v_2048pixelsIn255mm
p_PageWidth.
public static final Symbol v_2432pixelsIn303mm
p_PageWidth.
public static final Symbol v_1216pixelsIn151mm
p_PageWidth.
public static final Symbol v_864pixelsIn107mm
p_PageWidth.
public static final Symbol p_PageLength
Symbol describing the pages length (the same for all pages !).
When receiving, the value is also a single Symbol describing the maximum page length.
v_A4_297mm | A4, 297 mm, 1143 lines |
v_B4_364mm | B4, 364 mm, 1401 lines |
v_UnlimitedLength | unlimited length |
public static final Symbol v_A4_297mm
p_PageLength.
public static final Symbol v_B4_364mm
p_PageLength.
public static final Symbol v_UnlimitedLength
p_PageLength.
public static final Symbol p_DataCompressionFormat
| Data Compression Format used on communication line | |
v_T4_1D_ModifiedHuffman | one-dimensionnal MH, always supported |
v_T4_2D_ModifiedRead | two-dimensionnal MR |
v_T6_ModifiedModifiedRead | two-dimensionnal MMR, requires ECM |
public static final Symbol v_T4_1D_ModifiedHuffman
p_DataCompressionFormat.
public static final Symbol v_T4_2D_ModifiedRead
p_DataCompressionFormat.
public static final Symbol v_T6_ModifiedModifiedRead
p_DataCompressionFormat.
public static final Symbol p_PagesEncoding
v_BandWarrays | FOR FUTURE USE. rectangle of Black or White dots (JAVA objects), given by p_PixelArrays |
v_FilesList | FOR FUTURE USE. .BMP file, given by p_PagesPaths |
v_TIFF | T37 fax page container, p_TiffPath compressed/expanded into p_PagesPaths by Oclet threads |
public static final Symbol p_TiffPath
v_TIFF in conjunction with p_DeTiffPrefix (e.g. /tmp/pages) and p_DeTiffSuffix (e.g. ".fax", to form /tmp/pages*.fax files).
The parent directories in p_DeTiffPrefix must exist.
This is the Oclet's responsibility to make sure there is no leftover file of the form p_DeTiffPrefix*p_DeTiffSuffix.
Property FAX_TIFFEXPAND_SCRIPT specifies the path to a script or command used to break down the TIFF-F container.
p_TiffPath is _not_ used for receiving, see FaxEvent.tiffify(String) instead.
public static final Symbol p_DeTiffPrefix
p_TiffPath.
public static final Symbol p_DeTiffSuffix
p_TiffPath.
public static final Symbol v_TIFF
p_PagesEncoding.
public static final Symbol v_FilesList
p_PagesEncoding.
public static final Symbol v_BandWarrays
p_PagesEncoding.
public static final Symbol p_PixelArrays
public static final Symbol p_ErrorCorrection
v_DisableECM | Disable ECM (Annex A/T.30) |
v_EnableECM_64bytes | Enable ECM, 64 bytes/frame |
v_EnableECM_256bytes | Enable ECM, 256 bytes/frame |
public static final Symbol v_DisableECM
p_ErrorCorrection.
public static final Symbol v_EnableECM_64bytes
p_ErrorCorrection.
public static final Symbol v_EnableECM_256bytes
p_ErrorCorrection.
public static final Symbol v_Rcv_Qual_OK
public static final Symbol v_Rcv_Qual_Medium
public static final Symbol v_Rcv_Qual_Bad
public static final Symbol v_Error_File_Open
public static final Symbol v_Error_Decomp_Init
public static final Symbol v_Error_Illegal_Width
public static final Symbol v_Error_Conversion_To_G3
public static final Symbol v_Error_Page_Format
public static final Symbol v_Error_Disconnect
public static final Symbol v_Page_File_Name_Size
public static final Symbol v_Encoding_MS_BMP
public static final Symbol v_T4_Buff_Size
public static final Symbol p_ScanTimePerLine
| Scan Time/Line | v_Normal_98lpi | v_Fine_196lpi |
v_ST0000 | 0 ms | 0 ms |
v_ST0505 | 5 ms | 5 ms |
v_ST1005 | 10 ms | 5 ms |
v_ST1010 | 10 ms | 10 ms |
v_ST2010 | 20 ms | 10 ms |
v_ST2020 | 20 ms | 20 ms |
v_ST4020 | 40 ms | 20 ms |
v_ST4040 | 40 ms | 40 ms |
public static final Symbol v_ST4040
p_ScanTimePerLine.
public static final Symbol v_ST4020
p_ScanTimePerLine.
public static final Symbol v_ST2020
p_ScanTimePerLine.
public static final Symbol v_ST2010
p_ScanTimePerLine.
public static final Symbol v_ST1010
p_ScanTimePerLine.
public static final Symbol v_ST1005
p_ScanTimePerLine.
public static final Symbol v_ST0505
p_ScanTimePerLine.
public static final Symbol v_ST0000
p_ScanTimePerLine.
| |||||||||