voice-cmds.html

VoiFax is a program that manage voice/data/fax modem in the same manner of vgetty and mgetty.VoiFax

decimal value in result code format.

</dd><dt>#VBS=? </dt><dd>Returns "2,3,4", which are the ADPCM compression bits/sample
rates available. These bits/sample rates are correlated
with the #VCI? query command response which provides the single compression
 method available.

</dd><dt>#VBS=2 </dt><dd>Selects 2 bits per sample.

</dd><dt>#VBS=3 </dt><dd>Selects 3 bits per sample.

</dd><dt>#VBS=4 </dt><dd>Selects 4 bits per sample.
</dd></dl>

<h5>#VBT - Beep Tone Timer</h5>

This command defines the time period, in 10ths of a second up to 4 seconds
(40) which is used by the modem as the DTMF or fixed
tone duration for generating tones via the D command while in Online Voice
Command Mode.<p>

Parameters: n = 0 - 40 (0 - 4 seconds)</p><p>

Default: 10</p><p>

Result Codes:
</p><dl><dt>OK </dt><dd>If n = 0 - 40.

</dd><dt>ERROR </dt><dd>Otherwise.
</dd></dl>

Command options:
<dl><dt>#VBT? </dt><dd>Returns the current setting of the #VBT command as an ASCII
decimal value in result code format.

</dd><dt>#VBT=? </dt><dd>Returns the message, "0-40".

</dd><dt>#VBT=0 </dt><dd>Disables the tone generation capability.

</dd><dt>#VBT=1 to 40 </dt><dd>Sets tone duration time.
</dd></dl>

<h5>#VCI? - Identify Compression Method</h5>

This command queries the modem as to its compression method and raw
bits-per-sample capability. &lt;O&gt;;&lt;D&gt; pairs, separated
by &lt;LF&gt;s. Within each line, the &lt;O&gt; is left justified,
and is separated from the &lt;D&gt; by the semicolon character and separated
from the bits-per-sample string by another semicolon.<p>

Parameters: None</p><p>

Command option:
</p><dl><dt>#VCI? </dt><dd>Returns the message, "ROCKWELL;ADPCM;8".
</dd></dl>

<h5>#VLS - Voice Line Select</h5>

This action command can be used to select which devices are routed through
the modem.<p>

