Global Tuning Tool User Guide

The Global Tuning Tool (GTT) is a software tool developed by Harman International, a leading audio and electronics company. The tool is designed to help audio engineers to create audio post-processing pipelines and tune audio the systems to get the best audio performance.

This is a windows-based tool that is part of the Harman AudioworX product suite. The Global Tuning Tool includes a comprehensive set of core audio functions, a powerful signal flow designer, tuning tool, and the framework for processing the entire audio signal path, enabling easy integration of both HARMAN and 3^rd party technologies.

Key Features of Global Tuning Tool

• Real-Time Analysis: The software provides real-time analysis of audio system performance, allowing engineers to quickly tune the system as per requirement.
• System Optimization: The Global Tuning Tool uses advanced algorithms to optimize the audio system performance, based on the specific acoustics of the venue and the desired sound quality.
• Intuitive User Interface: The Global Tuning Tool features an intuitive user interface, with easy-to-use tools and visualizations, making it easier for engineers to make adjustments and optimize the sound system performance.
• Preset Management: The software includes a library of preset configurations for different types of venues and events, making it easier for engineers to get started and save time during the tuning process.
• Signal Flow Designer: The software allows users to drag and drop audio processing modules such as volume, limiter, filters, and mixers onto a virtual canvas, and then connect the input/output pins of modules to create a signal flow diagram. The signal flow diagram provides a visual representation of the path that an audio signal takes through a system, including where it is processed, amplified, and mixed with other signals.

Your computer must meet the minimum technical specifications outlined below to run and use Global Tuning Tool.

Table 1: Global Tuning Tool System Requirements

Component	Minimum Requirement	Recommended Requirement
Processor	Intel® Core – i3 processor (4.3GHz)	Intel® Core -i5 processor (1.7GHz or above)
Operating System	Windows 10 (64-bit support)
Memory	4 GB RAM	8 GB RAM or above
Hard disk	20 GB of available hard-disk space; additional space is required for installation	50 GB or above
Display Resolution	800 x 600 display	1920 x 1080 display
Graphics	Driver Version – Supported Intel, GPU version greater than 30.0.100.x. 1.5 GB of GPU memory	Driver Version – Supported Intel, GPU version greater than 31.0.101.3959. 4 GB of GPU memory for 4k displays and greater
Browser	The current version of Microsoft Edge, Internet Explorer, Chrome, or Firefox. Internet connection is necessary for GTT registration, license activation, membership validation, and access to online services.

Currently, the Global Tuning Tool is not supported on macOS systems.

The below figure explains the workflow of the Global Tuning Tool.

The GTT workspace consists of several tabs, including the Home screen, Device Designer, Panel Designer, and Parameter Sets. Additionally, there are specialized tabs for tasks such as IR Measurements, IVP RTA, Central Viewer, Auto EQ, and AI Module. This guide focuses on providing information about the Home screen, Device Designer, Panel Designer, and Parameter Sets tabs.

The Global Tuning Tool Home screen allows you to perform various operations like creating, importing projects, opening pre-configured templates, and launching default features.

When you launch GTT, the home screen appears, which includes the following tabs:

• Projects
• Audio Library Manager
• Features
• Sample Project

Also, Global Tuning Tool Home screen contains various options like export/import, renew license, configuring GTT settings, refer to Home Screen Options.

Projects

On the Project tab, you can create new projects, edit existing projects, import and delete projects.

On the Project tab, you can perform the following operations:

