Controlling MXW through Python - Revision history

Admin: Admin moved page 1. Controlling MXW through Python to Controlling MXW through Python: Remove leading index prefix from title

2026-08-08T18:58:03Z

Admin moved page 1. Controlling MXW through Python to Controlling MXW through Python: Remove leading index prefix from title

← Older revision	Revision as of 20:58, 8 August 2026
(No difference)

Admin: Update links after removing '3.' prefix from reference titles (bot)

2026-08-08T15:28:25Z

Update links after removing '3.' prefix from reference titles (bot)

Admin: remove cross-language see-also links (covered by sidebar)

2026-08-08T12:21:46Z

remove cross-language see-also links (covered by sidebar)

← Older revision		Revision as of 14:21, 8 August 2026
Line 55:		Line 55:
	* [[3. Python imgui reference\|Python ImGui reference]] – drawing plugin panels with <code>mxw_imgui</code>		* [[3. Python imgui reference\|Python ImGui reference]] – drawing plugin panels with <code>mxw_imgui</code>
	* [[3. Python plugin reference\|Python plugin reference]] – writing media and playlist plugins		* [[3. Python plugin reference\|Python plugin reference]] – writing media and playlist plugins
	* [[3. JavaScript command reference\|JavaScript command reference]] – the same object interface from JavaScript

Admin: de-duplicate: turn into overview/hub linking the command, imgui and plugin reference pages

2026-08-08T12:17:23Z

de-duplicate: turn into overview/hub linking the command, imgui and plugin reference pages

Show changes

Admin at 09:31, 29 May 2024

2024-05-29T09:31:19Z

← Older revision		Revision as of 11:31, 29 May 2024
Line 70:		Line 70:
	\|-		\|-
	\| '''onActivateInUI()''' \|\| Called when the item is selected in the ui		\| '''onActivateInUI()''' \|\| Called when the item is selected in the ui
			\|-
			\| '''onNewFrameInPlayoutCue()''' \|\| Called on each frame when in current active cue
			\|-
			\| '''onRenderPanel()''' \|\| Called on each frame when actvated in UI to render the panel
	\|-		\|-
	\| '''onActiveCueChange()''' \|\| Called when the playlist seeks		\| '''onActiveCueChange()''' \|\| Called when the playlist seeks

Hwendler at 22:31, 3 December 2023

2023-12-03T22:31:49Z

← Older revision		Revision as of 00:31, 4 December 2023
Line 32:		Line 32:
	\| 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_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~~"		\| plugin_tooltip \|\| Tool tip in grid and panel \|\| "This plugin triggers the playlist when it finds a face"
	\|}		\|}

Hwendler at 22:29, 3 December 2023

2023-12-03T22:29:17Z

