REGULUS - The regserver Utility

What is the regserver?

The regserver (Regulus Server) utility is a runtime component that connects to a Nuance^TM recognition server, and performs recognition and playback.

The utility listens on a socket for incoming requests, and forwards the requested operation to the nuance platform.

How to run the regserver

The regserver takes as input a mandatory argument which points to a compiled recognition package (-package), and optionally

the port where it will listen to for a connection (-p <port>)
an optional log file (-f <log file>)
a switch that controls how verbose the output will be (-v)

Here's how the console output looks like when the utility is invoked without any arguments:

Usage: ${REGULUS}/RegulusSpeechServer/runtime/regserver.exe \
        -package  \
        [nuance parameters] \
        [-port ] \
        [-v] \
        [-f ]

A convenient way to run a regserver process is to use the REGULUS Java API.
Here's an example on how to use it:

	// run the regserver process and open a connection to it
	RegClient regClient = new RegClient("localhost", "2555", "audio.OutputVolume=200", "path/to/regserver.exe -v -f /path/to/logfile.txt", 2000);

	// start a recognition action, and wait for it's completion
	RegResult result = regClient.recognize(".MAIN");

	// print the result
	if( result.isActionSuccesfull() ){
		System.out.println("Recognition result: '" + result.getRecognition() + "'");
	}

	// shutdown connection to regserver, and exit regserver process
	regClient.shutdown();

Do I need to use the regserver utility?

No, you can interface to the recognition engine yourself:
REGULUS is a utility that compiles unification grammars. Once you've compiled your grammar you don't need any additionl REGULUS runtime component.
Regserver and the Java API are provided to help develop applications faster.