You are here:

Commands (Administrator)

Commands control and define various actions or events in the system. There are three general types of Commands you can create: Public Address (PA) Commands, Control Commands and Snapshot Commands.

You can restrict User access to Commands in the User properties, and the Page Station properties.

Commands can be invoked from Page Station Command Buttons, through keypad entry of a code on a Page Station or telephone, from GPIO or using the Command Schedule tab.

PA Commands

The following are the available PA Commands:
- PA Play Messages This Command plays a selected pre-recorded message.
- PA Page This Command is used for live pages.
Each PA Command type includes Destination Zones, a Name, and a numeric Code. Other Command parameters are specific to the Command type and are listed in the tables below.
You can invoke any of the PA Commands from a Page Station. (Can be restricted by other parameters.)
You can invoke PA Play Messages Commands using the Command Schedule feature.

Control Change Commands

Control Commands specify an action to be performed on controls in the Named Controls list in your design.
To create a Control Command, you must add at least one Control to the Named Controls list in your design.
You can invoke Control Commands from the Command Scheduler to schedule a Control change, run a Script, and so on.
You can invoke a Control Command from a Page Station. (Can be restricted by other parameters.)
You cannot create a Command using a control typically displayed in the Control Panel of a Component as a drop-down type control. The following is a list of controls, and the components containing them, that cannot be used in a Control Command.

Control Name	Components
Type	Crossfade
Voicing Filter Type	Custom Voicing
Normalization	Custom Voicing, Crossover
Filter Order	Custom Voicing
Filter Slope	Custom Voicing, Crossover
Crossover Type	Custom Voicing, Crossover
Gated Mic Mixer Mode	Gated Automatic Mixer
GPIO Output Select	GPIO components in Raw mode
Low Frequency Shading	Wideline array
Peak RMS Select	Various meter selects
Side-chain Filter Type	Gated Automatic Mixer

Load Snapshot Commands

Snapshot Commands invoke a specific Snapshot within a Snapshot Bank.
To create a Snapshot Command you can use the Global Snapshot Bank, or create a new Snapshot Bank.
Snapshot Commands the same as Control Commands except you can have multiple controls associated with a Snapshot Bank. (If you specify a Snapshot Load button in a Control Command, when invoked, that button uses the Ramp Time specified in the Snapshot Bank.)

Creating Commands

Select the Commands tab in the Administrator. (The design must be in the Run or Emulate mode.)
Click the plus sign in the upper left corner of the interface. A drop-down list displays listing the types of Commands available to create.
- For PA Commands, you must have at least one Page Station, and only one PA Router component in the design.
- For Control Commands, you must have at least one control in the Named Controls list.
- For Snapshot Commands, the Global Snapshot is defined in the design by default and you can create a Snapshot Command using the Global Snapshot.
Select the type of Command you wish to create. A dialog box displays with controls relating to the type of Command selected.
Define the Command according to the information listed in the Command Controls tables in this topic.
Add and assign Tags as desired. Refer to Assigning Tags to Commands for details.
When you are finished, click the OK button to save the Command, or the Delete button to discard the Command and exit the dialog box.

Assigning Tags to Commands

You may wish to establish a group of Commands that all perform the same or similar functions. To form a group of Commands:

Create the Commands you are going to add to the group. Each Command must have a unique Code.
Select the Commands you want in the group. Ctrl+click for one Command at a time, or Shift-click for a contiguous group of Commands.
Create a Tag to identify the group. When you create the Tag, and have the Commands selected, the Tag is applied to all the selected Commands.
With the Commands still selected, double-click one of the Commands. Do not use Ctrl+click or Shift-click at this point as it will change your selection. The Command Settings dialog box displays.
The Code is not accessible at this point. Make selections, from the items that are accessible. Refer to the Controls table below. Any changes you make, with multiple Commands selected, are applied to all selected Commands.
When you edit the properties for a Page Station, or User, you can select the entire group of Commands to make them available for the Page Station or User simply by selecting the Tag you assigned to them.

To add another Command to the group, select the Command, and click the checkbox next to the group Tag in the Tags list.

Note: The assigned Tags are listed alphabetically from left to right next to the Commands.

Filter the Commands by Tags

You can filter the list of Commands based on the Tags you assign.

