Loading...
This chapter gives an overview of the members available for the Jog/Shuttle device.
Please read the chapter "Jog/Shuttle" if you would like to know how to add and use this device. As explained in the topic"Object and Member Notation (dot syntax)", all kinds of objects can be addressed in the scripting language by using their members which set (or return if applicable) properties or methods of that object. Please refer to the chapter "Script Language" for more details about scripting in general.
Project.JogShuttle(deviceName or ID) |
Example: Alternative Example: |
This gives access to all further members of the device "JogShuttle" from the Configuration dialog. Using the Project object is an alternative to addressing the device directly by entering its name. The Project object allows to address the device through its name or ID. Substituting the ID with a dynamic variable allows automation. Actions can be performed on many devices of the same type simultaneously, e.g. by using for-loops: |
JogShuttleName.BottomButtonID.GetState |
Example: Alternative Example: |
This member returns the state of BottomButton1 (the button located below Fader1) as a Boolean value (True = pressed state or False = released state). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.BottomButton1.GetState This member is also available for "BottomButton2". |
JogShuttleName.BottomButtonID.State |
Example: Alternative Example: |
This member returns the state of BottomButton1 (the button located below Fader1) as a Boolean value (True = pressed state or False = released state). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.BottomButton1.State This member is also available for "BottomButton2". |
JogShuttleName.CueButtonID.GetLedBrightness |
Example: Alternative Example: |
This member returns the dimmer level of the LED of CueButton1 as an integer value (0-255). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.CueButton1.GetLedBrightness This member is also available for "CueButton2" - "CueButton16". |
JogShuttleName.CueButtonID.GetState |
Example: Alternative Example: |
This member returns the state of Button1 as a Boolean value (True = pressed state or False = released state). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.CueButton1.GetState This member is also available for "CueButton2" - "CueButton16". |
JogShuttleName.CueButtonID.LedBrightness |
Example: Alternative Example: |
This member sets and returns the dimmer level of the LED of CueButton1 as an integer value (0-255). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.CueButton1.LedBrightness Alternative commands are: JogShuttle.GetCueButtonLedBrightness(id,value) and JogShuttle.CueButton1.GetLedBrightness Example2: The second example shows, how to set the dimmer level for the LED of CueButton1 to a value of 125. Values between 0 (off) and 255 (fully on) are possible. This member is also available for "CueButton2" - "CueButton16". |
JogShuttleName.CueButtonID.SetLedBrightness(value) |
Example: Alternative Example: |
This command sets the dimmer level for the LED of CueButton1 to a value of 125. Values between 0 (off) and 255 (fully on) are possible. This member is also available for "CueButton2" - "CueButton16". |
JogShuttleName.CueButtonID.State |
Example: Alternative Example: |
This member returns the state of Button1 as a Boolean value (True = pressed state or False = released state). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.CueButton1.State This member is also available for "CueButton2" - "CueButton16". Alternative commands are: JogShuttle.GetCueButtonState(id) and JogShuttle.CueButtonID.GetState |
JogShuttleName.Disable |
Example: Alternative Example: |
This disables the Jog/Shuttle device in the Configuration dialog as if the "Enable" check box in the window was unchecked. Use the .Enable member to reverse this command. |
JogShuttleName.Enable |
Example: Alternative Example: |
This enables the Jog/Shuttle device in the Configuration dialog as if the "Enable" check box in the window was checked. Use the .Disable member to reverse this command. |
JogShuttleName.FaderID.GetValue |
Example: Alternative Example: |
This member returns the raw fader position Fader1 as an integer value (0-65535). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.Fader1.GetValue This member is also available for "Fader2". |
JogShuttleName.FaderID.Value |
Example: Alternative Example: |
This member returns the raw fader position Fader1 as an integer value (0-65535). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.Fader1.Value This member is also available for "Fader2". |
JogShuttleName.GetBottomButtonState(id) |
Example: Alternative Example: |
This member returns the state of BottomButton1 (the button located below Fader1) as a Boolean value (True = pressed state or False = released state). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.GetBottomButtonState(1) Alternative commands are: JogShuttle.BottomButtonID.GetState and JogShuttle.BottomButtonID.State |
JogShuttleName.GetCueButtonState(id) |
Example: Alternative Example: |
This member returns the state of CueButton1 as a Boolean value (True = pressed state or False = released state). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.GetCueButtonState(1) This member is also available for CueButton ID 2-16. An alternative command is: JogShuttle.CueButtonID.GetState and JogShuttle.CueButtonID.State |
JogShuttleName.GetCueButtonLedBrightness(id) |
Example: Alternative Example: |
This member returns the dimmer level of the LED of (Cue) Button1 as an integer value (0-255). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.GetCueButtonLedBrightness(1) Alternative commands are: JogShuttle.CueButtonID.GetLedBrightness and JogShuttle.CueButtonID.LedBrightness |
JogShuttleName.GetFaderValue(id) |
Example: Alternative Example: |
This member returns the raw fader position Fader1 as an integer value (0-65535). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.GetFaderValue(1) |
JogShuttleName.GetTopButtonBlueLedBrightness(id) |
Example: Alternative Example: |
This member returns the dimmer level of the blue LED of TopButton1 (the button located above Fader1) as an integer value (0-255). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.GetTopButtonBlueLedBrightness(1) |
JogShuttleName.GetTopButtonRedLedBrightness(id) |
Example: Alternative Example: |
This member returns the dimmer level of the red LED of TopButton1 (the button located above Fader1) as an integer value (0-255). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.GetTopButtonRedLedBrightness(1) |
JogShuttleName.GetTopButtonState(id) |
Example: Alternative Example: |
This member returns the state of TopButton1 (the button located above Fader1) as a Boolean value (True = pressed state or False = released state). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.GetTopButtonState(1) Alternative commands are: JogShuttle.TopButtonID.GetState and JogShuttle.TopButtonID.State |
JogShuttleName.IsConnected |
Example: Alternative Example: |
This member returns the connection status for the Jog/Shuttle device as a Boolean value. The result is "True" if the device is connected and "False" if it is currently disconnected. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.IsConnected |
JogShuttleName.IsEnabled |
Example: Alternative Example: |
This member returns the status of the check box "Enable" of the configuration dialog as a string or Boolean value. The result is "True" if the device is enabled and "False" if it is currently not enabled. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.IsEnabled |
JogShuttleName.LeftButton.GetState |
Example: Alternative Example: |
This member returns the state of the left Button (next to the Play button) as a Boolean value (True = pressed state or False = released state). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.LeftButton.GetState An alternative command is: JogShuttle.LeftButton.State |
JogShuttleName.LeftButton.State |
Example: Alternative Example: |
This member returns the state of the left Button (next to the Play button) as a Boolean value (True = pressed state or False = released state). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.LeftButton.State An alternative command is: JogShuttle.LeftButton.GetState |
JogShuttleName.PlayButton.GetState |
Example: Alternative Example: |
This member returns the state of the Play Button as a Boolean value (True = pressed state or False = released state). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.PlayButton.GetState An alternative command is: JogShuttle.PlayButton.State |
JogShuttleName.PlayButton.State |
Example: Alternative Example: |
This member returns the state of the Play Button as a Boolean value (True = pressed state or False = released state). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.PlayButton.State An alternative command is: JogShuttle.PlayButton.GetState |
JogShuttleName.RightButton.GetState |
Example: Alternative Example: |
This member returns the state of the right button (next to the Play button) as a Boolean value (True = pressed state or False = released state). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.RightButton.GetState An alternative command is: JogShuttle.RightButton.State |
JogShuttleName.RightButton.State |
Example: Alternative Example: |
This member returns the state of the right button (next to the Play button) as a Boolean value (True = pressed state or False = released state). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.RightButton.State An alternative command is: JogShuttle.RightButton.GetState |
JogShuttleName.SetCueButtonLedBrightness(id,value) |
Example: Alternative Example: |
This member sets the dimmer level of the LED of (Cue) Button1 to a value of 125. Values between 0 (off) and 255 (fully on) are possible. Alternative commands are: JogShuttle.CueButtonID.SetLedBrightness and JogShuttle.CueButtonID.LedBrightness |
JogShuttleName.SetTopButtonBlueLedBrightness(id,value) |
Example: Alternative Example: |
This member sets the dimmer level of the blue LED of TopButton1 (the button located above Fader1) to a value of 125. Values between 0 (off) and 255 (fully on) are possible. An alternative command is: JogShuttle.TopButtonID.SetBlueLedBrightness and JogShuttle.TopButtonID.BlueLedBrightness |
JogShuttleName.SetTopButtonRedLedBrightness(id,value) |
Example: Alternative Example: |
This member sets the dimmer level of the red LED of TopButton1 (the button located above Fader1) to a value of 125. Values between 0 (off) and 255 (fully on) are possible. An alternative command is: JogShuttle.TopButtonID.SetRedLedBrightness and JogShuttle.TopButtonID.RedLedBrightness |
JogShuttleName.TopButtonID.BlueLedBrightness |
Example: Alternative Example: |
This command sets and returns the dimmer level for the blue LED of TopButton1 (the button located above Fader1) as an integer value (0-255). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.TopButton1.BlueLedBrightness Alternative commands are: JogShuttle.GetTopButtonBlueLedBrightness(id,value) and JogShuttle.TopButtonID.GetBlueLedBrightness Example2: The second example shows, how to set the dimmer level for the blue LED of TopButton1 to a value of 125. Values between 0 (off) and 255 (fully on) are possible. This member is also available for "TopButton2". |
JogShuttleName.TopButtonID.GetBlueLedBrightness |
Example: Alternative Example: |
This member returns the dimmer level of the blue LED of TopButton1 (the button located above Fader1) as an integer value (0-255). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.TopButton1.GetBlueLedBrightness |
JogShuttleName.TopButtonID.GetRedLedBrightness |
Example: Alternative Example: |
This member returns the dimmer level of the red LED of TopButton1 (the button located above Fader1) as an integer value (0-255). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.TopButton1.GetRedLedBrightness |
JogShuttleName.TopButtonID.GetState |
Example: Alternative Example: |
This member returns the state of TopButton1 (the button located above Fader1) as a Boolean value (True = pressed state or False = released state). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.TopButton1.GetState This member is also available for "TopButton2". Alternative commands are: JogShuttle.GetTopButtonState(id) and JogShuttle.TopButtonID.State |
JogShuttleName.TopButtonID.RedLedBrightness |
Example: Alternative Example: |
This command sets and returns the dimmer level for the red LED of TopButton1 (the button located above Fader1) as an integer value (0-255). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.TopButton1.RedLedBrightness Alternative commands are: JogShuttle.GetTopButtonRedLedBrightness(id,value) and JogShuttle.TopButtonID.GetRedLedBrightness Example2: The second example shows, how to set the dimmer level for the red LED of TopButton1 to a value of 125. Values between 0 (off) and 255 (fully on) are possible. This member is also available for "TopButton2". |
JogShuttleName.TopButtonID.SetBlueLedBrightness(value) |
Example: Alternative Example: |
This command sets the dimmer level for the blue LED of TopButton1 (the button located above Fader1) to 255. Values between 0 (off) and 255 (fully on) are possible. This member is also available for "TopButton2". |
JogShuttleName.TopButtonID.SetRedLedBrightness(value) |
Example: Alternative Example: |
This command sets the dimmer level for the red LED of TopButton1 (the button located above Fader1) to 255. Values between 0 (off) and 255 (fully on) are possible. This member is also available for "TopButton2". |
JogShuttleName.TopButtonID.State |
Example: Alternative Example: |
This member returns the state of TopButton1 (the button located above Fader1) as a Boolean value (True = pressed state or False = released state). You could also write it into a Widget, e.g. a Label via the script: Label1.Text = JogShuttle.TopButton1.State This member is also available for "TopButton2". Alternative commands are: JogShuttle.GetTopButtonState(id) and JogShuttle.TopButtonID.GetState |