controlSet command

Command

controlSet

Shortcut

cs

Arguments

control value

Availability

when logged in

Purpose

To set the string value of a control

Notes

Like controlGet, this command returns the Control name, the string value of the Control, and the positional value. When the Control name has spaces, the argument should be enclosed in double-quotes, as in: controlSet "Master Gain" -75

Response

Something like this: valueIs "Master Gain -75.0dB 0.250

In this section

Usage Example

Response

Possible Error Messages

See also

help Command

login command

statusGet command

keepAlive command

quietModeEnable command

quietModeDisable command

controlGet command

controlPositionSet command

controlList Command

changeGroupControlAdd command

changeGroupControlRemove Command

changeGroupGet Command

changeGroupClear Command

changeGroupSchedule Command

Usage Example

The client issues:

controlSet "Main Gain" -3.4\r

or

cs "Main Gain" -3.4\r

to set the control value to -3.4.

The Control Alias name is enclosed in quotes because it contain spaces. (If the name does not contain spaces, the quotes are not required.)

You can adjust the value of the control relative to its current value using:

cs "Main Gain" ++3\r

or

cs "Main Gain" --3\r

These examples increase the value by 3dB and decrease it by the same amount respectively.

You can reset the value of a string control by setting its value to double quotes "". For example:

controlSet "strcontrol2" ""

Response

valueIs "Main Gain" -3.50dB 0.818\r\n

In the response, the first token after the alias name is the current value expressed in the units appropriate to that particular control. In the response, the second token after the Control Alias name is the current value of the alias expressed as a percentage of the maximum value expressed as a decimal value between 0 and 1. This can be thought of as a physical knob position - in this example, the 0.615 (61.5%) knob position corresponds to -3.4dB, and a 1.000 (100%) knob position will correspond to +12dB.

Possible Error Messages

\aBadArgumentCount\r\n
\anotLoggedIn\r\n
\aUnlistedControl "AliasName"\r\n
\aOverflow\r\n