Python command reference - Revision history

Admin: Add Category:Python at page end (bot)

2026-08-08T15:33:29Z

← Older revision		Revision as of 17:33, 8 August 2026
Line 214:		Line 214:
	* [[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>
	* [[Python plugin reference\|Python Plugin Howto]] – writing media and playlist plugins		* [[Python plugin reference\|Python Plugin Howto]] – writing media and playlist plugins
			[[Category:Python]]
	[[Category:Reference]]		[[Category:Reference]]

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

2026-08-08T15:28:28Z

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

← Older revision		Revision as of 17:28, 8 August 2026
Line 1:		Line 1:
	<!-- MXWendler wiki page: Python command reference (module mxw) -->		<!-- MXWendler wiki page: Python command reference (module mxw) -->
	<!-- Intended location: https://wiki.mxwendler.net/index.php?title=~~3._Python_command_reference~~ -->		<!-- Intended location: 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 -->

	This page lists the commands of the Python module <code>mxw</code>, MXWendler's general Python command interface. It is available from the script console and from Python plugins (see the [[3. Python plugin reference\|Python Plugin Howto]]). For drawing plugin panels see the [[3. Python imgui reference\|Python ImGui Reference]].		This page lists the commands of the Python module <code>mxw</code>, MXWendler's general Python command interface. It is available from the script console and from Python plugins (see the [[Python plugin reference\|Python Plugin Howto]]). For drawing plugin panels see the [[Python imgui reference\|Python ImGui Reference]].

	The embedded interpreter is '''Python 3.12'''. Import is implicit in the script console; in a plugin module use <code>import mxw</code>.		The embedded interpreter is '''Python 3.12'''. Import is implicit in the script console; in a plugin module use <code>import mxw</code>.
Line 212:		Line 212:
	=== See also ===		=== See also ===

	* [[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 Howto]] – writing media and playlist plugins		* [[Python plugin reference\|Python Plugin Howto]] – writing media and playlist plugins
	[[Category:Reference]]		[[Category:Reference]]

Admin: Admin moved page 3. Python command reference to Python command reference: Remove nonsensical '3.' numbering prefix from reference titles

2026-08-08T15:27:37Z

Admin moved page 3. Python command reference to Python command reference: Remove nonsensical '3.' numbering prefix from reference titles

← Older revision	Revision as of 17:27, 8 August 2026
(No difference)

Admin: Add to Category:Reference (bot)

2026-08-08T14:45:06Z

Add to Category:Reference (bot)

← Older revision		Revision as of 16:45, 8 August 2026
Line 214:		Line 214:
	* [[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 Howto]] – writing media and playlist plugins		* [[3. Python plugin reference\|Python Plugin Howto]] – writing media and playlist plugins
			[[Category:Reference]]

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

2026-08-08T12:21:45Z

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

← Older revision		Revision as of 14:21, 8 August 2026
Line 214:		Line 214:
	* [[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 Howto]] – writing media and playlist plugins		* [[3. Python plugin reference\|Python Plugin Howto]] – writing media and playlist plugins
	* [[3._JavaScript_command_reference\|JavaScript command reference]] – the same object interface from JavaScript

Admin: remove reg_* removal sentence

2026-08-08T12:11:55Z

remove reg_* removal sentence

← Older revision		Revision as of 14:11, 8 August 2026
Line 23:		Line 23:
	'''Addressing:''' widgets are targeted by their OSC-style address string, e.g. <code>/mxw/track/active/layer/active/clip</code>. The same addresses used over OSC work here.		'''Addressing:''' widgets are targeted by their OSC-style address string, e.g. <code>/mxw/track/active/layer/active/clip</code>. The same addresses used over OSC work here.

	'''Access model (7.2):''' widget values are read/written through <code>mxw.widget(address)</code>; global functions live in the submodules/factories <code>mxw.playlist</code>, <code>mxw.io</code>, <code>mxw.preload(n)</code>, <code>mxw.media(name)</code>, <code>mxw.grabber(name)</code>~~. The older global <code>reg_*</code> helper functions have been removed in favour of this object interface~~.		'''Access model (7.2):''' widget values are read/written through <code>mxw.widget(address)</code>; global functions live in the submodules/factories <code>mxw.playlist</code>, <code>mxw.io</code>, <code>mxw.preload(n)</code>, <code>mxw.media(name)</code>, <code>mxw.grabber(name)</code>.

	</div>		</div>

Admin: 7.2: reword version note (bold), drop per-command 7.2 tags, fix imgui/plugin links

2026-08-08T10:55:25Z

7.2: reword version note (bold), drop per-command 7.2 tags, fix imgui/plugin links

Admin: 7.2: regenerate from source (unified script interface: widget().info(), mxw.describe(), OO proxies)

2026-08-08T10:49:49Z

7.2: regenerate from source (unified script interface: widget().info(), mxw.describe(), OO proxies)

Show changes

Hwendler at 08:27, 12 June 2024

2024-06-12T08:27:33Z

← Older revision		Revision as of 10:27, 12 June 2024
Line 165:		Line 165:
	\|-		\|-
	\|<code>mxw.playlist.go_first()</code> \|\| go to the first cue \|\| <code>mxw.playlist.go_first()</code>		\|<code>mxw.playlist.go_first()</code> \|\| go to the first cue \|\| <code>mxw.playlist.go_first()</code>
			\|-
			\|<code>mxw.playlist.get_active_cue()</code> \|\| return active cue index\|\| <code>index = mxw.playlist.get_active_cue()</code>
	\|-		\|-
	\|<code>mxw.playlist.navigate_index(index_value)</code> \|\| go to the specified cue index\|\| <code>mxw.playlist.navigate_index(2)</code>		\|<code>mxw.playlist.navigate_index(index_value)</code> \|\| go to the specified cue index\|\| <code>mxw.playlist.navigate_index(2)</code>

Hwendler: /* Set Reference */

2023-12-03T22:10:30Z

Set Reference

← Older revision		Revision as of 14:21, 8 August 2026
Line 214:		Line 214:
	* [[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 Howto]] – writing media and playlist plugins		* [[3. Python plugin reference\|Python Plugin Howto]] – writing media and playlist plugins
	* [[3._JavaScript_command_reference\|JavaScript command reference]] – the same object interface from JavaScript

← Older revision		Revision as of 12:55, 8 August 2026
Line 1:		Line 1:
	<!-- MXWendler wiki page: Python command reference (module mxw) -->		<!-- MXWendler wiki page: Python command reference (module mxw) -->
	<!-- Intended location: https://wiki.mxwendler.net/index.php?title=3._Python_command_reference -->		<!-- Intended location: https://wiki.mxwendler.net/index.php?title=3._Python_command_reference -->
	<!-- See also: https://wiki.mxwendler.net/index.php?title=~~Python_ImGui_Reference~~ -->		<!-- See also: https://wiki.mxwendler.net/index.php?title=3._Python_imgui_reference -->
	<!-- See also: https://wiki.mxwendler.net/index.php?title=~~Python_Plugin_Howto~~ -->		<!-- See also: https://wiki.mxwendler.net/index.php?title=3._Python_plugin_reference -->

	This page lists the commands of the Python module <code>mxw</code>, MXWendler's general Python command interface. It is available from the script console and from Python plugins (see the [[~~Python_Plugin_Howto~~\|Python Plugin Howto]]). For drawing plugin panels see the [[~~Python_ImGui_Reference~~\|Python ImGui Reference]].		This page lists the commands of the Python module <code>mxw</code>, MXWendler's general Python command interface. It is available from the script console and from Python plugins (see the [[3. Python plugin reference\|Python Plugin Howto]]). For drawing plugin panels see the [[3. Python imgui reference\|Python ImGui Reference]].

	The embedded interpreter is '''Python 3.12'''. Import is implicit in the script console; in a plugin module use <code>import mxw</code>.		The embedded interpreter is '''Python 3.12'''. Import is implicit in the script console; in a plugin module use <code>import mxw</code>.

	'''~~Applies to MXWendler StageDesigner 7.2.''' Commands marked '''(new~~ in 7.2~~)''' or '''(changed in 7~~.2)''' ~~were introduced or reworked in this version as part of the unified script/OSC interface.~~		'''The presented Python commands supported in version 7.2. and up'''

	=== Legend ===		=== Legend ===
Line 55:		Line 55:
	\|<code>mxw.makesectionscreenshot("path", x, y, w, h)</code> \|\| save a cropped screenshot of the region (x, y, w, h) \|\| <code>mxw.makesectionscreenshot("c:/Users/me/Desktop/crop.png", 0, 0, 400, 200)</code>		\|<code>mxw.makesectionscreenshot("path", x, y, w, h)</code> \|\| save a cropped screenshot of the region (x, y, w, h) \|\| <code>mxw.makesectionscreenshot("c:/Users/me/Desktop/crop.png", 0, 0, 400, 200)</code>
	\|-		\|-
	\|<code>mxw.describe()</code> \|\| ~~'''(new in 7.2)'''~~ return a text listing of every operation known to the unified interface registry (auto-docs / discovery) \|\| <code>mxw.print_console(mxw.describe())</code>		\|<code>mxw.describe()</code> \|\| return a text listing of every operation known to the unified interface registry (auto-docs / discovery) \|\| <code>mxw.print_console(mxw.describe())</code>
	\|-		\|-
	!colspan="3" \| I/O ( <code>mxw.io</code> )		!colspan="3" \| I/O ( <code>mxw.io</code> )
Line 97:		Line 97:
	\|<code>mxw.playlist.get_active_cue()</code> \|\| return the active cue index (int) \|\| <code>i = mxw.playlist.get_active_cue()</code>		\|<code>mxw.playlist.get_active_cue()</code> \|\| return the active cue index (int) \|\| <code>i = mxw.playlist.get_active_cue()</code>
	\|-		\|-
	\|<code>mxw.playlist.get_cue_count()</code> \|\| ~~'''(new in 7.2)'''~~ return the number of cues (int) \|\| <code>n = mxw.playlist.get_cue_count()</code>		\|<code>mxw.playlist.get_cue_count()</code> \|\| return the number of cues (int) \|\| <code>n = mxw.playlist.get_cue_count()</code>
	\|-		\|-
	\|<code>mxw.playlist.get_cue_names()</code> \|\| ~~'''(new in 7.2)'''~~ return the list of cue names (index matches <code>navigate_index</code>) \|\| <code>for name in mxw.playlist.get_cue_names(): pass</code>		\|<code>mxw.playlist.get_cue_names()</code> \|\| return the list of cue names (index matches <code>navigate_index</code>) \|\| <code>for name in mxw.playlist.get_cue_names(): pass</code>
	\|-		\|-
	\|<code>mxw.playlist.is_rehearsal()</code> \|\| ~~'''(new in 7.2)'''~~ return True if the playlist is in rehearsal mode \|\| <code>if mxw.playlist.is_rehearsal(): pass</code>		\|<code>mxw.playlist.is_rehearsal()</code> \|\| return True if the playlist is in rehearsal mode \|\| <code>if mxw.playlist.is_rehearsal(): pass</code>
	\|-		\|-
	!colspan="3" \|Preload ( <code>mxw.preload(n)</code> )		!colspan="3" \|Preload ( <code>mxw.preload(n)</code> )
Line 129:		Line 129:
	\|<code>mxw.preload(n).set_track_position(pos)</code> \|\| set the preload's track index \|\| <code>mxw.preload(2).set_track_position(2)</code>		\|<code>mxw.preload(n).set_track_position(pos)</code> \|\| set the preload's track index \|\| <code>mxw.preload(2).set_track_position(2)</code>
	\|-		\|-
	\|<code>mxw.preload(n).get_preload_names()</code> \|\| ~~'''(new in 7.2)'''~~ return the list of preload comment/name strings \|\| <code>names = mxw.preload(2).get_preload_names()</code>		\|<code>mxw.preload(n).get_preload_names()</code> \|\| return the list of preload comment/name strings \|\| <code>names = mxw.preload(2).get_preload_names()</code>
	\|-		\|-
	\|<code>mxw.preload(n).get_image_sample_cvmat(w, h)</code> \|\| ~~'''(new in 7.2)'''~~ return a <code>w</code>×<code>h</code> RGBA image sample of the preload as a buffer (OpenCV Mat) \|\| <code>img = mxw.preload(2).get_image_sample_cvmat(64, 64)</code>		\|<code>mxw.preload(n).get_image_sample_cvmat(w, h)</code> \|\| return a <code>w</code>×<code>h</code> RGBA image sample of the preload as a buffer (OpenCV Mat) \|\| <code>img = mxw.preload(2).get_image_sample_cvmat(64, 64)</code>
	\|-		\|-
	!colspan="3" \|Widgets ( <code>mxw.widget(address)</code> )		!colspan="3" \|Widgets ( <code>mxw.widget(address)</code> )
Line 147:		Line 147:
	\|<code>mxw.widget("/mxw/path").animate(initvalue, incomingvalue, duration, delta, type)</code> \|\| animate the widget value over <code>duration</code> ms \|\| <code>mxw.widget("/mxw/path").animate(0.0, 1.0, 1000, 0.0, 0)</code>		\|<code>mxw.widget("/mxw/path").animate(initvalue, incomingvalue, duration, delta, type)</code> \|\| animate the widget value over <code>duration</code> ms \|\| <code>mxw.widget("/mxw/path").animate(0.0, 1.0, 1000, 0.0, 0)</code>
	\|-		\|-
	\|<code>mxw.widget("/mxw/path").info()</code> \|\| ~~'''(new in 7.2)'''~~ return a list describing the widget. For a '''clip''': <code>[length, width, height, millis_per_frame, cache_state, media_path]</code>. Returns <code>[]</code> if the address does not resolve \|\| <code>length, w, h, mspf, cache, path = mxw.widget("/mxw/track/active/layer/active/clip").info()</code>		\|<code>mxw.widget("/mxw/path").info()</code> \|\| return a list describing the widget. For a '''clip''': <code>[length, width, height, millis_per_frame, cache_state, media_path]</code>. Returns <code>[]</code> if the address does not resolve \|\| <code>length, w, h, mspf, cache, path = mxw.widget("/mxw/track/active/layer/active/clip").info()</code>
	\|-		\|-
	!colspan="3" \|Media ( <code>mxw.media(name)</code> )		!colspan="3" \|Media ( <code>mxw.media(name)</code> )
Line 212:		Line 212:
	=== See also ===		=== See also ===

	* [[~~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>
	* [[~~Python_Plugin_Howto~~\|Python Plugin Howto]] – writing media and playlist plugins		* [[3. Python plugin reference\|Python Plugin Howto]] – writing media and playlist plugins
	* [[3._JavaScript_command_reference\|JavaScript command reference]] – the same object interface from JavaScript		* [[3._JavaScript_command_reference\|JavaScript command reference]] – the same object interface from JavaScript

← Older revision		Revision as of 00:10, 4 December 2023
Line 174:		Line 174:
	\|<code>mxw.preload(preload_number).clear()</code> \|\| clears the selected preload \|\| <code>mxw.preload(2).clear()</code>		\|<code>mxw.preload(preload_number).clear()</code> \|\| clears the selected preload \|\| <code>mxw.preload(2).clear()</code>
	\|-		\|-
	\|<code>mxw.preload(preload_number).set_media("media_name")</code> \|\| set a media in the preload with a filename string \|\| <code>mxw.preload(~~preload_number~~).set_media("try.mp4")</code>		\|<code>mxw.preload(preload_number).set_media("media_name")</code> \|\| set a media in the preload with a filename string \|\| <code>mxw.preload(2).set_media("try.mp4")</code>
	\|-		\|-
	\|<code>mxw.preload(preload_number).set_name("new_media_name")</code> \|\| renames a preload \|\| <code>mxw.preload(4).set_name("new_background")</code>		\|<code>mxw.preload(preload_number).set_name("new_media_name")</code> \|\| renames a preload \|\| <code>mxw.preload(2).set_name("new_background")</code>
	\|-		\|-
	\|<code>mxw.preload(preload_number).add_preload()</code> \|\| load a preload in the layers \|\| <code>mxw.preload(3).add_preload()</code>		\|<code>mxw.preload(preload_number).add_preload()</code> \|\| load a preload in the layers \|\| <code>mxw.preload(2).add_preload()</code>
	\|-		\|-
	\|<code>mxw.preload(preload_number).trigger_preload()</code> \|\| trigger a layer from the preload \|\| <code>mxw.preload(5).trigger_preload()</code>		\|<code>mxw.preload(preload_number).trigger_preload()</code> \|\| trigger a layer from the preload \|\| <code>mxw.preload(2).trigger_preload()</code>
	\|-		\|-
	\|<code>mxw.preload(preload_number).get_activated()</code> \|\| requests if the preload is editable \|\| <code>mxw.preload(9).get_activated()</code>		\|<code>mxw.preload(preload_number).get_activated()</code> \|\| requests if the preload is editable \|\| <code>mxw.preload(2).get_activated()</code>
	\|-		\|-
	\|<code>mxw.preload(preload_number).set_activated(true/false)</code> \|\| opens the preload for edit and viceversa \|\| <code>mxw.preload(12).set_activated(false)</code>		\|<code>mxw.preload(preload_number).set_activated(true/false)</code> \|\| opens the preload for edit and viceversa \|\| <code>mxw.preload(2).set_activated(false)</code>
	\|-		\|-
	\|<code>mxw.preload(preload_number).get_layer_position()</code> \|\| returns the layer index of the preload\|\| <code>mxw.preload(1).get_layer_position()</code>		\|<code>mxw.preload(preload_number).get_layer_position()</code> \|\| returns the layer index of the preload\|\| <code>mxw.preload(2).get_layer_position()</code>
	\|-		\|-
	\|<code>mxw.preload(preload_number).get_track_position()</code> \|\| returns the track index of the preload\|\| <code>mxw.preload(8).get_track_position()</code>		\|<code>mxw.preload(preload_number).get_track_position()</code> \|\| returns the track index of the preload\|\| <code>mxw.preload(2).get_track_position()</code>
	\|-		\|-
	\|<code>mxw.preload(preload_number).set_layer_position(layer_pos)</code> \|\| set layer index of the preload\|\| <code>mxw.preload(7).set_layer_position(2)</code>		\|<code>mxw.preload(preload_number).set_layer_position(layer_pos)</code> \|\| set layer index of the preload\|\| <code>mxw.preload(2).set_layer_position(2)</code>
	\|-		\|-
	\|<code>mxw.preload(preload_number).set_track_position(track_pos)</code> \|\| set the track index of the preload\|\| <code>mxw.preload(11).set_track_position(2)</code>		\|<code>mxw.preload(preload_number).set_track_position(track_pos)</code> \|\| set the track index of the preload\|\| <code>mxw.preload(2).set_track_position(2)</code>
	\|-		\|-
	\|<code>mxw.makesectionscreenshot("directory_saving_path", initial_x, initial_y, size_x, size_y)</code> \|\| saves a cropped screenshot in the ~~desiderd~~ path\|\| <code>mxw.makesectionscreenshot("c:/Users/MXWendler/Desktop/b.png", 0,1, 400, 200)</code>		\|<code>mxw.makesectionscreenshot("directory_saving_path", initial_x, initial_y, size_x, size_y)</code> \|\| saves a cropped screenshot in the set path\|\| <code>mxw.makesectionscreenshot("c:/Users/MXWendler/Desktop/b.png", 0,1, 400, 200)</code>
	\|-		\|-
	\|<code>mxw.widget("/mxw/path").setStringValue("named by script")</code> \|\| set the name of a cue in the playlist\|\| <code>mxw.widget("/mxw/playlist/container/1/column/0/row/1").setStringValue("background videoclip")</code>		\|<code>mxw.widget("/mxw/path").setStringValue("named by script")</code> \|\| set the name of a cue in the playlist\|\| <code>mxw.widget("/mxw/playlist/container/1/column/0/row/1").setStringValue("background videoclip")</code>