Importing and Exporting Set File

The GTT allows you to import and export a set file, these set file is in human-readable set format. There are multiple ways to import the set file.

Importing Set File

Using import you can load a .set or .setr file.

  1. On the Parameter Set tab, chosen the Set column, and click on the on the Import
    Or
    Right-click on the chosen Set column to open the context menu and select Import Set File option.
    This opens a dialog box to select the .setr file (human readable set file).

  2. Browse the location, select the .set or .setr file, and click Open. Once the set or .setr file selected, the device processing blocks will be updated with the tuning information extracted from the imported file.
    A screenshot of a computer Description automatically generated

GTT will highlight values excluded from import, invalid values, and autocorrected values after import. You can use filter options to view these values.

Hover over the cells to see tooltips indicating whether the imported data is excluded.

Tuning data is imported to the chosen set upon selection of the .setr file. When you click “Undo”, the import action is reversed, and the screen displays the previous preset values.
Only matching (CoreId, InstanceId, BlockId, and SublockId) objects tuning data will be imported.
Graphical user interface, application Description automatically generated

Tuning data will be imported only in the parameter set column. Not on to the state variables.

The following notifications are displayed in the cases mentioned below:

  • If there are additional objects in .set or .setr file then set group a notification message will be displayed.
  • If there are additional objects in the set group, then in .set and .setr file a notification message will be displayed.
  • If there is a mismatch in the size of the AO a notification message will be displayed.
  • If there is mismatch in state variable names, a notification message will be displayed.
  • If there are mismatching objects in both .set and .setr file and set group, a notification message will be displayed.
  • If an error occurs while importing to Device, below message will be displayed.
    A screenshot of a computer Description automatically generated with low confidence

All the mismatched object details will be displayed in the event log.

Exporting Set File

Using export you can export a .set or .setr file.

  1. On the Parameter Set tab, chosen the Set column, and click on the Export.
    Or
    Right-click on the chosen Set column to open the context menu and select Export Set File.

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.
A screenshot of a computer Description automatically generated

Configure Parameter Set Data

Using the settings you can configure the Parameter Set Data.

To configure the parameter set data:

  1. Select any parameter set column, right-click, and select Settings. This displays the settings dialog box.
  • The “Edit” option is a toggle button that defaults to a disabled state to prevent unintentional edits.
  • When the “Edit” option is enabled, you can edit all fields except the Tuning tool version and String Value.
  • The tuning tool version is installed GTT Tool version and gets auto-populated.
  • By default, the product name will be the name of the device.
  • You can independently update each of the header metadata, Product name, Sink name, Flowchart version, and Set version.
  • You can include or exclude header metadata, which can be controlled by the Include Header option.
  • The Include Header option performs a data merge operation when the option is selected. This means that the header metadata is prepended to User Data, and it will be reflected in both the String Values section and in hex format in the Hex Values section.
  • Any modification done to any header metadata or user data will immediately be reflected in the String Value and Hex Values at the appropriate index.
  • Header metadata can only be included once.
  • There is no limitation on the number of characters entered in User data or Hex Values.
  • You can either enter values in the User data section or Hex values. Editing in the Hex Values section would clear the content of the User data and vice versa.
  • All information is persistent and can be retained and displayed when the settings window is relaunched.
  • String Values or Hex Values will be stored and loaded in hex format. And it can be exported or imported from the .Set file and .Setr file.

User settings created using an older version of GTT (W onwards), all the data would be treated as User data, including the header part if it was included.
You must clear the header information manually if the user data already includes header information. The header part can then be included as required. This is because earlier header metadata was editable, which is now controlled due to separate edit sections. This is a one-time process and would not require X release onwards.

Parameter Set Components

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

  1. Parameter Set Ribbon: 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. Parameter Sets View: This section displays the list of projects. In addition, you can add and delete a parameter set group.
  3. Venue Explorer: This section displays core objects. Core objects that are part of the Audio Core (virtual core) and operate at a higher level than audio objects.
  4. Tuning Panel: The workspace is used to add audio object/ xAF instance and program the device core.

Parameter Set Ribbon

Clipboard You can select either a single value or multiple values from a set to copy.
To select a single value, click on the cell. If you want to select multiple values, hold down the Shift or Ctrl key while clicking on the cells to choose them for copying.

  • Clear Selection: If you have selected multiple cells and want to clear them without copying, you can click on the “Clear Selection” option in the ribbon bar or click on any other set.
  • Copy: You can use the Ribbon bar’s copy option or the keyboard shortcut CTRL+C to copy the values of selected cells.
  • Paste: You can paste selected values into the same or a different set using the paste option in the ribbon bar or by using the keyboard shortcut CTRL+V. First, select the cell in the set where you want to paste the values. Then click on ‘Paste,’ and it will paste all the copied values in sequence into the set.

When pasting, values are validated; invalid or autocorrected values will be highlighted in the cells, along with tooltips indicating whether the data is autocorrected or invalid.

AutoCorrected values can be reviewed and corrected if needed.
Invalid data must be corrected. Without correction, the system will not allow you to move from parameter sets.

Editing
  • Undo: Allows you to undo changes (Ctrl+Z).
  • Redo: Allows you to redo several actions (Ctrl+Y).
  • Delete: Deletes the current selection.
Set
  • New: Creates a new preset with default values. For more details, refer to Create a Parameter Set.
  • Duplicate: Use the “Duplicate” option to create a copy of the set and set group.
    • To duplicate a set: Select a set column and click Duplicate. A duplicate set column will be added next to the existing set.
    • To duplicate a set group: Select a set group and click Duplicate. A duplicate set group will be added in the parameter set view.
  • Default Values: Use the “Default Values” option to reset all the parameters of the selected set to their default values.
  • Retrieve: Retrieve the current set of values from the state variables. For more details, refer to Retrieve Parameter Sets.
  • Apply Delta: To send only the Preset parameter values that are updated in the selected set (i.e. the values of changed parameters). The tuning values of the presets are sent to the device via XTP messages. For more details, refer to Apply Delta in Parameter Sets.
  • Apply:  To send all preset parameter values of the selected set to the device.
  • Verify: To compare the presets loaded on a device with the presets available in the GTT in order to ensure their accuracy. For more details, refer to Verify Parameter Sets.
  • Export: To export you can export a .set or .setr file, refer to Import and Export Set File.
  • Import: GTT will highlight values excluded from import, invalid values, and autocorrected values after import. You can use filter options to view these values. The clear warning will remove the highlighted color from these excluded import values, refer to Import and Export Set File.
Venue

Sort By Name: Allows sorting the parameter sets explorer data in alphabetical order. It will sort all items by Name.

Sort By HiQNetId: Allows to sort explorer data in HiQNetId order.

By default, the parameter sets explorer shows data in HiQNetId order.

Preset Comparison
  • Compare Presets: Sequential comparison of 2 selected Presets.
  • Next: Navigate to the next mismatch cell value.
  • Previous: Navigate to the previous mismatch cell value.
  • Clear Comparison: Discard and disable all the preset comparison functionality.

By default, Presets Comparison ribbon buttons will be disabled.

For more details about Preset Comparison, refer to Preset Comparison.

Views
  • Errors: To filter and view only invalid values.
  • Warnings: To filter and view auto-correct values.
  • Exclude import data: To filter and view excluded import values.
  • Reset: To reset the view back to the original state.
  • Clear Warnings: Remove highlighted color from autocorrected values and clear all warnings.
File Save: To save changes made in the parameter sets window.

The Save option will check that all required data is present before allowing the save. When a device is removed or GTT is closed, parameter sets are automatically saved.

When you navigate from the “Parameter Sets” tab to another tab in GTT, a confirmation message will appear, asking if you would like to save any unsaved changes.
If you choose “Yes,” your changes will be saved immediately, ensuring that your updates are applied. If you select “No,” your changes will not be discarded; instead, they will be retained in memory for later use.
Additionally, GTT will automatically save any changes when you close the application.

Parameter Sets View

The Parameter Sets section allows you to perform the following actions:

  • Add a new parameter set group.
  • Provides options to remove the set group.
  • Allows to secure a set group.

Securing a set group: Securing set group options prevents unauthorized editing of group data. You can lock individual set groups with a password.

For the locked set group following restrictions are added:

  • Deleting a set group, set or any object from a locked set group.
  • Renaming the set group or set
  • New, duplicate, default values, retrieve, and import.
  • Editing the set value
  • Dragging a new object to the locked set group.
  • Copy and paste the set values.

To lock a specific group, click on the lock icon. A prompt will appear asking for a password. Enter the password and click OK.

