1. Controlling MXW through Python - Revision history

Admin at 09:31, 29 May 2024

2024-05-29T09:31:19Z

← Older revision		Revision as of 09: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 22:31, 3 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 22:29, 3 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 22:28, 3 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 22:28, 3 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 20: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

Hwendler at 20:44, 3 December 2023

2023-12-03T20:44:45Z

← Older revision		Revision as of 20:44, 3 December 2023
Line 84:		Line 84:
	\|}		\|}

			Note that not all of the interface functions need to be implemented. If a function is not defined, it is probed but not called.

Hwendler at 20:43, 3 December 2023

2023-12-03T20:43:07Z

← Older revision		Revision as of 20:43, 3 December 2023
Line 50:		Line 50:


	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 ~~the~~ 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:auto"
	\|+ Fields		\|+ Fields
	\|-		\|-
	! ~~function~~ !! ~~Called on~~		! Function Name !! Details
	\|-		\|-
	\| '''onCreate()''' \|\| Called when the plugin item is created		\| '''onCreate()''' \|\| Called when the plugin item is created

Hwendler at 20:41, 3 December 2023

2023-12-03T20:41:46Z

@@ Line 50: / Line 50: @@
-The plugins are defined in a mxw_main.py file. This file is loaded, and the main UI calls the provided interface functions. This is a minimal example of video writing and placing the recorded video into the first preload:
+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 the playlist plugins:
 <syntaxhighlight lang="Python" line>
@@ Line 63: / Line 100: @@
 out = object()
 def onCreate():
 	global capture_device
@@ Line 104: / Line 140: @@
 	mxw_imgui.text_unformatted("This plugin records a camera")
 	return
 ‎</syntaxhighlight>

Hwendler at 20:40, 3 December 2023

2023-12-03T20:40:30Z

← Older revision		Revision as of 20:40, 3 December 2023
Line 116:		Line 116:
	\| '''onCreate()''' \|\| Called when the plugin item is created		\| '''onCreate()''' \|\| Called when the plugin item is created
	\|-		\|-
	\| onDelete \|\| Called when the plugin item is deleted. Note that this is only called on shutdown not called when the plugin is e.g. removed, since ~~the~~ items are kept for eventual undo-operations		\| '''onDelete()''' \|\| Called when the plugin item is deleted. Note that this is only called on software shutdown, not called when the plugin is e.g. removed, since items are kept for eventual undo-operations
	\|-		\|-
	\| getColorBG \|\| Get background color, called each render cycle		\| '''getColorBG()''' \|\| Get background color, called each render cycle
	\|-		\|-
	\| onAction \|\| Called when cue is entered		\| '''onAction()''' \|\| Called when cue is entered
	\|-		\|-
	\| 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 \|< button is pressed)
	\|-		\|-
	\| onActivateInUI \|\| Called when the item is selected in the ui		\| '''onActivateInUI()''' \|\| Called when the item is selected in the ui
	\|-		\|-
	\| onActiveCueChange \|\| Called when the playlist seeks		\| '''onActiveCueChange()''' \|\| Called when the playlist seeks
	\|-		\|-
	\| getDuration \|\| Get action duration		\| '''getDuration()''' \|\| Get action duration
	\|-		\|-
	\| getText \|\| Get grid text, called each render cycle (may display some information)		\| '''getText()''' \|\| Get grid text, called each render cycle (may display some information)
	\|-		\|-
	\| onCleanup \|\| Called when the playlist aborts or seeks		\| '''onCleanup()''' \|\| Called when the playlist aborts or seeks
	\|-		\|-
	\| getTimeSinceOnActionIssued \|\|Get action duration, called each render cycle (may display a countdown)		\| '''getTimeSinceOnActionIssued()''' \|\|Get action duration, called each render cycle (may display a countdown)
	\|-		\|-
	\| onPause \|\| Called when the playlist goes paused		\| '''onPause()''' \|\| Called when the playlist goes paused
	\|}		\|}