beyond:pangoscript_commands
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| beyond:pangoscript_commands [2026/02/24 10:53] – [PangoScript Commands] Bob Varkevisser | beyond:pangoscript_commands [2026/02/27 12:51] (current) – Bob Varkevisser | ||
|---|---|---|---|
| Line 13: | Line 13: | ||
| + | ---- | ||
| + | Information below is being rewritten | ||
| - | + | < | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | Information below this line is being rewritten | + | |
| - | ---- | + | |
| ==== Intro ==== | ==== Intro ==== | ||
| Line 436: | Line 432: | ||
| GetTimelineTabName: | GetTimelineTabName: | ||
| - | |||
| - | |||
| - | |||
| - | ==== General commands ==== | ||
| - | |||
| - | |||
| - | |||
| - | StartCue | ||
| - | Parameters: Page - page index, 1..100,. Cell - cell index, 1..100; | ||
| - | Parameters: "cue name" is a string that define cue name as we see it in the grid. At first BEYOND search for cue name in the current page. If not found than the search starting from the first page of the grid. | ||
| - | Purpose: Start the cue. If cue already started the no action | ||
| - | |||
| - | StopCue Page, Cell or StopCue | ||
| - | Parameters: Page - page index, 1..100,. Cell - cell index, 1..100; | ||
| - | Parameters: "cue name" is a string that define cue name as we see it in the grid. At first BEYOND search for cue name in the current page. If not found than the search starting from the first page of the grid. | ||
| - | Purpose: Stop the cue. If cue is not started then no action. | ||
| - | |||
| - | ToggleCue Page, Cell or Toggle | ||
| - | Parameters: Page - page index, 1..100,. Cell - cell index, 1..100; | ||
| - | Parameters: "cue name" is a string that define cue name as we see it in the grid. At first BEYOND search for cue name in the current page. If not found than the search starting from the first page of the grid. | ||
| - | Purpose: Start cue if it is not currently playing, or stop a cue if it is currently playing. | ||
| - | |||
| - | |||
| - | StopCueType mask, time | ||
| - | mask: | ||
| - | 1-Image | ||
| - | 2-Timeline | ||
| - | 4-DMX | ||
| - | 8-Fixture Sequence | ||
| - | 16-Beams | ||
| - | 32-Capture | ||
| - | time � optional value, this is for soft stop. Zero means "right now". | ||
| - | |||
| - | |||
| - | PauseCue Page, Cell, State | ||
| - | Parameters: Page - page index, 1..100,. Cell - cell index, 1..60; State - recommended to use predefined constants OFF, ON or TOGGLE. Values - 0,1,2 | ||
| - | Purpose: allow to pause or unpause the cue | ||
| - | |||
| - | RestartCue | ||
| - | Parameters: Page - page index, 1..100,. Cell - cell index, 1..60; | ||
| - | Purpose: restart the cue if it already playing. Otherwise, no action. | ||
| - | |||
| - | CueDown Page, Cell | ||
| - | Parameters: Page - page index, 1..100,. Cell - cell index, 1..60; | ||
| - | Purpose: does a "mouse down" on the cue | ||
| - | |||
| - | CueUp Page, Cell | ||
| - | Parameters: Page - page index, 1..100,. Cell - cell index, 1..60; | ||
| - | Purpose: does a "mouse up" on the cue | ||
| - | |||
| - | StopCueNow Page, Cell | ||
| - | Parameters: - page index, 1..100,. Cell - cell index, 1..60; | ||
| - | Purpose: | ||
| - | |||
| - | StopCueSync Page, Cell | ||
| - | Parameters: page index, 1..100,. Cell - cell index, 1..60; | ||
| - | Purpose: | ||
| - | |||
| - | HoldClick state | ||
| - | Parameters: state - 0,1,2 or the constants ON, OFF, TOGGLE | ||
| - | Purpose: This is additional modifier for coming " | ||
| - | |||
| - | |||
| - | StopAllNow | ||
| - | Parameters: none | ||
| - | Purpose: Stop all running cues. Equal to click on menu " | ||
| - | Example: StopAllNow | ||
| - | |||
| - | StopAllSync Time | ||
| - | Parameters: time in seconds. | ||
| - | Purpose: Stop all running cues with specified soft-stop time. Also, wait for completion | ||
| - | Example: StopAllSync 0.2 | ||
| - | |||
| - | StopAllAsync Time | ||
| - | Parameters: time in seconds. | ||
| - | Purpose: Stop all running cues with specified soft-stop time. Do not wait for command completion | ||
| - | Example: StopAllAsync 0.5 | ||
| - | |||
| - | |||
| - | |||
| - | BlackOut | ||
| - | Parameters: none | ||
| - | Purpose: The same action as click on " | ||
| - | Example: Blackout | ||
| - | |||
| - | |||
| - | EnableLaserOutput | ||
| - | Parameters: none | ||
| - | Purpose: Access to " | ||
| - | Example: EnableLaserOutput | ||
| - | |||
| - | DisableLaserOutput | ||
| - | Parameters: none | ||
| - | Purpose: Access to " | ||
| - | Example: DisableLaserOutput | ||
| - | |||
| - | MasterPause | ||
| - | Parameters: On or Off or Toggle | ||
| - | Purpose: Control of " | ||
| - | Example: | ||
| - | MasterPause On | ||
| - | MasterPause Toggle | ||
| - | |||
| - | |||
| - | MasterSpeed Speed | ||
| - | Parameter: Speed, normalized value in range from 0 to 1. 0 represent full stop, 1 means normal speed | ||
| - | Purpose: It is global speed multiplier for players from Grid | ||
| - | |||
| - | |||
| - | VirtualLJ | ||
| - | Parameters: On or Off or Toggle | ||
| - | Purpose: Control of " | ||
| - | Example: VirtualLJ OFF | ||
| - | |||
| - | |||
| - | ==== VLJFX ==== | ||
| - | |||
| - | |||
| - | |||
| - | OneCue | ||
| - | Parameters: none | ||
| - | Purpose: Control of "One Cue" button on main toolbar. This command enable "One cue" mode | ||
| - | Example: OneCue | ||
| - | |||
| - | OnePer | ||
| - | Parameters: none | ||
| - | Purpose: Control of "One Per Zone" button on main toolbar. This command enable "One Per Zone" mode. Note, this mode share the button with OneCue mode | ||
| - | Example: OnePer | ||
| - | |||
| - | |||
| - | MultiCue | ||
| - | Parameters: none | ||
| - | Purpose: Control of "Multi Cue" button on main toolbar. This command enable "Multi cue" mode | ||
| - | Example: MultiCue | ||
| - | |||
| - | Transition | ||
| - | Parameters: On or Off or Toggle | ||
| - | Purpose: Control of " | ||
| - | Example: Transition On | ||
| - | |||
| - | ClickSelect | ||
| - | Parameters: none | ||
| - | Purpose: Control of " | ||
| - | Example: ClickSelect | ||
| - | |||
| - | ClickToggle | ||
| - | Parameters: none | ||
| - | Purpose: Control of " | ||
| - | Example: ClickToggle | ||
| - | |||
| - | ClickRestart | ||
| - | Parameters: none | ||
| - | Purpose: Control of " | ||
| - | Example: ClickRestart | ||
| - | |||
| - | ClickFlash | ||
| - | Parameters: none | ||
| - | Purpose: Control of " | ||
| - | Example: ClickFlash | ||
| - | |||
| - | ClickSoloFlash | ||
| - | Parameters: none | ||
| - | Purpose: Control of " | ||
| - | Example: ClickSoloFlash | ||
| - | |||
| - | ClickLive | ||
| - | Parameters: none | ||
| - | Purpose: This button is currently invisible, but t active mode of LivePRO - like tracks. | ||
| - | Example: ClickLive | ||
| - | |||
| - | ClickTrack - enable ProTrack click mode. | ||
| - | |||
| - | StartPrevious - start previously started cue. Command is for button Back of the main toolbar (Grid mode). | ||
| - | |||
| - | TogglePrevious - stop current cue and start previously stated cue. Command is for button Swap of the main toolbar (Grid mode). | ||
| - | |||
| - | TimerBeat | ||
| - | Parameters: none | ||
| - | Purpose: Simulate Timer beat (BPM timer on the main toolbar) | ||
| - | Example: TimerBeat | ||
| - | |||
| - | AudioBeat | ||
| - | Parameters: none | ||
| - | Purpose: Simulate Audio beat what usualy comes from AudioIn and FFT. | ||
| - | Example: AudioBeat | ||
| - | |||
| - | ManualBeat | ||
| - | Parameters: none | ||
| - | Purpose: Manual beam comes from keyboard. Now it is possibl to initiate it from code. | ||
| - | Example: ManualBeat | ||
| - | |||
| - | |||
| - | SetBPM value- set master Beat timer value in BPM (beat per minute). The talk about BPM (Metronome) panel on the main toolbar in the Grid mode. | ||
| - | |||
| - | SetBpmDelta value - increase or decrease the BPM. This is relative version of SetBPM command. It designed for use with MIDI controllers, | ||
| - | |||
| - | |||
| - | BeatTap | ||
| - | Parameters: none | ||
| - | Purpose: This is tap-tempo. It work in BPM panel in a main toolbar and allow enter beat-per-minute by means of tapping. Command work same as click on BMP panel. Or " | ||
| - | Example: BeatTap | ||
| - | |||
| - | BeatResync | ||
| - | Parameters: none | ||
| - | Purpose: Synchronize Beat timer to the moment of this command execution. Same as " | ||
| - | Example: BeatResync | ||
| ==== FX and Live Control commands ==== | ==== FX and Live Control commands ==== | ||
| - | |||
| Line 665: | Line 454: | ||
| For the script, to make a complex command that include all fields is not practical. Because the process has two parts. The first part - you define the destination. By default it is Master. The second part is a Command itself. BEYOND memorize the setting of destination and all consequent commands will use it. | For the script, to make a complex command that include all fields is not practical. Because the process has two parts. The first part - you define the destination. By default it is Master. The second part is a Command itself. BEYOND memorize the setting of destination and all consequent commands will use it. | ||
| - | |||
| - | |||
| - | ControlMaster | ||
| - | Parameters: none | ||
| - | Purpose: Select Master LiveControl as a destination for Live Control commands | ||
| - | |||
| - | ControlCue PageIndex, CellIndex | ||
| - | Parameters: PageIndex (1..PageNumber) and Cell Index 1..100. By default the grid has 60 cells (10x6 mode). But the grid may have another dimension with 100 cells as max. | ||
| - | Purpose: Select Cue LiveControl as a destination for Live Control commands | ||
| - | |||
| - | ControlZone ZoneIndex | ||
| - | Parameters: Zone index, 1..ZoneNumber; | ||
| - | Purpose: Select Zone LiveControl as a destination for Live Control commands | ||
| - | |||
| - | ControlProTrack ProTrackIndex | ||
| - | Parameters: Iindex, 1 to number of ProTracks created in the BEYOND/ | ||
| - | Purpose: Select ProTrack LiveControl as a destination for Live Control commands. Possible to select only one ProTrack | ||
| - | |||
| - | ControlSelZones | ||
| - | Parameters: none | ||
| - | Purpose: In opposite to ConrolSelZones, | ||
| - | Also, this command address selected ProTracks. | ||
| - | |||
| - | ControlSelCues | ||
| - | Parameters: none | ||
| - | Purpose: Control currently selected Cues. This command allow to address Live Control to multiple (currently selected) cues. The action of command limited to one page only. If BEYOND in Grid mode, then will be used the page of Main grid. If BEYOND in Timeline/ | ||
| - | |||
| - | ControlFromUI | ||
| - | |||
| - | |||
| - | Note: commands above are local commands, and modify internal register of interpreter that execute this code. It means, that the setting work only for this code, and till | ||
| - | |||
| - | |||
| - | |||
| - | ==== FX Control ==== | ||
| - | |||
| - | |||
| - | FX Index1, (Index2, | ||
| - | Parameters: At least one argument that define | ||
| - | Command designed to setting all FX layers at once, by means of one command. For setting each Layer separately use SetFX | ||
| - | Purpose: Control of FX register of cues, zones, and master | ||
| - | |||
| - | 0 - stop. | ||
| - | | ||
| - | Example: | ||
| - | FX 0,0,0,0 // stop four FX layers | ||
| - | FX 10 // set 1st later to effect number 10. | ||
| - | |||
| - | Example: | ||
| - | FX 2,3,4,5 // lineary select 2th, 3rd, 4th, 5th FXs | ||
| - | | ||
| - | |||
| - | |||
| - | |||
| - | FXAction Action1, (Action2, | ||
| - | Parameters: At least one argument that define | ||
| - | 0 - OFF, no action at all | ||
| - | 100 - norma;. full action. | ||
| - | Example: | ||
| - | FXAction 0,0,0,0 // set action for four FX layers | ||
| - | |||
| - | Note: Action parameter is not same as " | ||
| - | |||
| - | |||
| - | |||
| - | SetFX LayerIndex, | ||
| - | A bit more compact version. First parameter index of layer 1 to 4, and Effect index of 1..100. | ||
| - | Set state of one layer. | ||
| - | If EffectIndex is not defined, then command will stop the layer | ||
| - | If there are multiple Effectindex then command will activate multiple effects in this layer | ||
| - | |||
| - | SetFXAction LayerIndex, Action | ||
| - | Purpose: set Action parameter of one layer | ||
| - | Layer index - index of FX layer, 1..N | ||
| - | Action - 0..100, in percents | ||
| - | |||
| - | |||
| - | SetFXAction1 ActionValue | ||
| - | SetFXAction2 ActionValue | ||
| - | SetFXAction3 ActionValue | ||
| - | SetFXAction4 ActionValue | ||
| - | Purpose: set Action parameter of one layer | ||
| - | Action - 0..100, in percents | ||
| - | |||
| - | SetFXActionDelta ActionDelta1, | ||
| - | Shift the action value bu delta. For each layer value of delta is personal. | ||
| - | |||
| - | FXTimeScale Layer, ClockSale, BeatScale | ||
| - | |||
| - | FXTimeScaleDelta Layer, ClockSale, BeatScale | ||
| - | |||
| - | FXTimeShift Layer, ClockValue, BeatValue | ||
| - | |||
| - | FXTimeShiftDelta Layer, ClockValue, BeatValue | ||
| - | |||
| - | ShiftFX LayerIndex, | ||
| - | Delta version of control. Allow to shift effect index on N | ||
| - | |||
| - | ToggleFX LayerIndex | ||
| - | Toggle between internal LC register and current state. Layer index is optional. If Layer not defined that will be swapped all layers | ||
| - | |||
| - | ShiftFX | ||
| - | LayerIndex - 1..N | ||
| - | IndexDelta - how to shift current index | ||
| - | |||
| - | |||
| - | DropFX Layer, Effect, DurationMS | ||
| - | Layer - index of effect later in grid | ||
| - | Effect - inded of effec in grid | ||
| - | DurationMS - define how long effect will be executed | ||
| - | |||
| - | |||
| - | FXClick Layer, Index - click on effect of FX grid, with absolute effect index, 1..N | ||
| - | |||
| - | FXCellClick Layer, CellIndex - click on effect of FX grid, but effect index based on left corner, so, click on visible area | ||
| - | |||
| - | FXScroll BaseIndex | ||
| - | Base index - control scrollbar of FX gird, define left corner. 0 - default state. | ||
| - | |||
| - | |||
| - | |||
| - | ==== Live Control ==== | ||
| - | |||
| - | |||
| - | |||
| - | Size X, Y, Z | ||
| - | Parameters: X, Y and Z are size in %. 100% means a full size. Max value 400%. | ||
| - | Purpose: Access to Size of LiveControl object. | ||
| - | Example: Size 100,100,100 | ||
| - | |||
| - | SizeDelta X, Y, Z | ||
| - | Parameters: X, Y and Z are deltas that will be added to Size values. Value in %. | ||
| - | Purpose: Access to Size of LiveControl object. Good to incrementive control | ||
| - | Example: SizeDelta 0,1,0 | ||
| - | |||
| - | Zoom 100 | ||
| - | Parameter - zoom value, 0..100 | ||
| - | ZoomDelta 0 | ||
| - | Parameter - zoom delta, | ||
| - | |||
| - | Position X,Y,Z | ||
| - | Parameters: X, Y and Z are value of Position. Value in %. 0,0,0 is a center :-), 100% is boundary. Max value 400%. | ||
| - | Purpose: Access to Position of LiveControl object. | ||
| - | Example: Position 100, | ||
| - | |||
| - | PositionDelta X,Y,Z | ||
| - | Parameters: X, Y and Z are deltas for Position. Value in % | ||
| - | Purpose: Access to Positiion of LiveControl object. | ||
| - | Example: PositionDelta -5, | ||
| - | |||
| - | PositionIndex AxisIndex, Value | ||
| - | Parameters: Axis Index means: 0 is X, 1 is Y, 2 is Z. Value is value of position, in %, as usual :-) | ||
| - | Purpose: Access to Position of LiveControl object. | ||
| - | Example: PositionDelta | ||
| - | |||
| - | AngleX angle | ||
| - | Parameters: Angle in degrees | ||
| - | Purpose: Access to Rotation of LiveControl object. | ||
| - | Example: AngleX 45 | ||
| - | |||
| - | AngleY angle | ||
| - | Parameters: Angle in degrees | ||
| - | Purpose: Access to Rotation of LiveControl object. | ||
| - | Example: AngleY 0 | ||
| - | |||
| - | AngleZ angle | ||
| - | Parameters: Angle in degrees | ||
| - | Purpose: Access to Rotation of LiveControl object. | ||
| - | Example: AngleZ 180 | ||
| - | |||
| - | Angle X, Y, Z | ||
| - | Parameters: X,Y ans Z are angle in degrees. Directly define a value of rotation angles | ||
| - | Purpose: Access to Rotation of LiveControl object. | ||
| - | Example: Angle 0, 0, 90 | ||
| - | |||
| - | AngleDelta | ||
| - | Parameters: X,Y ans Z are deltas of angle in degrees. | ||
| - | Purpose: Access to Rotation of LiveControl object. | ||
| - | Example: AngleDelta 0, 0, 5 // increment Z rotation angle | ||
| - | |||
| - | RotoSpeedX | ||
| - | Parameters: Value - speed. Degrees per second. | ||
| - | Purpose: Access to Rotation of LiveControl object. | ||
| - | Example: RotoSpeedX 0 | ||
| - | |||
| - | RotoSpeedY Value | ||
| - | Parameters: Value - speed. Degrees per second. | ||
| - | Purpose: Access to Rotation of LiveControl object. | ||
| - | Example: RotoSpeedY 0 | ||
| - | |||
| - | RotoSpeedZ Value | ||
| - | Parameters: Value - speed. Degrees per second. | ||
| - | Purpose: Access to Rotation of LiveControl object. | ||
| - | Example: RotoSpeedX 0 | ||
| - | |||
| - | RotoSpeed X, Y, Z | ||
| - | Parameters: X,Y and Z are rotation speed for corresponding axis | ||
| - | Purpose: Access to Rotation of LiveControl object. | ||
| - | Example: RotoSpeed 0, 0, 0 // turn off rotation | ||
| - | |||
| - | RotoSpeedDelta X, Y, Z | ||
| - | Parameters: X,Y and Z are deltas of rotation speed. | ||
| - | Purpose: Access to Rotation of LiveControl object. | ||
| - | Example: RotoSpeedDelta 0,0, -1 // decrement of rotation speed | ||
| - | |||
| - | Brightness Value | ||
| - | Parameters: Brightness, 0..100% | ||
| - | Purpose: Access to Brightness of LiveControl object. | ||
| - | Example: Brightness 50 // half dimmed image | ||
| - | |||
| - | BrightnessDelta Value | ||
| - | Parameters: delta-version of brightnes control | ||
| - | Purpose: Access to Brightness of LiveControl object. | ||
| - | Example: BrightnessDelta +1 // positive increment | ||
| - | |||
| - | VisiblePoints Value | ||
| - | Parameters: percentage of visible points, 0%..100%. | ||
| - | Purpose: Access to VisiblePoints of LiveControl object. | ||
| - | Example: VisiblePoints 100 | ||
| - | |||
| - | VisiblePointsDelta Value | ||
| - | Parameters: delta-version of brightnes control | ||
| - | Purpose: Access to VisiblePoints of LiveControl object. | ||
| - | Example: VisiblePointsDelta 0 | ||
| - | |||
| - | ColorSlider Value | ||
| - | Parameters: Value range is 0..255. | ||
| - | Purpose: Access to Color Slider of LiveControl object. | ||
| - | Example: ColorSlider 0 | ||
| - | |||
| - | ColorSliderDelta Value | ||
| - | Parameters: Value is delta to be added to ColorSlider | ||
| - | Purpose: Access to Color Slider of LiveControl object. | ||
| - | Example: ColorSliderDelta 5 | ||
| - | |||
| - | AnimationSpeed Value | ||
| - | Parameters: Value range is 25..200 | ||
| - | Purpose: Access to AnimationSpeed Slider of LiveControl object. | ||
| - | Example: AnimationSpeed 100 // defaul value | ||
| - | |||
| - | AnimationSpeedDelta Value | ||
| - | Parameters: Value is delta to be added to AnimationSpeed | ||
| - | Purpose: Access to AnimationSpeed Slider of LiveControl object. | ||
| - | Example: AnimationSpeedDelta -10 | ||
| - | |||
| - | ScanRate Value | ||
| - | Parameters: Value range is 25..200 | ||
| - | Purpose: Access to ScanRate Slider of LiveControl object. | ||
| - | Example: ScanRate 100 // defauul state | ||
| - | |||
| - | ScanRateDelta Value | ||
| - | Parameters: Value is delta to be added to ScanRate | ||
| - | Purpose: Access to ScanRate Slider of LiveControl object. | ||
| - | Example: ScanRateDelta 10 | ||
| - | |||
| - | RGBA Red, Green, Blue, Alpha | ||
| - | RGBA Red, Green, Blue | ||
| - | RGBA Index, Value | ||
| - | |||
| - | If 4 parameters: Red, Green, Blue are color channels, values 0..255. Alpha is transparency control, range 0..255 | ||
| - | If 3 parameters: Red, Green, Blue are color channels, values 0..255. Same as four parameters, but alpha channel stay unchanged | ||
| - | If 2 parameters then Index define what parameter to change, and Value define the value of corresponding channel. | ||
| - | Index values are | ||
| - | 0 - Red | ||
| - | 1 - Green | ||
| - | 2 - Blue | ||
| - | 3 - Alpha | ||
| - | |||
| - | Purpose: Direct color control of of LiveControl object. RGBA is additional and independent layer to ColorSlider parameter | ||
| - | Example: RGBA 255, 255, 0, 128 // makes image yellow-shaded (on 50%) | ||
| - | |||
| - | RGBADelta Red, Green, Blue, Alpha | ||
| - | RGBADelta Red, Green, Blue | ||
| - | RGBADelta Index, Value | ||
| - | |||
| - | If 4 parameters: Delta (relative change) by Red, Green, Blue and Alpha channels | ||
| - | If 3 parameters: Delta (relative change) by Red, Green, Blue and Alpha channels | ||
| - | If 2 parameters then Index define what parameter to change, and Value define the delta of value of corresponding channel. | ||
| - | Index values are | ||
| - | 0 - Red | ||
| - | 1 - Green | ||
| - | 2 - Blue | ||
| - | 3 - Alpha | ||
| - | Example: RGBADelta 0, 0, 0, -16 | ||
| - | |||
| - | ResetAllRoto | ||
| - | Parameters: none | ||
| - | Purpose: reset all rotation to zero, and clear accumulator | ||
| - | Example: ResetAllRoto | ||
| - | |||
| - | ResetLiveControl | ||
| - | Parameters: none | ||
| - | Purpose: reset all sparameters of LiveControl object to default | ||
| - | Example: ResetLiveControl | ||
| - | |||
| - | |||
| - | |||
| - | |||
| - | ==== Live Control - UI surface ==== | ||
| - | |||
| - | |||
| - | Live Control tab contain a sliders like a Size, Color, etc. Each such slider has two button that scroll the slider to minimum or to maximum value. | ||
| - | |||
| - | ClickScrollZoom speed. | ||
| - | ClickScrollSize speed. | ||
| - | ClickScrollFade speed | ||
| - | ClickScrollVPoints speed | ||
| - | ClickScrollScanRate speed | ||
| - | ClickScrollColor speed | ||
| - | ClickScrollAniSpeed speed | ||
| - | ClickScrollR speed | ||
| - | ClickScrollG speed | ||
| - | ClickScrollB speed | ||
| - | ClickScrollA speed | ||
| - | |||
| - | Each function control corresponding slider in Live Control tab. Note, that this is control of UI slider. This is not a control of some exact LiveControl object. | ||
| - | |||
| - | |||
| - | ClickLCTabMode Index | ||
| - | Parameters: Index represent mode of Live Control tab. (In UI mode controlled by Master, | ||
| - | 1 - Master | ||
| - | 2 - Cue | ||
| - | 3 - Zone | ||
| - | 4 - ProTrack | ||
| - | Purpose: Control of Live Control tab mode | ||
| - | Example: ClickLCTabMode 2 // control currently selected cue in the grid | ||
| - | |||
| - | |||
| - | ClickTCTabMode Index | ||
| - | Parameters: Index represent mode. See constants of ClickLcTabMode above. | ||
| - | Purpose: Control of Time Control tab mode | ||
| - | Example: ClickTCTabMode 1 // control master | ||
| - | |||
| - | ClickFXTabMode Index | ||
| - | Parameters: Index represent mode. See constants of ClickLcTabMode above. | ||
| - | Purpose: Control of FX tab mode | ||
| - | Example: ClickFXTabMode 1 // control master | ||
| - | |||
| - | ClickFXStopAll | ||
| - | Parameters: no arguments | ||
| - | Purpose: Same as click on Stop All button on FX tab (stop all effects in currently selected Live Control) | ||
| - | Example: ClickFXStopAll | ||
| - | |||
| - | ClickFxVlj Index, State | ||
| - | Parameters: Index of FX line. Indexing from 1. Up to 8 lines. State is optional parameter and represent state of VLJ for this FX line (on or off). State values are | ||
| - | 0 - Off, 1 - On, 2 - Toggle. | ||
| - | Purpose: Enable or disable VLJ for FX line. | ||
| - | Example: ClickFxVlj 2, 0 // disable VLJ for second FX line | ||
| - | |||
| - | |||
| Line 1033: | Line 472: | ||
| - | WaitForMidi Command, Data1, Data2 | ||
| - | Parameters: Command, Data1, Data2. MIDI messages contain 3 bytes. 1st known as Command, and ha steh range 0x80h, up to 0xFF. Data1 and Data2 are parameters of command, max value is ox7F (127 decimal). It is possible to use special value "minus one", (-1), it will means "any value" | ||
| - | Purpose: Allow to make reaction on incoming MIDI event. | ||
| - | Example: | ||
| - | WaitForMidi 0x90, 0x01, -1 | ||
| - | NextPage | ||
| - | Restart | ||
| - | Note: See SelectMidi command that allow select a MIDI device from what expect the message. SelectMidi control input and output operations | ||
| - | |||
| - | |||
| - | WaitForArtNet ChannelIndex | ||
| - | Parameters: ChannelIndex | ||
| - | Purpose: Wait for change of value in incoming ArtNet packet. ChannelIndex values from 1 to 512. Special value " | ||
| - | Example: WaitForArtNet 2 | ||
| - | |||
| - | WaitForDmx ChannelIndex | ||
| - | Parameters: ChannelIndex | ||
| - | Purpose: Wait for change of value in incoming DMX packet. ChannelIndex values from 1 to 512. Special value " | ||
| - | Example: WaitForArtDMX 512 | ||
| - | |||
| - | WaitForChannel ChannelIndex | ||
| - | Parameters: ChannelIndex | ||
| - | Purpose: Wait for change of internal Channels. BEYOND has 256 channels that typically used in effects, shapes, abstracts. | ||
| - | Example: WaitForChannel 512 | ||
| - | |||
| - | WaitForCueStart PageIndex, CellIndex. | ||
| - | Parameters: PageIndex, CellIndex. | ||
| - | Purpose: Wait for start of exact Cue. Cue addres composes of Page and Cell. BEYOND has up to 64 pages, and 60 cell (cues) per page. So, address is two numbers - page and cell. Special value " | ||
| - | Example: WaitForCueStart | ||
| - | |||
| - | WaitForCueStop PageIndex, CellIndex. | ||
| - | Parameters: PageIndex, CellIndex. | ||
| - | Purpose: Wait for stop of exact Cue. Cue addres composes of Page and Cell. BEYOND has up to 100 pages, and 60 cell (cues) per page. So, address is two numbers - page and cell. Special value " | ||
| - | Example: WaitForCueStop | ||
| - | |||
| - | WaitForCellDown CellIndex. | ||
| - | Parameters: CellIndex. | ||
| - | Purpose: Main storage of cues is a Grid. When we click on the grid cell teh we start a cue, at least this is initial, and default action. But, click itself is just a click. There is special "input manager" | ||
| - | Example: WaitForCellDown | ||
| - | |||
| - | WaitForCellUp CellIndex. | ||
| - | Parameters: CellIndex. | ||
| - | Purpose: | ||
| - | Example: | ||
| - | |||
| - | WaitForCellUp 1 | ||
| - | MidiOut 0x90, 0x40, 127 | ||
| - | Sleep 100 | ||
| - | MidiOut 0x80, 0x40, 0 | ||
| - | Restart | ||
| - | |||
| - | WaitForTime Hour, | ||
| - | Parameters: Hour - 0..23, Minute - 0..59, Seconds - 0..59 , Milliseconds - 0..999; | ||
| - | Purpose: | ||
| - | Example: | ||
| - | WaitForTime 21,00,0,0 // wait for 9 PM, and then allow code for go forward | ||
| - | |||
| - | WaitForTimePos Hour, | ||
| - | Parameters: Hour - 0..23, Minute - 0..59, Seconds - 0..59 , Milliseconds - 0..999; | ||
| - | Purpose: | ||
| - | Example: | ||
| - | WaitForTime 0,1,45,0 // wait for 1 minute, 45 seconds from teh script start. | ||
| - | |||
| - | |||
| - | WaitForHotkey no arguments | ||
| - | Parameters: | ||
| - | Purpose: | ||
| - | Example: | ||
| - | WaitForHotkey | ||
| - | DmxOut 1, 255 // set first channel to 255 | ||
| - | Sleep 500 // wait a half of second | ||
| - | DmxOut 1, 0 // zero first channel | ||
| - | |||
| - | |||
| - | WaitForAudioBeat no arguments | ||
| - | Parameters: | ||
| - | Purpose: | ||
| - | |||
| - | WaitForManualBeat no arguments | ||
| - | Parameters: | ||
| - | Purpose: | ||
| - | |||
| - | WaitForTimerBeat no arguments | ||
| - | Parameters: | ||
| - | Purpose: | ||
| - | |||
| - | ==== Custom Events ==== | ||
| - | |||
| - | |||
| - | |||
| - | WaitForEvent | ||
| - | Parameters - at least one string that define name of event. May be used more than one event names. | ||
| - | |||
| - | PulseEvent Name[, Name, Name] | ||
| - | Parameter - at least one name of the event. It will reactive the scripts that suspended by WaitForEvent | ||
| - | |||
| - | |||
| - | ==== Workspace Pages, Tabs, Category ==== | ||
| - | |||
| - | |||
| - | SelectGrid Index | ||
| - | Index allow to choose what grid will be used for executing commands below. Zero (0) means " | ||
| - | |||
| - | SelectTabName " | ||
| - | Select the tab of the grid by specified name. Name is a string. Function work within current category. | ||
| - | |||
| - | SelectTab Index | ||
| - | Select the tab by linear index. Counting starts from 1. Function work within current category. | ||
| - | |||
| - | SelectNextTab | ||
| - | Select the next tab relatively to current. No arguments. Function work within current category. | ||
| - | |||
| - | SelectPrevTab | ||
| - | Select the previous tab relatively to current. No arguments. Function work within current category. | ||
| - | |||
| - | |||
| - | SelectPageName " | ||
| - | Select the page/tab of the grid by specified name. Name is a string. Function work independently on current category. | ||
| - | |||
| - | SelectPage Index | ||
| - | Select the page/tab by linear index. Counting starts from 1. Function work independently on current category. | ||
| - | |||
| - | SelectNextPage | ||
| - | Select the next page/tab relatively to current. No arguments. Function work independently on current category. | ||
| - | |||
| - | SelectPrevPage | ||
| - | Select the previous page/tab relatively to current. No arguments. Function work independently on current category. | ||
| - | |||
| - | SelectAllCat | ||
| - | No argumens. Select all categoris of pages, same as click on " | ||
| - | |||
| - | SelectCatName CategoryName | ||
| - | CategoryName - string. Select a category by name. Names of categories are completelly user defined, and may vary from workspace to workspace. | ||
| - | |||
| - | SelectCat Index | ||
| - | Select category by index. Counting from 1. -1 mean all, this is analog of SelectAllCat. | ||
| - | |||
| - | SelectNextCat | ||
| - | Select next category relatively to current. No arguments. | ||
| - | |||
| - | SelectPrevCat | ||
| - | Select previous category relatively to current. No arguments. | ||
| - | |||
| - | |||
| - | ==== Zones ==== | ||
| - | |||
| - | |||
| - | UnselectAllZones | ||
| - | Unselect all projection zones. Analog of "use cue defined routing" | ||
| - | |||
| - | StoreZoneSelection | ||
| - | Store information about currently selected zones in local buffer of interpreter. Lifetime of strong is limited to lifertime of time of executing this code | ||
| - | |||
| - | ReStoreZoneSelection | ||
| - | Restore previously store zone selection. | ||
| - | |||
| - | SelectZone Index | ||
| - | Select the zone by index. Argument - number. Counting from 1. | ||
| - | |||
| - | UnSelectZone Index | ||
| - | Select the zone by index. Argument - number. Counting from 1. | ||
| - | |||
| - | ToggleSelectZone Index | ||
| - | Toggle zone selection state. Argument - number. Counting from 1. | ||
| - | |||
| - | SelectZoneName ZoneName | ||
| - | Select zone by name. Argument - string. | ||
| - | |||
| - | UnSelectZoneName ZoneName | ||
| - | Unselect zone by name. Argument - string. | ||
| - | |||
| - | ToggleSelectZoneName ZoneName | ||
| - | Toggle zone selection state. Argument - string. | ||
| - | |||
| - | |||
| - | |||
| - | ==== Cell Navigation ==== | ||
| - | |||
| - | |||
| - | Command from this section designed to actiavte the cues within the page. Functionality affected by SelectGrid !!! | ||
| - | |||
| - | FocusCell Col, Row | ||
| - | Set focused cell by Column and Row. Columt range 1..10. Row range 1..6. | ||
| - | |||
| - | FocusCellIndex Index | ||
| - | Set focused cell by index (1..60) | ||
| - | |||
| - | StartCell | ||
| - | No arguments. Start focused cell | ||
| - | |||
| - | StopCell | ||
| - | No arguments. Stop focused cell | ||
| - | |||
| - | ShiftFocus DeltaIndex | ||
| - | Shift focused cell on DeltaIndex cells forward or backward. Positive value - go forward. Independently on step value the resulting index will be valid range. | ||
| - | |||
| - | MoveFocus DeltaX, DeltaY | ||
| - | DeltaX - how many cells to go horizontaly | ||
| - | DeltaY - how many cells to go vertically | ||
| - | |||
| - | ==== Local Commands ==== | ||
| - | |||
| - | |||
| - | Restart | ||
| - | Parameters: none | ||
| - | Purpose: | ||
| - | Example: Restart | ||
| - | |||
| - | Exit | ||
| - | Parameters: none | ||
| - | Purpose: | ||
| - | Example: Restart | ||
| - | |||
| - | Autostart | ||
| - | Parameters: none | ||
| - | Purpose: Automatically start the script execution. Suitable for PangoScript tab and MIDI background scripts. | ||
| - | |||
| - | StopOnBlackout | ||
| - | Purpose: this option define how the scripter should react on blackout. By default (at least now), the script execution will not be interrupted. If to will enable this option then the script execution will stop. | ||
| - | |||
| - | CodeName string | ||
| - | Parameters: String. Allow define a program name in the Code list. This string is also used for identification of Code for StartCode and StopCode functions. | ||
| - | Example: Name "my first code" | ||
| - | |||
| - | CodeShortcut shortcut-string | ||
| - | Paremeter: a string that contain a shortcut in text form. As example: "" | ||
| - | |||
| - | StartCode CodeName | ||
| - | Parameter: string that define code name to start. Could be used only code from the main pool (listbox in Code tab); | ||
| - | Purpose: | ||
| - | Example: | ||
| - | // First script | ||
| - | WaitForHotkey " | ||
| - | StartCode " | ||
| - | WaitForHotekey " | ||
| - | StopCode " | ||
| - | Restart | ||
| - | |||
| - | // Second script | ||
| - | CodeName " | ||
| - | WaitForBeat | ||
| - | LCMaster | ||
| - | AngleDelta 0,0, 5 | ||
| - | Restart | ||
| - | |||
| - | |||
| - | StopCode CodeName | ||
| - | Parameter: string that define code name to stop. | ||
| - | Purpose: | ||
| - | |||
| - | |||
| - | |||
| - | ==== Output ==== | ||
| - | |||
| - | |||
| - | SelectMidi DeviceNumber | ||
| - | Parameters: DeviceNumber is from 1 to 4 and correspond to device number of MIDI settings dialog. Special value " | ||
| - | Example: | ||
| - | SelectMidi 1 | ||
| - | WaitForMidi 0xC0, 00, ANY | ||
| - | |||
| - | See also - GetMidiDeviceIndex. Function return currently selected device number | ||
| - | |||
| - | SetMidiLayer | ||
| - | |||
| - | |||
| - | MidiOut Message, Data1, Data2 | ||
| - | Parameters: 3 parameters, standard for MIDI, Message is value in range of 80h up to FFh. Data1 and Data2 from zero to 7Fh. | ||
| - | |||
| - | DmxOut Channel, Value | ||
| - | Parameters: Channel is index of DMX channel, value range 1..512. Value is state of DMX channel, range 0..255 | ||
| - | Example: DmxOut 1,255 | ||
| - | |||
| - | DmxOutRange | ||
| - | |||
| - | |||
| - | ChannelOut ChannelIndex, | ||
| - | Parameters: ChannelIndex is index of internal BEYOND Channel, value range 1..255. Value is state of DMX channel, range 0..1000. | ||
| - | Example: ChannelOut 1,1000 | ||
| - | |||
| - | OscOut Address, [Agrument] | ||
| - | The first parameter is osc message address. string. | ||
| - | Second and other agruments are optional. Types - string or number. | ||
| - | |||
| - | ==== Unsafe commands ==== | ||
| - | |||
| - | |||
| - | RunApp File, Parameters, ShowCmd | ||
| - | Purpose: This command use ShellExecute() function inside it. Please check MSDN: http:// | ||
| - | Reason of adding this command - ability to run extenal application from BEYOND. Internally, BEYOND use this code: | ||
| - | |||
| - | ShellExecuteW(0, | ||
| - | |||
| - | Parameters: | ||
| - | File - string. exe file name including path. | ||
| - | Parameters - string. | ||
| - | ShowCmd - number, see MSDN for details are optional. For more info please check MSDN. Default value is SW_SHOWNORMAL (1) | ||
| - | |||
| - | Example: RunApp " | ||
| - | |||
| - | IMPORTANT: This command is disabled by default because of security reasons. If you going to use this command, enable it in " | ||
| - | |||
| - | ==== Limiters ==== | ||
| - | |||
| - | |||
| - | SetLimiterProfile Index | ||
| - | Parameter - index of profile. There are two profiles, the 1st for "One Cue" mode, and second for "Multi Cue" mode. You should select 1 or 2 before using SetLimiter commands. This also will affect the state of BEYOND and change the active profile. It is recommended to call OneCue, OnePer or MultiCue command after the profile. | ||
| - | |||
| - | SetLimiterPerZone Value | ||
| - | Value specify max number of cues per Zone. The range is 1..30. The range is big, and we recommend to keep the values in reasonable limits | ||
| - | |||
| - | SetLimiterPerGrid Value | ||
| - | Value specify max number of cues per Grid. The range is 1..30. | ||
| - | |||
| - | SetLimiterFlash Value | ||
| - | Value specify max number of cues that can be in Flash mode. The range is 1..30. | ||
| - | |||
| - | SetLimiterHold Value | ||
| - | Value specify max number of cues that can be in Hold mode. The range is 1..30. | ||
| - | |||
| - | SetLimiterBeam Value | ||
| - | Value specify max number of playing Beam cues. The range is 1..30. | ||
| - | |||
| - | SetLimiterDMX Value | ||
| - | Value specify max number of playing Beam cues. The range is 1..30. | ||
| - | |||
| - | SetLimiterShow Value | ||
| - | Value specify max number of playing Show cues. The range is 1..30. | ||
| Line 1380: | Line 491: | ||
| Color - index, 1..10; | Color - index, 1..10; | ||
| - | |||
| - | ==== QuickDMX Editor ==== | ||
| - | |||
| - | |||
| - | SetDmxEditorChannel | ||
| - | |||
| - | |||
| - | ==== Play List control ==== | ||
| - | |||
| - | |||
| - | PlayListStop | ||
| - | Stop playing of current show | ||
| - | |||
| - | PlayListPlay | ||
| - | Start playing of current show | ||
| - | |||
| - | PlayListFirst | ||
| - | Jump to first show in the list. Work in play and edit modes. | ||
| - | |||
| - | PlayListLast | ||
| - | Jump to last show in the list. Work in play and edit modes. | ||
| - | |||
| - | PlayListNext | ||
| - | Jump to next show in the list. Work in play and edit modes. | ||
| - | |||
| - | PlayListPrev | ||
| - | Jump to previous show in the list. Work in play and edit modes. | ||
| - | | ||
| - | PlayListSetPos index | ||
| - | Jump to specified show of the list. Index define a number of show in the list | ||
| - | |||
| - | PlayListSetTime time | ||
| - | Jump to time position of the show, value defined in seconds. Work only in PLAY mode. | ||
| - | |||
| - | |||
| - | ==== Debug messages ==== | ||
| - | |||
| - | |||
| - | qLog string or numeric argument(s) | ||
| - | Purpose: display message in QLog tab. Usefull for debug purposes. | ||
| - | |||
| - | Write string or numeric argument(s) | ||
| - | |||
| - | Purpose: create special output window and display message. | ||
| - | |||
| - | WriteLn string or numeric argument(s) | ||
| - | Purpose: create special output window and display message. | ||
| - | |||
| - | |||
| - | ==== Player control ==== | ||
| - | |||
| - | |||
| - | InvertPlayersTime | ||
| - | No arguments. Invert time direction of all currently playing cues. Works for all dynamic players. Used in corresponding button on Master tab | ||
| - | |||
| - | PlayersSetJump (no argument) | ||
| - | No arguments. The first call memorize current player position and second call restore the time of player to that position. See PlayersResetTime that clear this time storage. Works for all dynamic players. Used in corresponding button on Master tab | ||
| - | |||
| - | PlayersResetJump | ||
| - | No arguments. Function is an addition for PlayersSetJump, | ||
| - | |||
| - | PlayersSetLoop | ||
| - | No arguments.One more function of "time fun" groups. First call memorize time position A, second call memorize time position B, and after that, Player bounce the time within specified A-B range. Third call of this procedure clear the time varibales, and player continue normal playback. Works for all dynamic players. Used in corresponding button on Master tab | ||
| - | |||
| - | PlayersDisk | ||
| - | PlayersDisk provide access to "DJ disk" from Master tab of BEYOND. Disk action based on two things - distance from center that define the slowdown of rotation (speed control) and second is position shift - what actually is time shift delta. | ||
| - | SpeedMultipler is normalized value within 0..1 range, where 1 is full speed, 0 a full stop | ||
| - | PositionDelta is a shift of time, backward or forward. Value in radians. Each call add this value to time position of the players. Parameter is optional!, there is a special procedure for this if you plan to use it from MIDI. | ||
| - | Works for all dynamic players. Used in corresponding button on Master tab | ||
| - | |||
| - | PlayersDiskShift PositionDelta | ||
| - | Command does the time shift (on delta) of all currently playing cue. It is simple action like Time=Time+Delta; | ||
| - | Command made for use with MIDI and action is equal to PlayersDisk command. | ||
| Line 1764: | Line 802: | ||
| + | </ | ||
beyond/pangoscript_commands.1771926803.txt · Last modified: by Bob Varkevisser