It will display a success message and lock the respective set group.

To unlock the group, click on the unlock icon. It will prompt you for a password; enter a valid password to unlock the set group.

Venue Explorer

In venue explorer allows you to navigate and explore various parameter set groups and audio objects. Drag and drop the desired objects you wish to have presets configured in onto the workspace.

Parameter Sets Explorer Color scheme: Parameter Set uses the following color scheme to represent the usage of nodes in the set group.

  • Yellow: To represent partial use of the object state variables.
  • Green: To represent complete use of the node.
  • No color: To represent, the node is not used in the set group.
    Graphical user interface Description automatically generated

Colors are visible in Explorer only for Parameter sets. Colors are updated when something gets updated in the Set group.
You can easily determine which nodes from the Explorer are a part of Set Group and which ones are not by using the color coding. This will enable to modify the set group further.

Tuning Panel

The tuning panel shows the tuning data of the audio objects used in the SFD. You can perform the following actions on the tuning panel.

  • Modify the tuning data of the audio objects.
  • Manage or filter the columns and set groups.
  • Search the audio objects.
  • Stores the tuning data in set files. These files are in Intel Hex format.

Save the modification or progress of tuning of audio objects.

AO Visualization

To view audio objects added in parameter sets, the “AO Visualization” view can be used.

You can view the compact view of the device, cores, and audio objects by checking “AO Visualization” checkbox in the header.  On unchecking this checkbox, the default view of parameter sets will be shown. This compact view is specific to each set group, so you can enable this for one set group and view the default view for another.

Operations such as adding new parameters by drag and drop, deleting parameters, and creating new sets are allowed in the AO Visualization view, but the view will be reset back to default.

Search Parameter Sets

A search box is available on the top right of the window to search parameter sets by Audio-object name.

To enable the search, at least 3 characters must be entered. When an audio object’s name is searched, any matching audio objects that contain the key are highlighted in yellow, and a navigation to the first matching row is automatically carried out.
You can use “<< and >>” options to navigate between the highlighted audio objects.

If a row is added or removed from parameter sets, and if a set group is changed, the search results will be cleared.

Checksum Visualization

Checksum visualization allows you to view more sets of data by hiding the left side columns.

Parameter Sets Checksum

A checksum is an alphanumeric string that serves as a fingerprint for data. Later, this data can be used for comparisons to detect errors in the data. The checksum is significant because it helps to validate the data. This feature allows you to view the checksum of each set and export the checksum along with the set files.
You can use this set checksum to verify exported set files to validate whether the set files data and parameter sets set data is the same or not.

Refresh Checksum

The Refresh checksum option gets enabled when any changes are made in the set data and user data. You can click on the refresh icon to calculate the latest checksum.

Export Checksum in Set file

GTT allows you to export the set checksum in .set and .setr files.

Checksum will not be saved in .set and .setr files in below cases:
– While saving .set and .setr files in the State Variable explorer.
– While exporting .set and .setr files from Export Tuning Data.

GTT stores the tuning data in set files these files are in Intel Hex format. Due to the complexity to analyze the data stored in set files a human readable set file is generated. This type of file is generated when you check the check box in the parameter sets workspace.

A confirmation message appears when you save a set file using the device context menu or the state variable explorer. This file will have the same file name that set file but with extension “.setr”. The human readable set file is in XML format, this file contains three main nodes:

Data in GTT Data in human readable set file
Header: Generic file information
Graphical user interface, application Description automatically generated
Graphical user interface, text Description automatically generated
User data: User data defined in preset settings.
Graphical user interface Description automatically generated
Text Description automatically generated
Tuning data: Values associated to each state variable for each audio object.
Graphical user interface Description automatically generated
Text Description automatically generated

Each processing block corresponds to each Audio Object in current configuration.

Working with GTT Project

This section provides step-by-step instructions to perform the following operations.

Use Case

  • Offline Tuning: Set tuning parameters for audio objects without connecting to the device.

A picture containing text Description automatically generated

  • Real-Time Tuning of a Target Device: Live tuning connected to the target device.

Graphical user interface Description automatically generated

  • Real Time Tuning of a IVP/VST: Live tuning connected to the virtual device (IVP/Audio Mulch).

Graphical user interface Description automatically generated with low confidence

  • Socket: A socket is an interface type, that can send or receive data within a PC (from one application to another) or over a computer network from one PC to another.

