BTCall Parameters

Debug

Debug Log File Name:
[debug] This parameter specifies the name of the debug file for the debug function to send its output, if a debug function was not already set by the application.

API Debugging:
[debug_enable] This parameter specifies whether the API debugging is enabled or disabled.
Enabled - The debug keyword will be written to the btcall configuration file and the API debugging will be enabled. API debug mode will be using DEBUG_ALL after the first call to BfvLineReset, if debug mode is not already enabled by the application. It will also enable the 'debug' parameter that can be used to set the location of the log file.
Disabled - The debug keyword will not be written to the btcall configuration file and the API debugging will be disabled. This is the default setting.

1st Debug Log File Name:
[debug_file_1] This parameter specifies the name of the first debug file for the debug function to send its output, if a debug function was not already set by the application.

2nd Debug Log File Name:
[debug_file_2] This parameter specifies the name of the second debug file for the debug function to send its output, if a debug function was not already set by the application.

Maximum Debug File Size:
[debug_max_file_size] This parameter specifies the maximum size that the debug file will be limited to.

Trace Bfv API Function Calls:
[debug_options] This parameter specifies if the tracing of Bfv API function calls is enabled or disabled.

Country Telephony Parameter File:
[bt_cparm] This parameter specifies the name of the country telephony parameter file to use.

Country:
[country_code] This parameter specifies the international country code with modifiers. Initial digits (up to 3) identify the host country; the last digit supplies a modifier for properties such as the phone system attached to the board.

Maximum Timeout, sec:
[max_timeout] This parameter specifies the maximum time that the API will delay waiting for activity to occur on a board. If any API function allows specification of a timeout value, that value takes precedence. The units are in seconds. Default value is 0 (disabled).

Advanced Settings

Fax

Action Taken on Mismatches:
[width_res_behavior] This parameter specifies the action taken as a result of page width or resolution mismatches on fax transmission. Does not affect fax reception. Scaling the fax is not available for all combinations of resolution mismatches.

Bad Line Behavior:
[badline_behavior] This parameter specifies the behavior during non_ECM when a bad line is detected in received MH or MR data. The option to attempt to repair the line is not available on the TruFax platform.

Default ID String:
[id_string] This parameter specifies the default ID string (up to 20 characters long) for fax machines. This parameter can be overridden by the BfvFaxSetLocalId function if the host country permits changing the ID string.

Error Correction Mode:
[ecm_enable] This parameter specifies whether the ECM (error correction mode) is enabled or disabled. If disabled, MMR fax compression on the line is unavailable. The normal ECM frame size is 256 bytes. You can enable a frame size of 64 bytes, but the board uses that frame size on transmit only. On receive, it always uses the frame size that the transmitter selects.
Error Correction Mode (ECM) is not supported for TruFax BRI boards. Therefore, disabling applies to all other board types.

Error Threshold Value:
[error_thresh] This parameter specifies the error threshold value of n (2n for fine resolution) number of consecutive bad G3 lines on a received page. A page with errors in this number of consecutive lines is considered bad, regardless of the results from error_mult. An RTN is returned when a bad page occurs.

Font Files:
[font_file] This parameter specifies names of files that contain the transmit/convert font for ASCII. To add files, place the cursor at the end of the last entry and press Return. Then key in the name of the new file. Verify that the file name and location are correct. You can specify an optional font number, indicating the downloadable font to use (if no font number is specified, 0 is assumed). The font file must be located in the current directory, or you must include the correct path with its name. The file is opened, and the contents downloaded to the module when the application calls BfvLineReset using the mill_load_fonts option. Multiple occurrences of font file parameters with different font numbers are permitted in the configuration file. When a font number that is specified for ASCII conversion has not been downloaded, a default font is used (font 255). Specify the default (font 255) using the font_file keyword. If not, it defaults to ibmpcps.fz8 (no path). When font downloads are done as described above, the application downloads font 255 regardless of whether other font numbers are listed using this keyword. Some font numbers might be reserved for preloaded fonts.

Maximum Error Multiplication Value:
[error_mult_rtp] This parameter specifies the error multiplication value used to determine if the error percentage on a received page is too high. The number of errors per page is multiplied by this number and the product is divided by 2. If this result exceeds the number of lines on the page, the error percentage per page is too high and an RTP signal is returned to the transmitting station. The value of this parameter should normally be greater than that of the error_mult parameter (corresponding to a smaller percentage). The RTN threshold takes precedence over the RTP threshold. Default value is 200 (for a 1% error rate).

Maximum Number of Pages:
[max_pagelist] This parameter specifies the maximum number of pages allowed for storing results during a call. The last max_pagelist PAGE_RES structures are accessible via the FAX_RES structure if this feature has been enabled.

Maximum Page Width:
[max_width] This parameter specifies the maximum page width permitted for fax reception.