Click the filter icon in the top left corner (next to the plus sign). A list of Tags displays.
Click the checkbox of the Tag or Tags you wish to filter by. Only the Commands assigned the selected Tags display.
Click the filter icon again and uncheck any or all of the Tags to remove or modify the filter.

Controls

Controls are available in a dialog box depending on the type of Command, and the Priority Mode set in the PA Global Settings.

Common

Applies to all Command types

Control	Function	Default / Range
Name	Text name identifying the item.	Default = "New <type of command>" User Defined
Code	The Code is a unique number used to invoke a Command on the numeric keypad of a Page Station. The code cannot have leading zeros. Applies only to the Page Station Model PS-1600.	Default = 3 digits Range = 1 to n digits

Control

Function

Default / Range

Name

Text name identifying the item.

Default = "New <type of command>"

User Defined

Code

The Code is a unique number used to invoke a Command on the numeric keypad of a Page Station. The code cannot have leading zeros.

Applies only to the Page Station Model PS-1600.

Default = 3 digits

Range = 1 to n digits

PA Page Commands

Create a Page Command for each paging scenario your system will encounter.

Control	Function	Default / Range
Override Source Priority Level	When the PA Global Settings Priority Mode is Station/User Priority, this is used to give this PA Page Command precedence over the Station's priority. When this is set to Yes, the Priority Level setting becomes available.	Default / Range = No / Yes
Priority Level	Used to determine the priority of a page or message relative to other PA events. Priority Levels are defined in the PA Global Settings tab. Priority Levels are available for PA Page Commands when the Priority Mode is Command Priority, also when the Priority Mode is Station/User Priority and the Override Source Priority Level is set to Yes.	Default = the middle priority defined Range = the number of priorities defined
Queuing Mode	Determines the method by which a page is placed in the queue. There are three types: Live, Delayed, and Automatic. Live means the page will not be Recorded. If the PA Zones are in use by a page of equal or higher Priority, the request will be queued up behind other queued pages of equal or higher Priority, but before pages of lower priority. PA Zones that are in use by pages of lower priority will be interrupted. When the page request reaches the front of the queue, the preamble (if configured) plays and the operator can speak. Delayed means the page will always be Recorded. After the recording is complete, and a five second interval has passed (to give you time to cancel the page before it begins), the playback either begins or is queued according to the same rules as a Live page. When playback begins, you can cancel it, select a Command button (A-D), or enter a Command Code to initiate a new page while the recorded page completes in the background. Automatic stores the page in memory as it is going out live. If the page is completed, the memory is cleared. If the page is interrupted, the remainder of the page will continue to be stored. Once the page is complete, it is played out like a Delayed page, and the memory is cleared.	Default = Automatic Range = Automatic, Delayed, Live
Preamble	Select one of the available .wav files to be played prior to a page. Click the arrow (play button) to the right of the selected file to start playback, and the red square (stop button) to end playback. You can manage the Preamble files in the Q-SYS Core Manager > Audio Files page. QSC supplies a number of pre-recorded preamble audio files with Q-SYS Designer. These files are typically chimes, tones, and so on.	Default = None Range = number of audio files in Preamble subdirectory
Preamble Gain (dB)	The Preamble Gain control is used to compensate for variations in the recording level of audio files. You can adjust this gain for each PA Page Command and keep the gain for the PA Zone in the PA Router at a consistent level. This Gain interacts cumulatively with the Message Gain control in the PA Router. Note: This gain does not affect the level of the preamble preview when you click the play button next to the Preamble field.	Default = 0 Range = -12 to 12
Destination Zones	Used to select the PA Zones affected by the Command. You can select one zone at a time or multiple zones at once by selecting a Tag defined in the PA Zones tab. You can expand the Tag to see which zones are included with the Tag. The default is none selected. Note: If no PA Zones are selected, the Command is not usable.	Default = nothing selected Range = number of PA Zones and Tags defined

Control

Function

Default / Range

Override Source Priority Level

When the PA Global Settings Priority Mode is Station/User Priority, this is used to give this PA Page Command precedence over the Station's priority.

When this is set to Yes, the Priority Level setting becomes available.

Default / Range = No / Yes

Priority Level

Used to determine the priority of a page or message relative to other PA events. Priority Levels are defined in the PA Global Settings tab.

Priority Levels are available for PA Page Commands when the Priority Mode is Command Priority, also when the Priority Mode is Station/User Priority and the Override Source Priority Level is set to Yes.