In this case, a socket connection is used to send data from GTT to AmpSrv2 and vice versa.

  • VST: Virtual Studio Technology is a software interface definition for audio plugins into music software by Steinberg company. Usually, these plugins are shipped as Windows Dlls that can be used inside of a VST-Host (e.g. AudioMulch).

In this use case, AudioworX provides the file (xAFVirtualAmp.dll) that simulates the audio behavior of an amplifier or head unit.

Basic

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

Text design  
Fader design
Rotary design
Button design
Box design
LED design
Meter design
Note design

Text Design

Text Display

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.

Text Label

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.

Text Box

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.

Common Text Design Properties

Properties Type
Description
General
  • Control Info: Shows control type. This propery is 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 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

Fader Design

Fader Horizontal

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.

Fader Vertical

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.

Fader Multi Parameter

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

Common Fader Design Properties

Properties Type
Description
General
  • Control Info: Shows control type. This propery is 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
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.
  • 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

Rotary Design

Rotary

A rotary is an adjustable 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.

Rotary Encoder

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.

Common Roter Design Properties

Properties Type
Description
General
  • Control Info: Shows control type. This propery is 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: Brings up the Select Background Image window.
  • 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
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.
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.
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.
  • 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.
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.
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

Button design

Button

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.

Button On/Off

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.

Button Momentary

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.

Button Latching

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.

Button MultiState

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.

Button Radio

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.

Button Region

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.

Button System Functions

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.

Common Button Design Properties

Properties Type
Description
General
  • Control Info: Shows control type. This propery is 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.
  • On Value: Value sent when button is pressed.
  • Off Value: Value sent when button is released.
  • Value Matrix: Allows changes to the button states, and images associated with each state.
  • Value List: Allows editing of the value range of the control. Brings up the Discrete Values Editor.
  • 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.
  • 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. Change width and height values. You can also re-size the control manually.
  • 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.
  • Background Image: Background graphic of control. Brings up the Select Image File window.
  • Background Color: Background color of the control. Brings up the Select Color 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 = Does not appear
  • 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)
Button
  • Primary Font: Font style for the text on the control. Click on “…” to select desired font. Selects from Windows fonts.
  • 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.
  • 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.
  • Button Action: When an event occurs when the button is clicked. OnUp, OnDown, or OnBoth.
  • Button Image: The image displayed as the button. Brings up the Select Image File window.
  • Alignment: Alignment of the button nubs. vertical and 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.
  • 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.
System Indication
System Functions
  • System Functions: Assign specific system operations to be performed when the button is pressed.
    Brings up the System Function editor.

Box Design

Combo Box

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.

List Box

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.

Spinner

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.

Check Box

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.

Common Roter Design Properties

Properties Type
Description
General
  • Control Info: Shows control type. This propery is 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.
  • 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.
  • Disable Mixed-sate Editor: When checked, disables the mixed-state context menu and 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.
  • Border Style: The style of the Spinner border.
    • Choose from drop down menu.
  • Border Color: The color of the Spinner border
  • 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.
  • 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
Combo Box
  • Background Color: The background color of the Combo Box.
  • Text Color: The color of the Combo Box text
  • 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.
  • 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.
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
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.

LED Design

Led Image

An LED is a display-only control that shows the state of a device parameter. The LED control helps the designer to graphically show a certain condition, as defined by the designer, such as a warning. The “LED Image” control allows you to change the entire image of the LED where the “LED Color” control is a simplified control where you only need to change the color of the LED.
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.
For example, the designer wants to show when the pink noise levels on each of the four inputs of a DriveRack 4800 are more than 10dB. First, he adds an LED and links it to the pink noise on Channel 1.

The designer then goes into the Properties field to the Parameters Value and defines the value with the LED Values Editor.

Led Color

An LED is a display-only control that shows the state of a device parameter. The LED control helps the designer to graphically show a certain condition, as defined by the designer, such as a warning.

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.
For example, the designer wants to display when pink noise levels on each of the four inputs of a DriveRack 4800 are more than 10dB. First, he adds an LED and links it to the pink noise on Channel 1.
The designer then goes into the Properties field to the Parameters Value and defines the value with the LED Values Editor.

Led Preset Trigger

A preset trigger is a control on a Custom Panel that causes an activation event to execute when a specific condition occurs. The Custom Panel must be activated for the action to be performed. You can, however, set up a venue-wide rule with Logic Rules.