Parameters: n = 0, 1, 2, 3, or 4   [This is the device position number
(not device number) as reflected in response to #VLS=?]</p><p>

Default: 0</p><p>

Result Codes:
</p><dl><dt>OK </dt><dd>If n = 0, 1, 2, 3, or 4.

</dd><dt>VCON </dt><dd>If device selected does not connect to the telephone line.
(A speaker is such a device, but a telephone line with speaker
ON is not such a device, and generates OK.)

</dd><dt>ERROR </dt><dd>If n does not equal 0, 1, 2, 3, or 4, or if already off-hook.
</dd></dl>
Command options:
<dl><dt>#VLS? </dt><dd>This query returns the current setting of the #VLS command
as an ASCII decimal value in result code format.

</dd><dt>#VLS=? </dt><dd>This query requests a report of the device types available
for selection. The response is a series of numbers separated
by commas, and each number indicates a device position number. Currently,
device position numbers do happen to correspond to
device type numbers as shown in Table 8-5, but this correlation is not
required (i.e., 0's could be placed in the first few
device position number locations to correspond to multiple telephone line
connections).

</dd><dt>#VLS=0 </dt><dd>The default option on the modem. This command instructs
the modem that when entering any of the three voice operating
submodes (Online Command, Transmit, or Receive), that the telephone line
interface should be routed through the modem. The
OK response is sent to the DTE, and any previous connection is lost (i.e.,
the modem ends up on-hook as a result of issuing
this command to connect to the telephone line).

</dd><dt>#VLS=1 </dt><dd>This command instructs the modem to route only the handset
through the modem. This setting can be chosen before recording
a greeting message.

</dd><dt>#VLS=2 </dt><dd>This command instructs the modem to route only the speaker
through the modem. This setting can be chosen before playing
back any message. The modem immediately switches to Online Voice Command
Mode, and the VCON response is generated for completeness.<p>

However, since this is an output only device, nothing of consequence can
happen until the DTE sends the #VTX command.

</p></dd><dt>#VLS=3 </dt><dd>This command instructs the modem that only the auxiliary
input device (microphone) should be routed through the modem.
This setting can be chosen before recording a greeting message.

</dd><dt>#VLS=4 </dt><dd>This command is the same as #VLS=0, except that the modem
enables the internal speaker as well as the telephone line/handset
circuit.
</dd></dl>


<table border="1">
<caption>Table 8-5.  Device Types Supported by #VLS</caption>
<tbody><tr><th>ASCII Digit
 </th><th>Device Type and Considerations

</th></tr><tr><td> 0
 </td><td>Telephone Line with Telephone handset. This is the default device
	selected. In this configuration, the user can pick up a
	handset which is connected to the same telephone line as the modem,
	and * record both sides of a conversation with a remote
	station. The modem currently supports one telephone line/handset,
	which is in the first position of the #VLS=? response. (Note
	that the modem can interface to multiple telephone lines by having
	"0"'s in multiple positions in the #VLS ? response.) If
	a telephone line is selected, the modem must be on-hook or
	it hangs up. The OK message is generated.

</td></tr><tr><td> 1
 </td><td>Transmit/Receive Device (other than telephone line). This is a handset,
	headset, or speaker-phone powered directly by the
	modem. When such a device is selected, the modem immediately enters
	Online Voice Command Mode, DTMF monitoring is enabled if
	applicable, and the VCON response is sent. The modem supports
	one such device as the second device listed in the #VLS=? response.

</td></tr><tr><td> 2
 </td><td>Transmit Only Device. Normally, this is the onboard speaker.
	When this device is selected, the modem immediately enters Online
	Voice Command Mode, and the VCON response is sent. The modem supports
	selection of the internal speaker as the third device
	listed in #VLS=? response.

</td></tr><tr><td> 3
 </td><td>Receive Only Device. Normally, this is a microphone. When such a device
	is selected, the modem immediately enters Online Voice
	Command Mode, DTMF monitoring is enabled if applicable, and the VCON
	response is sent. The modem supports one microphone as
	the fourth element returned in the #VLS=? response.

</td></tr><tr><td> 4
 </td><td>Telephone line with Speaker ON and handset. This device type can be used
	to allow the DTE to select the telephone line/handset
	(if picked up) with the modem speaker also turned ON. This can be
	used by the DTE to allow the user to monitor an incoming
	message as it is recorded.
</td></tr></tbody></table>

<h5>#VRA - Ringback Goes Away Timer (Originate)</h5>

This command can be used, when originating a voice call (#CLS=8) to set
the "Ringback Goes Away" timer value, i.e., an amount
of time (in units of 100 ms) measured from when the ringback cadence stops
once detected. If ringback is not detected within
this period, the modem assumes that the remote has picked up the line and
switches to Online Voice Command Mode. Every time
a ringback cycle is detected, this timer is reset.<p>

Parameters: n = 0 - 255  (0 - 2.55 seconds)</p><p>

Default: 70</p><p>

Result Code:
</p><dl><dt>OK </dt><dd>If n = 0 - 255.

</dd><dt>ERROR </dt><dd>Otherwise.
</dd></dl>


Command options:
<dl><dt>#VRA? </dt><dd>Returns the current setting of the #VRA command as an ASCII
decimal value in result code format.

</dd><dt>#VRA=? </dt><dd>Returns the message, "0-255".

</dd><dt>#VRA=0 </dt><dd>Turns off the "ringback goes away timer."
After one ringback, the dialing modem sends VCON and enters Online Voice
Command Mode immediately.

</dd><dt>#VRA=n </dt><dd>Where n defines the period without ringback (after at least
one ringback has been detected) in 100 ms units.
</dd></dl>

<h5>#VRN - Ringback Never Came Timer (Originate)</h5>

This command can be used when originating a voice call (#CLS=8) to set
the "Ringback Never Came" timer value, i.e., an amount
of time (in units of 100 ms) measured from completion of dialing.
If ringback is not detected within this period, the modem
assumes the remote has picked up the line and switches to Online Voice
Command Mode.<p>

Parameters: n = 0 - 255  (0 - 2.55 seconds)</p><p>

Default: 100</p><p>

Result Code:
</p><dl><dt>OK </dt><dd>If n = 0 - 255.

</dd><dt>ERROR </dt><dd>Otherwise.
</dd></dl>

Command options:
<dl><dt>#VRN? </dt><dd>Returns the current setting of the #VRN command as an ASCII
decimal value in result code format.

</dd><dt>#VRN=? </dt><dd>Returns the message, "0-255".

</dd><dt>#VRN=0 </dt><dd>Turns off the "ringback never came timer."
After dialing, the modem sends VCON and immediately enters Online Voice
Command Mode.

</dd><dt>#VRN=n </dt><dd>Where n defines the period without ringback after dialing
in 100 ms units.
</dd></dl>

<h5>#VRX - Voice Receive</h5>

This action command is only valid if the modem is in the Online Voice
Command Mode (indicated previously with the VCON message),
and is the switch to the Voice Receive Mode. This command is used when a
voice file is to be received from the line, microphone,
or handset. The #VLS command should have been previously issued to select
the input source.<p>

Parameters: None</p><p>

Result Codes:
</p><dl><dt>CONNECT </dt><dd>When voice transfer from modem to DTE can begin.

</dd><dt>ERROR </dt><dd>If #VLS=0 and not connected to any input device.
</dd></dl>

<h5>#VSD - Enable Silence Deletion (Voice Receive)</h5>

This command is used to enable or disable Voice Receive Mode silence
deletion.<p>

Parameters: n = 0 or 1</p><p>

Default: 0 or 1

Result Code:
</p><dl><dt>OK </dt><dd>If n = 1.

</dd><dt>ERROR </dt><dd>Otherwise.
</dd></dl>

Command options:
<dl><dt>#VSD? </dt><dd>Returns the current setting of the #VSD command as an ASCII
decimal value in result code format.

</dd><dt>#VSD=? </dt><dd>Returns the message, "1".

</dd><dt>#VSD=0 </dt><dd>Turns off the silence deletion.

</dd><dt>#VSD=1 </dt><dd>Turns on the silence deletion if the silence sensitivity
setting #VSS is nonzero. The aggressiveness of the silence
deletion is controlled by #VSS.
</dd></dl>

<h5>#VSK - Buffer Skid Setting</h5>

This command queries and sets the number of bytes of spare space, after
the XOFF threshold is reached, in the modem's buffer
during Voice Transmit Mode. This equates to the "skid" spare buffer space,
or the amount of data the DTE can continue to send
after being told to stop sending data by the modem, before the modem voice
transmit buffer overflows.<p>

Parameter: n = 255  (Number of bytes of "skid spare buffer space)</p><p>

Default: 255</p><p>

Result Code:
</p><dl><dt>OK </dt><dd>If n = 255.

</dd><dt>ERROR </dt><dd>Otherwise.
</dd></dl>

Command options:
<dl><dt>#VSK? </dt><dd>Returns the current setting of the #VSK command as an ASCII
decimal value in result code format.

</dd><dt>#VSK=? </dt><dd>Returns the message, "255".

</dd><dt>#VSK=n </dt><dd>n defines the 255 unused bytes remaining in the modem voice
transmit buffer after an XOFF is sent to the DTE.
</dd></dl>

<h5>#VSP - Silence Detection Period (Voice Receive)</h5>

This command sets the Voice Receive Mode silence detection period
(inactivity timer) value. The parameter, in units of 100
ms, can be used when receiving voice data. This is an amount of time,
which if elapsed without receiving any ADPCM data, causes
the modem to send the &lt;DLE&gt;s or &lt;DLE&gt;q codes after insuring
that the buffer is empty. There are two cases:
<ol>
<li>With the modem's silence deletion feature enabled, the #VSP setting is
in effect an inactivity timer. The modem must reset
this timer on every byte of voice data received.

</li><li>With the modem's silence deletion feature disabled, the modem determines
 what constitutes silence. This involves monitoring
and debouncing the modem value for average energy. If this debounced value
is less than an arbitrary threshold constituting
the modem's definition of silence for a period greater than that defined by
 the #VSP setting, the modem sends the &lt;DLE&gt;q or
&lt;DLE&gt;s shielded code to the DTE.
</li></ol>

Parameters: n = 0 - 255 (0 - 25.5 seconds)<p>

Default: 55</p><p>

Result Code:
</p><dl><dt>OK </dt><dd>If n = 0 - 255.

</dd><dt>ERROR </dt><dd>Otherwise.
</dd></dl>

Command options:
<dl><dt>#VSP? </dt><dd>Returns the current setting of the #VSP command as an ASCII
decimal value in result code format.