Default = the middle priority defined

Range = the number of priorities defined

Queuing Mode

Determines the method by which a page is placed in the queue. There are three types: Live, Delayed, and Automatic.

Live means the page will not be Recorded. If the PA Zones are in use by a page of equal or higher Priority, the request will be queued up behind other queued pages of equal or higher Priority, but before pages of lower priority. PA Zones that are in use by pages of lower priority will be interrupted. When the page request reaches the front of the queue, the preamble (if configured) plays and the operator can speak.

Delayed means the page will always be Recorded. After the recording is complete, and a five second interval has passed (to give you time to cancel the page before it begins), the playback either begins or is queued according to the same rules as a Live page. When playback begins, you can cancel it, select a Command button (A-D), or enter a Command Code to initiate a new page while the recorded page completes in the background.

Automatic stores the page in memory as it is going out live. If the page is completed, the memory is cleared. If the page is interrupted, the remainder of the page will continue to be stored. Once the page is complete, it is played out like a Delayed page, and the memory is cleared.

Default = Automatic

Range = Automatic, Delayed, Live

Preamble

Select one of the available .wav files to be played prior to a page. Click the arrow (play button) to the right of the selected file to start playback, and the red square (stop button) to end playback.

You can manage the Preamble files in the Q-SYS Core Manager > Audio Files page.

QSC supplies a number of pre-recorded preamble audio files with Q-SYS Designer. These files are typically chimes, tones, and so on.

Default = None

Range = number of audio files in Preamble subdirectory

Preamble Gain

(dB)

The Preamble Gain control is used to compensate for variations in the recording level of audio files. You can adjust this gain for each PA Page Command and keep the gain for the PA Zone in the PA Router at a consistent level.

This Gain interacts cumulatively with the Message Gain control in the PA Router.

Note: This gain does not affect the level of the preamble preview when you click the play button next to the Preamble field.

Default = 0

Range = -12 to 12

Destination Zones

Used to select the PA Zones affected by the Command. You can select one zone at a time or multiple zones at once by selecting a Tag defined in the PA Zones tab. You can expand the Tag to see which zones are included with the Tag. The default is none selected.

Note: If no PA Zones are selected, the Command is not usable.

Default = nothing selected

Range = number of PA Zones and Tags defined

PA Play Message Commands

Control	Function	Default / Range
Message File	An .mp3 file played when a Message type Command is invoked. You can manage the Message files in the Q-SYS Core Manager > Audio Files page. Click the arrow (play button) to the right of the selected file to start playback, and the red square (stop button) to end playback.	Default = no default Range = number of audio files in the Messages subdirectory
Priority Level	Used to determine the priority of a message relative to other PA events. Priority Levels are defined in the PA Global Settings tab. The Command priority is used, and there is no override available for Play Message Commands. Priority Levels are always available for PA Message Commands.	Default = the middle priority defined Range = the number of priorities defined
Gain (dB)	The Gain control is used to compensate for variations in the recording level of audio files. You can adjust this gain for each Message Command and keep the Message Gain for the PA Zone in the PA Router at a consistent level. This Gain interacts cumulatively with the Message Gain control in the PA Router.	Default = 0 Range = -12 to 12
Mode	Queued Mode – you invoke the message command, and when its turn comes, it is played. Looped Mode – you invoke the message command, and it repeats as long as you hold the Talk button down.	Queued / Looped
Destination Zones	Used to select the PA Zones affected by the Command. You can select one zone at a time or multiple zones at once by selecting a Tag defined in the PA Zones tab. You can expand the Tag to see which zones are included with the Tag. The default is none selected. Note: If no PA Zones are selected, the Command is not usable.	Default = nothing selected Range = number of PA Zones and Tags defined

Control

Function

Default / Range

Message File

An .mp3 file played when a Message type Command is invoked. You can manage the Message files in the Q-SYS Core Manager > Audio Files page.

Click the arrow (play button) to the right of the selected file to start playback, and the red square (stop button) to end playback.

Default = no default

Range = number of audio files in the Messages subdirectory

Priority Level

Used to determine the priority of a message relative to other PA events. Priority Levels are defined in the PA Global Settings tab. The Command priority is used, and there is no override available for Play Message Commands.

Priority Levels are always available for PA Message Commands.

Default = the middle priority defined

Range = the number of priorities defined

Gain

