voice-cmds.html

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

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

</dd><dt>#VSP=0 </dt><dd>Turns off the silence period detection timer.

</dd><dt>#VSP=n </dt><dd>Where n defines the period without received voice data
in 100 ms units.
</dd></dl>

<h5>#VSR - Sampling Rate Selection</h5>

This parameter, along with the bits per sample (#VBS) command, determines
the necessary DTE interface speed to transmit and
receive in the Voice Mode.<p>

Parameter: n = 7200  (7200 Hz sampling rate)</p><p>

Default: 7200</p><p>

Result Codes:
</p><dl><dt>OK </dt><dd>If n = 7200.

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

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

</dd><dt>#VSR=? </dt><dd>Returns the message, "7200".

</dd><dt>#VSR=7200 </dt><dd>Default.
</dd></dl>

<h5>#VSS - Silence Detection Tuner (Voice Receive)</h5>

This command enables or disables the Voice Receive mode silence detection,
and controls the sensitivity employed by the modem
in compressing periods of silence.<p>

Parameters: n = 0 - 3</p><p>

Default: 2</p><p>

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

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

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

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

</dd><dt>#VSS=0 </dt><dd>Disables silence detection by the modem when
in Voice Receive Mode.

</dd><dt>#VSS=1 </dt><dd>Least sensitive setting. When this command is received
by the modem, the system is configured to a state which is least
likely to detect and compress periods of silence, but still able
to do so if the line is really quiet.

</dd><dt>#VSS=2 </dt><dd>Midrange setting (default).
When this command is received by the modem, the system is configured
to a state which is likely to be the best overall compromise
on normal telephone lines.

</dd><dt>#VSS=3 </dt><dd>Most sensitive setting. When this command is received
by the modem, the system is configured to a state which is most
likely to detect and compress periods of silence.
</dd></dl>

<h5>#VTD - DTMF Tone Reporting</h5>

This command queries and controls which types of tones can be detected and
reported to the DTE via shielded codes in Voice
Transmit, Voice Receive, and Online Voice Command Modes.<p>

Parameters: i,j,k (three ASCII hexadecimal bit maps)</p><p>

Default: 3F,3F,3F</p><p>

Result Codes:
</p><dl><dt>OK </dt><dd>If bits supported with #VTD=? are selected.

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

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

</dd><dt>#VTD=? </dt><dd>Returns the tone reporting capabilities of the modem.

</dd><dt>#VTD=i,j,k </dt><dd>Where i,j,k corresponds (in ASCII hexadecimal)
to the desired capabilities, as shown in Table 8-6, for Voice Transmit,
Voice Receive, and Online Voice Command Modes, respectively.
</dd></dl>

<table border="1">
<caption>Table 8-6.  #VTD Tone Detection/Reporting Bit Settings</caption>

<tbody><tr><th>Bit
 </th><th>Description

</th></tr><tr><td> 0
    </td><td>0 = Disable DTMF tone capability;<br>
        1 = Enable DTMF tone capability 1.

</td></tr><tr><td> 1
    </td><td>0 = Disable V.25 1300 Hz Calling tone capability;<br>
        1 = Enable V.25 1300 Hz Calling tone capability 1.

</td></tr><tr><td> 2
    </td><td>0 = Disable T.30 1100 Hz Facsimile Calling tone capability;<br>
        1 = Enable T.30 1100 Hz Facsimile Calling tone capability 1.

</td></tr><tr><td> 3
    </td><td>0 = Disable V.25/T.30 2100 Hz Answer tone capability;<br>
        1 = Enable V.25/T.30 2100 Hz Answer tone capability 1.

</td></tr><tr><td> 4
    </td><td>0 = Disable Bell 2225 Hz Answer tone capability;<br>
        1 = Enable Bell 2225 Hz Answer tone capability 1.

</td></tr><tr><td> 5
    </td><td>0 = Disable call progress tone and cadence
	    (e.g., busy and dial tone) capability;<br>
        1 = Enable call progress tone and cadence
	    (e.g., busy and dial tone) capability 1.

</td></tr><tr><td> 6-7
    </td><td>Reserved.

</td></tr><tr><td>Notes:
    </td><td>1. The modem detects this tone/cadence, and reports it
	via a shielded code to the DTE.
</td></tr></tbody></table>

<h5>#VTS - Generate Tone Signals (Online Voice Command)</h5>

This action command can be issued to play one of more DTMF or other tones
(such as a "beep") if and only if the modem is in
the Online Voice Command Mode. The modem parses and plays the tones defined
 in the parameter in the order listed, and no key
abort is accepted. The parameter can have three types of elements separated
 by commas:
<dl><dt>Dual or Single Tones:
</dt><dd>These are represented by a substring enclosed in square brackets
("[ ]") within the parameter. Each such
substring consists of three sub-elements corresponding to 2 frequencies in
Hz (0, or 200-3000) and a duration (ASCII decimal
in units of 100 ms).

</dd><dt>Varying DTMF Digits: 
</dt><dd>This is represented by a substring enclosed in curly braces
("{ }") within the parameter. Each such substring
consists of two sub-elements corresponding to a DTMF digits (0-9,A-D,*,#),
and alternate durations in units of 100 ms.
</dd></dl>

Parameters: The tone generation consists of elements in a list with each
element separated by commas.<p>

Result Codes:
</p><dl><dt>OK </dt><dd>Command to play tones on currently selected device is accepted.

</dd><dt>ERROR </dt><dd>Command was not issued during Online Voice Command Mode
or string is grammatically incorrect.
</dd></dl>

<h5>#VTX - Voice Transmit</h5>

This action command can be issued if and only if the modem is in the Online
 Voice Command Mode (indicated previously with the
VCON message), and is the switch to Voice Transmit Mode. #VTX is used when
a voice file is to be transmitted to the line, speaker,
or handset. The #VLS command should have been previously issued to select
the output source.<p>

Parameters: None</p><p>

Result Codes:
</p><dl><dt>CONNECT </dt><dd>When voice transmission by DTE can begin.

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

<h3>8.4. S-REGISTERS</h3>

The following S-register is global, meaning that it can be set in any
appropriate mode (i.e., any #CLS setting).

<h4>S30 - Deadman (Inactivity) Timer</h4>

Range: n = 0 - 255<p>

Default: 0 (OFF, which means DTE should usually set it to some value
for Voice)</p><p>

Command options:
</p><dl><dt>S30=0 </dt><dd>Deadman timer off. No matter how long it might continue,
the modem never spontaneously hangs up the telephone line or
switches to autobaud mode as a result of inactivity.

</dd><dt>S30=1 to 255 </dt><dd>This is the period of time (in seconds),
which if expired causes the modem to hang up the telephone line if it
is off-hook and no data has passed during the period. The timer is also
active whenever the #BDR setting is non-zero. In order
to avoid a state where speed sense is disabled (even though the PC can
crash, come back up, and try to issue commands at what
should be a supported speed), the inactivity time-out occurs if there is
no data passed on the DTE interface within the S30
period, even if the modem is on-hook. DTE software must not select
a nonzero setting for #BDR until it is ready to establish
a telephone call or virtual connection to a speaker or microphone.
When there is an inactivity time out with #CLS=3D8, the modem
always forces #CLS=0 and #BDR=0.
</dd></dl>

<h3>8.5. RESULT CODES FOR VOICE OPERATION</h3>

<dl><dt>VCON </dt><dd>VCON is sent when the modem is configured for voice (#CLS=8),
or when after answering or originating a call, the modem
enters the Online Voice Command Mode for the first time. Typically, this is
 immediately after an off-hook in answer mode, and
after ringback ceases in originate mode. VCON is also sent when the DTE
requests a switch from Voice Transmit Mode to Online
Voice Command Mode by issuing a &lt;DLE&gt;&lt;ETX&gt; to the modem,
or when the DTE requests a switch from Voice Receive Mode to Online
Voice Command Mode via the key abort.

</dd><dt>CONNECT </dt><dd>CONNECT is sent when switching from the Online Voice
Command Mode to either Voice Receive Mode via the #VRX command,
or to Voice Transmit Mode via the #VTX command. This message is sent to the
 DTE to inform it that it may begin receiving or sending ADPCM data.
</dd></dl>

<h3>8.6. EXAMPLES OF VOICE OPERATION</h3>

See Tables 8-7 through 8-13.


<table border="1">
<caption>Table 8-7.  Record a Greeting Message</caption>

<tbody><tr><th>DTE to Modem
 </th><th>Modem to DTE
 </th><th>Description and Interpretation

</th></tr><tr><td> #CLS=8
 </td><td>-
 </td><td>Configure the modem for Voice Mode.


</td></tr><tr><td>-
 </td><td> OK
 </td><td>The modem confirms command implemented, and is now set up for voice.

</td></tr><tr><td> #VBS=4
 </td><td>-
 </td><td>The DTE asks for 4-bit compression. The DTE needs to work at 38,400 bps
     since after start and stop bits are added, the speed
     increases to 36,000 bps.

</td></tr><tr><td>-
 </td><td> OK
 </td><td>The modem is configured for 4-bit compression.

</td></tr><tr><td> S30=60
 </td><td>-
 </td><td>DTE wants to insure that the modem can recover even if DTE dies
     with the baud rate set to a speed which cannot be speed sensed.

</td></tr><tr><td>-
 </td><td>OK
 </td><td>Modem now has deadman timer set to 1 minute. If no activity takes place
     after a connection, or no DTE activity takes place
     after #BDR is changed, the modem reverts to #CLS=0, #BDR=0.

</td></tr><tr><td> #BDR=16
 </td><td>-
 </td><td>The DTE knows that compression requires a 38,400 bps speed,
     so it forces this as the new speed. (For this example, lets say
     that the DTE was sending all commands, including this one, at 2400 bps.)

</td></tr><tr><td>-
 </td><td>OK
 </td><td>This OK message is sent at 2400 bps, but the modem then switches
     to 38,400 bps. All subsequent commands are assumed to be
     sent at 38,400 bps.
     If the DTE does not switch to 38,400 bps after the
     OK&lt;CR&gt;&lt;LF&gt;, it will not recognize the data stream coming
     from the modem. The S30 timer is now active.

</td></tr><tr><td> #VSP=20
 </td><td>-
 </td><td>The DTE changes its own speed to 38,400 bps and sends this command
     to set up the silence detection period for 2 seconds.

</td></tr><tr><td>-
 </td><td>OK
 </td><td>The modem agrees. When receiving voice data, 2 seconds of silence
     terminates the Receive Mode. For handset operation, this
     amounts to a hang up.

</td></tr><tr><td> #VSD=1
 </td><td>-
 </td><td>This enables silence deletion.

</td></tr><tr><td>-
 </td><td>OK
 </td><td>The modem confirms command reception.

</td></tr><tr><td> #VSS=1
 </td><td>-
 </td><td>The DTE has decided to use level "1" silence detection sensitivity,
     meaning it is making it somewhat more difficult to delete
     and compress silence for the modem, but expects that when the user
     has hung up the handset, the silence is indeed detected.
     The DTE has tried to improve the quality of the message because
     it knows this is a handset operation. Also, since silence deletion
     has been enabled, the #VSP setting for silence detection now becomes
     basically an inactivity timer. If silence deletion is
     turned off here instead of enabled, the #VSP timer is based
     upon average energy readings from the modem.

</td></tr><tr><td>-
 </td><td>OK
 </td><td>The modem confirms command reception.

</td></tr><tr><td> #VLS=?
 </td><td>-
 </td><td>Find out what type of devices are supported by the product.

</td></tr><tr><td>-
 </td><td>0,1,2,3,4<br>
     OK
 </td><td>The modem tells the DTE that is has a telephone line with handset
     (#VLS=0), an input/output d