To Set Up a Preset Trigger

Add the preset trigger control to the Custom Panel then do one of the following:

  • Right click the control and select edit parameter assignment.
    or
  • In the properties section of the graph, select the “…” at the right of parameter addresses.

To Reset a Preset Trigger

If the condition for the activation event is set to manual reset, the user must reset the control. Right-click the control on the activated panel and select “Reset Trigger.”

Led Region

The LED Region control 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.

Led System Indicator

The system indicator is an LED-style control that allows you to define and show the state of specified devices. For example, on an activated panel, a system indicator will turn red and beep when a device is offline, then return to green when the connection is restored. A right mouse click on the system indicator on an activated panel also shows what state attached devices are in.
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.

Common LED Design Properties

Properties Type
Description
General
  • Control Info: Shows control type. This propery is 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
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.
  • 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

 

Meter Design

Common Roter Design Properties

Properties Type
Description
General
  • Control Info: Shows control type. This propery is 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
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.
  • 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

 

Note Design

 

 

Properties Type
Description
General
  • Control Info: Shows control type. This propery is 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
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.
  • 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

State Indication Setup Window

The State Indication Setup window allows you to customize the look of a control such as a button.

Graphical user interface, application Description automatically generated

  • Label: Enter the name of the label for the current state.
  • Label Color: The color of the label. Select the color from the Select Color window.
  • Backing Color: The color of the label background (such as the color of a button). Select the color from the Select Color window.
  • Backing Image: An image for the label. Select the image from the Select Image File window.

System Function Editor

The System Function Editor is a separate window that allows you to assign a certain System Function or functions upon an action, such as pressing a button or receiving an external control signal.
Graphical user interface, application, Teams Description automatically generated

In this section, you can choose the function to assign. Additional options will appear below, providing supporting parameters or functions based on your selection.

Below is the list of the functions that can be assigned.

System Functions
  • None
  • Close Current Panel: Closes the current Panel
  • Close Custom Panel: Closes a selected Custom Panel
  • Close Device Panel: Closes a selected Device Panel
  • Close Master Panel: Closes a selected Master Panel
  • Launch Custom Panel: Launches a selected Custom Panel
  • Launch Device Panel: Launches a selected Device Panel
  • Launch Master Panel: Launches a selected Master Panel
  • Locate: Select a device in the venue and determine whether you want its Locate feature on or off
  • Mute Device: Mutes a selected Device
  • Unmute Device: Unmutes a selected Device
  • Mute Channel: Select a device in the venue and select a channel within that device to mute.
  • Unmute Channel: Select a device in the venue and select a channel within that device to unmute.
  • Solo Channel: Select a device in the venue and select a channel within that device to solo.
  • Recall Device Preset: Select a device in the venue and recall a preset within that device.
  • Recall Panel Preset: Select a custom Panel and recall a preset within that panel.
  • Recall Venue Preset: Brings up the Venue Presets window.
  • Save File: Saves the current project file.
  • Logout: Logout the current user from GTT.
  • Switch User: Brings up a window to login a different GTT user.
  • Close Application: Shuts down GTT.
  • Shutdown Computer: Shuts down the computer GTT is running on.
  • Play Sound File: Brings up a window to select a sound file. Selections include MP3, MIDI, Windows Audio, or Windows Media files.
  • Launch Scheduler: Activates the Scheduler.
  • Launch Event Log: Activates the Event Log.
  • Processing State: To change the processing state of audio objects, except for Audio-In/Out and Control-In/Out objects.
  • xTP Command: Using this option, any xTP command can be configured on the custom panel.

Processing State


Using the Processing State option, you can modify the processing state of audio objects, with the exception of Audio-In/Out and Control-In/Out objects. This can be accomplished through the System Function. Any UI control that supports System Function can be configured with Processing State and can then be activated by interacting with the UI control after launching the custom panel.

The option to process the state is available in the drop-down list under System Functions.

Configuring Processing State: When selecting the Processing State from the system function list, an additional combo box will appear with the available processing state options.

  • Normal: Normal operation with the update of necessary internal states of the audio object; normal output.
  • Bypass: Normal operation with the update of necessary internal states of the audio object; input channel buffer data copied to the output channel buffers.
  • Mute: Normal operation with the update of necessary internal states of the audio object; output channel buffers cleared.
  • Stop: Input channel buffer data copied to the output channel buffers (no update of internal states).