← Older revision		Revision as of 00:29, 4 December 2023
Line 52:		Line 52:
	The plugins are defined in a mxw_main.py file. This file is loaded, and the main UI calls the provided interface functions. The following interface functions are available for playlist plugins:		The plugins are defined in a mxw_main.py file. This file is loaded, and the main UI calls the provided interface functions. The following interface functions are available for playlist plugins:

	{\| class="wikitable" style="margin:~~auto~~"		{\| class="wikitable" style="margin-left: 0px;"
	\|+ Fields		\|+ Fields
	\|-		\|-

Hwendler at 22:28, 3 December 2023

2023-12-03T22:28:58Z

← Older revision		Revision as of 00:28, 4 December 2023
Line 13:		Line 13:

	The file '''mxw_plugin.ini''' defines the registration of the plugin. The following fields are valid:		The file '''mxw_plugin.ini''' defines the registration of the plugin. The following fields are valid:
	{\| class="wikitable" style="margin-left~~: 0px; margin-right~~: 0px;"		{\| class="wikitable" style="margin-left: 0px;"
	\|+ Fields		\|+ Fields
	\|-		\|-

Hwendler at 22:28, 3 December 2023

2023-12-03T22:28:37Z

← Older revision		Revision as of 00:28, 4 December 2023
Line 13:		Line 13:

	The file '''mxw_plugin.ini''' defines the registration of the plugin. The following fields are valid:		The file '''mxw_plugin.ini''' defines the registration of the plugin. The following fields are valid:
	{\| class="wikitable" style="margin:~~auto~~"		{\| class="wikitable" style="margin-left: 0px; margin-right: 0px;"
	\|+ Fields		\|+ Fields
	\|-		\|-

Hwendler at 20:57, 3 December 2023

2023-12-03T20:57:02Z

← Older revision		Revision as of 22:57, 3 December 2023
Line 67:		Line 67:
	\| '''onPostAction()''' \|\| Called when the cue is left		\| '''onPostAction()''' \|\| Called when the cue is left
	\|-		\|-
	\| '''onPreparePlayback()''' \|\| Called when the playlist gets a preloading command (e.g. when the \|< button is pressed)		\| '''onPreparePlayback()''' \|\| Called when the playlist gets a preloading command (e.g. when the GoToStart button is pressed)
	\|-		\|-
	\| '''onActivateInUI()''' \|\| Called when the item is selected in the ui		\| '''onActivateInUI()''' \|\| Called when the item is selected in the ui

← Older revision		Revision as of 14:21, 8 August 2026
Line 55:		Line 55:
	* [[3. Python imgui reference\|Python ImGui reference]] – drawing plugin panels with <code>mxw_imgui</code>		* [[3. Python imgui reference\|Python ImGui reference]] – drawing plugin panels with <code>mxw_imgui</code>
	* [[3. Python plugin reference\|Python plugin reference]] – writing media and playlist plugins		* [[3. Python plugin reference\|Python plugin reference]] – writing media and playlist plugins
	* [[3. JavaScript command reference\|JavaScript command reference]] – the same object interface from JavaScript

← Older revision		Revision as of 17:28, 8 August 2026
Line 1:		Line 1:
	<!-- MXWendler wiki page: Controlling MXW through Python (overview / hub) -->		<!-- MXWendler wiki page: Controlling MXW through Python (overview / hub) -->
	<!-- Intended location: https://wiki.mxwendler.net/index.php?title=1._Controlling_MXW_through_Python -->		<!-- Intended location: https://wiki.mxwendler.net/index.php?title=1._Controlling_MXW_through_Python -->
	<!-- See also: https://wiki.mxwendler.net/index.php?title=~~3._Python_command_reference~~ -->		<!-- See also: https://wiki.mxwendler.net/index.php?title=Python_command_reference -->
	<!-- See also: https://wiki.mxwendler.net/index.php?title=~~3._Python_imgui_reference~~ -->		<!-- See also: https://wiki.mxwendler.net/index.php?title=Python_imgui_reference -->
	<!-- See also: https://wiki.mxwendler.net/index.php?title=~~3._Python_plugin_reference~~ -->		<!-- See also: https://wiki.mxwendler.net/index.php?title=Python_plugin_reference -->

	MXWendler StageDesigner embeds '''Python 3.12'''. Python is used in two ways:		MXWendler StageDesigner embeds '''Python 3.12'''. Python is used in two ways:
Line 20:		Line 20:
	! Topic !! Page		! Topic !! Page
	\|-		\|-
	\| The <code>mxw</code> command interface – software info, <code>playlist</code>, <code>io</code>, <code>widget(address)</code>, <code>media(name)</code>, <code>preload(n)</code>, <code>grabber(name)</code> \|\| [[3. Python command reference\|Python command reference]]		\| The <code>mxw</code> command interface – software info, <code>playlist</code>, <code>io</code>, <code>widget(address)</code>, <code>media(name)</code>, <code>preload(n)</code>, <code>grabber(name)</code> \|\| [[Python command reference\|Python command reference]]
	\|-		\|-
	\| Drawing plugin settings panels with <code>mxw_imgui</code> (MXWendler's Dear ImGui binding) \|\| [[3. Python imgui reference\|Python ImGui reference]]		\| Drawing plugin settings panels with <code>mxw_imgui</code> (MXWendler's Dear ImGui binding) \|\| [[Python imgui reference\|Python ImGui reference]]
	\|-		\|-
	\| Writing '''plugins''' – media and playlist – the manifest (<code>mxw_plugin.ini</code>), the hooks, per-instance state, examples \|\| [[3. Python plugin reference\|Python plugin reference]]		\| Writing '''plugins''' – media and playlist – the manifest (<code>mxw_plugin.ini</code>), the hooks, per-instance state, examples \|\| [[Python plugin reference\|Python plugin reference]]
	\|}		\|}

Line 48:		Line 48:
	</pre>		</pre>

	The host discovers it at startup, shows it in the user interface and calls its hooks at the right moments. See the [[3. Python plugin reference\|Python plugin reference]] for the manifest fields, the full hook list for media and playlist plugins, plugin locations, installing extra packages with <code>mxw-pip</code>, and complete examples.		The host discovers it at startup, shows it in the user interface and calls its hooks at the right moments. See the [[Python plugin reference\|Python plugin reference]] for the manifest fields, the full hook list for media and playlist plugins, plugin locations, installing extra packages with <code>mxw-pip</code>, and complete examples.

	== See also ==		== See also ==

	* [[3. Python command reference\|Python command reference]] – the <code>mxw</code> module		* [[Python command reference\|Python command reference]] – the <code>mxw</code> module
	* [[3. Python imgui reference\|Python ImGui reference]] – drawing plugin panels with <code>mxw_imgui</code>		* [[Python imgui reference\|Python ImGui reference]] – drawing plugin panels with <code>mxw_imgui</code>
	* [[3. Python plugin reference\|Python plugin reference]] – writing media and playlist plugins		* [[Python plugin reference\|Python plugin reference]] – writing media and playlist plugins