Minimum Error Multiplication Value:
[error_mult] This parameter specifies the error multiplication value used to determine if the error percentage on a received page is too high. The number of errors per page is multiplied by this number and the product is divided by 2. If this result exceeds the number of lines on the page, the error percentage per page is too high and an RTN signal is returned to the transmitting station. The value of this parameter should normally be less than that of the error_mult_rtp parameter (corresponding to a larger percentage). The RTN threshold takes precedence over the RTP threshold. Default value is 40 (for a 5% error rate).

Minimum Number of Lines, x10 units:
[min_length] This parameter specifies the minimum number of lines (in 10 scan line units) required for a fax page received in non-ECM mode. The firmware considers any fax page with fewer lines invalid and responds with an RTN signal. Default value is 0 (disabled).

Permitted Compression Types:
[line_compression] This parameter specifies the permitted compression types for fax transmission or reception on the phone line. This specification is independent of the file format specified for transmission or reception. If ECM is disabled, then MMR fax compression on the line is unavailable. TruFax boards only support 'MH only' and 'MR or MH' options.

Send RTP FSK:
[fax_rtp_enable] This parameter controls whether an RTP FSK signal can be sent during fax receive.

Time to Wait for CED Tone, x10msec:
[ced_timeout] This parameter specifies the length of time, in 10ms units, to wait for a fax answer tone (CED tone) from a remote fax machine. This parameter can only be set if the host country permits changing the wait_for_ced timeout value. This parameter also controls the amount of time CNG plays. Default value is country dependent; 4000(40secs) in the USA.

V.34 Enable Send Call Indicator:
[v34_ci_enable] This parameter specifies whether to enable or disable the ability to detect and send call indicator (CI) in order to enter V.8 mode and V.34 mode after having missed the initial CED tone. This parameter is applicable only for TR1034.

V.34 High Speed Control Signaling:
[v34_2400_baud_ctrl] This parameter specifies whether to enable or disable the use of high speed control signaling for V.34. This parameter is applicable only for TR1034.

V.34 Modulation Capability:
[v34_enable] This parameter specifies whether to enable or disable V.34 fax modulation capability, if the hardware and firmware support it. If V.34 fax is enabled, then when V.34 actually occurs, ECM is used regardless of the setting of ecm_enable. This parameter is applicable only for TR1034.

IAF Capability:
[iaf_enable] This parameter specifies whether to enable or disable Internet Aware Fax capability. The T.38 version under Advanced Settings on the T.38 Parameters tab must be set to 1 or 3 for IAF. The IAF Maximum Bit Rate field should be used to specify the maximum bit rate in bits per second when IAF is enabled. This parameter applies to the SR140 only. The SR140 must have an IAF license.

IAF Maximum Bit Rate, bps:
[iaf_max_bit_rate] This parameter specifies the Internet Aware Fax Maximum Bit Rate. Unit: Bits per second. An empty field or a value of 0 will choose the default value. The default value means the Maximum Bit Rate is unlimited up to the IAF license value. This field can be empty, 0 or a value between 14400 and 2400000. The IAF Capability field should be set to enable. The T.38 version under Advanced Settings on the T.38 Parameters tab must be set to 1 or 3 for IAF to work. This parameter applies to the SR140 only. The SR140 must have an IAF license.

Enhanced Fax Format Page Types:
[eff_pt_caps] This parameter specifies the enhanced fax format pages that the channel is permitted to receive. If none of the options are selected, this enhanced fax format will be disabled(0) by default. If enhanced fax format is enabled, then ECM is automatically enabled for receive faxes regardless of the setting of ecm_enable parameter. This parameter is not available on TruFax.

Enable Receive SUB, PWD, SEP FSK:
[subpwdsep] This parameter specifies whether to enable or disable reception of the SUB, PWD, and SEP FSK signals. Applications typically use these signals to direct or validate incoming calls. If none of the options are selected, then SUB,PWD and SEP, reception will be disabled. This parameter is not applicable for TruFax.

Allowable Resolutions:
[restrict_res] This parameter specifies allowable resolutions for fax reception. Regardless of the value chosen, 200H x 100V (normal) and 100H x 100V (for JPEG only) is always allowed. If none of the options are selected, the parameter will be set to 200H x100V and 100H x 100V (for JPEG only). TruFax boards only support 200H x 100V (no JPEG) or 200H x 200V (no JPEG).

Voice and DTMF

Auto Gain Control:
[agc] This parameter specifies the automatic gain control (AGC) method to use during speech recording. Use only for half duplex recording when board is setup as full duplex for an ASR application. In this case, there is no AGC. AGC is automatically turned off.
0 = None
>0 = Dynamic AGC; levels adjusted during recording.