After selecting the state, a pop-up configuration window will be shown having the following options.

Option Description
Devices List of all devices configured in the project.

The device name is listed as per the format below.
Device Address: Device Name: Device Template Name

Audio Object List of all audio objects in the project that are available for the selected devices, except Audio In/Out and Control In/Out.

On pressing OK, the command would be saved.

The configured Processing State system function is retained during the export and import of the Custom Panel or Project.

Executing Processing State System Function: After launching the custom panel, you can execute the system function configured on the control through its actions.

Example: If a button is configured with Processing State Command, then upon clicking the button, the command shall be executed.

The device for which the Processing State Command is configured must be connected to execute the configured Processing State Command system function.

xTP Command System Function


Using this option, any xTP command can be configured on the custom panel. This can be done via System Function; any UI control that supports System Function can be configured with xTP Command, and it can then be executed by clicking on the UI control after launching the custom panel.

The option of xTP Command is available on the System Functions drop-down list.

Configuring xTP Command System Function:  Upon selecting the xTP Command from the system function list, a configuration pop-up window appears with the following options.

Option Description
Device List of all devices configured in the project. Selecting a device from the list will limit the length of the data (in bytes) that can be entered. The maximum length of the data field will equal the device’s MaxNetworkDataSize (in bytes).

The device name is listed as per the format below.
Device Address : Device Name : Device Template Name

xTP Command The xTP Command with data that needs to be executed. Data can only be entered in Hex, i.e following characters are allowed 0123456789ABCDEF and space.
For example:
64 00 05 01, here 64 is the Command Id, followed by other header information and data.
OR
73 00 00 00 07 13 02 00 00 00, 73 is the Command Id, followed by header information and data.
Count Displaying the total number of hex values entered in the Data field.
Comment Additional information regarding the command that is configured. (This will be limited to 300 characters.)

On pressing OK, the command would be saved.

The configured xTP Command is retained during export and import of the Custom Panel or Project.

Executing xTP Command System Function: After launching the custom panel, the control on which system function is configured can be executed by user action on the control.

Example: If a button is configured with an xTP Command, then upon clicking the button, the command shall be executed.

The device for which xTP Command is configured must be connected to execute the configured xTP Command system function.

Editing the configured System function: Reselecting xTP Command options from the System Function window will re-open the configuration screen, populating the device, xTP Comman,d and comments field.

Parameter Address Editor

The Parameter Address Editor allows you to add or remove parameters linked to a control. It is accessed in the Custom Panel Designer Tab from Properties, Parameters, Address or with a right click on the control and selecting Edit parameters.

The top section of the parameter address editor shows all available parameter assignments Device, Object and Parameter.

  • Device, Object, and Parameter Search: Since there are often a large number of items in the Device, Object and Parameter lists, the Search window allows you to narrow down the number of items in that list. For example, if you want to narrow the search to all Crown, Output Faders you would enter these into the Search windows.
    The bottom half of the Parameter Address Editor shows assignments made to the control.
  • Add Assignment: On the top section, select the parameters to be added to the control. Only devices that have been added to the venue will display in the “device” column.
    Click the Add button or drag and drop the selection to the lower section. The parameters are assigned to the control.
  • Remove Assignment: Select the parameters to be removed from the control then click the Remove button.
  • Data Type: Shows the Address data type.
  • Device Address: A drop-down list showing current available device addresses.
  • Device Type: Shows type of device.
  • Device Name: Shows the name of the device given in the venue.
  • Object Address: A drop-down list showing current available object addresses.
  • Object Name: Shows the name of the object where the parameter resides.
  • Parameter Address: A drop-down list showing current addresses available for the selected parameter.
  • Parameter Name: The name of the selected parameter

Panels View

The Panels view in Panel Designer lists all custom panels. You can use the Panel view to create a new panel, export a panel, import a panel, and delete the panel. You can access additional options like Application, Parameter Sets, and Venue in the panel menu.

Icon Description
Icon Description automatically generated Add Panel: Click on this option to add new panel.
Rename Panel: Allows you to rename the existing panel.
Import Panel: Click on this option to import a panel.
Export Panel: Click on this option to export a panel.
A picture containing text, monitor Description automatically generated Remove Devices: Click on this option to delete the panel.