Nuance Citrix Client Audio Extension for Linux

This product configures audio redirection on a Linux thin client in a Citrix environment, to provide optimal support for speech recognition.

Please report your feedback to support.speechmagic@nuance.com.

Contents

Thin clients supported

Audio devices supported

Audio formats

Installation:

Installing on a Futro thin client

Installing on an IGEL thin client (firmware version 5.08.100 or higher)

Installing on an IGEL thin client (firmware versions lower than 5.08.100)

Upgrading IGEL firmware from version 5.07.100 or lower to 5.08.100 or higher

Logging

Philips SpeechMike

Internal sound card

Thin clients supported

The following thin clients are supported:

Important: Due to changes in the firmware versions by the manufacturer we do not guarantee that our drivers will work with other firmware versions than the ones tested by us.

Back to top

Audio devices supported

Device Sound card ID Sound card name Comments
Philips SpeechMike III III SpeechMike III 64-bit and 32-bit clients
Philips SpeechMike Premium III SpeechMike III 64-bit and 32-bit clients
Grundig Digta SonicMic II II Digta Sonic Mic II 32-bit clients
Grundig Digta SonicMic II (US edition) US Digta SonicMic II US 32-bit clients
Grundig Digta SonicMic 3 D3 Digta SonicMic 3

32-bit clients

Button controls are not supported with the firmware available at the release of Capture Services (Desktop) 5.0

For the selection of audio devices, the following priority conditions apply:

Back to top

Audio formats

The following audio formats are supported:

Back to top

Installation

Installing on a Futro thin client

Update the client firmware with the Nuance Citrix Client Audio Extension for Linux package in the Audio redirection\Citrix\Client\Client Linux folder of the Nuance virtual extensions package.

Proceed as follows:

  1. Start the UniCon Elias program (double-click the image, .idf, file in Scout Enterprise).
  2. Remove any older versions of the Nuance Citrix Client Audio Extension for Linux.
  3. Add the new Nuance Citrix Client Audio Extension for Linux package, save and export the image.
  4. Update the firmware (in Scout Enterprise or start the Firmware Update on the Client).

Installing on an IGEL thin client (firmware version 5.08.100 or higher)

In version 5.08.100 and higher, the Nuance Citrix Client Audio Extension is delivered with the IGEL firmware. To activate the extension, do the following:

  1. Start the IGEL setup utility.
  2. In the Sessions tab, browse for:

    Citrix XenDesktop / XenApp, HDX / ICA Global, Mapping, Device Support

  3. Enable Nuance Channel for Dictation.

Installing on an IGEL thin client (firmware versions lower than 5.08.100)

  1. Start the IGEL setup utility.
  2. Enable the Nuance Citrix Client Audio Extension for Linux in the IGEL Registry.
  3. Install IGEL via a custom partition.

To create a custom partition on the IGEL thin client, do the following:

  1. Open the Application Launcher and browse for:

    System, Firmware Customization, Custom Partition, Partition

  2. Select Enable Partition.
  3. Enter 10M for the size of the partition.
  4. Enter /custom_nuance for the mount point. If this folder does not exist, it will be created.
  5. Click OK to exit the dialog box. The custom partition is created and mounted.

To set up the Nuance IGEL package on the custom partition, do the following:

  1. Copy the Nuance_CEL_Archiv.tar.bz2 and Nuance_CEL_Igel.inf files from the Audio redirection\Citrix\Client\Client Linux folder of the Nuance virtual extensions package to a network location accessible from the IGEL thin client.
  2. On the IGEL thin client, open the Application Launcher and browse for:

    System, Firmware Customization, Custom Partition, Download

  3. Select Add or edit an entry.
  4. Enable Automatic Update.
  5. In the URL field, enter the network location of Nuance_CEL_Igel.inf. For example:

    http://Your.Server:portnumber/dir1/Nuance_CEL_Igel.inf

    or

    file:///mnt/MOUNTDIR/dir1/Nuance_CEL_Igel.inf

  6. Enter a Username and Password for access to the network location.
  7. In Initializing Action, enter the following: /custom_nuance/Nuance_CEL_Files/Nuance_CEL_Init_Igel.sh.
  8. Click OK to close the dialog box.
  9. Restart the IGEL thin client. The Nuance archive is downloaded and installed on the custom partition.

Upgrading IGEL firmware from version 5.07.100 or lower to 5.08.100 or higher

In version 5.08.100 and higher, the Nuance Citrix Client Audio Extension is delivered with the IGEL firmware. If you have already installed the extension via a custom partition, disable the partition before you upgrade the firmware to 5.08.100 or higher. To disable the custom partition, do the following:

  1. Open the Application Launcher and browse for:

    System, Firmware Customization, Custom Partition, Partition

  2. Clear the Enable Partition check box.
  3. Click OK to close the dialog box.
  4. Restart the IGEL thin client.

Back to top

Logging

To enable logging, do the following:

  1. Make sure that log4crc is available in the $HOME directory of the user who starts the client and rename it to .log4crc. For example:

    IGEL: cp/usr/lib/ICAClient/log4crc/userhome/.log4crc

    Futro: cp/usr/lib/ICAClient/log4crc/home/elux/.log4crc

  2. Open .log4crc; if the file is read-only change it to read/write (you must have rights to change the file).

    If the file has an attribute which prevents you from changing the file, remove it. You can check this with lsattr -a "dir path" to see all file attributes. If the file has the a or i attribute you can remove it with chattr -a "file name" or chattr -i "file name".

  3. Set the priority to "trace" (for detailed logging) or "error" (for error logging only) and change the line which begins with category name = to:

    Audio extension: nuance.smac.citrix.sbext

    Mixer: nuance.smac.citrix.mixer

    Note: If you do not want logging, comment out these lines or remove the .log4crc file completely.

Remarks

Back to top

Philips SpeechMike

Button redirection

For Philips SpeechMike and Foot Control devices contact Philips Speech Processing Solutions. The Nuance Citrix Audio Extension does not provide support for SpeechMike button redirection.

SpeechMike (USB) audio

To use the Philips SpeechMike if it is not the default audio device, set the environment variable NUANCE_USED_SOUNDCARDNUMBER to the sound card number of the SpeechMike. If the environment variable does not exist or is invalid, the default sound card will be used.

Back to top

Internal sound card

Recording with the internal sound card is not supported.

Using the internal sound card in parallel with a USB audio device is currently not possible because it is not possible to set the internal sound card as the default sound card when a USB default audio device is plugged in (except the Futro S400 where it is set as the default).

Back to top

Use of this software is subject to the terms and conditions of the License Agreement.

© %COPYRIGHT_YEAR% Nuance Communications, Inc. All rights reserved. Reproduction in whole or in part is prohibited without the written consent of the copyright owner.