Moving Light Assistant - New pages [en-gb]

PresetDocView:GetSelectedChannelCount

2019-01-22T00:00:29Z

Andyv wiki admin: Added Page.

===GetSelectedChannelCount()===
:''Returns an integer.''

This function will return the number of selected channel rows displayed in the Preset Documentation channel list.

''Example.''

:<code>numSelected = PresetDocView:GetSelectedChannelCount()</code>
This would assign to the variable ''numSelected'' the number of channels selected in the channel list.

''Available in MLA v1.3.2 Beta 5 onwards.''

PresetDocView:GetSelectedPresetCount

2019-01-21T23:58:41Z

Andyv wiki admin:

===GetSelectedPresetCount()===
:''Returns an integer.''

This function will return the number of selected preset rows displayed in the Preset Documentation preset list.

''Example.''

:<code>numSelected = PresetDocView:GetSelectedPresetCount()</code>
This would assign to the variable ''numSelected'' the number of presets selected in the preset list.

''Available in MLA v1.3.2 Beta 5 onwards.''

CueInfo:SaveCueInfo

2017-12-17T23:59:07Z

Andyv wiki admin:

===SaveCueInfo(cueinfo)===
:''cueInfo is the CueInfo structure to save.''

Note this function is only available in MLA v1.3.1 Beta 14 and onwards.

This function will store the passed CueInfo structure. This is useful when the structure has been modified and the changes need storing. For every call to SaveCueInfo, an entry in the applications Undo/Redo stack will be created so that it is possible to Undo the action after the script has finished.

''Example.''

:<code>cueinfo = CueInfo:GetSelectedCueInfo()</code>
:<code>if cueinfo ~= nil then</code>
::<code>cueinfo.Image1Caption = "Photo 1 Caption"</code>
::<code>SaveCueInfo(cueinfo)</code>
:<code>end</code>

CueInfo:GetSelectedCueInfo

2017-12-17T23:52:50Z

Andyv wiki admin:

===GetSelectedCueInfo()===
:''Returns an CueInfo structure.''

Note this function has a bug and does not work correctly prior to MLA v1.3.1 Beta 14.

This function will return a CueInfo structure for the currently selected cue in the Cue List view. It will return nil if no cue is selected. It is worth adding checking for this situation.

''Example.''

:<code>cueinfo = CueInfo:GetSelectedCueInfo()</code>
:<code>if cueinfo ~= nil then</code>
::<code>cueNumber = cueinfo.CueNumber</code>
:<code>end</code>

RunAppleScript

2017-11-12T09:09:22Z

Andyv wiki admin: Page Added

===RunAppleScript( scriptString )===
:''scriptString is a string. The string is the text of the script.''
:''No Return value''
'''THIS FUNCTION WILL ONLY WORK ON macOS.''' 
'''This function is only available in MLA v1.3.1 Beta 7 onwards.'''

This function will run an Apple Script to allow control of the Finder and other applications. 

''Example..''. 
<code>-- This script will bring Image Capture to the front and simulate pressing the space bar</code> 
<code>-- to capture an image from the tethered camera.</code> 
<code>photoScript = "tell application \"Image Capture\"\n"</code> 
<code>photoScript = photoScript .. "activate\n"</code> 
<code>photoScript = photoScript .. "tell application \"System Events\"\n"</code> 
<code>photoScript = photoScript .. "key code 49\n"</code> 
<code>photoScript = photoScript .. "end tell\n"</code> 
<code>photoScript = photoScript .. "end tell\n"</code> 
<code>RunAppleScript(photoScript)</code> 
<code>Wait(0.5)</code> 
<code>-- We need MLA to be at the front to wait for image to arrive.</code> 
<code>mlaScript = "tell application \"Moving Light Assistant\"\n"</code> 
<code>mlaScript = mlaScript .. "activate\n"</code> 
<code>mlaScript = mlaScript .. "end tell\n"</code> 
<code>RunAppleScript(mlaScript)</code> 
<code>Wait(0.5)</code> 
Note that any quote character needs to be 'escaped', i.e. <code>tell application "Image Capture"</code> would need to have a '\' character before the quote to become <code>tell application \"Image Capture\"</code>

TimecodeToMA2TCTime

2017-02-20T23:16:31Z

Andyv wiki admin:

===TimecodeToMA2TCTime( timecodeString, fpsString )===
:''timecodeString is a string. This is a timecode string, i.e. 10.00.03.15''
:''fpsString is a string. This is the timecode base the timecodeString is in, i.e. 24, 25, 29.97, 30 or 100''
:''Returns an integer. This is the value of the timecodeString string in 30ths of a second''
'''This function is only available in MLA v1.3 onwards.'''

This function is used to convert a timecode string into an integer value that the grandMA2 console understands. The integer value is the timecode string as a value of 30ths of a second. The timecode string can have any separator between the hours, minutes, seconds and frames, as long as there is a separator.

''Code Example..''. 
<code>a = FormattedTimeToSeconds("00.00.05.00", "25")</code> 
The variable ''a'' would be assigned the value <code>150</code>

PresetInfo:GetSelectedChannel

2016-12-07T11:10:12Z

Andyv wiki admin: Added Page.

===GetSelectedChannel()===
:''Returns an PresetInfo structure.''

This function will return a PresetInfo structure for the currently selected channel in the channel list on the right in the main Preset Documentation view. It will return nil if no channel is selected. It is worth adding checking for this situation.

''Example.''

:<code>preset = PresetInfo:GetSelectedChannel()</code>
:<code>if preset ~= nil then</code>
::<code>presetName = preset.PresetName</code>
:<code>end</code>

PresetInfo:GetSelectedPreset

2016-12-07T11:07:59Z

Andyv wiki admin: Added Page - In Progress.

===GetSelectedPreset()===
:''Returns an PresetInfo structure.''

This function will return a PresetInfo structure for the currently selected preset in the preset list on the left in the main Preset Documentation view. If you want to access the channels in a preset, you should use PresetInfo:GetSelectedChannel(). It will return nil if no preset is selected. It is worth adding checking for this situation.

''Example.''

:<code>preset = PresetInfo:GetSelectedPreset()</code>
:<code>if preset ~= nil then</code>
::<code>presetName = preset.PresetName</code>
:<code>end</code>

PresetDocFixtureView:DispatchAction

2016-09-29T17:37:32Z

Andyv wiki admin:

===DispatchAction( action, optionalParameter )===
:''action is a string.''
:''optionalParameter is a string (only some actions require the optionalParameter).''
''Available in MLA v1.3 onwards.''

This function sends a user interface action to the Preset Documentation Fixture view. These actions would normally by triggered by clicking on the user interface, i.e. selecting a Preset in the Fixtures Preset table.

''Example.''

:<code>PresetDocFixtureView:DispatchAction("Select First Preset")</code>
This would send an action that would be the same as clicking on the first preset in the preset list for a fixture.

:<code>PresetDocFixtureView:DispatchAction("Set Hide Ignored", "False")</code>
This function with an optional parameter would be the same as clicking on the ''Hide Ignored'' checkbox. In this case, the it will set to False (off).

==Action Strings==

===Select First Preset===
Will select the first Preset in the Fixtures Preset table in the Preset Documentation Fixture view. It is the same as if you had clicked on the first Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Last Preset===
Will select the last Preset in the Fixtures Preset table in the Preset Documentation Fixture view. It is the same as if you had clicked on the last Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Next Preset===
Will select the next Preset in the Fixtures Preset table in the Preset Documentation Fixture view. If no Preset was previously selected, it will select the first Preset. Note that table will not scroll to show the selection.

===Select Previous Preset===
Will select the previous Preset in the Fixtures Preset table in the Preset Documentation Fixture view. If no Preset was previously selected, it will not do anything. Note that table will not scroll to show the selection.

===Select Preset===
:parameter (string) = Preset Type and/or Preset ID. i.e.<code>Preset,27</code>.
Will select the specified Preset in the Fixtures Preset table in the Preset Documentation Fixture view. Note that table will not scroll to show the selection.

:''Examples.''
:<code>PresetDocFixtureView:DispatchAction("Select Preset", "Preset,27")</code>
:This will select specifically Preset Type <code>Preset</code> with the Preset ID of <code>27</code>.

:<code>PresetDocFixtureView:DispatchAction("Select Preset", "46")</code>
:This will select the first Preset, regardless of Preset Type with a Preset ID of <code>46</code>.

===Display First Preset Photo===
Will display the first preset photo for the selected preset.

===Display Last Preset Photo===
Will display the last preset photo for the selected preset.

===Display Next Photo===
Where a preset/channel has multiple photos, this will display the next photo.

===Display Previous Photo===
Where a preset/channel has multiple photos, this will display the previous photo.

===Display Channel===
:parameter (string) = channel number.

===Display Fixture===
:parameter (string) = fixture number.

===Display Next Channel/Fixture===
Will increment the channel/fixture number and display the relevant presets for the channel/fixture.

===Display Previous Channel/Fixture===
Will decrement the channel/fixture number and display the relevant presets for the channel/fixture.

===Set Hide Ignored===
:parameter (string) = checkbox state (True or False).

Will set if the preset list displays ignored presets.

===Set Channel Focussed===
:parameter (string) = ''Focussed'' checkbox state for presets displayed (True or False).

SUBJECT TO CHANGE !
Will set or clear the ''Focussed'' flag for the channel in all the presets displayed in the preset list.
Note, while the word ''Channel'' is used, it will apply if a fixture is displayed.

===Sort By===
:parameter (string) = sort by item.

Will set the Sort for the Fixtures Preset list. 
Sort Items... 
:<code>Focus Order</code> 
:<code>Preset ID</code> 
:<code>Focus Cue</code> 
:<code>Set</code> 
:<code>Priority</code> 

Example. 
:<code>PresetDocFixtureView:DispatchAction("Sort By", "Preset ID")</code>

===Order By===
:parameter (string) = sort by item.

Will set the Order for the Fixtures Preset list. Works the same as ''Sort By'' but provided for consistency with the fixture view user interface. 
Sort Items... 
:<code>Focus Order</code> 
:<code>Preset ID</code> 
:<code>Focus Cue</code> 
:<code>Set</code> 
:<code>Priority</code> 

Example. 
:<code>PresetDocFixtureView:DispatchAction("Sort By", "Preset ID")</code>

PresetDocFixtureView:GetPresetCount

2016-09-29T17:03:08Z

Andyv wiki admin: Added Page.

===GetPresetCount()===
:''Returns an integer.''
:''Available in MLA v1.3 onwards.''

This function will return the number of preset rows displayed in the Preset Documentation Fixture preset list.

''Example.''

:<code>numPresets = PresetDocFixtureView:GetPresetCount()</code>
This would assign to the variable ''numPresets'' the number of presets displayed in the fixture preset list.

PresetDocFixtureView:IsLastPresetRowSelected

2016-09-29T16:58:56Z

Andyv wiki admin: Added Page.

===IsLastPresetRowSelected()===
:''Returns a boolean.''
''Available in MLA v1.3 onwards.''

This function will return true if the last preset is selected in the fixture preset list, otherwise will return false. Useful when iterating through the preset list.

''Example.''

:<code>PresetDocFixtureView:DispatchAction("Select First Preset")</code>
:<code>presetListFinished = false</code>

:<code>while presetListFinished == false do</code>
::<code> -- Insert code here to do what you want with the preset.</code>
::<code> -- Continue to next preset, or are we done.</code>
::<code> if PresetDocFixtureView:IsLastPresetRowSelected() == true then</code>
:::<code> presetListFinished = true</code>
::<code> else</code>
:::<code> PresetDocFixtureView:DispatchAction("Select Next Preset")</code>
::<code> end</code>
:<code>end</code>
This will select the first preset in the preset list and step through all the displayed presets.

Preset Documentation Fixture View

2016-09-29T16:56:08Z

Andyv wiki admin:

''Available in MLA v1.3 onwards.'' 
This page shows the functions that can be used within the Preset Documentation Fixture view. The Preset Documentation Fixture view does not need to be visible at the time these functions are called from a script.

{| style="border: 1px solid darkgray;" cellpadding="5" cellspacing="0" width="600"
|-
| colspan="3" align="left" style="background:#efefef;"| '''Functions'''
|- border="0"
|
* [[PresetDocFixtureView:DispatchAction|DispatchAction]]
* [[PresetDocFixtureView:IsLastPresetRowSelected|IsLastPresetRowSelected]]
* [[PresetDocFixtureView:GetPresetCount|GetPresetCount]]
|}

PresetDocView:IsLastChannelRowSelected

2016-09-22T06:27:52Z

Andyv wiki admin: Page created.

===IsLastChannelRowSelected()===
:''Returns a boolean.''
''Available in MLA v1.3 onwards.''

This function will return true if the last channel is selected in the channel list for the selected preset, otherwise will return false. Useful when iterating through the channel list.

''Example.''

:<code>PresetDocView:DispatchAction("Select First Channel")</code>
:<code>channelListFinished = false</code>

:<code>while channelListFinished == false do</code>
::<code> -- Insert code here to do what you want with the channel.</code>
::<code> -- Continue to next channel, or are we done.</code>
::<code> if PresetDocView:IsLastChannelRowSelected() == true then</code>
:::<code> channelListFinished = true</code>
::<code> else</code>
:::<code> PresetDocView:DispatchAction("Select Next Channel")</code>
::<code> end</code>
:<code>end</code>
This select the first channel in the channel list and step through all the displayed channels.

PresetDocView:IsLastPresetRowSelected

2016-09-22T06:21:17Z

Andyv wiki admin: Page created.

===IsLastPresetRowSelected()===
:''Returns a boolean.''
''Available in MLA v1.3 onwards.''

This function will return true if the last preset is selected in the preset list, otherwise will return false. Useful when iterating through the preset list.

''Example.''

:<code>PresetDocView:DispatchAction("Select First Preset")</code>
:<code>presetListFinished = false</code>

:<code>while presetListFinished == false do</code>
::<code> -- Insert code here to do what you want with the preset.</code>
::<code> -- Continue to next preset, or are we done.</code>
::<code> if PresetDocView:IsLastPresetRowSelected() == true then</code>
:::<code> presetListFinished = true</code>
::<code> else</code>
:::<code> PresetDocView:DispatchAction("Select Next Preset")</code>
::<code> end</code>
:<code>end</code>
This select the first preset in the preset list and step through all the displayed presets.