1. Controlling MXW through Python: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 21: | Line 21: | ||
|- | |- | ||
| plugin_script_language || Plugin Script Language || Python | | plugin_script_language || Plugin Script Language || Python | ||
|- | |||
| plugin_action_level || Plugin Activity Switch || disabled = not visible | |||
|- | |- | ||
| plugin_menu_parent || Top level parent in playlist menu || "AI", "IO" .. | | plugin_menu_parent || Top level parent in playlist menu || "AI", "IO" .. | ||
| Line 32: | Line 34: | ||
| plugin_tooltip || Tool tip in grid and panel || "This plugin triggers the playlist when it finds a Face" | | plugin_tooltip || Tool tip in grid and panel || "This plugin triggers the playlist when it finds a Face" | ||
|} | |} | ||
An example mxw_plugin.ini looks like this: | |||
<syntaxhighlight lang="ini" line> | <syntaxhighlight lang="ini" line> | ||
Revision as of 19:53, 3 December 2023
Python is used in MXW trough a plugin interface. Specified program paths are searched for plugins which are registered, and then loaded through the user interface.
As of version 7.2., plugins are available in the playlist. There are two paths searched during program startup, the program folder and the user folder:
- (Program folder)/plugins/playlist/python/
- ~.StageDesigner/plugins/playlist/python/ (Unix)
- ~.StageDesigner/plugins/playlist/python/ (Windows)
Each plugin resides in a folder. Inside this folder, two files have to be present,
- mxw_plugin.ini
- mxw_main.py
The file mxw_plugin.ini defines the registration of the plugin. The following fields are valid:
| Tag | Use | Values/Example |
|---|---|---|
| plugin_version | Plugin Version | 1 |
| plugin_script_language | Plugin Script Language | Python |
| plugin_action_level | Plugin Activity Switch | disabled = not visible |
| plugin_menu_parent | Top level parent in playlist menu | "AI", "IO" .. |
| plugin_menu_name | Playlist menu entry | "Face detection" |
| plugin_grid_name | Default name in grid (may be completed via script) | "Face detect" |
| plugin_grid_bg_color | Default color in grid (may be changed via script) | 0.95 0.05 0.45 1.00 (RGBA with range 0..1) |
| plugin_tooltip | Tool tip in grid and panel | "This plugin triggers the playlist when it finds a Face" |
An example mxw_plugin.ini looks like this:
[mxw_plugin] ; must be here
plugin_version = 1 ; must be V1 (as of V7.2)
plugin_script_language = Python ; must be Python (as of V7.2)
plugin_menu_parent = AI
plugin_menu_name = NeuronalNet(Dlib) Face Detect Plugin
plugin_grid_name = Face Detect Plugin
plugin_grid_bg_color = 0.950000 0.050000 0.450000 1.000000 ; set plugin color.
plugin_tooltip = This plugin triggers the playlist when it finds a Face using a neuronal net (Dlib)