Create Project	Use this option to create a new project. Once you click on the Create Project option, a Create Project window will be displayed. You can choose Empty Template or One Core Template option to create a project. Project name will be automatically filled when selecting any template, you can manually change the project name by editing the default project name. By default, empty projects do not contain a description, you have to enter the details manually. Empty Template: Select the Empty Template, enter the project name and project description, and click Create. This creates a new project. Now you can add a device or discover a device to the project. One Core Template: Select the One Core Template, edit the project name and description as per requirement, and click Create. A new project is created with pre-configured template settings.
Import Project	Use this option to import existing GTT project. Click on Import Project and navigate to the folder, select the existing project, and click Open. This imports the GTT project on the project tab. If there is a version mismatch between the current audio library version and version saved in each device, of the imported file, then a warning message will be popped up. Import Project with Measurement sessions When a Project is imported and an associated Measurement Raw data file ({projectname}.mmdata exists, then the Measurement sessions will also be imported along with the project. To avoid Measurement sessions from importing, don’t keep associated raw data {projectname}.mmdata file in the same directory as the project.
Delete Projects	Use this option to delete a project. You can delete multiple projects as well as single project. Select the checkbox and click Delete. This will delete all the available projects from GTT. Select the required checkbox present in each row of the project and click Delete. This will delete the specific projects from the project list. Use this delete option to delete the respective project.
Edit Project	Use this option to edit project name and description. On the Project tab, navigate to the respective project, and click the Edit option. Modify the name and description as required and click Update.

Audio Library Manager

The GTT interacts with the audio library service, which is a Windows service. This service hosts the C++ dynamic linked library xAFVirtualAmp.dll. This DLL exposes a number of methods that GTT calls from the managed environment, in order to determine what audio algorithms and memory layouts are available in the DLL.

Every audio library has a version, and GTT stores this information alongside the data received from the xAF service.

GTT requires an audio library to perform operations required for tuning amplifiers. It obtains audio objects, their properties, memory layout, and so on from the audio library. This library is hosted in a Windows service and communicates with it via IPC. The Windows service is called Harman audio library. The block diagram below shows high-level communication between GTT and an audio library service.

Column	Description
Default	This column shows which DLL has been set as the default.
Audio Library Version	This column displays the version of the DLL.
Audio Library Name	This column displays Audio Library file name (DLL name).
Description	This column displays description of the DLL . By default description will be taken from file description property of the DLL  meta data.
Audio Library Path (DLL Path)	This column displays the source path of the DLL.

You can perform the following actions on the Audio Library Manager tab.

• Select the checkbox in the default column to set the audio library as default.
• Click on edit icon to edit the audio library description.
• Click on the Delete option to delete the audio library.

Load Audio Library

On the Audio Library Manager tab, click on Load Audio Library icon. You can load multiple xAF libraries.

If the same xAF library version is already present in GTT, a prompt will appear before overwriting the DLL.

When a new audio library is loaded, it will not set to default automatically; instead, you need to select the checkbox to make it default.

After extending support for multiple libraries, each version of xAF libraries will be separately stored for simultaneous use in GTT. Prior to this, existing xAF dlls were overwritten when another DLL file was loaded, and GTT could only work with one xAF dll version at a time.

Set Default Audio Library

Installed audio library will be set to default when first time launch of the GTT application. User can change the default audio library by checking the checkbox in Default column and the same will be updated and notified to the user.

The default audio library version set from this screen would be used for basic GTT operations – Add Device/ Discover Device/Project import (if last saved audio library is not loaded in GTT).

• Set the default audio library version by selecting the checkbox.
• Only one audio library version can be set as default.
• Settings shall be saved once check the selected audio library.

On GTT installation, the latest audio library will be loaded automatically and set as default.

Edit Audio Library Description

You can modify the description of audio library DLL by clicking on Edit Description option. After changing the description, click on Update to save the changes.

By default, Description is taken from the file description of DLL meta data until the user manually updates it by clicking the Edit icon.

Delete Audio Library

Click on Delete icon to delete an audio library.

To delete the Audio Library, you should run GTT with the “run as administrator” option.

Audio libraries can be deleted only when associated device and compound audio objects are deleted.

Audio library which is set as default cannot be deleted.

Any unsaved settings should be saved before audio library delete.

Feature

The Feature tab allows you to directly access the MM-IR (Measurement Module for synchronous and asynchronous impulse response measurement, and recording) and MM-RTA (Measurement Module for Real Time Analyzer) features without having to go through the entire process of creating a regular GTT project.

If a project is in the open state and you double-click on the MM-IR or MM-RTA features, a feature window will open, and the relevant data will be updated and stored in the project.

If you double-click on the MM-IR or MM-RTA features from the home screen, a dummy project will be created in the background and you will be directed to the feature window. However, it is not possible to export the dummy project

MM-IR

The MM-IR defines the Measurement Module for synchronous and asynchronous impulse response measurement, and recording. A device is not necessary for the Measurement Module to function in the project. The Measurement Module enables direct sound card measurements without an intermediate device, whereas tests controlled by gain channels can be carried out via a device.

To open the Measurement Module dashboard, double-click on MM-IR.

For more information, refer to GTT Measurement Module 2.0 User Guide.

MM-RTA

The MM-RTA defines the Measurement Module for multi-channel Real-Time analyzers for audio signals.

It provides time and frequency domain analysis tools for measuring RMS/peak levels, frequencies, THD, delays, magnitude, and phase responses. In addition, a built-in signal generator provides sine tones, sweeps, pulses, and various noise signals. Analyzing recorded signals is possible with a file player.

To open the Measurement Module dashboard, double-click on MM-RTA.

For more information, refer to the Real Time Analyzer User Guide.

Sample Projects

The Sample Projects tab allows you to get access to the example project. This will help you to understand how various audio objects are configured in the Signal Flow Designer.

Double-click on the example project, this will create a copy of the example project. You can modify the newly created example project. Similarly, you can create any number of copies of an example project.

More Options

On the right side of the GTT home screen, you will find an ellipsis menu that contains additional options.

Additionally, there is the “Current Project” option, which allows you easy navigation to the existing project window. You must have a project open in order to use the ” Current Project” option; otherwise, the feature will be inactive.

• About Global Tuning Tool: Displays software version of Global Tuning Tool, release type, and license status.
  
• Thumbnail View: To display all items on the home page in thumbnails. The Thumbnail option is only available in Feature and Sample Projects tab.
  
• List View: To display all items on the home page in the list.
  
• AudioworX Documentation:  To open the AudioworX documentation page.
• Know your GTT license status: Displays GTT license status. Also, you can renew your GTT license.
  

The home screen contains following options:

• Export Project: To export a project, for more details refer to Export Project.
• Import/Export Project Settings: To export and import project settings of RTA, Central Viewer and Measurement Module, or more details refer to Import and Export project settings. 
• Renew License: To renew a global tuning tool license, for more details refer to Renew License.
• Options: To configure global tuning tool settings, for more details refer to Application Options.
• About: To know Global Tuning Tool version, release type, and license status.
• Help: To open AudioworX documentation.

Once you complete the signal flow design you can export the project.

Follow the below steps to export the project:

1. Click on the File menu and select Export Project option.
   
2. In the Export dialog box, choose the desired destination where you would like to save the project file, and then click the Save button.

The project file is stored with file extension *.gttd.

Export Project with Measurement Sessions

When a project is exported, by default the project will be exported with measurement sessions and session associated raw data will be stored in the {projectname}.mmdata file in the same destination folder.
If you want to exclude measurement session data from the project export, make sure to configure the project settings prior to initiating the export process.

Follow the below steps to exclude measurement session from project export:

1. Click on the File menu and select Options.
2. In the Application Options dialog box, click on Project Settings, and uncheck Include Measurement Session in the Project export options.
   
3. Click OK to save the change.

The Export and Import project settings allows you to share project settings of certain components like RTA, Central Viewer, Auto EQ, and Measurement Module etc to other team or to a end user.

Export Settings: Allows you to export RTA, Central Viewer, and Measurement Module settings of a project. The settings will be exported as a *.gttdSettings file.

Import Settings: You can import the previously exported project settings (*.gttdSettings file) after creating a project and wants to replicate the same project environment with the same settings.

During the import process, you can optionally choose to import component-wise settings.

You might see the “Renew GTT license” message on your GTT platform home page or dashboard. This happens due to an upcoming expiration date of the GTT license.
The “Renew license” operation enables you to extend the validity of your GTT license, and you may also request new features as part of the renewal process.

Follow the below steps to renew the GTT license:

1. Click on the File menu and select Renew License.
   

The system will start downloading the latest license. The GTT platform notifies you after a successful license renewal.

The option menu allows you to configure various settings in GTT, such as the general settings, project settings, custom panel grid settings, and event log settings.

General Settings

In the general settings dialogue box, you have the option to customize measurement settings, venue menu settings, explorer settings, and system conversion settings.

Measurement Settings	Measurement Session Raw Data Folder: Specify a desired location where you would like to store the raw data for the measurement session. Predefined Stimulus Signals Folder: Specify a desired location where you would like to store the predefined stimulus signals.
Venu View Settings	– Show Warnings: If enabled, all device alerts will be displayed in the venue.  – Show Incompatible HiQnet App Warning: If enabled, a warning dialog will appear upon startup if another HiQnet application is already running.  – Load Previous File On Startup: If checked the venue file that was last used or saved will be automatically loaded upon startup. If unchecked the venue file needs to be loaded manually (default)
Explorer Settings	If enabled a drop-down arrow appears next to discovered devices in the venue explorer. When the arrow is clicked, the complete device information is displayed.
Address Settings	– Display Addresses in Hex. If checked, the displays device and object addresses in hexadecimal. If unchecked, the displays the device and object addresses in decimal.  – Display Object Addresses as Octals. If checked, the displays the object addresses in three period-separated values. If unchecked, the displays object addresses as a single value.
System Conversions	This option makes all instances of parametric EQ displayed either as bandwidth in Octaves or as bandwidth as Q at the user’s discretion. Switching from one option to the other will be on a global basis for the entire application.
Advanced	– Increase Window Handle Limit to Maximum: This option allows you to set the handle limit to it s maximum value (checking the checkbox), this will increase the maximum number of controls/planes allowed by the operating system. By default, this option is unchecked. If GTT exhausts its handle resources and is unable to launch a panel, it will notify you of the issue and prompt you to close any unused panels in order to free up resources.  – Select wiring controls in real-time when using lasso selecting: When using the lasso to select objects, having this box checked allows the selection of wiring contThis option makes all instances of parametric EQ displayed either as bandwidth in Octaves or as bandwidth as Q at the user’s discretion. Switching from one option to the other will be on a global basis for the entire application.rols.  – Error Reporting: This option enables GTT to send important error information automatically to Harman. On Harman Crash Reporting Disclaimer dialogue box, check the “Send important error information automatically to Harman” option. This feature will send application and computer information to the Harman GTT team in the event of an application crash. Uncheck the checkbox if you do not want any information sent.

Project Settings

Project	In the project settings, you have the option to designate a folder where you would like to store the project file. If you want to exclude Measurement Session data from the project export, uncheck the “Include Measurement Sessions in Project Export” options.
Decimal Separator for Exported files	You can select between a dot or comma to specify the separator of any quantity for the files you export in GTT. Currently this option is only supported for traces exported in .txt and .txtrclist in the RTA module.

Make sure to configure the project settings prior to initiating the export process.

Custom Panel Designer Settings

In GTT, you can modify the settings for the custom control panel design view, such as the grid, snap lines, and control transparency configuration.

However, it is important to note that once you make changes to these settings, you must close any open custom control panel designer and reopen it for the changes to take effect.

Grid Layout

The design grid allows you to arrange controls relative to specific marks on the design view of the Custom Panel. Show Grid: If checked, it will display the design grid. This feature is overridden with the “Snap Lines” feature below. Snap to Grid: If checked, it will snap design objects to the design grid (if selected). Grid Size: It is the distance between grid lines (in pixels); x = horizontal, y = vertical

Advanced

Enable Control Transparency Control transparency gives the controls on Custom Panels transparent backgrounds. While this option makes the control panel designer more attractive, it may slow the computer system performance significantly to process all the graphics. If you are having problems with the graphics building too slowly on the screen, uncheck the box “Enable Control Transparency.” While they will show up as overlapped on the Custom Panel designer, they will show up as transparent on the Custom Panel if the background is transparent (defined in Control Properties).

User Interface Settings

Font Size

Choose the desired font size: Small (12 points): Select this if you prefer a smaller font. This is the default setting. Medium (16 points): This size is suitable for a moderate, more comfortable reading experience. Large (20 points): Choose this if you prefer a larger, more readable font. Currently font size change will impact only in the Central Viewer Browsing and Permanent curve name font sizes.

Windows Setting

– Show all sub windows on top: Check this option to ensure all sub windows are always visible above the main window.

Tuning Data Settings

Retain Tuning Data

By default, tuning data of the Audio object will be lost when the Mode, Additional Parameter, or Number of Elements property changes in the signal flow. To retain tuning data in the above cases, please check the appropriate option based on your needs.

Event Log Settings

Event Log View

Clear Log at Startup: Enabling this option will result in the event log being automatically cleared every time GTT is started up. Maximum number of events in view: Sets the maximum number of events shown in the event log window. View Update Rate: You can configure the update rate to be either instantaneous or delayed. View Archive: Brings up the “Event Log Archive” dialogue box. The Event Log window tab shows events that have occurred on HiQnet devices. The log may be utilized by individual devices to perform certain operations. You can also use the logs for troubleshooting. The Event Log Indicator will notify you in real time as events occur. You can also group information by heading. Click and hold on the heading and drag it to the top just below the log file to the “Group(s)” option. The screen will now display by the heading you selected. To remove the grouping, click and hold on the heading and drag it off the “Group(s)” option. The Event Log Archive is a store of the Event Log from when the application was opened.

Miscellaneous

Disable Logging: Turns off the Event Log. Capture BSS Logfiles: Include the Log Files that have been saved in BSS devices into the Audio. Customize Warnings: This window allows you to set the minimum warning priority level, which warning types you want to receive a warning from and which category you want to receive warnings from.

 

The Device Designer comprises of various tools and interfaces that are used to create and run audio processing systems on hardware. The Device Designer contains the canvas and modules needed to create the signal processing template, while the SFD interface handles most of the target and audio object interactions.

When you launch a project in GTT, the Device Designer screen appears, which includes the following elements:

1. Ribbon and Group: The ribbon is composed of six groups, each of which represents a subset of program functionality. In addition to these programs, there are also additional contextual programs that automatically appear depending on what is currently selected.
2. Devices List: This section displays the list of projects. In addition, you can add and delete a device.
3. Toolbox: This section display core levels of processing, such as block length conversion, merger/splitter, and sample rate conversion within the audio processing pipeline.
4. Device Operations: This section contains several functions related to physical/virtual devices like Load Device Config, Edit Device, Send Device Config, Send Signal Flow, Export SFD, and Control Ids.
5. Properties Panel: A Device Template is a combination of three layers – Physical Layer, Virtual Core, and Core Object. When you select one of the cores, the properties of the core are displayed on the right side. If required you can modify the core properties.
6. Device View: The workspace is used to add devices and program the device core. You can use the magnifier function to adjust and change the size of the design workspace.

The GTT ribbon comprises six groups: Tools, Connection, File, Tuning, Device Panels, and External Endpoints. Each group has specific tools of related functions. It gives you quick access to the tools and functions you need to complete a task.

• Tools: This group includes three tools: Services Monitor, Event Log, and xTP Log. The event log and xTP log in GTT can both be checked and monitored using all these tools.
• Connection: This group includes tools to set up the connection between the physical or virtual device, such as configuring socket connections and port settings. Additionally, it facilitates you to establish the connection once it has been configured.
• Import/Export: This group allows you to import and export device files, tuning data files, device description data files, and corporate pin data.
• Tuning: This group includes Tuning Data and Virtual Tuning. Using Tuning Data, you can open and tune the audio files. Virtual Tuning enables the measurement of impulse responses of an acoustic environment using the AudioworX measurement Module.
• Device Panels: This group includes the following tools: State Variables, Default Control-Ids, Present Controller, Controller, Linking Window, Mips, Memory, Memory Latency, Streaming, and File Controller. Each of these tools is equipped with a unique set of functions.
• External Endpoints: This feature allows external tuning to communicate with the device. The GTT will receive the requests from external tuning tools and send them to the device via GTT. This is made possible by a WCF service endpoint that third-party tools can access.

The Tools group allows you to monitor the all services running on GTT, view the event and xTP logs, and perform the sound card configuration.

• Service Monitor
• Event Log
• xTp Log
• Soundcard Configuration

Global Tuning Tool provides a comprehensive set of tools for monitoring following services:

• SQL Server Service
• Measurement Service
• Harman Audio Library 32
• Harman Audio Library 64
• AI Module

The choice of tool depends on the type of monitoring or tuning to be done and the events to be monitored.

The Event Log window tab shows events that have occurred within Global Tuning Tool and on connected devices. The log may be utilized by individual devices to perform certain operations. You can also use the logs for troubleshooting.

The Event Log Indicator will notify you in real-time as events occur.

Any error on the device is displayed in GTT in the XTP viewer and Event log.

 

The xTP-Viewer has two sections:

• Left side section: Display message flow view and show raw data of several messages.
• Right side section: Detailed view of a selected message on the right side (is empty, if message interpretation is not implemented up to now for the specific message).

The Sound Card Setting  allows you to configure the host API (audio driver), device, sample rate, block length, and the master output for the audio processing. Based on device selection, input and output channels are available for configuration.
Using “Master Output” you can set master and device output modes for speaker configuration in Measurement Module.
The configured sound card configuration is used throughout the RTA and Measurement Acquisition features.

Before you start Measurement wizard or set the “Sound In” and “Sound Out” devices in the RTA, make sure you have configured sound card settings like Host API (Driver Protocol), Device, Sample Rate and Block length of the sound card.

On the “Streams” section list of available channels for input and outputs is displayed .

GTT supports two host API “MME” and “ASIO”.

• MME: This is the standard windows audio driver. It allows operation of multiple audio devices at the same time. Sample rates are handled by the operating system. Can be set to any sample rate. If the sample rate of the physical audio device is different, then OS takes care of the sample rate conversion. This mode is recommended if multiple devices are running at the same time, e.g. measuring with an USB microphone while playing back generator signals with an internal sound card.

 It is recommended to keep the block length at the maximum value of 4096 and the sample rate at 44.1 kHz or 48 kHz.

•  ASIO: This driver is used with multi-channel sound cards. It enables low latencies and ensures that all input and output channels are in sync. Depending on the latency requirements of the audio signal processing provided by a loaded plugin (future feature) the block length can be reduced down to 64 samples. The RTA sample rate setting has to be equal to the audio device driver sample rate.

It is recommended to use an ASIO sound card instead of Windows drivers. When using Windows drivers, it is advised to use a block length greater than 1024 in order to avoid the noise distortion effect, which is a known limitation of the Windows driver (as observed even in audio mulch).

The setting for sample rate does not change the actual setting in the sound card driver. The alignment of the sample rate setting has to be ensured by the user.

Supported sample rate

Supported block length

You must connect the device instance containing the tuning data to the physical/virtual device to send tuning data to the physical device.

Connect Device

To connect a device, select the device from the device list, and then click Connect Device.

If there is no instance of AmpSrv2 running with the required port, then a new instance of AmpSrv2 will start. Otherwise, it will use the current AmpSrv2 instance.

The communication port between GTT and AmpSrv2 is calculated automatically on GTT side: 24575 + HiQnet node address of the device instance.

If AmpSrv2 is started by GTT, then AmpSrv2 settings will not be stored.

If AmpSrv2 settings change permanently, then a manual start of AmpSrv2 is required.

Automatic startup of AmpSrv2 only works for single device instances. If you want to connect to multiple device instances in parallel, you will need to manually start multiple AmpSrv2 instances (running on the requested port addresses).

From Herbie Hancock release onward, the default port of the virtual device has changed. The default port is now 25001 (before it was 8080).
If an old audio library is used, the settings should be adapted manually. In AmpSrv2 > File > Options > click Socket.

Disconnect Device: Click the Disconnect Device button in the ribbon bar.

If AmpSrv2 was launched by GTT, AmpSrv2 will be closed. Otherwise, AmpSrv2 will keep on running.

AmpSrv2 Settings

AmpSrv2 is software to connect the tuning tool to either a physical target device or a virtual amplifier.

The AmpSrv2 shows the following menus:

• File: Click on the File menu to open the Options window or close the AmpSrv2.
• View: Click on the View menu to open dialogues and protocols functionalities.
• Extra: Click on the Extra menu to import CAN SID, OS-Msg Description, GATI/xTP Description, and Protocol file.
  

• Info: To get the AmpSrv2 version and license details.

AmpSrv2 License

The AmpSrv2 dialogues and protocols functionalities are licensed-based. If any dialog or protocol is grayed out or not available, this means you have a limited license.

The AmpSrv2 is shipped with a limited license (Customer.lic).

To check AmpSrv2 license:

1. On the AmpSrv2 window, click Info, and then click About. This displays the AmpSrv2 info screen. Verify the license information.

To activate the new AmpSrv2 license:

1. Navigate to the C:\Program Files\Harman\HarmanAudioworX\tools\AmpSrv2.
2. Locate Customer.lic file (license file) and delete the existing license file.
3. Copy and paste the new license file (xxx.lic) into the same AmpSrv2 directory.

To changing AmpSrv2 Settings:

1. On the AmpSrv2 window, click File, and then click the option. This opens the Options window.
2. On Socket tab, set the protocol to GATI.

If you experience network conflicts, choose a different port above 50000 because port 8080 is very popular. Your selection must appear in the VST client (probably AudioMulch).

1. On the Tuning GATI tab, set the Databytes per to 192, and click Ok.
2. On the AmpSrv2 window, check the checkbox

When you start GTT and connect to AmpSrv2, the AmpSrv2 window will show the number of connected clients.

Once you have completed the necessary Ampsrv2 modifications, go to AmpSrv2 Settings and save the Ampsrv2 modifications.

This saved configuration will now be used for this specific device on Connect Device. The saved configuration will also be exported/imported using the GTT project Export/Import functionality.

If no AmpSrv2 settings are connected with a device, the default settings will be used. You can modify the GTT default AmpSrv2 settings. Follow the steps mentioned in the above topic “To changing AmpSrv2 Settings”.

The AmpSrv2 window will appear, and the user can modify the settings, which will be considered the Default Settings for GTT.

In the case of a Discover device, you should first open AmpSrv2 Settings, modify settings as needed, and then click on Discover Device. This modified configuration will be used to discover the device.

In the AmpSrv2 window, the port number of the server is not saved in the General tab.

Two AmpSrv2 windows with the same port number cannot be opened or an error message will be displayed.

Import

• Tuning Data: Use this option to import an existing tuning file (*.set or *.setr).

Users can use the following hints to see if the “imported tuning file” has made any changes to the device:

• Check the State Variable Explorer to see if the values of the corresponding state variables have changed.
• If the device and GTT are in sync, sending tuning data should cause the frequency response to change.
• The user can manually create a set column to obtain the current state of the state variables after importing the tuning data file on the device.
• The user can use the set column that is already present after importing the tuning data file on the device and pressing the “store” button. If the set column in the set file contains state variables, the user can view the modifications.

Export

• Tuning Data: Use this option to export a tuning file (*.set or *.setr).

This method creates a .set file which contains all the object tuning data, that includes all of the device’s state variables. For example, if certain objects are not tuned, their default tuning values will be exported to the set file.

• Export DDF Data: Use this option to export a device description data file (*.ddf ).
• Export Control Pin Data: Use this option to export Control Pin Data (*.csv).

If no configured control pin data is available its shows the message “Control pin not configured for device”.

• Device Template: Use this option to save device template file  (*.flash).

Important The Device File option is hidden by default. Steps to make Device File option visible under in Import/Export option: 1. Go to GTT installation path and locate GlobalTuningTool.exe.Config file. Location: C:\Program Files\Harman\HarmanAudioworX\tools\GTT\ 2. Open the file in any text editor (notepad) and update “AudioObjectDeveloperMode” attribute under “appSettings” node as shown below. 3. Set Value = true to enable Device File option. Similarly, set Value = false to disable Device File option. Restart the GTT to take effect of updated setting.

Tuning Data

You need to connect a device to GTT to send/receive tuning or state data.

When the device is connected you will get the following options.

• Send Tuning Data
• Receive Tuning Data
• Receive State Data

Virtual Tuning

This feature will be removed in the future Global Tuning Tool release.

Virtual Tuning allows you to measure impulse responses of an acoustic environment using the AudioworX Measurement Module. Based on these measurements, a production signal flow can be virtually tuned.

For this purpose, two new audio objects are implemented in AudioworX:

• IppMimoConvolver
• Time Multiplexer

IppMimoConvolver: The IppMimoConvolver audio object provides MIMO convolution with FIR filters using the Intel Integrated Performance Primitives (IPP) library, a multi-threaded software library of multimedia and data processing applications. It is highly optimized for various Intel® architectures and is a comprehensive library of out-of-the-box, domain-specific functions. The library is available for the Linux, MacOS, Windows and Android operating systems.

In the SFD, you can select the following object parameters at design time:

• Number of input channels
• Number of output channels
• Number of taps of filters

Tuning: For each filter combination in IppMimoConvolver, this object exposes these one tuning parameters set to the GTT

• Coefficients: The coefficients of the filters can be imported from .csv files. The filter taps that are set in the GTT must match the taps of the filter that is imported from the .csv file.

Filter coefficients can also be loaded directly from a Measurement Module session that has been pre-measured in AudioworX.

Time Multiplexer: The Time Multiplexer combines multiple input audio signals into a single audio signal by dividing the input channels into equal fixed length time slots and mixing them into a common output channel with fading between channels.

The length of the time slots and the fading characteristics can be configured at runtime.

The output signal is the signal of one input channel at a time. The next input channel becomes the first input channel again when the last input channel is reached. Depending on the fading mode, there might be a block length of fading between 2 channels.

In the SFD, you can select the following object parameters at design time:

• Number of input channels

Tuning: This audio object exposes four tuning parameters to the GTT.

• Mode: The mode can be set to:
  • Normal Mode: Performing multiplexing
  • Active Channel Mode: Single channel passed to the output
  • Off: No output
• Multiplex number of blocks : Only evaluated in “Normal mode”. It presents a number of blocks (block length) after which to switch to the next input.
• Fading mode: Only evaluated in “Normal mode”. It sets a type of fading method:
  • Cosine square fading
  • Linear fading
  • No fading (hard switch)
• Active channel
  • If in mode “Active channel mode” – The channel number of the input channel that will be routed to the output channel.
  • If in mode “Normal mode” – Set the selected channel as current input and continue with the next channel in normal/multiplex mode after the configured number of blocks.

Virtual Tuning Configuration Prerequisites

The steps listed below describe how to configure an IppMimoConvolver object using GTT.

1. Create a signal flow with the IppMimoConvolver object with m inputs, n outputs, and j number of taps for filters.
2. Create a measurement with n mics and m speakers.
3. Adjust measurement length, sample rate, etc to get exactly the required amount of coefficients (ir data points) before starting measurement.

Once the above steps are done, select the device (which contains a mimo object) from the device list to activate the device tab.

Steps to launch Virtual Tuning:

1. Select a device, and click Virtual Tuning. This opens the Virtual tuning configuration screen.
   

Apply Coefficients to Virtual Tuning

Steps to apply coefficients to Virtual Tuning:

1. Open Virtual Tuning and select suitable Measurement Session.
2. Select Convolution Object to which the Coefficients to be applied.
3. Click Apply.

The selected measurement’s IRData is retrieved and applied to the convolver object. A toast message appears, stating that the coefficients were successfully applied.

Virtual Tuning Panel: The IppMimoConvolver panel is used to view the coefficients assigned to the object. This panel provides the following functions.

• Flat
• Import
• Export
• Import All

The Device Panel group offers a set of tools that lets you perform various functions on a device.

The following tools are available on the Device panel.

• State Variables
• Default Control-Ids
• Preset Controller
• Controller
• Link Window
• MIPS
• Memory
• Memory Latency
• Streaming
• File Controller

The State Variable Explorer window allows you to view the memory layout of each device instance. It can also be used to send and receive tuning data.

To copy values of FloatArraySV type state variable to the Windows clipboard, press CTRL+ C in the table . The float values are located in the clipboard. The same can be achieved by using the context menu (Copy All) of the table.

File: Using the file options you can load and save the set file.

• Load Set: To load a set file, click on “Load Set”. Browse the location of .set or .setr file and click “Open”. This loads the set or .setr file in State Variables explorer.
• Save Set As: To save a set file, click on “Save Set As”. A dialog box will appear, where you can choose the folder to store the files (.set/.setr). Enter a file name and click on the “Save” button.

Target: Using target options you can send or receive tuning data from the connected device. When the device is connected you will get the following options.

• Send Tuning Data
• Receive Tuning Data
• Receive State Data

Sort by: Using sort options you can sort the state variables and audio objects in the state variable explorer.

• Name: To sort the audio objects or state variables based on their names
• Block Id: To sort the audio objects or state variables based on audio objects block Id.
• Object Type: To sort the audio objects or state variables based on audio object types.
• HiQnet Id: To sort the audio objects or state variables based on audio object HiQNetIds.

When you click it the first time, it will sort in ascending order; the next time, it will sort in descending order, and so on.

Search: Using the search option, you can locate and highlight a matching record and move on to the next or previous matching data set.
It will search audio objects and state variables based on Name, Block Id and HiQnet Id.

Reset: The Reset option will clear all search and sort data and reset state variable explorer to default state.

The Configure Default Controls option allows you to specify which default control ids should appear in the “Control In” control list.

To Configure the Configure Default Controls:

1. Click on Default Control-Ids. This opens the Configure Default Controls window.
   If no configuration is defined, all Control IDs are selected in the Configure Default Controls window.
   
   In the Configure Default Controls window, you can select or unselect control IDs.

   You cannot deselect the Control ID used in the Signal Flow Designer.

2. Select or deselect the required control Ids and click Save to update the configuration.
   

Use the search text box to search and filter the control Ids.

Once you have modified the Configure Default Controls data, you can verify the changes.

Go to the Signal flow designer window and open the Control In property window to verify the configured default control IDs along with custom control IDs.

Sort Control In Pin Data

The Control In panel shows all user-configured control pins data.

You can click on any of the column headings to sort the data. Clicking alternately will change the sorting direction from ascending to descending or vice-versa.

The ascending order of the Pin column is the default sort order for the Control In panel.

Click on any column header to sort the respective data on the Control In panel.

The preset controller is the central place for managing and organizing how you will load presets in your signal flow.  It also contains other related features such as creating .set files, storing sets, and recalling sets of parameter sets available.
A “Slot” is a group of parameters set one level above. You can create multiple such slots and do any actions like create set files, store , recall etc.
In addition to GTT functionalities, it is also possible to send Xtp commands to device. There are XTP commands to send slot map and Load the slot on to device. You need to export all .set files and manually flash on to the amp.
For more details Preset Controller, refer to Configuring Preset Controller.

The controller window is used to send instance commands.

The controller feature is enabled only when the device xAF dll version is lower than 18.x.x.xxx.

Steps to setup controller:

1. Enter a valid Core Id and Instance Id and click on Get Status to get the current available slot of the device. The response from the device will be displayed in the Response section.
   
2. Click Save to save the current instance data on the device to the memory slot entered.
3. Click Load to load the data from the memory slot to the device RAM.

If there is any error in the device connection or if any invalid Core Id and/or Instance Id were entered, the error message “Request failed!!!! Please make sure […]” will be displayed.

The Linking Window is designed to assist you by reducing the number of audio parameter configurations. It enables you to organize the filters and channels. When you set one item in a group, the remaining items in the group will have the same value.

By default, all the groups link are enabled. If you want to disable the specific group link, click on the toggle button to disable it.  GTT will store the group linking status in project file.

If you want to disable all the groups link, select the Disable Linking checkbox.

Create a New Group

Steps to create a new group:

1. Open Linking Window, expand the task, and drag-drop the object to the right-side section under Groups. A new group is created, expand the new group. Under the new group, you can view the added object.
   

Renaming Groups: Double-click on a group name to rename it.

Only groups can be renamed; Audio objects cannot be renamed.

Removing Objects: Click on the remove icon to remove the object. This will also delete all child objects.

Removing Groups: Click the remove icon to the right of the group. This will also delete all child objects.

Add Object to Existing Group

Steps to add object to an existing group:

1. Open Linking Window, expand the task, and drag-drop the object to the right-side section under target group. A new group is created, expand the new group. Under the new group, you can view the added object.

If an object cannot be added to a specific group, the color of that group will change to grey.

If the object is added to the group, the color of the group will change to blue.

Linking Rules

• Each of the audio objects can be part of only one group.
• If a child audio object is part of a group, the parent element cannot be part of that group.
• Groups can contain only one type of audio object. For example, you cannot link a Biquad with a Delay. Each group can contain more than one AO.
• Objects in groups are linked according to their order. For example, if you link two EQ channels, the first Biquad from the first channel will be linked with the first Biquad from the second channel.
• Changing links is done live. You do not need to close the window for the changes to be working.

The MIPS window presents the CPU load of cores, instances, and audio objects of the connected device.

MIPS profiling data is fetched from the device (hardware) using xTP Commands and the user can optimize signal flow based on this information.

MIPS window is enabled only when the device xAF dll version is 18.x.x.xxx or higher.

Signal flow should be flashed before launching MIPS.

Launch MIPS Profiling

Steps to launch MIPS profiling:

1. Select the device node and click MIPS. This opens the MIPS window for the selected device.
   MIPS measurement on (0x64<deviceID>0501) and Audio Object level MIPS measurement off command (0x64<deviceID>0504) will be sent while opening MIPS window and a progress window will be seen as per below screenshot.
   

Below command will be seen in Xtp Log viewer.

Summary Tab

• Present virtual core and instance MIPS data (Average MIPS and Maximum MIPS) retrieved from the virtual device using the xTP Command.
• MIPS data displayed on the physical core are the aggregated value of its virtual cores.
• Audio Object level MIPS measurement off command (0x64<deviceID>0504) will be sent while switching to Summary tab from Instance tab and a progress window will be seen as per below screenshot.

Below command will be seen in Xtp Log Viewer.

Instance Tabs

• A new tab corresponding to the selected instance will be loaded, displaying audio-object MIPS data retrieved via the xTP Command.
• Inner audio objects will be displayed alongside compound audio objects for compound audio objects.
• Audio Object level MIPS measurement on command (0x64<deviceID>0503) will be sent while opening new Instance tab or switching to Instance tab from Summary tab and a progress window will be seen as per below screenshot.

Below command will be seen in Xtp Log Viewer.

Reset

When you click the Reset option, the MIPS number for the device will get reset for the selected tab and Reset command (0x64<deviceID>0500) will be sent and a progress window will be displayed as per below screenshot.

Below command will be seen in Xtp Log Viewer.

Refresh MIPS: When you click the Refresh Mips option, the MIPS data for the current tab will be refreshed.

Export to CSV: When you select the Export option, the Mips data for the current tab will be exported to a CSV file.

Closing MIPS Window: When you click on cross (x) to close the MIPS window, MIPS measurement off command (0x64<deviceID>0502) will be sent and a progress window will be displayed as per below screenshot.

Below command will be seen in Xtp Log Viewer.

The Memory window presents the CPU memory of cores, instances, and audio objects of the device in a single multi-level grid.

Memory profiling data of cores and instances is fetched from the device (hardware) using xTP Commands, and the memory of the audio object is fetched based on its memory latency configurations.

Overhead Memory consumed by core and instance is calculated and displayed as ‘Framework Memory’. You can optimize signal flow or adjust latency based on this information.

Memory window is only enabled if the device xAF dll version is 18.x.x.xxx or higher.

Before starting the Memory window, the signal flow should be flashed.

If the memory latency configuration is updated, the signal flow should be flashed again and the memory window should be restarted.

Launch MIPS Profiling

Steps to launch MIPS profiling:

1. Select the device node and click Memory. This opens the Memory window for the selected device.

When the Memory window is launched, a multi-level collapsible grid with core, instance, and audio objects will be displayed.

• The physical core memory values displayed are the sum of its virtual cores.
• xTP Commands are used to retrieve virtual core and instance memory from the device.
• Memory latency configurations are used to fetch audio-objects memory.
• Overhead Memory consumed by the core and instance is calculated and displayed as ‘Framework Memory’.

• Expand All: Expands all rows of the collapsible grid.
• Collapse All: Collapses all rows of the collapsible grid.
• Export to CSV: Click on the Export option to export the memory data of the device in a CSV file.

Memory latency shows the amount of time taken by the CPU from initiating a request for assessing memory to actual reading or writing data at the requested memory.

In AudioworX, the latency of the memory request is abstracted and only measured in relative levels.

• Level 1 – fastest memory available in the platform.
• Level 16 – slowest.

The Memory Latency Editor provides a way to configure latency levels for individual audio object memory records from GTT.

During design time, GTT retrieves memory records for audio objects from the audio library in the following cases:

• While adding an audio object.
• Modifying audio object i.e changing the number of inputs, outputs, number of elements, or selected mode.
• Modifying additional parameter value.
• Upgrading audio object.
• Import of project which defaults to a different dll other than the created one.
• Upgrading device framework to version 17 dll or above.
• The changing target type of Core.
• Changing Sample Rate or Block Length of instance.

GTT supports Memory Latency feature only if the xAF dll version is 17.x.x.xxx or above.

Editing Memory Latency

Memory records will have default latency selected by the Audio Object developer. GTT provides the option to set the latency for every memory record of the audio object in the Memory Latency Editor.

1. Select the device node and click Memory Latency. This opens the Memory Latency window for the selected device. When the Memory window is launched, a multi-level collapsible grid with core, instance, and audio objects will be displayed.

1 – Header, 2 – Column Filter, 3 – Header, 4 – Latency Sector

• Multiple memory latency record selection: You can select multiple records in the memory latency window.
  • To select the specific rows – Hold Ctrl and click on the required rows. This method is useful when you want to preform action on specifics rows.
  • To select a set of row – Click on the first row of the set, hold Shift, and then select last row of the set. This method is most useful when selecting a large number of rows in a range.

Sum of all the selected memory latency record size will be shown as “Total size of the selected records in bytes” in the memory latency window.

“Total size of the selected records in bytes” will be visible only on selecting any memory latency record in the window.

• Reset to default latency level: You can reset the selected records to its default latency level.  Right click on selected records or anywhere on latency grid. A context menu “Reset to default” option will be displayed. Click on the “Reset to default” option, all the selected records of the latency level will be set to default value which is “LEVEL5”. Click on “Save” button and it will be saved into database.
  • To reset records to default latency level for the specific rows – Hold Ctrl, select on the required rows, and then right-click on selected records. A context menu “Reset to default” option will be displayed. Click on the “Reset to default” option.
  • To reset records to default latency level for a set of row – Click on the first row of the set, hold Shift, select last row of the set, and then right-click on selected records. A context menu “Reset to default” option will be displayed. Click on the “Reset to default” option.

• Saving Latency memory: Only Latency can be selected. Other attributes of memory records are read-only. When you click on Save, the Latency for the memory record will be saved.

The Save Button is disabled until a change in latency is detected.

• Send Memory Records to Device: Send Signal Flow will handle sending Memory records to the Device with a specified latency. When the signal flow send is successful, the device will boot up with the memory latency specified.
• Import Export of Project having Memory Record: Memory latency is preserved if the export and import occur on the same xAF dll by version.
  If the dll version changes, Import will generate a new memory record based on the new target xAF dll version.
• Copy Paste of Audio Object or Core Object Containing Memory Latency: If the properties of the source and targets are the same, memory latency is retained in the pasted object.
• CSV Import/Export: You can export and import of memory map to CSV files. The primary operation of this feature is to export memory latency to CSV, adjust memory levels, and then import the updated memory levels back into the GTT. When the memory map form file does not match the one in GTT, GTT will request permission to import only the items that match.

You can stream live data from the device. The state variables which support streaming and polling are displayed in the state variable explorer tree with “Category” other than “Tuning”.

This feature needs a license to unlock. Please talk to the license administrator to get the license.

Configure Streaming

If you want to stream streamable state variable, then you can enable Streaming option.

To enable Streaming per core:

1. Open the Device View and select the Virtual core layer of the device.
2. Go the Virtual core properties, select the Streaming checkbox, and set a number of State Variables per core.

Maximum 32 state variables can be configured for streaming.

If you want to perform the operation using non-streamable state variables, then there is no need to enable these options

For more details about Streaming, refer to Streaming and Polling.

The File Controller allows you to send audio files from GTT to device. The file controller suports .wav and .pcm formats audio files.

Following are the options available in file controller.

• Select Workspace
• Add Files
• Delete File
• Replace File
• Send to Device
• Verify Checksum
• Export Options

The file controller feature is available from W release onwards.

Select Workspace

The Select Workspace option allows you to browse and select workspace or root folder from the local directory. Once the folder is selected you can add the respective audio files.

Also, you can also copy & paste the path of your workspace folder in the “Workspace” field.

Add Files

Once workspace folder is selected, click on the “Add” to launch file browser. You can navigate to the respective folder and add audio files (.pcm/.wav) in file controller from the workspace folder.

The file browser will open the workspace folder by default.

After adding the files, following details of the files will be displayed in file controller.

• File ID:  This ID is generated from GTT, it’s range from 1 to 254.
• File Name: If the file name is exceeding length of 15 characters (including file extension), GTT will trim it to 15 characters.
• Path: Relative path of file, based on workspace folder selected.
• Size: Size of the file in KB. If the file size is less than 1KB, the size will be displayed in bytes.
• Checksum: Checksum calculated using file content.

In case if you add any file from non-workspace folder, following prompt will appear.

• Copy: To create a duplicate copy of the file within your workspace folder.
• Move: To relocate the selected file to your workspace folder, removing it from their original location.
• Cancel: To stop the ongoing operation.

This facilitates the sharing of project files and files added to the file controller by ensuring that all files added to the file controller are present in the workspace folder.

The number of files added will be displayed in File Controller.

Maximum 254 files can be added in file controller.

Once after adding files to file controller, on relaunching file controller if any file not found to load, the error is indicated by showing “0 Bytes” size and invalid checksum as below,

Delete Files

The file controller offers two ways to manage your files:

• Click “Delete All” to remove all files at once.
• Use the “Delete” button for each file to remove them individually.

The delete operation will delete file entry from file controller, not the file from file system.

Replace File

You can replace file in the file controller. Click on the “Replace” button, this will open the file browser, allowing you to select the new file you wish to use.
Also, allows you to reuse file id for different file easily.

Send to Device

The “Send to Device” allows to send the loaded files in file controller to the device.
While sending files to device, file map will be sent to device first. File map contains metadata about the files being sent.
If it fails to send file map, the audio files will not be transferred to device.

Verify Checksum

The “Verify Checksum” feature helps ensure you’re working with the correct files. The Verify Checksum option uses the file content checksum to confirm that a file with the same file ID is present on the device.

Use the “Verify All” button to check all files at once or the individual “Verify” button in each row for specific files.

	Indication of default state “Not Verified”.
	Indication, when the file is found in device with same file id. Also, on successfully file send to device.
	Indication, when the file is not found in device with same file id.

Export Options

To export files from file controller, following options are available.

• Export File Map
• Export Audio Files
• Export All Files

These options will be displayed on clicking “Export Options” button.

Upon selecting any of these options, a folder browser will open allowing you to select the destination folder.

Export File Map: This option is to export filemap file and human readable filemap.

Export Audio Files: This option is to export audio files added in file controller.

Export All Files: This option is to export all files including filemap and human readable filemap.

Export & Import File Controller Data

The selected workspace and metadata of loaded files in file controller can be exported through project file (.gttd). This metadata includes file id, name and relative path of file. After importing the gttd file with file controller data, if the workspace folder is not found, files will be displayed with “0 bytes” Size and invalid checksum as shown below.

You can select workspace folder with same sub folder structure to automatically reload files loaded in file controller. The files should be present in same hierarchy and name.

GTT allows external tools to interact with devices. The tuning of 3rd  party audio objects can be done directly in GTT, or it can also be done from an external tool.

The requests from external tuning tools will come to GTT and GTT will forward these requests to the device. This is enabled through a WCF service endpoint that external tools can tap into.
To help external tools integrate with GTT, the GTT process hosts a WCF endpoint; external tools can connect to that endpoint and use the exposed APIs.

Refer the contact information mentioned in the latest release notes to get more details on “External third party tool” documentation and package.

Before proceeding with the following sections, it is understood that you have received 3 compressed zip files. It is recommended that you use these for integration purposes.

• HarmanReferenceTool.zip: This compressed folder contains an executable sample tool that you can run and verify the endpoint functionality. Unzip the HarmanReferenceTool.zip file, go to the HarmanReferenceTool\Release\net6.0-windows folder, and locate the ExternalTuningTool.exe. Run the exe to open Harman Reference Tool.
  
• ExternalToolCode.zip: This compressed folder contains visual studio solution for the sample tool. One can refer to this code to understand how the endpoint is accessed. Unzip the ExternalToolCode.zip file and locate the file under ExternalToolCode\ExternalTool.
• WcfServiceProxyLib.zip: This compressed folder contains a proxy library dll that should be referenced for integration with the GTT endpoint.

The “WcfServiceProxy.dll” is a .net dll which has the implementation of the client code for the endpoint hosted in the GTT.

Setup

GTT needs a minimum setup for external endpoints to function.

1. Right-click on GTT launcher and click on the “Run as administrator” option.

   For the external endpoint feature to work correctly, it is necessary to run GTT as an administrator.

2. GTT should have an open project. Only external audio objects can be accessed from external tools.
   Accordingly, the project must contain at least one external audio object within the signal flow. An external audio object is defined as an object with Class ID between 9000 and 9999.
3. GTT should be connected to the device. The device can be a virtual device or a physical board.
4. Click on the Start/Stop button to start the External Endpoint. The same button works as a toggle switch to start and stop the endpoint.

   A license is required to use this feature. Contact the solution management team to enable the feature.

5. Once the endpoint is hosted,  the 3rd party applications can use the proxy dll or write their own proxy to access the WCF endpoint. For more details about WCF proxy, refer to “About WcfServiceProxy.dll in the GTT Third Party Tool Integration User Guide. 

Supported Features

Sending and Receiving Tuning Data

To support sending and receiving tuning data, the following methods are exposed.

• GetExternalAudioObjects: This method will return all the 3rd party audio objects in the device.
• SendTuningDataAsync: This method is used to send tuning data to audio object.
• ReceiveTuningDataAsync: This method is used for receiving tuning data from an audio object.

Sending and Receiving Control Data

To support sending and receiving control data, the following methods are exposed.

• SendControlDataAsync: This method should be used to send control data by mentioning the control id and control data.

  The control data supports 16.16 format.

• ReceiveControlDataAsync: This method can be used for retrieving control data by providing the control id to the control elements to be read back.

Streaming Methods

GTT also supports streaming with the following methods.

• EstablishSocketConnection: This method must be called first in order for streaming to work. The third-party tool should first establish a socket connection and then make a call to the port number where it is listening. GTT will connect to that port. This is a socket connection.
• DisconnectSocketConnection: This method is used to unsubscribe all the subscriptions and close the socket connection.
• SubscribeForStreamDataAsync: This method is used to subscribe for stream data for an audio object.
• UnSubscribeForStreamData: This method is used to stop or unsubscribes the stream data.

To know more about all the API methods described above, refer to the API Reference section in the GTT Third Party Tool Integration User Guide. 

External Tool Interaction

The following are the steps to integrate with GTT.

GTT will host the WCF endpoint at the following URI (http://localhost:8080/XtpHandlerService).

Steps to get started with the WCF service.

1. Discover the service using this URL. Use the known tools like visual studio service reference tool or any 3rd party tools.
2. Create a service reference for the same.
3. Then using the service reference call the APIs for different operations.

Otherwise, developers can follow the “Third Party Tool Tuning Sequence Workflow” and  “Third Party Tool Streaming Sequence Workflow”  to write code to consume the endpoint hosted by GTT using the proxy library (WcfServiceProxy.dll) shared and explained in the GTT Third Party Tool Integration User Guide. 

API References

GTT endpoint APIs definition and parameter details are provided in the GTT Third Party Tool Integration User Guide. 

API: ExternalAudioObject API Function: ExternalAudioObjectResponse GetExternalAudioObjects(); Description: This function will return all the audio objects that are used in the currently open signal flow in GTT. It returns only those audio objects which have Class ID between 9000 and 9999. Also, any audio objects that are listed in external category.

API: SendTuningDataAsync API Function: Task<XtpEndpointResponse> SendTuningDataAsync(ExternalAudioObject audioObject, int subBlock, int offset, byte[] data); Description: This function will apply the data payload to the ExternalAudioObject  passed into the function.

API: ReceiveTuningDataAsync API Function: Task< XtpEndpointResponse > ReceiveTuningDataAsync(ExternalAudioObject audioObject, int subBlock, int offset, byte[] size); Description: This function will retrieve tuning data from the ExternalAudioObject.

API: SendControlDataAsync API Function:  XtpEndpointResponse SendControlDataAsync(int controlId, byte[] data); Description: This function will send control data to the control id mentioned in the function.

API: ReceiveControlDataAsync API Function: XtpEndpointResponse ReceiveControlDataAsync(int controlId, byte[] data); Description: This function will get the control data from the control id that is passed into the function.

API: EstablishSocketConnection API Function:  XtpEndpointSocketResponse EstablishSocketConnection(int port); Description: This function will instruct GTT to connect to the socket connection listening at the port passed as parameter. The integrating application will create a socket connection and listen at a port and send this port id to GTT, so GTT can establish a connection and send stream data through the socket.

API: DisconnectSocketConnection API Function:  XtpEndpointSocketResponse DisconnectSocketConnection(int port); Description: This function will instruct GTT to disconnect the previously established connection. The integrating application will close the socket connection.

API: SubscribeForStreamDataAsync API Function: Task<SubscriptionResponse> SubscribeForStreamDataAsync(ExternalAudioObject audioObject, int subBlock, int messagesPerSecond, bool beforeCalc); Description: This function will create a subscription for data streaming of a particular state variable of the audio object mentioned at subblock/offset. This function can be used to subscribe for streaming of a particular data from audio object. Parameters include audio object, its subblock. There is an option to send the number of messages to be streamed per second and if the streaming data is to be retrieved before calc or after calc. All this needs to be supported by the audio object. Once the subscription is complete, the subscription id and status are returned to the object.

API: UnSubscribeForStreamData API Function:  SubscriptionResponse UnSubscribeForStreamData(Guid subscriptionId); Description: This function will terminate the subscription that is currently running. GTT will stop the subscription that is started with the subscritionId passed as parameter.

The Devices section allows you to perform the following actions:

• Add a new device to the project.
• The Discover Device option allows you to discover connected physical or virtual devices and GTT will interact with the target device to obtain the device information available on the device.
• Display lists all the devices in a project.
• Provides options to remove the device from the project.

On the Device Designer tab, click on the (+) icon to add the device. This opens the Add Device dialog box.

On the Add Device, you can perform the following operations.

• The Add Device dialog box lists existing device templates available in GTT.
• You can add new device templates using any of the methods; Discover Device, Create Light Device, or Create Device File options.
• You can delete existing device templates if they are not used in a project.
• Custom Device is also listed in the Device template list as the first template. You can select a custom device and add it to the project like other templates.

GTT supports 1 custom device at a time as per the current design.

You can use any of the options to add a device template to the project.

• Discover Device: Click on Discover Device, if you have the preconfigured device template available and connected to the physical or virtual device.
• Create Light Device: Click on Create Light Device, if you want to create a new template.
• Create Device File: Click on the Device file, if you want to create a device file.

The Discover Device feature allows you to read and write the device configuration from or to the device.

This function allows you to read information from a device that is connected to the Global Tuning Tool. This information is used to create a device template that reflects the internal layout structure of the device, which includs its physical cores, virtual cores, and routing information from device input to virtual cores between virtual cores and core objects.

You can also write (download) your own configuration to the device using this feature.

Below are the few details which GTT will get from the device to construct the inner layout.

• Physical cores information.
• Core information.
• Core objects information.
• Device and Virtual Core Routing (For more details refers to Device Routing)

Below are the prerequisites to start a Discover a Device.

• Copy the flash file (device.flash) and the audio library xAFVirtualAmp.dll file available in AWXInstalledLocation/HarmanAudioworX/AudioFrameworkDLLs to your working folder.
• Launch IVP, open to “Advanced” settings, go to “Plugins” tab, and select the correct path to the xAFVirtualAmp64.dll.

Before using this feature, delete all the *.flash files from the working folder. IVP may crash, if it has the old tuning flash files.

Follow the below steps to discover a device:

1. On Add Device window, click on Discover Device. The GTT will start to communicate with the target device, gather the device information, and add the device to the Devices templates.
   

The device identification feature is enabled for audio libraries version 13 and higher.

Only after you have completed the prerequisites the Discover Device feature function will work properly.

Using the Create Light Device option, you can create a new template.

Follow the below steps to create a device template:

1. On Add Device window, click Create Light Device. This opens the Add Device dialog box.
   
2. Enter the details in the following fields and configure the device core type.
   
   • Reference ID: Enter the reference ID of the template.
   • Device ID: Enter the initial value of the Device ID field for the first device instance created out of that template Device template name.
   • Device Name: Enter the device name.
   • Brand: Enter the brand name required for legacy AA infrastructure.
   • Family: Enter the family name required for legacy AA infrastructure.
   • Number of Channels: Enter the number of channels supported by the device.
   • Max Tuning Data Size: Enter the maximum count of bytes included in a single tuning data message.
   • Communication Type: Select ID-based tuning or address-based tuning.
     • IdBasedTuning –
     • AddressBasedTuning –
   • Core(s): Each device template exposes one or more physical cores.

   For the xAF library before the O release: multiple cores from the given list can be selected.
   
   For the xAF library from O release: Cores can be added/removed. Core types and Data-formats supported by xAF will be listed for configuring the core.
   

3. Click Add Core, select core type and date format from the drop-down list, and then click Ok.
   When the default xAF library version is < 15 (O dll), GTT displays a static set of core types with corresponding data formats.
   Based on the default xAF library selected, you can add multiple cores, and two modes of core selections (Core Type and Date Formate) are available. Below is the example showing the available core type supported by respective xAF dll versions.
     
   While configuring the core type of the device, if you want to remove any core, select the core, and click Remove Core.
   
4. Click OK. The new template is added to the device templates list.

The GTT allows you to create a device flash file using Device File Editor (DFE) in a project. The device file is a combination of Physical Cores, Input Groups, and Output Groups.

Follow the below steps to create a device file:

1. On Add Device window, click Create Device File.
   
   This opens the Device File Editor window. The editor interface uses a tree-like structure to display items at each level and this structure is defined in the xTP specification. Furthermore, a Virtual Core will have Input and Output Groups as defined by the xTP specification. Each Input Group and Output Group have one group added by default.
   By right-clicking on each item, a context menu will appear that will allow you to add or remove subtree items.
   
2. Select Physical Cores and enter the hardware and software version.
   There could be one or more Physical cores under a Device and each Physical core can have more than one virtual core inside it.
   
3. Right-click Physical Cores and select Add Physical Core.
   
4. Select Physical Cores 0You must specify the Core Type of Physical Core. When the default xAF library is set to O release or above, the supported xAF core-types will be listed or set the default value to ‘0’.
   
5. Right-click on Physical Cores 0 and select Add Virtual Core.
   
6. Select Virtual Core 0, enter the Task Priority, and select the Date Format.
   
   A Virtual Core is made up of Input and Output Groups. You can add one or more Physical Cores, and each Physical Core can have many Virtual Cores.

   It is important that you should specify the Core-type of the Physical Core, Data Format of Virtual Core, Device Input, or Output Group.

   When the selected default xAF library is “O” release or above, the xAF supported data formats will be listed or the default value set to ‘2’.

7. Expand Input Groups, select Group 0, and configure the respective properties. Similarly, expand Output Groups, and configure the Group 0. In order to allow routing from Device Input/Virtual Core to other Virtual Cores or Device Output Groups, select Connectable Cores and Connectable Device Output groups.
   You can add multiple Group inside an Input Group.
   
8. Once all the configuration is done, click Save Device File. A save file dialog box appears, enabling you to save the flash file.
   The flash file contain the information related to structure of the device like Device Id, hardware version, software version, input groups count (No. of input pins), output groups count (No. of output pins), physical cores count,
   
   To view or modify an existing flash file, click Load Device File. The Device File Editor displays an Open file dialog box, selects the flash file, and clicks Open.
   

The Toolbox contains the core objects that were retrieved from the xAF dll. The objects that can be used within the core to create the device signal flow are called core objects. Each core object has its own purpose and solves parametric issues which block routing within the core.

Core Objects are classes that are part of the Audio Core (virtual core) class and operate at a higher level than audio objects. The audio processing class itself is a core object. The relationship between core objects and Audio core is similar to that of audio objects and the Audio Processing class.

• Xaf Instance
• Buffer
• Splitter
• Merger
• Ssrc lir Int
• Float to Fixed
• Fixed to Float
• Nan Detector

The execution order (or index) of the core object is displayed by Core Object Id. Routing determines the order in which core objects are executed within a core. The core objects that are connected to the core input will be executed first, and the core objects that are connected to the root object after that will be given the next execution order.

The device identification feature is enabled for audio libraries version 13 and higher.

The Xaf Instance is the core object inside which the signal flow for that instance can be created.

• Core Object Id (execution order of core-object with-in core) and Instance Id (index of xAF instance with-in core, based on execution order) will be displayed as read-only fields.
• The sample rate and block length of the instance will control signal flow within the instance. You can change the sample rate and block length of the instance in the properties section.

Further information on signal flow creation is available in the GTT Signal Flow Designer guide.

Buffer core object is used to convert the input block length into the required output block length. The buffer core object has an equal number of input and output channels. It can be used as a pass through core object OR it can be used to, as its name suggests, buffer samples from the input to the output. The object does not change the sample rate (it is the same at the input and the output).

If you want to connect two core objects with different block lengths, you can use a buffer core object. As a result, the input block length will be the Block Length of the first core object, and the output block length should be the Block Length of the other core object.

It can be configured as follows:

• If the input block length is equal to the output block length, then it behaves as a pass through object (so you could have an audio core with a buffer object to connect the core input to the output)
• Input and output block lengths must be integer multiple of each other
• When input and output block lengths are not equal, the object handles taking in input at a lower block length and outputting it at a higher one and vice versa. For example, it facilitates the connection of an object at block length 32 to an object at block length 64

Introducing this object into your signal flow for any case but pass through WILL result in latency at the output.

Splitter core object is used to convert one input to multiple outputs of the same sample rate and block length.

• This core object always has a single input.
• In order to make routing from any core object to the splitter both the source core object and splitter core objects sample rate and block length should match.
• Number of output channels for the splitter is configurable.

It is not to be confused with the Splitter audio object.

This object operates in parallel to an xAF instance NOT within it.

Merger core object is used to merge multiple inputs into a single output of the same block length and sample rate.

• This core object always has a single output.
• In order to make routing from any core object to merger both the source core object and merger core objects sample rate and block length should match.
• Number of input channels for the merger is configurable.

It is not to be confused with the Merger audio object.

This object operates in parallel to an xAF instance NOT within it.

Synchronous Sample Rate Converter (SSRCs) is used to convert the input sample rate to the required output sample rate.
SSRCs are core objects that can operate within an audio core. Currently there is one implementation of SRCs in Awx.

Two options are provided to convert the sample rate. Both these options are mutually exclusive.

IIR Integer Multiple SSRC

This core object implements a synchronous sample rate converter whose input sample rate / input block length and output sample rate / output block length are integer multiple of each others. This is also an infinite impulse response implementation (IIR).

The object operates in one of 2 modes:

• User Coefficients mode
• Predefined Coefficients mode

Before we get into the details, there are some common configuration parameters between the two.

• The input block length needs to be set by the user.
• The Biquad filter topology. Currently 2 topologies are exposed.
  • Direct Form I
  • Direct Form II

User Coefficients mode: In this mode, the user has to provide the input and output sample rate. Input and output sample rates should not be equal. The Number of Biquads field is read-only.
User has to import the coefficients by clicking on the button “Import Co-efficients”. Based on the number of coefficients in the file, the Number of Biquads is updated.

Validations for User Coefficients mode: The Input and Output sample rates cannot be the same. Validation is shown when the same values are entered.

After adding a new “Ssrc lir Int” object and selecting “User Coefficients Mode”, if the coefficients are not imported, the following message will be displayed on various operations such as “Save”, “Edit Device”, “Copy Core Objects” and “Paste Core Objects”. After importing coefficients, the user can perform the required operation.

Predefined Coefficients mode: In this mode, the xAF dll is used to read the input sample rate, output sample rate, and the number of biquads. When a value in the combo box is selected, the xAF dll is also used to fetch the corresponding coefficients.

Biquad Co-efficient has to be re-imported whenever the mode is switched between Predefined Co- efficient mode to User Co-efficient mode.

For these pre-defined coefficients, the quality measures are as follows:

• Signal to noise ratio: 80 dB
• Total harmonic distortion: 2e-3f
• Spurious free dynamic Range: 59 dB
• Total harmonic distortion plus noise: -60 dB
• Frequency response flatness: 3 dB

Output block length (Displayed as a read-only field) = (Output sample rate /Input sample rate) * Input block length.

Float to Fixed core object accepts audio buffers that are in floating point format and outputs buffers that are in fixed point format (16-bit, 24-bit, 32-bit etc).

• # of Channels is configurable. No of Input channels = No of Output channels
• The user can configure the scalar value to indicate what fixed point format is required. This scalar value is multiplied by the floating point input samples to convert them to fixed point.
  For example, to convert from float to 32 bit fixed point, this scalar value must be:
  (1 << (32-1) – 1) = 2,147,483,647
• In order to make routing from any core object to Float2Fixed object both the source core object and Float2Fixed core objects sample rate and block length should match.

Float To Fixed core object is enabled for audio libraries version 16 and greater.

Fixed to Float core object accepts audio buffers that are in fixed point format (16-bit, 24-bit, 32-bit, etc) and outputs buffers that are in floating point format.

• # of Channels is configurable. No of Input channels = No of Output channels.
• The user can configure the scalar value to suit the fixed point format of the input samples. The reciprocal of this scalar value is multiplied by the fixed point input samples to convert them to floating point.
  For example, to convert from 32 bit fixed point to float, this scalar value must be:
  (1 << (32-1) – 1) = 2,147,483,647
• In order to make routing from any core object to Fixed2Float object both the source core object and Fixed2Float core objects sample rate and block length should match.

Fixed To Float core object is enabled for audio libraries version 16 and greater.

The NaN (Not a Number) detector core object detects NaN from input samples and informs the platform using an xTP command if NaN is found. The xTP command will inform about the core id, core object instance id and channel index, so that platform can react accordingly by muting or resetting states. The input samples are copied to the output without doing any other processing. The number of output channel(s) is always same as the number of input channel(s).

• # of Channels is configurable. No of Input channels = No of Output channels.
• Block length and Sample rate are configurable.
• The number of input channels is user configurable and ranges from 1 to 255.
• This core objects’ block length and sampling rate are the same at both input and output side.
• Block length is configurable in the range of 4 to 4096 samples.
• Sample rate is configurable in the range of 8 kHz to 192kHz.

In order to make routing from any core object to NaN Detector, both the source core object and NaN Detector core objects sample rate and block length should match.

NaN Detector core object is enabled for audio libraries version 19 and greater.

When the GTT is loaded with a version of the xAF library lower than 13. If a user tries to open a device view that contains core objects other than a XAF instance, they will see the following error message.

Aside from the Xaf instance, every other core object will be red.

This section explains the device operation features available at the bottom of the Device Designer workspace.

• Load Device Config
• Connect Blocks
• Edit Device
• Send Device Config
• Send Signal Flow
• Export
• Control IDS

When there are no core objects in the cores, the Load Device Config option is enabled. The Physical Cores and Virtual Cores (available within a Physical Core) as well as their connection points that were fetched from the target during device discovery are visible after the device has been loaded. Since they are read from the device, the number of virtual cores and their connection points cannot be changed.
You can connect core objects by dragging them onto the virtual cores. Alternatively, you can select the “Load Device Config” option, which will read the target’s device routing information as well as the layout and routing between core objects and display it on the GUI.

In the device view, a property section has been added to display and change the properties of chosen Core or Core Objects. When the virtual core or core object is selected, their respective properties are shown on the screen.

If you don’t clear the device view first, you won’t be able to save or access SFD.

The device identification feature is enabled for audio libraries version 13 and higher.

You can auto-connect selected devices, cores, and core objects using Connect Blocks.

Choose at least two cores and click Connect Blocks.

You can auto-connect the following components.

• Device – Virtual Core(s)
• Virtual Core(s) – Virtual Core(s)
• Virtual Core – Core Objects (within selected Virtual Core)
• Core Object(s) (within same Virtual Core)

In Device File Editor you can modify the device configuration, then perform “Save Device Template” or “Update Device” operation.

You can create your own configuration and write this configuration to the target device. The Send Device Config option sends the device configuration (Core Objects, Device Routing, and Virtual Core routing) to the target device.
Before sending the device configuration, all the input and output connection points of the core objects must be connected. If any of the pins are not connected, an error message is displayed.

The Device view (number of Cores, Physical Cores, Connection points, Sample Rate, and Block Length) inside GTT and the data inside the Device. The flash file on the target should match before Sending the Device configuration. If the data doesn’t match then the below transmission error is seen

The data in the device view (number of cores, physical cores, connection points, sample rate, and block length) and the data in the device. The flash file on the target device should match before the device configuration is sent. If the data doesn’t match, you will see the transmission error.

If any changes are made to the configuration, the send device config must be completed before sending the signal flow.

The device identification feature is enabled for audio libraries version 13 and higher.

Feedback Loop

In the device view, feedback connections are allowed. You can connect the output of any core object as input to any other core object.

Core object Id defines the order of execution of core objects. Execution order of any core object depends on the IO dependency. IO side dependency is not considered when there are feedback loops.

Self-loop is not supported as feedback.

In the image, connection highlighted in green color is a feedback connection.

The Send Signal Flow option sends the configuration of the signal flow design to the target device. You can also use this to test how the target device responds to specific test signals. In a test scenario, you can configure specific test signals and send them to the amplifier.

Using the Export option in the device view, you can export the device configuration data and the signal flow design details.

*.Core files would be created for each Virtual Core available in the device. One *.route file will be created for Device routing data. One .mcd file will be generated for master control data and one .SFD file will be generated per instance per core.

• One core file per virtual core in the signal flow.
• The core objects within the virtual core.
• The routing within those objects.
• The destination of the output pins of the virtual core.
• One signal flow file per xAF instance.
• This is the same legacy file.
• One input device routing file.
• This basically describes how the device input buffers are connected to the virtual cores and/or the device outputs.

The Control IDs are used to configure Custom Control IDs. Users can add, edit, export, and import Custom Control IDs data.

To open the Control IDs

1. On the Device View, click on the Control IDs. This opens the Custom Control IDs configuration window.
   The Custom Control IDs window shows all the custom control ID details.
   

To add the custom control ID

1. On the Custom Control IDs panel, click on Add. This opens the Add Control Signal window, where the user can enter the details of the new custom control.
   
   You need to enter details in all fields. The maximum value of control should be greater than the minimum value. The Control ID range should be between 61440 to 65535.
2. Click OK to save the custom control id details.

To edit the custom control ID

1. On the Custom Control IDs panel, click on the Edit icon. This opens the Edit Control Signal window, where the you can update or change the custom control details.
   
2. Click OK to update the custom control id details.

To delete the custom control ID

1. On the Custom Control IDs panel, click on the Delete icon. This deletes custom control and also removes its associated data.
   

To export the custom control ID

Using the export option, all custom control data can be exported in the provided destination directory with the file extension *.csv.

1. On the Custom Control IDs panel, click on Export. This opens the file directory.
   
2. Navigate to the desired location and click Save to export the file.

To import the custom control ID

Using the import option, all the custom control data can be imported to GTT.

1. On the Custom Control IDs panel, click on Import. This action opens the file directory.
   
2. Navigate to the file location and click Open to import the file.

This action will import all the custom control pins from the file (with *.csv extension) in the custom control list.

A message will appear if the file is invalid or does not contain the required data.

If GTT contains custom control IDs, it will ask for confirmation whether the user wants to overwrite them.

An error message will be displayed if the import file contains duplicate control IDs.

• Class Name: Display type of device and this property is read-only,
• Audio Library Version: Display the audio library version used in the selected device. You can change the audio library version. On the property panel, click on the audio library version, select the desired audio library version, and click save.
  
  If a device has a signal flow with audio objects created in an older version, compatible audio objects will upgrade automatically. Non-compatible audio objects in Signal Flow Designer will be highlighted in blue or displayed as a warning in the compiler; these audio objects can be upgraded using the audio object context menu.In the following cases device association with a dll cannot be changed.
  • If a device’s signal flow is open.
  • If you have a monitoring window open, such as a streaming or profiler window.

  A change in dll association for one device has no effect on other device instances.

• Device Id: Enter the ID of the selected device. Make sure the device ID should be unique.
• Node Address: The Node address of the selected device. Each device has a unique node address assigned to it.
• Name: Name of the device.
• MaxTuningDataSize: Maximum tuning data.
• System Context: Set the system context Init or Runtime.

The Device View is used to view and modify detailed information and settings for a specific device. Double-click on the desired device from the list to open a device template in the Device View.

Device Object Properties

A device is a combination of four layers: Device Layer, Physical Layer, Virtual Core Layer, and Core Object Layer. When you select any of the layer, you will see the properties of the selected layer on the right side.

Device Layer: Device layer properties include Device Name, Hardware, and Software version.

Device layer properties are not editable.

Physical Core Layer: Physical Core layer properties include Physical Core Name, Physical Core Type and MIPS.

The “Physical Core Name” property in the Physical Core layer properties can be changed, but the “Physical Core Type” and “MIPS” properties are non editable.

By default, the “Physical Core Name” property value is same as the “Physical Core Type”. If you want to change the physical core name, enter the value for “Physical Core Name”, the updated in the Physical Core layer value will be reflected in the device view, then click on save button to save the changes.

Only from the Device File editor window, you can update Physical Core Type.

If you keep the Physical Core Name field empty, GTT will ask you enter the valid name for “Physical Core Name”.

Virtual Core Layer: Virtual Core layer includes the following properties:

• Core Id: Display the core id.
• Core Name: Display the core name.
• Data Format: Display the date format type.
• Task Priority: Display the date priority value.
• Queue Size: Size of message queue
• Guard Time: Time to avoid message processing as percent of interrupt time.
• Ramp Time (ms): Duration between two processing state (in ms), when Core Object processing state is enabled.
• Core Object Processing State: Enable or disable processing state for Core objects in core.
• Streaming: Enable or disable streaming. Enabling steraming option allows you to set “Set Variables”, “Probe Points “, and “Level Meters”.

Queue Size and Guard Time will be supported only for Devices with audio library version “O” release and above or “M+2” release and above.

Enable Core Object Processing State and Ramp Time will be supported only for Devices with audio library version “O” release and above.

Processing state for Core objects will be applied only if Enable Core Object Processing State was enabled before Send Device Configuration.

Enable Probe Points and the Number of Probe Points will be supported only for Devices with audio library version S release and above.

Core Object Layer: Each core object has different properties. For more details refer to the ToolBox.

Magnifier options

1. Fit to Window: Click on this button will change the current view to the size of your device view window.
2. Zoom to 100%: Click on this button will return the view to 100% zoom.
3. Zoom In: Click on this button (+) to zoom in for gradual increments.
4. Zoom Slider: Slide to the desired percentage zoom setting.
5. Zoom Out: Click on this button (-) to zoom out for gradual decrement.

The Panel Designer comprises of various features, that offer you a thoughtfully designed, clean, and easy-to-use workspace. Using Panel Designer, you can quickly create a custom panel with all the elements you need and link the panel with a desired audio object. Let us have a look at some of the components of the Panel Designer workspace.

1. Panel Designer Ribbon: The Panel Designer ribbon contains tools for designing and editing the custom panel. The ribbon is divided into the following groups: Tools, Current Panel, Controls, Clipboard, Editing, Layout, and Parameters.
2. Panels View: The Panels view in Panel Designer displays all the custom panels and allows you to create, delete and import the custom panels. In addition, you can access the Venue Explorer to view available Device(s), Applications, and Parameter Sets.
3. Custom Panel Properties View: The Properties view displays the properties of each component used to design the custom Panel and also allows you to customize the Panel to meet your needs. The Properties view is displayed on the right-hand side of the screen.
4. Designer Workspace: You can use various tools available in the Toolbox to create a custom panel in the Designer workspace.
5. Editor Windows: In the Properties view you can customize the Panel using various editour windows. These editour windows are mapped with corresponding properties.

The Panel Designer ribbon contains tool for designing and editing the custom panel.

The Panel Designer ribbon comprises the following group.

• Controls
• Clipboard
• Editing
• Panels
• Layout
• Parameters

The Control group comprises of designer tools that allow you to design the custom panel. This includes Basic, Image, Advanced, Group, and Ungroup.

• Basic
• Image
• Advanced
• Group
• Ungroup

The first toolset is a group of basic design tools. The tools are grouped into the following toolset.

A text display is a dynamic text control on a Custom Panel that can be linked to the value of a specific device parameter. It shows the control value as it changes, much like a text box, but cannot be changed by the user.

Use either the Text Label or Note control to add static text to a Custom Panel.

A Text Display control can be managed in the Custom Panel designer and, once the Custom Panel is activated, viewed (but not changed) by the end user.

• Unlinked (Static) Text: If a label is not linked to a control, the text does not change on the control but is merely the default text as defined in the text attributes. Once another control is linked, the value is overridden by the parameter value.
• Linked (Updating) Text: If a label is linked to a control, on the activated Custom Panel it will reflect the value of the control as it changes, much like a text box. However, the value cannot be changed by the user.

Once a label is linked to a control, you can add a label showing the parameter address of the label.

Properties Type	Options
General	Control Info: Shows control type. Read only.
	Locked: Specifies if the control is locked out so that it cannot be moved or re-sized. Checked = Locked Unchecked = Unlocked
Parameters	Address: Enables panel designer to edit addressing information with the added benefit that the values can be validated as a group before being applied to the device. This editor also allows the user to assign multiple parameters to the control. Properties correspond to the system explorer.
	Information: Shows information about the Parameter Address. Read only. Properties correspond to the system explorer.
Appearance	Location: Control location (in pixels) of the control on the Custom Panel. Change X (horizontal) and Y (vertical) values in relation to upper left corner. You can also drag the control to a different location
	Size: Control size (in pixels). Change width and height values. You can also re-size the control manually.
	Background Image: Background image of the control.
	Background Color: Background color of the control.
	Paint Style: Background paint style of the control. Solid Brush – solid background Gradient Brush – gradient fill background
	Gradient Color Start: Beginning gradient color if gradient is selected in Paint Style.
	Gradient Color End: Ending gradient color if gradient is selected in Paint Style.
	Gradient Mode: Type of gradient fill if gradient is selected in Paint Style. Click to select type of gradient.
	Border Color: Border color of the control. Brings up the Select Color window. Default color is transparent
	Border Style: Click to select border style. Default style is flat
Text Attributes	Text: Enter the text for the Text Display. Default text is “TextDisplay1”.
	Text Font: Click on “…” to select desired font. Brings up a Font Select window. Selects from Windows fonts.
	Text Color: Text color of the control. Default color is black.
	Text Alignment: Alignment of the label text. Default alignment is middle center

 

A text label is a static text control on a Custom Panel. It is text only, cannot be linked to a device parameter, and is not interactive for the user.

Text Label controls can be managed in the Custom Panel designer and, once the Custom Panel is activated, viewed (but not changed) by the end user.

Properties Type	Options
General	Control Info: Shows control type. Read only.
	Locked: Specifies if the control is locked out so that it cannot be moved or re-sized. Checked = Locked Unchecked = Unlocked
Appearance	Location: Control location (in pixels) of the control on the Custom Panel. Change X (horizontal) and Y (vertical) values in relation to upper left corner. You can also drag the control to a different location
	Size: Control size (in pixels). Change width and height values. You can also re-size the control manually.
	Background Color: Background color of the control.
	Background Image: Background image of the control.
	Paint Style: Background paint style of the control. Solid Brush – solid background Gradient Brush – gradient fill background
	Gradient Color Start: Beginning gradient color if gradient is selected in Paint Style.
	Gradient Color End: Ending gradient color if gradient is selected in Paint Style.
	Gradient Mode: Type of gradient fill if gradient is selected in Paint Style. Click to select type of gradient
	Border Color: Border color of the control. Brings up the Select Color window. Default color is transparent
	Border Style: Click to select border style. Default style is flat
Text Attributes	Text Line: Enter the text for the Text Label. Default text is “TextDisplay1”.
	Text Font: Click on “…” to select desired font. Brings up a Font Select window. Selects from Windows fonts.
	Text Color: Text color of the control. Default color is black
	Text Alignment: Alignment of the label text. Default alignment is middle center.

 

A text box allows the user to specify the exact value of a device parameter by typing it in rather than running through a long list of values. In tablet mode, a keypad loads when a text box is selected.

Controls can be managed in the Custom Panel designer and, once the Custom Panel is activated, utilized by the end user. This control must be linked to a parameter to function properly.

Properties Type	Options
General	Control Info: Shows control type. Read only.
	Locked: Specifies if the control is locked out so that it cannot be moved or re-sized. Checked = Locked Unchecked = Unlocked
Parameters	Address: Enables panel designer to edit addressing information with the added benefit that the values can be validated as a group before being applied to the device. This editor also allows the user to assign multiple parameters to the control. Properties correspond to the system explorer.
	Information: Shows information about the Parameter Address. Read only. Properties correspond to the system explorer.
	Rest Text: Optional text to display in right click context popup
Appearance	Location: Control location (in pixels) of the control on the Custom Panel. Change X (horizontal) and Y (vertical) values in relation to upper left corner. You can also drag the control to a different location
	Size: Control size (in pixels). Change width and height values. You can also re-size the control manually.
	Background Color: Background color of the control.
	Border Color: Border color of the control. Brings up the Select Color window. Default color is transparent.
	Tool Tip Text: The text of the Tool Tip.
	Tab Index: If tab stop is checked, determines the position of the control in the tab order.
	Tab Stop: Specifies whether the control appears in the tab order. Checked = Appears Unchecked = Does not appear
Text Attributes	Text: Enter the text for the Text Display. Default text is “TextDisplay1”.
	Maximum Length: Maximum text input length.
	Text Alignment: Alignment of the label text. Default alignment is middle center.
	Text Font: Click on “…” to select desired font. Brings up a Font Select window. Selects from Windows fonts.
	Text Color: Color of the text on the control. Default color is black.
	Value Format: The number format used when displaying the value. # = number variable
	Text Border Style: Style of control border. Default style is flat
	Banner Scroll: Check this box to scroll the text.
	Banner Scroll Speed: The speed at which the text should scroll. Select between Slow, Medium, or Fast

 

A Fader Horizontal is an adjustable horizontally-positioned fader control that manipulates a device parameter.
Controls can be managed in the Custom Panel designer and, once the Custom Panel is activated, utilized by the end user. This control must be linked to a parameter to function properly.

Properties Type	Options
General	Control Info: The control type. Read only
	Locked: Specifies if the control is locked out so that it cannot be moved or re-sized. Checked = Locked Unchecked = Unlocked
Parameters	Addresses: Enables panel designer to edit addressing information with the added benefit that the values can be validated as a group before being applied to the device. This editor also allows the user to assign multiple parameters to the control. Click to select Parameter Address Editor. Properties correspond to the system explorer.
	Information: Shows information about the Parameter Address. Read only. Properties correspond to the system explorer
	Maximum: Maximum parameter value. The largest parameter value.
	Minimum: Minimum parameter value. The smallest parameter value.
	Reset Text: Optional text to display in right click context popup.
Appearance	Location: Control location (in pixels) of the control on the Custom Panel. Change X (horizontal) and Y (vertical) values in relation to upper left corner. You can also drag the control to a different location
	Size: Control size (in pixels). Change width and height values. You can also re-size the control manually
	Background Image: Brings up the Select Background Image window
	Background Color: Background color of the control
	Tool Tip Text: The text that appears on control mouse-over
	Tab Index: Determines the position of the control in the tab order
	Tab Stop: Specifies whether the control appears in the tab order. Checked = Appears Unchecked = Does not appear
Fader Cap	Fader Cap Image: The image displayed for the fader cap. Click Browse to locate custom fader caps
	Fader Cap Size: How large the fader cap will be
	Arrow Box Width: The width of the arrow box in pixels
	Vertical Offset: The vertical offset of the fader cap, in pixels, from the fader channel
	Horizontal Offset: The horizontal offset of the fader cap, in pixels, from the fader channel
	Hot Spot: Sets mouse sensitivity to the fader cap or the entire length of the slider
Channel	Channel Color: Color of the fader channel Default is Dim Gray
	Channel Width: Width of the fader channel in pixels
	Channel Start: Distance, as a percentage of length, from the bottom or left edge to where the fader channel will start
	Channel End: Distance, as a percentage of length, from the bottom or left edge to where the fader channel will end
	Channel Center: Distance, as a percentage of width, from the bottom or left edge to where the fader channel will be located
Scale	Display Tick Marks: Option to display the tick marks of the control. Must be set to true for custom ticks to display. Checked = Display Unchecked = Do not display
	Number of Major Ticks: How many major ticks are displayed
	Custom Ticks: Option to display custom tick values by utilizing the scale editor. Checked = Display Unchecked = Do not display
	Display Tick Values: Option to display the tick values.
	Value Format: Allows you to format the tick values.
	Major Tick Color: The color of the major tick.
	Major Tick Length: The length of the major tick.
	Number of Minor Ticks: How many minor ticks are displayed.
	Minor Tick Color: The color of the minor tick.
	Minor Tick Length: The length of the minor tick.
	Tick Location: The location of the tick marks relative to the fader channel.
	Font: The font for the ticks.
	Labels Inside: Whether labels are drawn between tick marks and fader channel or not. Checked = labels drawn between tick marks and channel Unchecked = tick marks drawn between labels and channel
	Labels Vertical: Whether labels are displayed vertically or horizontally. Checked = labels display vertically Unchecked = labels display horizontally, left to right
	Label Margin: The amount of space, as a decimal fraction of the width of the control, between the center channel and the tick marks
Nudge Button	Nudge Button Location: Location of the nudge buttons. None, Center, Above or Below
	Nudge Type: Determines, with the increment amount, how much the control will adjust when a nudge button is pressed. Percent – percentage of the total visual display of the control. For non-logarithmic controls, the visual display and the total value of the control will be the same. For logarithmic controls, the visual display will differ from the total value. Bump – small increment Value – specified increment amount
	Increment Amount: Determines with the nudge type; how much the control will adjust when a nudge button is pressed.
	Nudge Button Separation: Distance in pixels from the edge to the nudge button
	Up Image: The static image for the “up” nudge button. Click the button to select a new image.
	Up Pushed Image: Image that displays when the “up” nudge button is pushed. Click the button to select a new image.
	Down Image: The static image for the “down” nudge button. Click the button to select a new image.
	Down Pushed Image: The image that displays when the “down” nudge button is pushed. Click the button to select a new image.
Popup Value	Popup Value Position – Fraction: The location of the popup value as a decimal fraction of the width (X) and height (Y) of the control
	Display Popup Value: Displays the value of the control in a popup, if set to true. Checked = Display Unchecked = Do not display

 

A vertical fader is an adjustable vertically-positioned control that manipulates a device parameter.

Controls can be managed in the Custom Panel designer and, once the Custom Panel is activated, utilized by the end user. This control must be linked to a parameter to function properly.

Properties Type	Options
General	Control Info: The control type Read only
	Locked: Specifies if the control is locked out so that it cannot be moved or re-sized. Checked = Locked Unchecked = Unlocked
Parameters	Addresses: Enables panel designer to edit addressing information with the added benefit that the values can be validated as a group before being applied to the device. This editor also allows the user to assign multiple parameters to the control. Click to select Parameter Address Editor. Properties correspond to the system explorer.
	Information: Shows information about the Parameter Address. Read only. Properties correspond to the system explorer
	Maximum: Maximum parameter value. The largest parameter value.
	Minimum: Minimum parameter value The smallest parameter value.
	Reset Text: Optional text to display in context popup
Appearance	Location: Control location (in pixels) of the control on the Custom Panel. Change X (horizontal) and Y (vertical) values in relation to upper left corner. You can also drag the control to a different location
	Size: Control size (in pixels). Change width and height values. You can also re-size the control manually
	Background Image: Brings up the Select Background Image window
	Background Color: Background color of the control
	Tool Tip Text: The text that appears on control mouse-over
	Tab Index: Determines the position of the control in the tab order
	Tab Stop: Specifies whether the control appears in the tab order. Checked = Appears Unchecked = Does not appear
Fader Cap	Fader Cap Image: The image displayed for the fader cap. Click Browse to locate custom fader caps
	Fader Cap Size: The size of the fader cap.
	Fader Cap Offset: The vertical offset of the fader cap, in pixels, from the fader channel
	Hot Spot: Sets mouse sensitivity of the fader cap or the entire length of the slider.
Channel	Channel Color: Color of the fader channel. Default is Dim Gray
	Channel Width: Width of the fader channel in pixels
	Channel Start: Distance, as a percentage of length, from the bottom or left edge to where the fader channel will start
	Channel End: Distance, as a percentage of length, from the bottom or left edge to where the fader channel will end
	Channel Center: Distance, as a percentage of width, from the bottom or left edge to where the fader channel will be located
Scale	Display Tick Marks: Option to display the tick marks of the control. Must be set to true for custom ticks to display. Checked = Display Unchecked = Do not display
	Number of Major Ticks: How many major ticks are displayed
	Custom Ticks: Whether to use custom tick values by utilizing the scale editor. Checked = Display Unchecked = Do not display
	Display Tick Values: The value of the ticks to be displayed
	Value Format: The format of the tick values
	Major Tick Color: The color of the major tick
	Major Tick Length: The length of the major tick
	Number of Minor Ticks: How many minor ticks are displayed
	Minor Tick Color: The color of the minor tick
	Minor Tick Length: The length of the minor tick
	Tick Location: The location of the tick marks relative to the fader channel
	Font: The font for the ticks
	Labels Inside: Whether labels are drawn between tick marks and fader channel. Whether labels are drawn between tick marks and fader channel or not. Checked = labels drawn between tick marks and channel Unchecked = tick marks drawn between labels and channel
	Labels Vertical: Whether labels are displayed vertically or horizontally. Checked = labels display vertically Unchecked = labels display horizontally, left to right
	Label Margin: The amount of space, as a decimal fraction of the width of the control, between the center channel and the tick marks.
Nudge Button	Nudge Button Location: Location of the nudge buttons. None, Center, Above or Below
	Nudge Type: Determines, with the increment amount, how much the control will adjust when a nudge button is pressed. Percent – percentage of the total visual display of the control. For non-logarithmic controls, the visual display and the total value of the control will be the same. For logarithmic controls, the visual display will differ from the total value. Bump – small increment Value – specified increment amount
	Increment Amount: Determines, with the nudge type, how much the control will adjust when a nudge button is pressed.
	Nudge Button Separation: Distance, in pixels, from the edge to the nudge button
	Up Image: The static image for the “up” nudge button. Click the button to select a new image.
	Up Pushed Image: The image that displays when the “up” nudge button is pushed. Click the button to select a new image.
	Down Image: The static image for the “down” nudge button. Click the button to select a new image.
	Down Pushed Image: The image that displays when the “down” nudge button is pushed. Click the button to select a new image.
Popup Value	Popup Value Position – Fraction: The location of the popup value as a decimal fraction of the width (X) and height (Y) of the control
	Display Popup Value: Displays the value of the control in a popup, if set to true. Checked = Display Unchecked = Do not display

A multiparameter fader manipulates multiple device parameters.

Controls can be managed in the Custom Panel designer and, once the Custom Panel is activated, utilized by the end user. This control must be linked to a parameter to function properly.

On an activated Custom Panel, levels on a multiparameter fader can be adjusted together or individually

Properties Type	Options
General	Control Info: The control type Read only
	Locked: Specifies if the control is locked out so that it cannot be moved or re-sized. Checked = Locked Unchecked = Unlocked
Parameters	Addresses: Enables panel designer to edit addressing information with the added benefit that the values can be validated as a group before being applied to the device. This editor also allows the user to assign multiple parameters to the control. Click to select the Multi-Parameter Address Editor. Properties correspond to the system explorer.
	Information: Shows information about the Parameter Address. Read only. Properties correspond to the system explorer
	Maximum: Maximum parameter value. The largest parameter value.
	Minimum: Minimum parameter value. The smallest parameter value.
	Reset Text: Optional text to display in right click context popup
Appearance	Location: Control location (in pixels) of the control on the Custom Panel. Change X (horizontal) and Y (vertical) values in relation to upper left corner. You can also drag the control to a different location
	Size: Control size (in pixels). Change width and height values. You can also re-size the control manually
	Background Image: Brings up the Select Background Image window
	Background Color: Background color of the control
	Tool Tip Text: The text that appears on control mouse-over.
	Tab Index: Determines the position of the control in the tab order
	Tab Stop: Specifies whether the control appears in the tab order. Checked = Appears Unchecked = Does not appear
Arrow	Maximum Arrows: The maximum number of arrows to display.
	Arrow Direction: The direction the arrows should point. Point Left or Point Right
Fader Cap	Fader Cap Image: The image displayed for the fader cap. Click Browse to locate custom fader caps
	Fader Cap Size: How large the fader cap will be
	Arrow Box Width: The width of the arrow box in pixels
	Vertical Offset: The vertical offset of the fader cap, in pixels, from the fader channel
	Horizontal Offset: The horizontal offset of the fader cap, in pixels, from the fader channel
	Hot Spot: Sets mouse sensitivity to the fader cap or the entire length of the slider
	Highlight Color: The channel highlight color
	Arrow Box Separation: The distance between the arrow box and the fader channel in pixels.
	Label Margin: The amount of space, as a decimal fraction of the width of the control, between the center channel and the tick marks
Channel	Channel Color: Color of the fader channel Default is Dim Gray
	Channel Width: Width of the fader channel in pixels
	Channel Start: Distance, as a percentage of length, from the bottom or left edge to where the fader channel will start
	Channel End: Distance, as a percentage of length, from the bottom or left edge to where the fader channel will end
	Channel Center: Distance, as a percentage of width, from the bottom or left edge to where the fader channel will be located
Scale	Display Tick Marks: Option to display the tick marks of the control. Must be set to true for custom ticks to display. Checked = Display Unchecked = Do not display
	Number of Major Ticks: How many major ticks are displayed
	Tick Location: The location of the tick marks relative to the fader channel.
	Custom Ticks: Whether to use custom tick values by utilizing the scale editor or not. Checked = Display Unchecked = Do not display
	Display Tick Values: The value of the ticks to be displayed
	Value Format: The format of the tick values
	Labels Inside:
	Major Tick Color: The color of the major tick
	Major Tick Length: The length of the major tick
	Number of Minor Ticks: How many minor ticks are displayed
	Minor Tick Color: The color of the minor tick
	Minor Tick Length: The length of the minor tick
	Font: The font for the ticks
Nudge Button	Nudge Button Location: Location of the nudge buttons. None, Center, Above or Below
	Nudge Type: Determines, with the increment amount, how much the control will adjust when a nudge button is pressed. Percent – percentage of the total visual display of the control. For non-logarithmic controls, the visual display and the total value of the control will be the same. For logarithmic controls, the visual display will differ from the total value. Bump – small increment Value – specified increment amount
	Increment Amount: Determines, with the nudge type, how much the control will adjust when a nudge button is pressed.
	Nudge Button Separation: Distance, in pixels, from the edge to the nudge button
	Up Image: The static image for the “up” nudge button. Click the button to select a new image.
	Up Pushed Image: The image that displays when the “up” nudge button is pushed. Click the button to select a new image.
	Down Image: The static image for the “down” nudge button. Click the button to select a new image.
	Down Pushed Image: The image that displays when the “down” nudge button is pushed. Click the button to select a new image.
Popup Value	Popup Value Position – Fraction: The location of the popup value as a decimal fraction of the width (X) and height (Y) of the control
	Display Popup Value: Displays the value of the control in a popup, if set to true Checked = Display Unchecked = Do not display

 

 

Property Type	Options
General	Control Info: The control type. Read only
	Locked: Specifies if the control is locked out so that it cannot be moved or re-sized. Checked = Locked Unchecked = Unlocked
Parameters	Addresses: Enables panel designer to edit addressing information with the added benefit that the values can be validated as a group before being applied to the device. This editor also allows the user to assign multiple parameters to the control. Click to select Parameter Address Editor. Properties correspond to the system explorer
	Information: Shows information about the Parameter Address. Read only. Properties correspond to the system explorer
	Maximum: Maximum value a control can be set. The largest control value.
	Minimum: Minimum value a control can be set. The smallest control value.
	Reset Text: Optional text to display in right click context popup
Appearance	Location: Control location (in pixels) of the control on the Custom Panel. Change X (horizontal) and Y (vertical) values in relation to upper left corner. You can also drag the control to a different location
	Size: Control size (in pixels). Change width and height values. You can also re-size the control manually
	Background Image: Click to select background image.
	Background Color: Background color of the control.
	Foreground Color: Foreground color of the control
	Anti-Aliasing: Whether to draw with anti-aliasing or not. Checked = With anti-aliasing. Unchecked = Without anti-aliasing
	Tool Tip Text: The text that appears on control mouse-over
	Tab Index: If tab stop is set to true, determines the position of the control in the tab order
	Tab Stop: Specifies whether the control appears in the tab order. Checked = Appears Unchecked = Does not appear
Knob	Base Image: The image displayed for the inside of the knob
	Ring Image: The image displayed for the outside of the knob.
	Shading Image: The image used to simulate lighting/shading effects of the knob.
	Knob Size: The size of the knob. Set to 0,0 to reset to the actual image size.
	Start Position: The angular starting point from vertical.
	End Position: The angular ending point from vertical.
	Orientation: The movement of the knob from min to max.
Scale	Display Tick Mark: Display mark on the control, when set to “true”.
	Number of Major Ticks: The number of major tick marks displayed on the control.
	Custom Ticks: Option to use custom tick values by utilizing the scale editor. Checked = Display Unchecked = Do not display
	Display Tick Values: Displays the value of a tick mark next to major tick marks when set to “True”.
	Value Format: The format of the value displayed next to major tick marks. This is an advanced feature.
	Major Tick Color: The color of major tick marks.
	Major Tick Length: The length, in pixels, of major tick marks.
	Number of Minor Ticks: The number of minor tick marks display between major tick marks
	Minor Tick Color: The color of minor tick marks.
	Minor Tick Length: The length, in pixels, of minor tick marks
	Font: The font for the ticks
	Inner Distance: The distance between the center of the knob and the inside end of the tick marks.
	Label Separation: The distance between the outer end of the major tick marks and the edge of the labels in pixels.
Nudge Button	Nudge Button Location: Location of the nudge buttons. None, Left, Right, Above or Below
	Nudge Type: Determines, with the increment amount, how much the control will adjust when a nudge button is pressed. Percent – percentage of the total visual display of the control. For non-logarithmic controls, the visual display and the total value of the control will be the same. For logarithmic controls, the visual display will differ from the total value. Bump – small increment Value – specified increment amount
	Increment Amount: Determines, with the nudge type, how much the control will adjust when a nudge button is pressed.
	Nudge Button Separation: Distance, in pixels, from the edge to the nudge button
	Up Image: The static image for the “up” nudge button. Click the button to select a new image.
	Up Pushed Image: The image that displays when the “up” nudge button is pushed. Click the button to select a new image.
	Down Image: The static image for the “down” nudge button. Click the button to select a new image.
	Down Pushed Image: The image that displays when the “down” nudge button is pushed. Click the button to select a new image.
Popup Value	Popup Value Position – Fraction: The location of the popup value as a decimal fraction of the width (X) and height (Y) of the control
	Display Popup Value: Displays the value of the control in a popup, if set to true Checked = Display Unchecked = Do not display

 

A rotary encoder is an adjustable rotary control that manipulates a device parameter and displays values of a device parameter.

When a Custom Panel is activated, the rotary control (inner ring) changes the linked parameter values as the end user clicks and slides it around it to the desired value position (like twisting a nob). The rotary encoder is controlled by right-clicking with the mouse and moving to the top or right to increase the value and moving to the bottom or left to decrease the value.

The LED meter (outer ring) reflects the selected parameter values, which are usually the same as those linked to and adjusted by the rotary control.

Controls can be managed in the Custom Panel designer and, once the Custom Panel is activated, utilized by the end user. This control must be linked to a parameter to function properly.

Property Type	Options
General	Control Info: The control type. Read only
	Locked: Specifies if the control is locked out so that it cannot be moved or re-sized. Checked = Locked Unchecked = Unlocked
Parameters	Addresses: Enables panel designer to edit addressing information with the added benefit that the values can be validated as a group before being applied to the device. This editor also allows the user to assign multiple parameters to the control. Click to select Parameter Address Editor. Properties correspond to the system explorer
	Information: Shows information about the Parameter Address. Read only. Properties correspond to the system explorer
	Rotary Maximum: Maximum parameter value. The largest parameter value
	Rotary Minimum: Minimum parameter value The smallest parameter value
	Meter Maximum: Maximum meter value The largest meter value
	Meter Minimum: Minimum meter value The smallest meter value
	Reset Text: Optional text to display in right click context popup
Appearance	Location: Control location (in pixels) of the control on the Custom Panel. Change X (horizontal) and Y (vertical) values in relation to upper left corner. You can also drag the control to a different location
	Size: Control size (in pixels). Change width and height values. You can also re-size the control manually
	Background Image: Click to select background image.
	Background Color: Background color of the control.
	Foreground Color: Foreground color of the control
	Font: Font style for the text on the control. Click on “…” to select desired font. Selects from Windows fonts
	Mode String: User-definable description of mode
	Anti-Aliasing: Whether to draw with anti-aliasing or not. Checked = With anti-aliasing. Unchecked = Without anti-aliasing
	Tool Tip Text: The text that appears on control mouse-over
	Tab Index: If tab stop is set to true, determines the position of the control in the tab order
	Tab Stop: Specifies whether the control appears in the tab order. Checked = Appears Unchecked = Does not appear
Backing Circle	Radius: Radius for the backing circle as fraction of control size
	Color: Color of the backing circle Use “Transparent” to disable
	Border Width: Width of the backing circle border
	Border Color: Color of the backing circle border
Rotary	Encoder Multiplier: The amount that the turn of the rotary is multiplied to tune sensitivity
	Base Image: The image displayed for the inside of the knob. Brings up the Select Image File window.
	Ring Image: The image displayed for the outside of the knob. Brings up the Select Image File window.
	Knob Radius: The radius of the rotary knob as percent of control size. Must be less than meter inner radius but greater than half of the meter inner radius.
	Nudge Amount: Determines, with the nudge type, how much the control will adjust when up and down arrow keys are pressed
	Nudge Type: Determines, with the nudge amount, how much the control will adjust when up and down arrow keys are pressed. Percent – percentage of the total visual display of the control. For non-logarithmic controls, the visual display and the total value of the control will be the same. For logarithmic controls, the visual display will differ from the total value. Bump – small increment Value – specified nudge amount
Meter	Encoder Mode: The display mode for the LED elements. Clockwise is the default
	Outer Radius: The outside edge of the display meter as a percentage of the entire circle. Must be less than 1 (outer edge of control) and greater than the inner radius
	Inner Radius: The inside edge of the display meter as a percentage of the entire circle. Must be less than meter outer radius
	Starting Angle: Where the meter display starts Measured in degrees from where “0” is straight up (-180…180)
	Ending Angle: Where the meter display ends Measured in degrees from where “0” is straight up (-180…180)
	Separation Angle: The angle, in degrees, separating each segment
	Segment Count (1..360): The number of segments in the display
	Off Color: The “off” color of the control
	On Color: The “on” color of the control
	Segment Border Color: The color of the segment border

A standard button sends a single value each time that it is pressed. While a button can be linked to a device parameter, it is more typically linked to a system function.

Controls can be managed in the Custom Panel designer and, once the Custom Panel is activated, utilized by the end user. This control must be linked to a parameter to function properly.

On the following example, if “Preset 1” button is pushed, the 1st preset is selected for DriveRack #1. If “Preset 2” button is pushed, the 2nd preset is selected. Each button push overrides the value of the previous button push.

Property Type	Options
General	Control Info: Shows control type. Read only
	Locked: Specifies if the control is locked out so that it cannot be moved or re-sized. Checked = Locked Unchecked = Unlocked
Parameters	Addresses: Enables panel designer to edit addressing information with the added benefit that the values can be validated as a group before being applied to the device. This editor also allows the user to assign multiple parameters to the control. Click to select Parameter Address Editor. Properties correspond to the system explorer
	Information: Shows information about the Parameter Address. Read only. Properties correspond to the system explorer
	Press Value: Value sent when button is pressed
	System Functions: Brings up the System Function editor.
	Reset Text: Optional text to display in right click context popup
System Functions	System Functions: Assign specific system operations to be performed when the button is pressed. Brings up the System Function editor.
Appearance	Location: Control location (in pixels) of the control on the Custom Panel. Change X (horizontal) and Y (vertical) values in relation to upper left corner. You can also drag the control to a different location.
	Size: Control size (in pixels). Change width and height values. You can also re-size the control manually
	Background Image: Background graphic of control Brings up the Select Image File window.
	Tool Tip Text: Text that appears when mouse pointer hovers over control.
	Tab Index: Indicates the sequence of an element within the tabbing order of all focusable elements in the document.
	Tab Stop: Whether the control appears in the tab order. Checked = Appears Unchecked = Won’t appear
Button	Text: Text appearing on the control. Select and type desired label. Default text is “Button” with the number of the control (order added to the panel)
	Font: Font style for the text on the control. Click on “…” to select desired font. Selects from Windows fonts
	Text Color: Color of the text on the control
	Fill Color: Changes the Fill Color of the control, will not be visible if you have an image selected.
	Border Color: The color of the Button border

 

An on/off button alternately turns on or off a device parameter value when pressed.

Controls can be managed in the Custom Panel designer and, once the Custom Panel is activated, utilized by the end user. This control must be linked to a parameter to function properly.

Property Type	Options
General	Control Info: Shows control type. Read only
	Locked: Specifies if the control is locked out so that it cannot be moved or re-sized. Checked = Locked Unchecked = Unlocked
Parameters	Addresses: Enables panel designer to edit addressing information with the added benefit that the values can be validated as a group before being applied to the device. This editor also allows the user to assign multiple parameters to the control. Click to select Parameter Address Editor. Properties correspond to the system explorer
	Information: Shows information about the Parameter Address. Read only. Properties correspond to the system explorer
	On Value: Value sent when button is pressed
	Off Value: Value sent when button is released
	Reset Text: Optional text to display in right click context popup
Appearance	Location: Control location (in pixels) of the control on the Custom Panel. Change X (horizontal) and Y (vertical) values in relation to upper left corner. You can also drag the control to a different location.
	Size: Control size (in pixels). Change width and height values. You can also re-size the control manually
	Center Text: Centers the tool tip text on the control
	Tool Tip Text: Text that appears when mouse pointer hovers over control.
	Tab Index: Indicates the sequence of an element within the tabbing order of all focusable elements in the document.
	Tab Stop: Whether the control appears in the tab order. Checked = Appears Unchecked = Won’t appear
Button	Button Action: When an event occurs when the button is clicked.
	Font: Font style for the text on the control. Click on “…” to select desired font. Selects from Windows fonts
	On Indication: Sets the button label, label color, background color, and background image for the “on” state.
	Off Indication: Sets the button label, label color, background color, and background image for the “off” state. Brings up the State Indication Setup window.
	Enable Flashing: Enables button to flash.
	Flash Frequency: If flashing is enabled, sets the flashing frequency.
	Flash In Phase: If flashing is enabled, determines if button will flash in or out of phase with other buttons
	Flash On Indication: Sets the button label, label color, background color, and background image for the “flash on” state. Brings up the State Indication Setup window.
	Flash Off Indication: Sets the button label, label color, background color, and background image for the “flash off” state. Brings up the State Indication Setup window.
	Timed(ms): How long button will remain active when pressed in milliseconds

 

A momentary button turns on a device parameter value while it is being pressed and turns the value off when released.

Controls can be managed in the Custom Panel designer and, once the Custom Panel is activated, utilized by the end user. This control must be linked to a parameter to function properly.

Property Type	Options
General	Control Info: Shows control type. Read only
	Locked: Specifies if the control is locked out so that it cannot be moved or re-sized. Checked = Locked Unchecked = Unlocked
Parameters	Addresses: Enables panel designer to edit addressing information with the added benefit that the values can be validated as a group before being applied to the device. This editor also allows the user to assign multiple parameters to the control. Click to select Parameter Address Editor. Properties correspond to the system explorer
	Information: Shows information about the Parameter Address. Read only. Properties correspond to the system explorer
	On Value: Value sent when button is pressed
	Off Value: Value sent when button is released
	Reset Text: Optional text to display in right click context popup
Appearance	Location: Control location (in pixels) of the control on the Custom Panel. Change X (horizontal) and Y (vertical) values in relation to upper left corner. You can also drag the control to a different location.
	Size: Control size (in pixels). Change width and height values. You can also re-size the control manually
	Center Text: Centers the tool tip text on the control
	Tool Tip Text: Text that appears when mouse pointer hovers over control.
	Tab Index: Indicates the sequence of an element within the tabbing order of all focusable elements in the document.
	Tab Stop: Whether the control appears in the tab order. Checked = Appears Unchecked = Won’t appear
Button	Primary Font: Font style for the text on the control. Click on “…” to select desired font. Selects from Windows fonts
	On Primary Indication: Sets the button label, label color, background color, and background image for the “on” state.
	Off Primary Indication: Sets the button label, label color, background color, and background image for the “off” state. Brings up the State Indication Setup window.
	Enable Flashing: Enables button to flash.
	Flash Frequency: If flashing is enabled, sets the flashing frequency.
	Flash In Phase: If flashing is enabled, determines if button will flash in or out of phase with other buttons
	Flash On Indication: Sets the button label, label color, background color, and background image for the “flash on” state. Brings up the State Indication Setup window.
	Flash Off Indication: Sets the button label, label color, background color, and background image for the “flash off” state. Brings up the State Indication Setup window.
	Multi-line: When checked, changes the button for multi-line operation. A secondary set of certain properties are added to the button: Secondary Font, Secondary On Indication and Secondary Off Indication. Default state is unchecked. The Secondary Font, On Indication and Off indication options are identical to the Primary Font, On Indication and Off indication options.
	Bump up: When checked, bumps up the assigned parameter by the Bump % amount.
	Bump %: Sets the percentage amount for the Bump function.
	Bump Down: When checked, bumps down the assigned parameter by the Bump % amount.

 

A latching button alternately turns on or off a device parameter value when pressed.

Controls can be managed in the Custom Panel designer and, once the Custom Panel is activated, utilized by the end user. This control must be linked to a parameter to function properly.

Property Type	Options
General	Control Info: Shows control type. Read only
	Locked: Specifies if the control is locked out so that it cannot be moved or re-sized. Checked = Locked Unchecked = Unlocked
Parameters	Addresses: Enables panel designer to edit addressing information with the added benefit that the values can be validated as a group before being applied to the device. This editor also allows the user to assign multiple parameters to the control. Click to select Parameter Address Editor. Properties correspond to the system explorer
	Information: Shows information about the Parameter Address. Read only. Properties correspond to the system explorer
	On Value: Value sent when button is pressed
	Off Value: Value sent when button is released
	Reset Text: Optional text to display in right click context popup
Appearance	Location: Control location (in pixels) of the control on the Custom Panel. Change X (horizontal) and Y (vertical) values in relation to upper left corner. You can also drag the control to a different location.
	Size: Control size (in pixels). Change width and height values. You can also re-size the control manually
	Center Text: Centers the tool tip text on the control
	Tool Tip Text: Text that appears when mouse pointer hovers over control.
	Tab Index: Indicates the sequence of an element within the tabbing order of all focusable elements in the document.
	Tab Stop: Whether the control appears in the tab order. Checked = Appears Unchecked = Won’t appear
Button	Button Action: When an event occurs when the button is clicked.
	Font: Font style for the text on the control. Click on “…” to select desired font. Selects from Windows fonts
	On Indication: Sets the button label, label color, background color, and background image for the “on” state.
	Off Indication: Sets the button label, label color, background color, and background image for the “off” state. Brings up the State Indication Setup window.
	Enable Flashing: Enables button to flash.
	Flash Frequency: If flashing is enabled, sets the flashing frequency.
	Flash In Phase: If flashing is enabled, determines if button will flash in or out of phase with other buttons
	Flash On Indication: Sets the button label, label color, background color, and background image for the “flash on” state. Brings up the State Indication Setup window.
	Flash Off Indication: Sets the button label, label color, background color, and background image for the “flash off” state. Brings up the State Indication Setup window.

 

A multi-state button both sets and displays a defined value of a device parameter. While the multi-state button is somewhat complex to set-up, its function can be very powerful. To set up an MS button, first you add (and link) the button, then change its properties. You must also define the button action. You can also change its other properties.

Controls can be managed in the Custom Panel designer and, once the Custom Panel is activated, utilized by the end user. This control must be linked to a parameter to function properly.

A multi-state button can be powerful but very complex, save your venue before adding or editing a multi-state button.

• Sets Value: Once the multi-state button is linked and defined, the parameter on the Custom Panel changes the parameter(s) on the device control panel(s):
• Multiple Device Parameters – If the multi-state button is linked to more than one device parameter, when the multi-state button on the Custom Panel is pushed, all the attached device parameters will be set to the specified value.
• Displays Value: Once the multi-state button is linked and defined, the parameter on the device control changes the parameter on the Custom Panel as defined in the properties section:
  • Multiple Device Parameters – If the multi-state button is linked to more than one device parameter, the multi-state button on the Custom Panel will update the device parameters with the new value.
• Add Multi-State Button: Add a multi-state button the same way you add other controls and link it to one or more device parameters
• Change button properties – In order for the linked multi-state button to work properly, you must define how the property works. This is accomplished in Properties in the “Value Indication Matrix” window. You must also set the button action.

Property Type	Options
General	Control Info: Shows control type. Read only
	Locked: Specifies if the control is locked out so that it cannot be moved or re-sized. Checked = Locked Unchecked = Unlocked
Parameters	Addresses: Enables panel designer to edit addressing information with the added benefit that the values can be validated as a group before being applied to the device. This editor also allows the user to assign multiple parameters to the control. Click to select Parameter Address Editor. Properties correspond to the system explorer
	Information: Shows information about the Parameter Address. Read only. Properties correspond to the system explorer
	Value Matrix: Allows changes to the button states, and images associated with each state
	Reset Text: Optional text to display in right click context popup
Appearance	Location: Control location (in pixels) of the control on the Custom Panel. Change X (horizontal) and Y (vertical) values in relation to upper left corner. You can also drag the control to a different location.
	Size: Control size (in pixels). Change width and height values. You can also re-size the control manually
	Background Image: Background graphic of control Brings up the Select Image File window.
	Background Color: Background color of control Brings up the Select Color window.
	Font: Font style for the text on the control. Click on “…” to select desired font. Selects from Windows fonts
	Center Text: Centers the tool tip text on the control
	Tool Tip Text: Text that appears when mouse pointer hovers over control.
	Tab Index: Indicates the sequence of an element within the tabbing order of all focusable elements in the document.
	Tab Stop: Whether the control appears in the tab order. Checked = Appears Unchecked = Won’t appear
Button	Button Action: When an event occurs when the button is clicked. OnUp, OnDown, or OnBoth

 

A radio button allows the user to select the value of a device parameter from a list.

Controls can be managed in the Custom Panel designer and, once the Custom Panel is activated, utilized by the end user. This control must be linked to a parameter to function properly.

Property Type	Options
General	Control Info: Shows control type. Read only
	Locked: Specifies if the control is locked out so that it cannot be moved or re-sized. Checked = Locked Unchecked = Unlocked
Parameters	Addresses: Enables panel designer to edit addressing information with the added benefit that the values can be validated as a group before being applied to the device. This editor also allows the user to assign multiple parameters to the control. Click to select Parameter Address Editor. Properties correspond to the system explorer
	Information: Shows information about the Parameter Address. Read only. Properties correspond to the system explorer
	Value List: Allows editing of the value range of the control. Brings up the Discrete Values Editor.
	Reset Text: Optional text to display in right click context popup
Appearance	Location: Control location (in pixels) of the control on the Custom Panel. Change X (horizontal) and Y (vertical) values in relation to upper left corner. You can also drag the control to a different location.
	Size: Control size (in pixels). Change width and height values. You can also re-size the control manually
	Text Color: Text color of the item text. Brings up the Select Color window.
	Background Color: Text that appears when mouse pointer hovers over control.
	Font: Font style for the text on the control. Click on “…” to select desired font. Selects from Windows fonts
	Tool Tip Text: Text that appears on control mouse-over.
	Tab Index: Indicates the sequence of an element within the tabbing order of all focusable elements in the document.
	Tab Stop: Whether the control appears in the tab order. Checked = Appears Unchecked = Won’t appear
Button	Alignment: Alignment of the button nubs. vertical horizontal
	Diameter: Diameter of the radio button nubs
	Style: The style (color) of the nubs. Select from the pull-down list.
	Border Style: The style of the control border. Select from the pull-down list
	Top Margin: Distance of the values, in pixels, from the top border of the control.
	Bottom Margin: Distance of the values, in pixels, from the bottom border of the control.
	Left Margin: Distance of the values, in pixels, from the left border of the control.
	Right Margin: Distance of the values, in pixels, from the right border of the control.

 

This button sends a single value each time that it is pressed. While a button can be linked to a device parameter, it is more typically linked to a system function.

Controls can be managed in the Custom Panel designer and, once the Custom Panel is activated, utilized by the end user. This control must be linked to a parameter or system function to function properly. You can also easily add a pre-defined label.

On the following example, if “Preset 1” button is pushed, the 1st preset is selected for DriveRack #1. If “Preset 2” button is pushed, the 2nd preset is selected. Each button push overrides the value of the previous button push.

Property Type	Options
General	Control Info: Shows control typey. Read only
	Locked: Specifies if the control is locked out so that it cannot be moved or re-sized. Checked = Locked Unchecked = Unlocked
Parameters	Addresses: Enables panel designer to edit addressing information with the added benefit that the values can be validated as a group before being applied to the device. This editor also allows the user to assign multiple parameters to the control. Click to select Parameter Address Editor. Properties correspond to the system explorer
	Information: Shows information about the Parameter Address. Read only. Properties correspond to the system explorer
	On Value: Value sent when button is pressed
	Off Value: Value sent when button is released
	Color 0 to Color 63: Background color of control Brings up the Select Color window.
	Indication same as Button: The value sent when the button is pressed.
System Indication	On State Logic: Link device state to the On state of the Region Button. Brings up the Indication Configuration editor.
	On Color: The color of the region when in the On state. Brings up the Select Color window.
	Partial State Logic: Link device state to the partial state of the region button. Brings up the Indication Configuration editor.
	Partial Color: The color of the region when in the Partial state. Brings up the Select Color window.
	Off Color: The color of the region when in the Off state. Brings up the Select Color window.
System Functions	System Functions: Assign specific system operations to be performed when the button is pressed. Brings up the System Function editor.
Appearance	Location: Control location (in pixels) of the control on the Custom Panel. Change X (horizontal) and Y (vertical) values in relation to upper left corner. You can also drag the control to a different location.
	Size: Control size (in pixels). Change width and height values. You can also re-size the control manually
	Transparency: Percent transparent, between 0 (opaque) and 90 (very transparent) Brings up the Select Image File window.
	Hover Transparency: Percent transparent when the mouse pointer is over the region
	Border Color: The color of the border. Brings up the Select Color window.
	Border Width: The width of the border (in pixels)

 

A System Functions button sends a single value each time that it is pressed. This button is specifically linked to a system function.

Controls can be managed in the Custom Panel designer and, once the Custom Panel is activated, utilized by the end user. This control must be linked to a parameter to function properly.

Property Type	Options
General	Control Info: Shows control type. Read only
	Locked: Specifies if the control is locked out so that it cannot be moved or re-sized. Checked = Locked Unchecked = Unlocked
System Functions	System Functions: Assign specific system operations to be performed when the button is pressed. Brings up the System Function editor.
Appearance	Location: Control location (in pixels) of the control on the Custom Panel. Change X (horizontal) and Y (vertical) values in relation to upper left corner. You can also drag the control to a different location.
	Size: Control size (in pixels). Change width and height values. You can also re-size the control manually
	Tool Tip Text: Text that appears on control mouse-over.
	Tab Index: Indicates the sequence of an element within the tabbing order of all focusable elements in the document.
	Tab Stop: Whether the control appears in the tab order. Checked = Appears Unchecked = Won’t appear
Button	Button Action: Determines which event occurs when the button is clicked. OnClick is recommended. OnClick, OnDown or OnUp
	Font: Font style for the text on the control. Click on “…” to select desired font. Selects from Windows fonts
	Text Color: Color of the text on the control Brings up the Select Color window.
	Button Image: The image displayed as the button. Brings up the Select Image File window.
	On Color: The color of the button in the On state Brings up the Select Color window.
	Off Color: The color of the button in the Off state Brings up the Select Color window.
	On Text: The text displayed on the button in the On state
	Off Text: The text displayed on the button in the Off state
	Mixed Text: The text displayed on the button when in a mixed state

 

A Combo Box allows the user to select the value of a device parameter from a drop-down list.

Controls can be managed in the Custom Panel designer and, once the Custom Panel is activated, utilized by the end user. This control must be linked to a parameter to function properly.

Property Type	Options
General	Control Info: Shows control type. Read only
	Locked: Specifies if the control is locked out so that it cannot be moved or re-sized. Checked = Locked Unchecked = Unlocked
Parameters	Addresses: Enables panel designer to edit addressing information with the added benefit that the values can be validated as a group before being applied to the device. This editor also allows the user to assign multiple parameters to the control. Click to select Parameter Address Editor. Properties correspond to the system explorer
	Information: Shows information about the Parameter Address. Read only. Properties correspond to the system explorer
	Value List: Allows editing of the value range of the control. Brings up the Discrete Values Editor.
	Reset Text: Optional text to display in right click context popup
Appearance	Location: Control location (in pixels) of the control on the Custom Panel. Change X (horizontal) and Y (vertical) values in relation to upper left corner. You can also drag the control to a different location.
	Size: Control size (in pixels). Change width and height values. You can also re-size the control manually
	Tool Tip Text: Text that appears on control mouse-over.
	Tab Index: Indicates the sequence of an element within the tabbing order of all focusable elements in the document.
	Tab Stop: Whether the control appears in the tab order. Checked = Appears Unchecked = Won’t appear
Combo Box	Background Color: The background color of the Combo Box Brings up the Select Color window
	Text Color: The color of the Combo Box text Brings up the Select Color window.
	Font: Font style for the text in the box. Click on “…” to select desired font. Selects from Windows fonts.
	Style: Sets the appearance and functionality of the Combo Box. Select from Drop Downlist, Simple or Drop-down
	Selected Item Color: The color of the selected item. Brings up the Select Color window.

 

A List Box allows the user to select the value of a device parameter from a list.

Controls can be managed in the Custom Panel designer and, once the Custom Panel is activated, utilized by the end user. This control must be linked to a parameter to function properly.

Property Type	Options
General	Control Info: Shows control type. Read only
	Locked: Specifies if the control is locked out so that it cannot be moved or re-sized. Checked = Locked Unchecked = Unlocked
Parameters	Addresses: Enables panel designer to edit addressing information with the added benefit that the values can be validated as a group before being applied to the device. This editor also allows the user to assign multiple parameters to the control. Click to select Parameter Address Editor. Properties correspond to the system explorer
	Information: Shows information about the Parameter Address. Read only. Properties correspond to the system explorer
	Value List: Allows editing of the value range of the control. Brings up the Discrete Values Editor.
	Reset Text: Optional text to display in right click context popup
Appearance	Location: Control location (in pixels) of the control on the Custom Panel. Change X (horizontal) and Y (vertical) values in relation to upper left corner. You can also drag the control to a different location.
	Size: Control size (in pixels). Change width and height values. You can also re-size the control manually
	Tool Tip Text: Text that appears on control mouse-over.
	Tab Index: Indicates the sequence of an element within the tabbing order of all focusable elements in the document.
	Tab Stop: Whether the control appears in the tab order. Checked = Appears Unchecked = Won’t appear
List Box	Background Color: The background color of the Combo Box Brings up the Select Color window.
	Text Color: The color of the Combo Box text Brings up the Select Color window.
	Font: Font style for the text in the box. Click on “…” to select desired font. Selects from Windows fonts.
	Border Style: Sets the style of the List Box border. Choose from syles in a drop down list
	Selected Item Color: The color of the selected item. Brings up the Select Color window.

 

A Checkbox turns on or off a device parameter value when pressed.

Controls can be managed in the Custom Panel designer and, once the Custom Panel is activated, utilized by the end user. This control must be linked to a parameter to function properly.

Property Type	Options
General	Control Info: Shows control type. Read only
	Locked: Specifies if the control is locked out so that it cannot be moved or re-sized. Checked = Locked Unchecked = Unlocked
Parameters	Addresses: Enables panel designer to edit addressing information with the added benefit that the values can be validated as a group before being applied to the device. This editor also allows the user to assign multiple parameters to the control. Click to select Parameter Address Editor. Properties correspond to the system explorer
	Information: Shows information about the Parameter Address. Read only. Properties correspond to the system explorer
	Value List: Allows editing of the value range of the control. Brings up the Discrete Values Editor.
	Reset Text: Optional text to display in right click context popup
Appearance	Location: Control location (in pixels) of the control on the Custom Panel. Change X (horizontal) and Y (vertical) values in relation to upper left corner. You can also drag the control to a different location.
	Size: Control size (in pixels). Change width and height values. You can also re-size the control manually
	Background Image: Background image of the control Brings up the Select Image File window.
	Text Color: Text color of the item text. Brings up the Select Color window.
	Background Color: Text that appears when mouse pointer hovers over control.
	Font: Font style for the text on the control. Click on “…” to select desired font. Selects from Windows fonts.
	Tool Tip Text: Text that appears on control mouse-over.
	Tab Index: Indicates the sequence of an element within the tabbing order of all focusable elements in the document.
	Tab Stop: Whether the control appears in the tab order. Checked = Appears Unchecked = Won’t appear
	Top Margin: The amount of space, in pixels at the top of the control where a label may be placed
	Bottom Margin: The amount of space, in pixels at the bottom of the control where a label may be placed
	Left Margin: The amount of space, in pixels to the left of the control where a label may be placed
	Right Margin: The amount of space, in pixels to the right of the control where a label may be placed
Combo Box	Check Box Text: The text shown in the Checkbox.
	Checkbox Size: The size of the Checkbox in pixels.
	Checkbox Style: The Checkbox style. Normal, flat, and various colors
	Label Separation: The space, in pixels between the checkbox and the checkbox text

 

A Spinner allows the user to change the value of a device parameter by adjusting it up or down; the increment can be specified by the Custom Panel designer.

Controls can be managed in the Custom Panel designer and, once the Custom Panel is activated, utilized by the end user. This control must be linked to a parameter to function properly.

Property Type	Options
General	Control Info: Shows control type. Read only
	Locked: Specifies if the control is locked out so that it cannot be moved or re-sized. Checked = Locked Unchecked = Unlocked
Parameters	Addresses: Enables panel designer to edit addressing information with the added benefit that the values can be validated as a group before being applied to the device. This editor also allows the user to assign multiple parameters to the control. Click to select Parameter Address Editor. Properties correspond to the system explorer
	Information: Shows information about the Parameter Address. Read only. Properties correspond to the system explorer
	Maximum: The maximum value that a control may be set to
	Minimum: The minimum value that a control may be set to
	Disable Mixed-sate Editor: When checked, disables the mixed-state context menu and editor
	Reset Text: Optional text to display in right click context popup.
Appearance	Location: Control location (in pixels) of the control on the Custom Panel. Change X (horizontal) and Y (vertical) values in relation to upper left corner. You can also drag the control to a different location.
	Size: Control size (in pixels). Change width and height values. You can also re-size the control manually
	Border Style: The style of the Spinner border. Choose from drop down menu.
	Border Color: The color of the Spinner border Brings up the Select Color window.
	Top Margin: The amount of space, in pixels at the top of the control where a label may be placed
	Bottom Margin: The amount of space, in pixels at the bottom of the control where a label may be placed
	Left Margin: The amount of space, in pixels to the left of the control where a label may be placed
	Right Margin: The amount of space, in pixels to the right of the control where a label may be placed
	Tool Tip Text: Text that appears on control mouse-over.
	Tab Index: Indicates the sequence of an element within the tabbing order of all focusable elements in the document.
	Tab Stop: Whether the control appears in the tab order. Checked = Appears Unchecked = Won’t appear
Text Attributes	Text Font: The font of the Spinner text. Choose from Windows fonts.
	Text Color: The color of the Spinner text Brings up the Select Color window.
	Background Color: The background color of the text area Brings up the Select Color window.
	Value Format: The format used when displaying the value. This is an advanced feature and must follow English conventions.
	Text Alignment: The horizontal alignment of the text. Left, center or right
	Text Border Style: The border style of the text area. Choose from drop down menu
Nudge Buttons	Nudge Type: Together with the Increment Amount, determines the amount that the control will increment/decrement when a Nudge Button is pressed. Percent, bump or value
	Increment: Together with the Nudge Type, determines the amount that the control will increment/decrement when a Nudge Button is pressed.
Spinner Attributes	Spinner Position: Specifies where the up/down arrows are to be located. Right or TopBottom
	Spinner Width: Sets the size of the up/down arrow buttons, in percent of width or height.
	Spinner Button Color: The color of the up/down arrow buttons. Brings up the Select Color window.
	Spinner Arrow Color: The color of the up/down arrows. Brings up the Select Color window.
	Arrow Width: The width of the base as a percentage of the spinner button width.