Rss Categories

Deprecated - client_property.conf

Reference Number: AA-01539 Views: 8614 0 Rating/ Voters

Deprecated Content

This page refers to outdated, obsolete, or deprecated products or software. This is provided for historical reference for users of older releases. Please see our current documentation about client_property.conf.

This file controls settings related to the speech client. This configuration file controls the bulkof functionality for speech recognition options.

It is located by default in /etc/lumenvox/.

See ConfigurationFiles for more information about otherconfiguration files.

The following parameters can be set. The format to use within the configuration file is PROPERTY_NAME= VALUE


Description: This property sets which Speech Engine servers are used for processingdecodes. 

Possible Values: A list ofIP addressesand optional ports separated by semicolons. For instance,; specifies a serverat using the default port of 5730, and a server at using the port 5721.

Default Value: 


Description: The license type to use when opening a port.

Possible Values: VoxLite, SpeechPort, or Auto.If the value is set to VoxLite,
the client will get the license from the Lite license pool (these licenses only allow up to 500
vocabulary items per recognition). If the value is set to SpeechPort, the client
will get the license from the Full license pool. By default, the client will auto-pick the license;
it will use up Full licenses before using Lite licenses.

Default Value: Auto


Description: The machine name hosting your license server(s) .

Possible Values:IP addresses separatedby semicolons.

Default Value: 


Description: The port number to use when contacting the license server.

Possible Values: A port number. If you have multiple IPaddresses specified for LIC_SERVER_HOSTNAME, the PORTNUM values should also be separated by semicolons.

Default Value: 7569 


Description: Specifies the maximum number of n-best results to be returned by theEngine.

Possible Values: Number of n-best results.

Default Value:


Description: Specifies the priority for the decode thread on the server. Higher prioritythreads will be processed before other applications on the same machine. Adjusting this parameteris useful for troubleshooting load issues on a machine.

Possible Values: 0 - 2
0 = Low Priority
1 = Normal Priority
2 = HighPriority

Default Value: 1


Description: In a non-blocking decode, this is the timeout value, in milliseconds,used by LV_SRE_WaitForDecode and LVSpeechPort::WaitForDecode functions. In blocking decode, this isthe time to wait until the decode times out and returns an error from LV_SRE_Decode and LVSpeechPort::Decode.

Possible Values: Time in milliseconds.

Default Value: 20000


Description: Specifies how long, in milliseconds, the client should wait for a grammarto load. If the timeout is reached before the grammar is loaded, the LoadGrammar function returnserror code -37, LV_LOAD_GRAMMAR_TIMEOUT.

Possible Values: Time in milliseconds.

Default Value: 200000


Description: Controls whether LumenVox will strictly implement the final SISR 1.0standard for adding tags to grammars. Unless this value is changed, LumenVox normally runs ina backwards compatibility mode, using an older draft of SISR unless the grammar's tag-formatis declared as semantics/1.0.2006. If strict compliance is enabled, then LumenVox will treata tag-format declaration of semantics/1.0 using the newer standard. 

Possible Values: 0 (disabled) or 1 (enabled)

Default Value:


Description: Controls how aggressively the Engine trims leading silence in incoming audio. 

Possible Values: A number ranging from 0 (very aggressive)to 1000 (not aggressive).

Default Value: 970 


Description: Controls whether the application will save off .callsre files used withthe LumenVox Speech Tuner. Turn this on to capture audio and more information related to eachdecode. These files will be saved by default to /var/lumenvox/responses/.See additional info here

Possible Values: 0 - 3
0 = NONE
3 = ALL

Default Value:


Description: Sets whether the Engine should prioritize speed or accuracy while performinga decode. By default (with a avalue of 0), it will switch between modes depending on how much load is happening onthe server machine; when the server becomes too busy it will begin optimizing speed over accuracy.The other two values force Speed over Accuracy, or vice versa.

Possible Values: 0 - 2
0 = Auto
1 = Speed
2 = Accuracy

Default Value:


Description: Specifies the Noise Reduction Model to be used by the Engine. These strip out background noise in audio being processed by the Engine.For most usersthe default noise reduction algorithm should work best. For certain noise coditions the Alternate noise reduction algorithm has shown better results. Hence, advanced users can try switching the algorithm to see if it improvestheir performance in noisy conditions. The Adaptive noise reductionalgorithm works best only when the noise is constantly changing such as car or highway noise. For more stationary noises like fan noise, the defaultalgorithm will show the best performance.

Possible Values: 0 - 3
0 = No Noise Reduction
1 = Default
2 = Alternate
3 = Adaptive

Default Value: 1

NOTE: The following two parameters are left out of the configuration file by default. They may be added in and used, but in most cases should not be touched.


Description: This is only used when you are using concept/phrasegrammars and a language other than English. Using SRGS grammars, this value does nothing.

Possible Values: A string specifying the language name.

Default Value: (null)


Description: Changes the size of the speech search beam.

Possible Values: A number between 0 and 1.

Default Value: 1e-6


If you wish to use License Authentication, you must add a new section to the client_property.conf file called [AUTHENTICATION] that appears at the bottom of the file.

This section must have two (and only two) key/value pairs:


Description: The username to be used by the client when requesting licenses from a License Server (there should be a corresponding entry in the license_authentication.conf file on the server side.

Possible Values: A string specifying the username.

Default Value: (null)


Description: The passwod to be used by the client when requesting licenses from a License Server (there should be a corresponding entry in the license_authentication.conf file on the server side.

Possible Values: A string specifying the password.

Default Value: (null)

As an example, if your username is Alice and your password is alicespassword then you should have an [AUTHENTICATION] section that looks like: