Both sides previous revisionPrevious revision | Last revisionBoth sides next revision |
scripting [2020/07/10 10:11] – tondose | scripting [2020/07/10 10:23] – tondose |
---|
For particular events within the mAirList programme, i. e. when a player is started or some marker is passed whilst playback, mAirList is calling an associated procedure by default. If no background script is available, no further action is taken. However, if a background script exists, the code therein will be executed on the said event. | For particular events within the mAirList programme, i. e. when a player is started or some marker is passed whilst playback, mAirList is calling an associated procedure by default. If no background script is available, no further action is taken. However, if a background script exists, the code therein will be executed on the said event. |
| |
Furthermore, certain procedures provide parameters related to the regarded event – for instance the ''procedure OnPlayerStart'' yields information about the assigned player, the item being played and its position whithin the playlist. | Furthermore, certain procedures provide parameters related to the regarded event – for instance the ''procedure OnPlayerStart'' yields information about the assigned player, the item being played and its position within the playlist. |
| |
An overview of the provided background script procedures is supplied with each version of mAirList within the file ''Background Script Template.mls''. | An overview of the provided background script procedures is supplied with each version of mAirList within the file ''Background Script Template.mls''. |
===== Creating Code ===== | ===== Creating Code ===== |
| |
The code can simply be typed into a text editor. Windows-supplied ''notepad.exe'' does the trick flawlessly, however, for major projects the use of some dedicated code editor, like [[https://notepad-plus-plus.org|Notepad++]], might be considered. The finished code is to be saved in UTF-8 format into a file **with the extension ''.mls''**. | The code can simply be typed into a text editor. Windows-supplied ''notepad.exe'' does the trick flawlessly. However, for major projects the use of some dedicated code editor, like [[https://notepad-plus-plus.org|Notepad++]], might be considered. The finished code is to be saved in UTF-8 format into a file **with the extension ''.mls''**. |
| |
The structure of a simple Delphi/Turbopascal programme is as follows: | The structure of a simple Delphi/TurboPascal programme is as follows: |
| |
<code delphi> | <code delphi> |
**Note** the different use of semicolon '';'' and period ''.'' in subprogramme and main programme respectively. | **Note** the different use of semicolon '';'' and period ''.'' in subprogramme and main programme respectively. |
| |
**Comments** may be typed into ''{''curly brackets''}'', a combination of ''(*''parentheses and asterisk''*)'' or behind a ''<nowiki>//</nowiki>'' double slash. While the former two can be expanded over multiple lines, the latter works for a single line or part of it only. | **Comments** may be typed into ''{'' curly brackets ''}'', a combination of ''(*'' parentheses and asterisk ''*)'' or behind a ''<nowiki>//</nowiki>'' double slash. While the former two can be expanded over multiple lines, the latter works for a single line or part of it only. |
| |
It is highly recommended to structure the code by indenting the statements with two whitespaces at a time. [[https://community.mairlist.com/t/scripting-hilfe-grundkurs-1-wie-schreibe-ich-code/12387|A beginner’s tuorial]] can be found in the Support Forum, however, at the time being, in German language only. {{:wiki:zeichen_123_-_arbeitsstelle_stvo_2013.svg.png?nolink&20|}} | It is highly recommended to structure the code by indenting the statements with two whitespaces at a time. |
| |
| [[https://community.mairlist.com/t/scripting-hilfe-grundkurs-1-wie-schreibe-ich-code/12387|A beginner’s tuorial]] can be found in the Support Forum, however, at the time being, in German language only. {{:wiki:zeichen_123_-_arbeitsstelle_stvo_2013.svg.png?nolink&20|}} |
| |
==== Background Scripts ==== | ==== Background Scripts ==== |
| |
As mAirlist is calling //procedures// in background scripting, their code is to be placed in the //subprogramme part// of the code. This may usually leave a sole | As mAirList is calling //procedures// in background scripting, their code is to be placed in the //subprogramme part// of the script. This may usually leave a sole |
| |
<code delphi> | <code delphi> |