(dB)

The Gain control is used to compensate for variations in the recording level of audio files. You can adjust this gain for each Message Command and keep the Message Gain for the PA Zone in the PA Router at a consistent level.

This Gain interacts cumulatively with the Message Gain control in the PA Router.

Default = 0

Range = -12 to 12

Mode

Queued Mode – you invoke the message command, and when its turn comes, it is played.

Looped Mode – you invoke the message command, and it repeats as long as you hold the Talk button down.

Queued / Looped

Destination Zones

Note: If no PA Zones are selected, the Command is not usable.

Default = nothing selected

Range = number of PA Zones and Tags defined

Control Change Commands

Control	Function	Default / Range
Control	Select a control from the drop-down list. The list displays all of the Named Controls defined in the Q-SYS design. Anything in a Control Panel is referred to as a "control". Controls that you cannot operate, such as a Meter, do not display in the list. Exceptions to this are, for example, a Meter from the Custom Controls component. You cannot create a Command using a control designated as "enum" or an enumerated control. This is a control that typically displays as a drop-down type control. An example is the Slope control in the Crossover Component.	Default = none
Value	Enter the target numeric value of a variable control. You can enter the value using your keyboard, or the spinner. The values you can enter are limited by the range and precision of the control. If you select a toggle type control, for example a Mute button, the Values available are On, Off, and Toggle. This field is not displayed for trigger type buttons. The Value drop-down menu is replaced by "Control will be triggered".	Range = the range of the control
Ramp Time (seconds)	The time it takes to get from the current position to the defined Value. This field does not display for momentary, text edit, toggle, or trigger type controls.	Default = 0 Range = 0 to 100

Control

Function

Default / Range

Control

Select a control from the drop-down list. The list displays all of the Named Controls defined in the Q-SYS design.

Anything in a Control Panel is referred to as a "control". Controls that you cannot operate, such as a Meter, do not display in the list. Exceptions to this are, for example, a Meter from the Custom Controls component.

You cannot create a Command using a control designated as "enum" or an enumerated control. This is a control that typically displays as a drop-down type control. An example is the Slope control in the Crossover Component.

Default = none

Value

Enter the target numeric value of a variable control. You can enter the value using your keyboard, or the spinner. The values you can enter are limited by the range and precision of the control.

If you select a toggle type control, for example a Mute button, the Values available are On, Off, and Toggle.

This field is not displayed for trigger type buttons. The Value drop-down menu is replaced by "Control will be triggered".

Range = the range of the control

Ramp Time

(seconds)

The time it takes to get from the current position to the defined Value.

This field does not display for momentary, text edit, toggle, or trigger type controls.

Default = 0

Range = 0 to 100

Snapshot Load Commands

Control	Function	Default / Range
Snapshot Bank	Select a Snapshot Bank from the drop-down list. The list displays all of the Snapshot Banks defined in the Q-SYS design. The Global Snapshot Bank is defined in the design by default and can be used in a Snapshot Command.	Default = none
Snapshot Number	Enter the target Snapshot Number in the selected Snapshot Bank. The number of Snapshots defined in the selected Snapshot Bank sets the number of Snapshots available for selection in the Snapshot Command.	Range = the number of Snapshots in the Bank
Ramp Time (seconds)	The time it takes to get from the current position to the defined Value. This value overrides the Ramp Time value set in the Snapshot Bank. If there are buttons or other discrete type controls, they will change state at 50% through the Ramp Time.	Default = 0 Range = 0 to 100

Control

Function

Default / Range

Snapshot Bank

Select a Snapshot Bank from the drop-down list. The list displays all of the Snapshot Banks defined in the Q-SYS design.

The Global Snapshot Bank is defined in the design by default and can be used in a Snapshot Command.

Default = none

Snapshot Number

Enter the target Snapshot Number in the selected Snapshot Bank.

The number of Snapshots defined in the selected Snapshot Bank sets the number of Snapshots available for selection in the Snapshot Command.

Range = the number of Snapshots in the Bank

Ramp Time

(seconds)

The time it takes to get from the current position to the defined Value. This value overrides the Ramp Time value set in the Snapshot Bank.

If there are buttons or other discrete type controls, they will change state at 50% through the Ramp Time.

Default = 0

Range = 0 to 100

Software and Firmware | Resources | QSC Self Help Portal | Q-SYS Help Feedback