DTMF Detection Threshold:
[dtmf_thresh] This parameter specifies the DTMF detection threshold to use during voice play and record. 0.5 dB units, two's complement. Value is added to the default DTMF threshold of -28dB.

DTMF High To Low Twist Idle, dB:
[dtmf_hi_to_lo_twist_idle] This parameter specifies the maximum amplitude allowed for a digit's high frequency to be louder than its low frequency when detecting DTMF digits while not playing speech.

DTMF High To Low Twist Play, dB:
[dtmf_hi_to_lo_twist_play] This parameter specifies the maximum amplitude allowed for a digit's high frequency to be louder than its low frequency when detecting DTMF digits during speech playback.

DTMF In To In Ratio Idle, x0.5dB:
[dtmf_in_to_in_ratio_idle] This parameter specifies the minimum difference required between the digit's highest signal energy and its next highest signal energy when detecting DTMF digits while not playing speech. Unit: 0.5 dB

DTMF In To In Ratio Play, x0.5dB:
[dtmf_in_to_in_ratio_play] This parameter specifies the minimum difference required between the digit's highest signal energy and its next highest signal energy when detecting DTMF digits during speech playback. Unit: 0.5 dB

DTMF In To Out Ratio Idle, x0.5dB:
[dtmf_in_to_out_ratio_idle] This parameter specifies the minimum difference required between the digit's signal energy and noise energy when detecting DTMF digits while not playing speech. Unit: 0.5 dB

DTMF In To Out Ratio Play, x0.5dB:
[dtmf_in_to_out_ratio_play] This parameter specifies the minimum difference required between the digit's signal energy and noise energy when detecting DTMF digits during speech playback. Unit: 0.5 dB.

DTMF Low To High Twist Idle, dB:
[dtmf_lo_to_hi_twist_idle] This parameter specifies the maximum amplitude allowed for a digit's low frequency to be louder than its high frequency when detecting DTMF digits while not playing speech.

DTMF Low To High Twist Play, dB:
[dtmf_lo_to_hi_twist_play] This parameter specifies the maximum amplitude allowed for a digit's low frequency to be louder than its high frequency when detecting DTMF digits during speech playback.

DTMF Min Off Idle, msec:
[dtmf_min_off_idle] This parameter specifies the minimum silence required to determine that a digit has ended when detecting like DTMF digits while not playing speech. Unit: millisecond(msec)

DTMF Min Off Play, msec:
[dtmf_min_off_play] This parameter specifies the minimum silence required to determine that a digit has ended when detecting like DTMF digits during speech playback. Unit: millisecond(msec)

DTMF Min On Idle, msec:
[dtmf_min_on_idle] This parameter specifies the minimum duration that a digit must be present in order to be detected while not playing speech. Unit: millisecond(msec)

DTMF Min On Play, msec:
[dtmf_min_on_play] This parameter specifies the minimum duration that a digit must be present in order to be detected during speech playback. Unit: millisecond(msec)

Initial Gain for Speech Playback:
[v_play_gain] This parameter specifies the initial gain value for speech playback. A positive value indicates a step up; a negative value indicates a step down. The gain steps are the same as those controlled by BfvSpeechModify.

Middle Silence Compr. Time, msec:
[silcompr_middle] This parameter specifies the time in milliseconds to which the silence in the middle of the recording will be compressed. This parameter will be effective only when silence compression is enabled.

PCPM Table:
[pcpm_table] This parameter specifies the filename of the PCPM table that should be used to program the channel. This parameter is applicable only for TR1000 series boards with analog or BRI interfaces.

Record Beep Tone Duration, msec:
[record_beep_dur] This parameter specifies the length of time to play the beep tone before starting to record speech. Unit: millisecond(ms)

Record Beep Tone Frequency, Hz:
[record_beep_freq] This parameter specifies the frequency of the beep tone that plays before starting to record speech. Unit: Hertz(Hz)

Start Silence Compr. Time, msec:
[silcompr_start] This parameter specifies the time in milliseconds to which the silence at the start of the recording will be compressed. This parameter will be effective only when silence compression is enabled.

Call Control (PSTN)

Number of Cycles Before Failure:
[busy_dt_ct] This parameter specifies the number of consecutive BUSY1, BUSY2 ,ROBUSY, or DIALTON call progress values that must occur before BfvLineOriginateCall will terminate with that result.

Line Encoding:
[line_encoding] This parameter allows overriding of the telephony configuration value for the line_encoding on the specific channel for which this parameter is in effect.

Max Wait for Call Completion, sec:
[v_timeout] This parameter specifies the maximum time (in seconds) to wait after the last dialed digit for a final call progress result. Use only when CALL_PROTOCOL_VOICE mode is selected. This parameter only applies to the use of BfvLineOriginateCall and BfvLineOrigCallDB.