https://wiki.mxwendler.net/api.php?action=feedcontributions&feedformat=atom&user=HwendlerMXWendler Wiki - User contributions [en]2026-05-13T17:05:30ZUser contributionsMediaWiki 1.42.3https://wiki.mxwendler.net/index.php?title=3._Python_command_reference&diff=60833. Python command reference2024-06-12T08:27:33Z<p>Hwendler: </p>
<hr />
<div>Here are listed the main commands that can be used for scripting with Python.<br />
<br />
=== Legend ===<br />
<div> <br />
<br />
The standard used to represent the available values for each command is:<br />
<br />
<br />
''FLOATS'' are represented with one decimal:<br />
<br />
<code>0.0 .. 1.0</code> &rarr; all float values between 0 and 1 included<br />
<br />
<br />
''INTEGERS'' are represented with numbers or descriptions:<br />
<br />
<code>1 .. 5</code> &rarr; all integers between 1 and 5 included ( 1 , 2 , 3 , 4 , 5 ) <br><br />
<code>1 .. (MAX n layers)</code> &rarr; all the integers between 1 and the maximum index of layers in MXW (e.g. if 6 layers are being used the values are integers between 1 and 6 included)<br />
<br />
When only one number is indicated it means that only one option is given. This is found in addresses of buttons, checkboxes and in the options where "0" or "1" are the only significant values<br />
<br />
<br />
''STRINGS'' are represented between double quotation marks:<br />
<br />
<code>/mxw/set info </code><br />
<br />
When <code>“name”</code> is contained in the available string variable, then the content is to be substituted with the actual name.<br />
<br />
E.G. : to select and play a patch called “patch_one” from its name, the address <code>/mxw/set</code> with tokens <code>"play" "name_of_patch"</code> has to be used, resulting in this OSC command:<br />
<br />
<code>/mxw/set play patch_one</code><br />
<br />
<br />
When <u>OR</u> is found it means that two options can deliver a similar result. One of the two formats has to be used at one time.<br />
<br />
Here are listed all the commands that MXW recognizes.<br />
<br />
=== Legend ===<br />
<div> <br />
<br />
The standard used to represent the available values for each command is:<br />
<br />
<br />
''FLOATS'' are represented with one decimal:<br />
<br />
<code>0.0 .. 1.0</code> &rarr; all float values between 0 and 1 included<br />
<br />
<br />
''INTEGERS'' are represented with numbers or descriptions:<br />
<br />
<code>1 .. 5</code> &rarr; all integers between 1 and 5 included ( 1 , 2 , 3 , 4 , 5 ) <br><br />
<code>1 .. (MAX n layers)</code> &rarr; all the integers between 1 and the maximum index of layers in MXW (e.g. if 6 layers are being used the values are integers between 1 and 6 included)<br />
<br />
When only one number is indicated it means that only one option is given. This is found in addresses of buttons, checkboxes and in the options where "0" or "1" are the only significant values<br />
<br />
<br />
''STRINGS'' are represented between double quotation marks:<br />
<br />
<code>/mxw/set info </code><br />
<br />
When <code>“name”</code> is contained in the available string variable, then the content is to be substituted with the actual name.<br />
<br />
E.G. : to select and play a patch called “patch_one” from its name, the address <code>/mxw/set</code> with tokens <code>"play" "name_of_patch"</code> has to be used, resulting in this OSC command:<br />
<br />
<code>/mxw/set play patch_one</code><br />
<br />
<br />
When <u>OR</u> is found it means that two options can deliver a similar result. One of the two formats has to be used at one time.<br />
<br />
<br />
===Set Reference===<br />
<br />
{| class="wikitable"<br />
|-<br />
! PYTHON COMMAND/SYMBOL !! DESCRIPTION !! EXAMPLE<br />
|-<br />
!colspan="3" |Software Info<br />
|-<br />
|<code>mxw.millis</code>|| returns the amount of milliseconds passed since opening the software|| <code>mxw.print_console("current passed time is" + str(mxw.millis) );</code> <br />
|-<br />
|<code>mxw.width</code>||returns the current frame width in px|| <code>mxw.print_console("frame width is" + str(mxw.width) );</code><br />
|-<br />
|<code>mxw.height</code>||returns the current frame height in px|| <code>mxw.print_console("frame height is" + str(mxw.height));</code><br />
|-<br />
|<code>mxw.outwidth</code>||returns current output width|| <code>mxw.print_console("output height is" + str(mxw.outwidth));</code><br />
|-<br />
|<code>mxw.outheight</code>||returns the current output height|| <code>mxw.print_console("output width is" + str(mxw.outheight));</code> <br />
|-<br />
|<code>mxw.framecounter</code>||returns the amount of frames rendered since opening the software|| <code>mxw.print_console("total number of frames rendered is" + str(mxw.framecounter));</code> <br />
|-<br />
|<code>mxw.print_console("text" + mxw.widget("/mxw/path").getStringValue())</code> || prints the name of the desired playlist cue || <code>mxw.print_console("The clip name in the second cue is" + mxw.widget("/mxw/playlist/container/1/column/0/row/1").getStringValue());</code><br />
|-<br />
|<code>mxw.print_statusline("text")</code> || print text on the status line|| <code>print text on status line()</code><br />
|-<br />
!colspan="3" | I/O<br />
|-<br />
|<code>mxw.dmx()</code> ||returns the DMX value received from the specified universe and channel|| <code>mxw.print_console("DMX value in u. 1, ch. 4 is" + mxw.dmx(1,4));</code><br />
|-<br />
|<code>mxw.midi()</code>||returns the MIDI value received from the specified device and channel|| <code>mxw.print_console("MIDI value in dev. 1, ch. 6 is" + mxw.midi(1,6));</code> <br />
|-<br />
|<code>mxw.keyboard("ASCII_code")</code> || returns if the specified key is pressed or not || <code>mxw.keyboard(65)</code><br />
|-<br />
|<code>mxw.io.pjlink("on", "IP_ADDRESS", "pj_password")</code> || sends a.io.pjlink command to the selected projector and turns it on || <code>mxw.io.pjlink("on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.io.pjlink("off", "IP_ADDRESS", "pj_password")</code> || sends a.io.pjlink command to the selected projector and turns it off|| <code>mxw.io.pjlink("off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.io.pjlink("avmute_on", "IP_ADDRESS", "pj_password")</code> || sends a.io.pjlink command to the selected projector and mutes audio and video || <code>mxw.io.pjlink("avmute_on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.io.pjlink("avmute_off", "IP_ADDRESS", "pj_password")</code> || sends a.io.pjlink command to the selected projector and unmutes audio and video || <code>mxw.io.pjlink("avmute_off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.io.pjlink("vmute_on", "IP_ADDRESS", "pj_password")</code> || sends a.io.pjlink command to the selected projector and mutes video || <code>mxw.io.pjlink("vmute_on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.io.pjlink("vmute_off", "IP_ADDRESS", "pj_password")</code> || sends a.io.pjlink command to the selected projector and unmutes video || <code>mxw.io.pjlink("vmute_off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_is_supported")</code> || control if a NDI Camera supports PTZ || <code>mxw.media("USB Cam").ptz("ptz_is_supported")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_zoom", value)</code> || control the zoom of a NDI PTZ Camera, values from 0(zoomed in) to 1(zoomed out) || <code>mxw.media("USB Cam").ptz("ptz_zoom", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_pan_tilt", value_pan, value_tilt)</code> || control the pan and tilting of a NDI PTZ Camera (values from -1 to 1) || <code><code>mxw.media("USB Cam").ptz("ptz_pan_tilt", -0.5, 0.2)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_zoom_speed", value)</code> || control the zoom speed a NDI PTZ Camera, values from -1(zoom outwards) to 1 (zoom inwards) || <code><code>mxw.media("USB Cam").ptz("ptz_zoom", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_pan_tilt_speed", pan_speed, tilt_speed)</code> || control the pan and tilt speed a NDI PTZ Camera, values -1 (move right/down) to 1 (move left/up) || <code>mxw.media("USB Cam").ptz("ptz_pan_tilt_speed", -0.3, 0.8)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_store_preset", preset_number)</code> || store current position, focus, zoom, values 0 to 99 || <code>mxw.media("USB Cam").ptz("ptz_store_preset", 75)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_recall_preset",preset_number, speed)</code> || recalls a previously stored preset,values 0 to 99 and changes to it at a specific speed (values 0 to 1) || <code>mxw.media("USB Cam").ptz("ptz_recall_preset", 4, 0.5 )</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_auto_focus")</code> || activates or deactivates the camera in auto-focus || <code>mxw.media("USB Cam").ptz("ptz.autofocus")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_focus", focus_value)</code> || focus to absolute value (0= focused to infinity, 1= focus the closest possible)|| <code>mxw.media("USB Cam").ptz("ptz_focus", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_focus_speed", speed_value)</code> || focus at a particular speed, values from -1(outwards), to 1 (inwards)|| <code>mxw.media("USB Cam").ptz("ptz_focus_speed", -0.2)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_auto")</code> || put the camera in auto white-balance mode || <code>mxw.media("USB Cam").ptz("ptz_white_balance_auto")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_indoor")</code> || put the camera in indoor white balance || <code> mxw.media("USB Cam").ptz("ptz_white_balance_indoor")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_outdoor")</code> || put the camera in outdoor white balance || <code> mxw.media("USB Cam").ptz("ptz_white_balance_outdoor")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_oneshot")</code> ||use the current brightness to automatically set the current white balance|| <code>mxw.media("USB_Cam").ptz("ptz_white_balance_oneshot")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_manual", red value, blue value)</code> || Set the manual camera white balance using the R, B values, (0.0 = not red/not blue , 1.0 = very red/very blue)|| <code>mxw.media("camera_name").ptz("ptz_white_balance_manual", 0.1, 0.7)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_auto")</code> || put the camera in auto-exposure mode || <code>mxw.media("USB_Cam").ptz("ptz_exposure_auto")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_manual", exposure_level)</code> || manually set the camera exposure iris, values from 0.0(dark) to 1.0(light)|| <code>mxw.media("USB_Cam").ptz("ptz_exposure_manual", 0.4)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_manual_v2", iris_level, gain_level, shutter_speed)</code> || Manually set the camera exposure parameters, values iris from 0.0(dark) to 1.0(light), values gain from 0.0(dark) to 1.0(light), values shutter_speed from 0.0(slow) to 1.0(fast) || <code> mxw.media("USB_Cam").ptz("ptz_exposure_manual_v2", 0.4, 0.2, 0.5) </code><br />
|-<br />
!colspan="3" |Playlist Control<br />
|-<br />
|<code>mxw.playlist.preload_media()</code> || preload used media || <code>mxw.playlist.preload_media()</code><br />
|-<br />
|<code>mxw.playlist.pause()</code> || pause the playlists or restart if already paused|| <code>mxw.playlist.pause()</code><br />
|-<br />
|<code>mxw.playlist.play()</code> || play the playlist || <code>mxw.playlist.play()</code><br />
|-<br />
|<code>mxw.playlist.go_pause()( true/false )</code> || pause the playlist (when true), unpause the playlist (when false) || <code>mxw.playlist.go_pause()(true)</code><br />
|-<br />
|<code>mxw.playlist.skiptonext()</code> || skip to the next cue || <code>mxw.playlist.skiptonext()</code><br />
|-<br />
|<code>mxw.playlist.go_next()</code> || go to the next cue without playing || <code>mxw.playlist.go_next()</code><br />
|-<br />
|<code>mxw.playlist.go_prev()</code> || go to previous cue || <code>mxw.playlist.go_prev()</code><br />
|-<br />
|<code>mxw.playlist.go_first()</code> || go to the first cue || <code>mxw.playlist.go_first()</code><br />
|-<br />
|<code>mxw.playlist.get_active_cue()</code> || return active cue index|| <code>index = mxw.playlist.get_active_cue()</code><br />
|-<br />
|<code>mxw.playlist.navigate_index(index_value)</code> || go to the specified cue index|| <code>mxw.playlist.navigate_index(2)</code><br />
|-<br />
|<code>mxw.playlist.navigate_string("index_string")</code> || go to the specified cue string|| <code>mxw.playlist.navigate_string("BG_video2")</code><br />
|-<br />
!colspan="3" |Preload Control<br />
|-<br />
|<code>mxw.preload(preload_number).clear()</code> || clears the selected preload || <code>mxw.preload(2).clear()</code><br />
|-<br />
|<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><br />
|-<br />
|<code>mxw.preload(preload_number).set_name("new_media_name")</code> || renames a preload || <code>mxw.preload(2).set_name("new_background")</code><br />
|-<br />
|<code>mxw.preload(preload_number).add_preload()</code> || load a preload in the layers || <code>mxw.preload(2).add_preload()</code><br />
|-<br />
|<code>mxw.preload(preload_number).trigger_preload()</code> || trigger a layer from the preload || <code>mxw.preload(2).trigger_preload()</code><br />
|-<br />
|<code>mxw.preload(preload_number).get_activated()</code> || requests if the preload is editable || <code>mxw.preload(2).get_activated()</code><br />
|-<br />
|<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><br />
|-<br />
|<code>mxw.preload(preload_number).get_layer_position()</code> || returns the layer index of the preload|| <code>mxw.preload(2).get_layer_position()</code><br />
|-<br />
|<code>mxw.preload(preload_number).get_track_position()</code> || returns the track index of the preload|| <code>mxw.preload(2).get_track_position()</code><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
<br />
|}</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Linux_and_No_Dongle_Detection&diff=6082Linux and No Dongle Detection2024-06-01T11:47:42Z<p>Hwendler: </p>
<hr />
<div>This applies to Ubuntu and Ubuntu-based Linux versions and all MXWendler versions<br />
<br />
'''Problem'''<br />
<br />
You start with a USB dongle attached but the log states there is no dongle found.<br />
<br />
'''Background'''<br />
<br />
Actually a dongle is found, but it is not usable because of insufficient udev permissions. Dongle values can be read, but no commands like e.g. 'Respond with dongle serial' can be sent (written) to the dongles.<br />
<br />
'''Solution'''<br />
<br />
For a first test, you can start MXWendler as root. If the dongle is usable now, it is a udev permission issue. Now enable the correct permissions for all users the USB dongle. Enable full access to the dongles with the following command sequence issued in a terminal:<br />
<br />
<code><br />
$ sudo touch /etc/udev/rules.d/999-ft-mxw.rules<br />
<br />
$ sudo vim /etc/udev/rules.d/999-ft-mxw.rules<br />
</code><br />
<br />
Enter this line:<br />
<br />
<code><br />
SUBSYSTEM=="usb",ATTRS{idVendor}=="096e",MODE="0666"<br />
</code><br />
<br />
Exit vim with <esc>,:,w,q,<enter>. Then restart udev service<br />
<br />
<code><br />
$ sudo /etc/init.d/udev restart<br />
</code><br />
<br />
and re-plug the dongle. This udev rule enables read/write permissions for all users when a Feitian dongle (Vendor id is 096e) is plugged into the system.<br />
<br />
'''Remark'''<br />
<br />
The 'write' - permissions added here allow sending device commands to the dongle. The values stored inside the dongle are never changed.</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Linux_and_No_Dongle_Detection&diff=6081Linux and No Dongle Detection2024-06-01T11:46:47Z<p>Hwendler: </p>
<hr />
<div>This applies to Ubuntu and Ubuntu-based Linux versions and all MXWendler versions<br />
<br />
'''Problem'''<br />
<br />
You start with a USB dongle attached but the log states there is no dongle found.<br />
<br />
'''Background'''<br />
<br />
Actually a dongle is found, but it is not usable because of insufficient udev permissions. Dongle values can be read, but no commands like e.g. 'Respond with dongle serial' can be sent (written) to the dongles.<br />
<br />
'''Solution'''<br />
<br />
For a first test, you can start MXWendler as root. If the dongle is usable now, it is a udev permission issue. Now enable the correct permissions for all users the USB dongle. Enable full access to the dongles with the following command sequence issued in a terminal:<br />
<br />
<code><br />
$ sudo touch /etc/udev/rules.d/999-ft-mxw.rules<br />
<br />
$ sudo vim /etc/udev/rules.d/999-ft-mxw.rules<br />
</code><br />
<br />
Enter this line:<br />
<br />
<code><br />
SUBSYSTEM=="usb",ATTRS{idVendor}=="096e",MODE="0666"<br />
</code><br />
<br />
Exit vim with <esc>,:,w,q,<enter>. Then restart udev service<br />
<br />
<code><br />
$ sudo /etc/init.d/udev restart<br />
</code><br />
<br />
and re-plug the dongle. This udev rule enables read/write permissions for all users when a Feitian dongle (Vendor id is 096e) is plugged into the system.<br />
<br />
'''Remark'''<br />
<br />
The 'write' - permissions here are about sending commands to the dongle. The values stored inside the dongle are never changed.</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Linux_and_No_Dongle_Detection&diff=6080Linux and No Dongle Detection2024-06-01T11:45:05Z<p>Hwendler: </p>
<hr />
<div>This applies to Ubuntu and Ubuntu-based Linux versions and all MXWendler versions<br />
<br />
'''Problem'''<br />
<br />
You start with a USB dongle attached but the log states there is no dongle found.<br />
<br />
'''Background'''<br />
<br />
Actually a dongle is found, but it is not usable because of insufficient udev permissions. Dongle values can be read, but no commands like e.g. 'Respond with dongle serial' can be sent (written) to the dongles.<br />
<br />
'''Solution'''<br />
<br />
For a first test, you can start MXWendler as root. If the dongle is usable now, it is a udev permission issue. Now enable the correct permissions for all users the USB dongle. Enable full access to the dongles with the following command sequence issued in a terminal:<br />
<br />
<code><br />
$ sudo touch /etc/udev/rules.d/999-ft-mxw.rules<br />
<br />
$ sudo vim /etc/udev/rules.d/999-ft-mxw.rules<br />
</code><br />
<br />
Enter this line:<br />
<br />
<code><br />
SUBSYSTEM=="usb",ATTRS{idVendor}=="096e",MODE="0666"<br />
</code><br />
<br />
Exit vim with <esc>,:,w,q,<enter>. Then restart udev service<br />
<br />
<code><br />
$ sudo /etc/init.d/udev restart<br />
</code><br />
<br />
and re-plug the dongle. This udev rule enables read/write permissions for all users when a Feitian dongle (Vendor id is 096e) is plugged into the system.<br />
<br />
'''Remark'''<br />
<br />
The dongle values are never changed, this is only possible for the dongle issuer.</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Linux_and_No_Dongle_Detection&diff=6079Linux and No Dongle Detection2024-05-31T23:38:16Z<p>Hwendler: </p>
<hr />
<div>This applies to Ubuntu and Ubuntu-based Linux versions and all MXWendler versions<br />
<br />
'''Problem'''<br />
<br />
You start with a USB dongle attached but the log states there is no dongle found.<br />
<br />
'''Background'''<br />
<br />
Actually a dongle is found, but it is not usable because of insufficient udev permissions. Dongle values can be read, but no commands like e.g. 'Respond with dongle serial' can be sent (written) to the dongles.<br />
<br />
'''Solution'''<br />
<br />
For a first test, you can start MXWendler as root. If the dongle is usable now, it is a udev permission issue. Now enable the correct permissions for all users the USB dongle. Enable full access to the dongles with the following command sequence issued in a terminal:<br />
<br />
<code><br />
$ sudo touch /etc/udev/rules.d/999-ft-mxw.rules<br />
<br />
$ sudo vim /etc/udev/rules.d/999-ft-mxw.rules<br />
</code><br />
<br />
Enter this line:<br />
<br />
<code><br />
SUBSYSTEM=="usb",ATTRS{idVendor}=="096e",MODE="0666"<br />
</code><br />
<br />
Exit vim with <esc>,:,w,q,<enter>. Then restart udev service<br />
<br />
<code><br />
$ sudo /etc/init.d/udev restart<br />
</code><br />
<br />
and re-plug the dongle.<br />
<br />
'''Remark'''<br />
<br />
The dongle values are never changed, this is only possible for the dongle issuer.</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Linux_and_No_Dongle_Detection&diff=6078Linux and No Dongle Detection2024-05-31T14:34:41Z<p>Hwendler: </p>
<hr />
<div>This applies to Ubuntu and Ubuntu-based Linux versions and all MXWendler versions<br />
<br />
'''Problem'''<br />
<br />
You start with a USB dongle attached but the log states there is no dongle found.<br />
<br />
'''Background'''<br />
<br />
Actually a dongle is found, but it cannot be read because of a udev permission issue. The dongle can be read, but no commands like 'Give the dongle serial' can be sent to the dongles.<br />
<br />
'''Solution'''<br />
<br />
For a first test, you can start MXWendler as root. If the dongle is correctly used, then it is a permission issue. Enable the correct permissions for all users the USB dongle. Enable full access to the dongles with the following command sequence issued in a terminal:<br />
<br />
<code><br />
$ sudo touch /etc/udev/rules.d/999-ft-mxw.rules<br />
<br />
$ sudo vim /etc/udev/rules.d/999-ft-mxw.rules<br />
</code><br />
<br />
Enter this line:<br />
<br />
<code><br />
SUBSYSTEM=="usb",ATTRS{idVendor}=="096e",MODE="0666"<br />
</code><br />
<br />
Then restart udev service<br />
<br />
<code><br />
$ sudo /etc/init.d/udev restart<br />
</code><br />
<br />
and re-plug the dongle.<br />
<br />
'''Remark'''<br />
<br />
The dongle values are never changed, this is only possible for the dongle issuer.</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Linux_and_No_Dongle_Detection&diff=6077Linux and No Dongle Detection2024-05-31T14:34:29Z<p>Hwendler: </p>
<hr />
<div>This applies to Ubuntu and Ubuntu-based Linux versions and all MXWendler versions<br />
<br />
'''Problem'''<br />
<br />
You start with a USB dongle attached but the log states there is no dongle found.<br />
<br />
'''Background'''<br />
<br />
Actually a dongle is found, but it cannot be read because of a udev permission issue. The dongle can be read, but no commands like 'Give the dongle serial' can be sent to the dongles.<br />
<br />
'''Solution'''<br />
<br />
For a first test, you can start MXWendler as root. If the dongle is correctly used, then it is a permission issue. Enable the correct permissions for all users the USB dongle. Enable full access to the dongles with the following command sequence issued in a terminal:<br />
<br />
<code><br />
$ sudo touch /etc/udev/rules.d/999-ft-mxw.rules<br />
<br />
$ sudo vim /etc/udev/rules.d/999-ft-mxw.rules<br />
</code><br />
<br />
Enter this line:<br />
<br />
<code><br />
SUBSYSTEM=="usb",ATTRS{idVendor}=="096e",MODE="0666"<br />
</code><br />
<br />
Then restart udev service<br />
<br />
<code><br />
$ sudo /etc/init.d/udev restart<br />
</code><br />
<br />
and re-plug the dongle.<br />
<br />
'''Remark'''<br />
The dongle values are never changed, this is only possible for the dongle issuer.</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Linux_and_No_Dongle_Detection&diff=6076Linux and No Dongle Detection2024-05-31T14:33:21Z<p>Hwendler: </p>
<hr />
<div>This applies to Ubuntu and Ubuntu-based Linux versions and all MXWendler versions<br />
<br />
'''Problem'''<br />
<br />
You start with a USB dongle attached but the log states there is no dongle found.<br />
<br />
'''Background'''<br />
<br />
Actually a dongle is found, but it cannot be read because of a udev permission issue. The dongle can be read, but no commands like 'Give the dongle serial' can be sent to the dongles. The dongle values are never changed.<br />
<br />
'''Solution'''<br />
<br />
For a first test, you can start MXWendler as root. If the dongle is correctly used, then it is a permission issue. Enable the correct permissions for all users the USB dongle. Enable full access to the dongles with the following command sequence issued in a terminal:<br />
<br />
<code><br />
$ sudo touch /etc/udev/rules.d/999-ft-mxw.rules<br />
<br />
$ sudo vim /etc/udev/rules.d/999-ft-mxw.rules<br />
</code><br />
<br />
Enter this line:<br />
<br />
<code><br />
SUBSYSTEM=="usb",ATTRS{idVendor}=="096e",MODE="0666"<br />
</code><br />
<br />
Then restart udev service<br />
<br />
<code><br />
$ sudo /etc/init.d/udev restart<br />
</code><br />
<br />
and re-plug the dongle.</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Linux_and_No_Dongle_Detection&diff=6075Linux and No Dongle Detection2024-05-31T14:32:01Z<p>Hwendler: </p>
<hr />
<div>This applies to Ubuntu and Ubuntu-based Linux versions and all MXWendler versions<br />
<br />
'''Problem'''<br />
<br />
You start with a USB dongle attached but the log states there is no dongle found.<br />
<br />
'''Background'''<br />
<br />
Actually a dongle is found, but it cannot be read because of a udev permission issue. The dongle can be read, but no commands like 'Give me the dongle serial' can be sent to the dongles.<br />
<br />
'''Solution'''<br />
<br />
For a first test, you can start MXWendler as root. If the dongle is found, then it is a permission issue. Enable the correct permissions for all users the USB dongle. Enable full access to the dongles with the following command sequence issued in a terminal:<br />
<br />
<code><br />
$ sudo touch /etc/udev/rules.d/999-ft-mxw.rules<br />
<br />
$ sudo vim /etc/udev/rules.d/999-ft-mxw.rules<br />
</code><br />
<br />
Enter this line:<br />
<br />
<code><br />
SUBSYSTEM=="usb",ATTRS{idVendor}=="096e",MODE="0666"<br />
</code><br />
<br />
Then restart udev service<br />
<br />
<code><br />
$ sudo /etc/init.d/udev restart<br />
</code><br />
<br />
and re-plug the dongle.</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Linux_and_No_Dongle_Detection&diff=6074Linux and No Dongle Detection2024-05-31T14:29:16Z<p>Hwendler: </p>
<hr />
<div>This applies to Ubuntu and Ubuntu-based Linux versions and all MXWendler versions<br />
<br />
'''Problem'''<br />
<br />
You start with a USB dongle attached but the log states there is no dongle found.<br />
<br />
'''Background'''<br />
<br />
Actually a dongle is found, but it cannot be read because of a udev permission issue <br />
<br />
'''Solution'''<br />
<br />
Enable the correct permissions for the USB dongle. Enable full access to the dongles with the following command sequence issued in a terminal:<br />
<br />
<code><br />
$ sudo touch /etc/udev/rules.d/999-ft-mxw.rules<br />
<br />
$ sudo vim /etc/udev/rules.d/999-ft-mxw.rules<br />
</code><br />
<br />
Enter this line:<br />
<br />
<code><br />
SUBSYSTEM=="usb",ATTRS{idVendor}=="096e",MODE="0666"<br />
</code><br />
<br />
Then restart udev service<br />
<br />
<code><br />
$ sudo /etc/init.d/udev restart<br />
</code><br />
<br />
and re-plug the dongle.</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Linux_and_No_Dongle_Detection&diff=6073Linux and No Dongle Detection2024-05-31T14:19:54Z<p>Hwendler: </p>
<hr />
<div>This applies to Ubuntu and Ubuntu-based Linux versions and all MXWendler versions<br />
<br />
'''Problem'''<br />
<br />
You start with a USB dongle attached but the log states there is no dongle found.<br />
<br />
'''Background'''<br />
<br />
Actually a dongle is found, but it cannot be read because of a udev permission issue <br />
<br />
'''Solution'''<br />
<br />
Enable the correct permissions for the USB dongle with the following command sequence issued in a shell<br />
<br />
<code><br />
$ sudo touch /etc/udev/rules.d/999-ft-mxw.rules<br />
<br />
$ sudo echo "SUBSYSTEM==\"usb\",ATTRS{idVendor}==\"096e\",MODE=\"0666\"">/etc/udev/rules.d/999-ft-mxw.rules<br />
<br />
$ sudo /etc/init.d/udev restart<br />
</code></div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Linux_and_No_Dongle_Detection&diff=6072Linux and No Dongle Detection2024-05-31T14:18:29Z<p>Hwendler: </p>
<hr />
<div>This applies to Ubuntu and Ubuntu-based Linux versions and all MXWendler versions<br />
<br />
'''Problem'''<br />
<br />
You start with a USB dongle attached but the log states there is no dongle found.<br />
<br />
'''Background'''<br />
<br />
Actually a dongle is found, but it cannot be read because of a udev permission issue <br />
<br />
'''Solution'''<br />
<br />
Enable the correct permissions for the USB dongle with the following command sequence issued in a shell<br />
<br />
<code><br />
$ sudo touch /etc/udev/rules.d/999-ft-mxw.rules<br />
<br />
$ sudo echo "SUBSYSTEM==\"usb\",ATTRS{idVendor}==\"096e\",MODE=\"0666\"">/etc/udev/rules.d//etc/udev/rules.d/999-ft-mxw.rules<br />
<br />
$ sudo /etc/init.d/udev restart<br />
</code></div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Linux_and_No_Dongle_Detection&diff=6071Linux and No Dongle Detection2024-05-31T14:13:05Z<p>Hwendler: </p>
<hr />
<div>This applies to Ubuntu and Ubuntu-based Linux versions and all MXWendler versions<br />
<br />
'''Problem'''<br />
<br />
You start with a USB dongle attached but the log states there is no dongle found.<br />
<br />
'''Background'''<br />
<br />
Actually a dongle is found, but it cannot be read because of a udev permission issue <br />
<br />
'''Solution'''<br />
<br />
Enable the correct permissions for the USB dongle with the following command sequence issued in a shell<br />
<br />
<code><br />
$ sudo touch /etc/udev/<br />
<br />
</code></div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Linux_and_No_Dongle_Detection&diff=6070Linux and No Dongle Detection2024-05-31T14:10:32Z<p>Hwendler: Created page with "This applies to Ubuntu and Ubuntu-based Linux versions and all MXWendler versions '''Problem''' You start with a USB dongle attached but the log states there is no dongle found. '''Background''' Actually a dongle is found, but it cannot be read because of a udev permission issue '''Solution''' Enable the correct permissions for the USB dongle with the following command sequence issued in a shell"</p>
<hr />
<div>This applies to Ubuntu and Ubuntu-based Linux versions and all MXWendler versions<br />
<br />
'''Problem'''<br />
<br />
You start with a USB dongle attached but the log states there is no dongle found.<br />
<br />
'''Background'''<br />
<br />
Actually a dongle is found, but it cannot be read because of a udev permission issue <br />
<br />
'''Solution'''<br />
<br />
Enable the correct permissions for the USB dongle with the following command sequence issued in a shell</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Trouble_Shooting&diff=6069Trouble Shooting2024-05-31T14:03:51Z<p>Hwendler: </p>
<hr />
<div><br />
Sometimes a driver update or a new hardware or a new operating system screws things up badly. We have collected a lot of knowledge from our test farm and our users over the years to help you across the most common pitfalls.<br />
<br />
'''All OS'''<br />
*[[Performance Problems]]<br />
*[[Smooth Playback/ Frame Drops and Audio Drivers]]<br />
*[[Keystone: not Opening ./skin/keystone/Video.png: file does not exist]]<br />
*[[Licenser: Wrong Key Format]]<br />
*[[Playlist: Crossfading Between Bright Media Becomes Temporarily Dark]]<br />
*[[Capture Cards (e.g. BM Decklink Studio2)]]<br />
*[[Memory Allocation Error]]<br />
*[[Time and Event Sync all PCs]]<br />
*[[MXW does not start any more]]<br />
*[[Projector Calculator]]<br />
*[[Artnet connection issues: Firewall]]<br />
*[[DMX CITP and Image Sequences]]<br />
*[[MAudio UC-33 to MXWendler controller programming]]<br />
*[[OSC Messages - Correct Text and Value Example]]<br />
*[[User Interface - outside of the main display]]<br />
*[[PJLink commands for DZ21]]<br />
*[[SDI Inputs - YUV Format and Wrong Color Output]]<br />
*[[Vision SDI - Internal Loop/Input]]<br />
<br />
<br />
'''Windows'''<br />
*[[Windows 11 + No Audio Device]]<br />
*[[Windows 10 + Optimizing Font]]<br />
*[[Windows 10 + Focusrite 18i20 Audio Issues]]<br />
*[[Windows 10 + Corrupted Live Video]]<br />
*[[Windows 10 + VCRUNTTIME140.dll missing]]<br />
*[[Windows 10 + AJA Kona 5]]<br />
*[[Windows 10 + Asus Motherboards - Multimonitoring Issues]]<br />
*[[Windows 10 x64 + Stage Designer/FXServer does not start]]<br />
*[[Windows 10 + Nvidia and Intel Cards]]<br />
*[[Windows + Blackmagic Decklink Capture Cards]]<br />
*[[Windows + How to Deactivate Aero Peek to Prevent Unwanted Output Blackouts]]<br />
*[[Windows + Unexpected Output Window Size]]<br />
*[[Windows + No Output in Output Window]]<br />
*[[Windows 7 + AMD + Stuttering Output]]<br />
*[[Windows 7 + AMD + Output Window On Wrong Screen]]<br />
*[[Windows 7 + Artnet]]<br />
*[[Windows 7 + No Audio]]<br />
*[[Windows 7 + Configuration (config.xml)]]<br />
*[[Windows 7 + Richtexteditor Glitches and ClearType]]<br />
*[[Windows 7 + NDI Tools]]<br />
*[[Windows XP + No output on second screen|Windows XP + NVidia No output on second screen]]<br />
*[[Re-Converting Video files using AVANTI GUI (Freeware)]]<br />
<br />
'''Linux'''<br />
*[[Linux and No Dongle Detection]]<br />
<br />
'''Mac OSX'''<br />
*[[Mac and No Default Clip]]<br />
*[[Mac and No Translation]]<br />
*[[Mac and No Shaders Update]]<br />
*[[Mac Sierra 10.12 Disable App Translocation]]<br />
*[[Macbook Pro Core 2 Duo with NVidia 9400M]]<br />
*[[Mac and Graphic Card Performance]]<br />
*[[Mac Yosemite 10.10 Multimonitor]]<br />
*[[Mac and Internal Cached Video]]<br />
*[[Mac and Audio]]<br />
*[[Mac and Soundflower 64ch Audio]]<br />
*[[Mac and DMX]]</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Tutorial_Eventmaster_Toolset_Controlling_MXWendler_by_e.g._e2_S3_Image_Processor&diff=6061Tutorial Eventmaster Toolset Controlling MXWendler by e.g. e2 S3 Image Processor2024-02-12T09:25:37Z<p>Hwendler: </p>
<hr />
<div>This tutorial applies to all different OS and MXWendler versions > 6.0.04<br />
<br />
== Introduction==<br />
This tutorial explains how to set up a Barco Eventmaster to trigger and control media playback on StageDesigner or FXServer.<br />
<br />
==Control Setup==<br />
<br />
1. Open SD (StageDesigner) and load a clip into preload 1:<br />
<br />
[[File:e2_01.png|600px]]<br />
<br />
2. Open Settings->IO->Barco e2 and activate TCP listening. Also note down the port number.<br />
<br />
[[File:e2_02.png|600px]]<br />
<br />
3. In the Barco Eventmaster Toolset, create an 'External Device', name it e.g. 'StageDesigner'.<br />
<br />
[[File:e2_03.png|600px]]<br />
<br />
4. In the 'Adjust: StageDesigner' tab, set IP address and port number.<br />
<br />
[[File:e2_04.png|600px]]<br />
<br />
5. In the 'Adjust: StageDesigner' tab, add a new command. Store the command content, e.g.<br />
* /mxw/preload/1 play to start a clip<br />
* /mxw/preload/1 play to stop a clip<br />
<br />
More possible commands are in the OSC control section: [[3._MXW_OSC_command_reference]]<br />
<br />
[[File:e2_05.png|600px]]<br />
<br />
6. In the 'Cue' section, add a cue.<br />
<br />
[[File:e2_06.png|600px]]<br />
<br />
7. In this 'Cue', add actions.<br />
<br />
[[File:e2_07.png|600px]]<br />
<br />
8. From 'External Devices' drop an available command onto the 'Commands' field of the action.<br />
<br />
[[File:e2_08c.png|600px]]<br />
<br />
9. Play this cue, a clip should be started in the StageDesigner</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Tutorial_Eventmaster_Toolset_Controlling_MXWendler_by_e.g._e2_S3_Image_Processor&diff=6060Tutorial Eventmaster Toolset Controlling MXWendler by e.g. e2 S3 Image Processor2024-02-10T14:14:21Z<p>Hwendler: /* Control Setup */</p>
<hr />
<div>This tutorial applies to all different OS and MXWendler versions > 6.0.4<br />
<br />
== Introduction==<br />
This tutorial explains how to set up a Barco Eventmaster to trigger and control media playback on StageDesigner or FXServer.<br />
<br />
==Control Setup==<br />
<br />
1. Open SD (StageDesigner) and load a clip into preload 1:<br />
<br />
[[File:e2_01.png|600px]]<br />
<br />
2. Open Settings->IO->Barco e2 and activate TCP listening. Also note down the port number.<br />
<br />
[[File:e2_02.png|600px]]<br />
<br />
3. In the Barco Eventmaster Toolset, create an 'External Device', name it e.g. 'StageDesigner'.<br />
<br />
[[File:e2_03.png|600px]]<br />
<br />
4. In the 'Adjust: StageDesigner' tab, set IP address and port number.<br />
<br />
[[File:e2_04.png|600px]]<br />
<br />
5. In the 'Adjust: StageDesigner' tab, add a new command. Store the command content, e.g.<br />
* /mxw/preload/1 play to start a clip<br />
* /mxw/preload/1 play to stop a clip<br />
<br />
More possible commands are in the OSC control section: [[3._MXW_OSC_command_reference]]<br />
<br />
[[File:e2_05.png|600px]]<br />
<br />
6. In the 'Cue' section, add a cue.<br />
<br />
[[File:e2_06.png|600px]]<br />
<br />
7. In this 'Cue', add actions.<br />
<br />
[[File:e2_07.png|600px]]<br />
<br />
8. From 'External Devices' drop an available command onto the 'Commands' field of the action.<br />
<br />
[[File:e2_08c.png|600px]]<br />
<br />
9. Play this cue, a clip should be started in the StageDesigner</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Tutorial_Eventmaster_Toolset_Controlling_MXWendler_by_e.g._e2_S3_Image_Processor&diff=6059Tutorial Eventmaster Toolset Controlling MXWendler by e.g. e2 S3 Image Processor2024-02-09T15:16:34Z<p>Hwendler: /* Wizard Setup */</p>
<hr />
<div>This tutorial applies to all different OS and MXWendler versions > 6.0.4<br />
<br />
== Introduction==<br />
This tutorial explains how to set up a Barco Eventmaster to trigger and control media playback on StageDesigner or FXServer.<br />
<br />
==Control Setup==<br />
<br />
1. Open SD (StageDesigner) and load a clip into preload 1:<br />
<br />
[[File:e2_01.png|600px]]<br />
<br />
2. Open Settings->IO->Barco e2 and activate TCP listening. Also note down the port number.<br />
<br />
[[File:e2_02.png|600px]]<br />
<br />
3. In the Barco Eventmaster Toolset, create an 'External Device', name it e.g. 'StageDesigner'.<br />
<br />
[[File:e2_03.png|600px]]<br />
<br />
4. In the 'Adjust: StageDesigner' tab, set IP address and port number.<br />
<br />
[[File:e2_04.png|600px]]<br />
<br />
5. In the 'Adjust: StageDesigner' tab, add a new command. Store the command content, e.g.<br />
* /mxw/preload/1 play to start a clip<br />
* /mxw/preload/1 play to stop a clip<br />
<br />
More possible commands are in the OSC control section: [[3._MXW_OSC_command_reference]]<br />
<br />
[[File:e2_05.png|600px]]<br />
<br />
6. In the 'Cue' section, add a cue.<br />
<br />
[[File:e2_06.png|600px]]<br />
<br />
7. In this 'Cue', add actions.<br />
<br />
[[File:e2_07.png|600px]]<br />
<br />
8. From 'External Devices' drop an available command onto the 'Commands' field of the action.<br />
<br />
[[File:e2_08c.png|600px]]</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Tutorial_Eventmaster_Toolset_Controlling_MXWendler_by_e.g._e2_S3_Image_Processor&diff=6058Tutorial Eventmaster Toolset Controlling MXWendler by e.g. e2 S3 Image Processor2024-02-09T15:11:32Z<p>Hwendler: /* Wizard Setup */</p>
<hr />
<div>This tutorial applies to all different OS and MXWendler versions > 6.0.4<br />
<br />
== Introduction==<br />
This tutorial explains how to set up a Barco Eventmaster to trigger and control media playback on StageDesigner or FXServer.<br />
<br />
==Wizard Setup==<br />
<br />
1. Open SD (StageDesigner) and load a clip into preload 1:<br />
<br />
[[File:e2_01.png|600px]]<br />
<br />
2. Open Settings->IO->Barco e2 and activate TCP listening. Also either change or not the port number<br />
<br />
[[File:e2_02.png|600px]]<br />
<br />
3. In the Barco Eventmaster Toolset, create an 'External Device', name it e.g. 'StageDesigner'<br />
<br />
[[File:e2_03.png|600px]]<br />
<br />
4. In the 'Adjust: StageDesigner' tab, set IP address and port number<br />
<br />
[[File:e2_04.png|600px]]<br />
<br />
5. In the 'Adjust: StageDesigner' tab, add a new command. Store the command content, e.g.<br />
* /mxw/preload/1 play to start a clip<br />
* /mxw/preload/1 play to stop a clip<br />
<br />
More possible commands are in the OSC control section: [[3._MXW_OSC_command_reference]]<br />
<br />
[[File:e2_05.png|600px]]<br />
<br />
6. In the 'Cue' section, add a cue<br />
<br />
[[File:e2_06.png|600px]]<br />
<br />
7. In this 'Cue', add actions<br />
<br />
[[File:e2_07.png|600px]]<br />
<br />
8. From 'External Devices' drop an available command onto the 'Commands' field of the action<br />
<br />
[[File:e2_08c.png|600px]]</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Tutorial_Eventmaster_Toolset_Controlling_MXWendler_by_e.g._e2_S3_Image_Processor&diff=6057Tutorial Eventmaster Toolset Controlling MXWendler by e.g. e2 S3 Image Processor2024-02-09T15:10:33Z<p>Hwendler: /* Wizard Setup */</p>
<hr />
<div>This tutorial applies to all different OS and MXWendler versions > 6.0.4<br />
<br />
== Introduction==<br />
This tutorial explains how to set up a Barco Eventmaster to trigger and control media playback on StageDesigner or FXServer.<br />
<br />
==Wizard Setup==<br />
<br />
1. Open SD (StageDesigner) and load a clip into preload 1:<br />
<br />
[[File:e2_01.png|600px]]<br />
<br />
2. Open Settings->IO->Barco e2 and activate TCP listening. Also either change or not the port number<br />
<br />
[[File:e2_02.png|600px]]<br />
<br />
3. In the Barco Eventmaster Toolset, create an 'External Device', name it e.g. 'StageDesigner'<br />
<br />
[[File:e2_03.png|600px]]<br />
<br />
4. In the 'Adjust: StageDesigner' tab, set IP address and port number<br />
<br />
[[File:e2_04.png|600px]]<br />
<br />
5. In the 'Adjust: StageDesigner' tab, add a new command. Store the command content, e.g.<br />
* /mxw/preload/1 play to start a clip<br />
* /mxw/preload/1 play to stop a clip<br />
<br />
More possible commands are in the OSC control section: [[OSC Reference]]<br />
<br />
[[File:e2_05.png|600px]]<br />
<br />
6. In the 'Cue' section, add a cue<br />
<br />
[[File:e2_06.png|600px]]<br />
<br />
7. In this 'Cue', add actions<br />
<br />
[[File:e2_07.png|600px]]<br />
<br />
8. From 'External Devices' drop an available command onto the 'Commands' field of the action<br />
<br />
[[File:e2_08c.png|600px]]</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Tutorial_Eventmaster_Toolset_Controlling_MXWendler_by_e.g._e2_S3_Image_Processor&diff=6056Tutorial Eventmaster Toolset Controlling MXWendler by e.g. e2 S3 Image Processor2024-02-09T14:58:57Z<p>Hwendler: Created page with "This tutorial applies to all different OS and MXWendler versions > 6.0.4 == Introduction== This tutorial explains how to set up a Barco Eventmaster to trigger and control med..."</p>
<hr />
<div>This tutorial applies to all different OS and MXWendler versions > 6.0.4<br />
<br />
== Introduction==<br />
This tutorial explains how to set up a Barco Eventmaster to trigger and control media playback on StageDesigner or FXServer.<br />
<br />
==Wizard Setup==<br />
<br />
1. Open SD (StageDesigner) and load a clip into preload 1:<br />
<br />
[[File:e2_01.png|728px]]<br />
<br />
2. Open Settings->IO->Barco e2 and activate TCP listening. Also either change or not the port number<br />
<br />
[[File:e2_02.png|728px]]</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Tutorials&diff=6055Tutorials2024-02-09T14:53:55Z<p>Hwendler: /* IO Devices */</p>
<hr />
<div>{{#mpdftags:<br />
pagebreak orientation="L"<br />
}}<br />
<br />
==General==<br />
*[[Tutorial Opening Different Media]]<br />
*[[Tutorial Setting up Stage Designer Output Windows]]<br />
*[[Tutorial Triggering Four Media with the Keyboard]]<br />
*[[Tutorial Coupling Video with Effects and Audio Signals]]<br />
*[[Tutorial Creating Predefined Layer Position]]<br />
*[[Tutorial Feedback]]<br />
*[[Tutorial Creating an I/O Event]]<br />
*[[Tutorial Creating an Autostart Showfile]]<br />
*[[Tutorial Creating Compositions (Sets and Patches)]]<br />
*[[Tutorial Creating Multiple Compositions and Patches]]<br />
*[[Tutorial Creating and Playing an RTF Text File]]<br />
*[[Tutorial Licensing New Features]]<br />
*[[Tutorial Loading and Using JavaScripts in MXWendler]]<br />
*[[Tutorial Configuring a Virtual Camera]]<br />
<br />
==Playlist==<br />
*[[Tutorial Creating Playlists (Cue Lists)]]<br />
*[[Tutorial Playlists with Images and Keystone Correction]]<br />
*[[Tutorial Playlists with Timeline]]<br />
*[[Tutorial Playlists with Multi-Timeline]]<br />
*[[Tutorial Playlists with Time and Date Conditions]]<br />
*[[Tutorial Playlists with Timecode]]<br />
*[[Tutorial Playlists with Subtitles]]<br />
*[[Tutorial Playlists with IO - Commands]]<br />
*[[Tutorial Playlists with PDF and Frame Step]]<br />
*[[Tutorial Resetting Runtime Counter with IO Commands in Playlist]]<br />
*[[Tutorial Playlists with Fade Clip]]<br />
*[[Tutorial Playlists with Auto Step]]<br />
*[[Tutorial Playlists with Reset Counter]]<br />
*[[Tutorial Playlists with Shutdown]]<br />
*[[Tutorial Playlists with Load Show]]<br />
*[[Tutorial Playlists with OSC Command]]<br />
*[[Tutorial Playlists with Sys Command]]<br />
*[[Tutorial Playlists with PJlink Command]]<br />
*[[Tutorial Playlists in Rehearsal Mode]]<br />
*[[Tutorial Creating an Automated Show with Daily Event and Playlist Conditions]]<br />
<br />
==Keystone==<br />
*[[Tutorial Simultaneous Playback of two Videos with two Video Projectors]]<br />
*[[Tutorial Mapping with UV View]]<br />
*[[Tutorial Masked Output]]<br />
*[[Tutorial Colored Output with Animations]]<br />
*[[Tutorial Capture Output Sections with Artnet DMX and Network Grabbers]]<br />
*[[Tutorial SVG Mapping with the MXWendler Automatic Calibration]]<br />
<br />
<br />
==IO Devices==<br />
*[[Reference Open Sound Control - OSC]]<br />
*[[Reference JavaScript]]<br />
*[[Tutorial Using the Akai APC Mini (Note On/Off)]]<br />
*[[Tutorial Connecting the grandMA 2Port Node with MXWendler via Art-Net]]<br />
*[[Tutorial Connecting Jands Vista2 with MXWendler via Art-Net]]<br />
*[[Tutorial Set up the CITP Footage Library on the Media Server]]<br />
*[[Tutorial Time-sync and sending IO Commands over OSC Protocol]]<br />
*[[Tutorial Connecting a Wiimote to MXWendler]]<br />
*[[Tutorial Controlling MXWendler via TouchOSC]]<br />
*[[Tutorial Optimum Audio Settings with an Integrated Audio Interface]]<br />
*[[Tutorial Optimum Audio Settings with an External Audio Interface]]<br />
<!-- *[[Tutorial Controlling MXWendler with Elgato Streamdeck XL]] --><br />
*[[Tutorial Eventmaster Toolset Controlling MXWendler by e.g. e2 S3 Image Processor]]<br />
<br />
==FXServer==<br />
*[[Tutorial FXServer Output Windows]]<br />
<br />
*[[Tutorial How to Setup a Datapath Fx4 for MXWendler with the Wall Designer Software]]<br />
<br />
*[[Tutorial How to Optimize Video Footages With Blender]]<br />
<br />
==Standalone Encoder==<br />
*[[Tutorial Standalone Encoder / Video Batch Encoder]]<br />
<br />
==EDID Manager==<br />
*[[Tutorial MXWendler EDID Manager]]<br />
<br />
==NDI Tools==<br />
*[[Tutorial NDI Tools ]]<br />
*[[Tutorial Sending and Receiving Multiple Video Streams with NDI]]<br />
<br />
==Spout==<br />
*[[Tutorial Sending and Receiving Media Through Spout]]<br />
*[[Tutorial Connecting Winamp Generative Visuals with MXWendler via Spout]]</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=File:E2_08c.png&diff=6054File:E2 08c.png2024-02-09T14:52:45Z<p>Hwendler: Uploaded with SimpleBatchUpload</p>
<hr />
<div></div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=File:E2_08b.png&diff=6053File:E2 08b.png2024-02-09T14:52:45Z<p>Hwendler: Uploaded with SimpleBatchUpload</p>
<hr />
<div></div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=File:E2_07.png&diff=6052File:E2 07.png2024-02-09T14:52:45Z<p>Hwendler: Uploaded with SimpleBatchUpload</p>
<hr />
<div></div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=File:E2_08.png&diff=6051File:E2 08.png2024-02-09T14:52:45Z<p>Hwendler: Uploaded with SimpleBatchUpload</p>
<hr />
<div></div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=File:E2_04.png&diff=6050File:E2 04.png2024-02-09T14:52:43Z<p>Hwendler: Uploaded with SimpleBatchUpload</p>
<hr />
<div></div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=File:E2_03.png&diff=6049File:E2 03.png2024-02-09T14:52:43Z<p>Hwendler: Uploaded with SimpleBatchUpload</p>
<hr />
<div></div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=File:E2_05.png&diff=6048File:E2 05.png2024-02-09T14:52:43Z<p>Hwendler: Uploaded with SimpleBatchUpload</p>
<hr />
<div></div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=File:E2_02.png&diff=6047File:E2 02.png2024-02-09T14:52:43Z<p>Hwendler: Uploaded with SimpleBatchUpload</p>
<hr />
<div></div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=File:E2_06.png&diff=6046File:E2 06.png2024-02-09T14:52:43Z<p>Hwendler: Uploaded with SimpleBatchUpload</p>
<hr />
<div></div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=File:E2_01.png&diff=6045File:E2 01.png2024-02-09T14:52:43Z<p>Hwendler: Uploaded with SimpleBatchUpload</p>
<hr />
<div></div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Tutorial_Controlling_MXWendler_Barco_e2_or_Barco_S3_Image_Processor&diff=6044Tutorial Controlling MXWendler Barco e2 or Barco S3 Image Processor2024-02-08T15:53:49Z<p>Hwendler: Created page with "This tutorial applies to all different OS and MXWendler versions. <div class="noprint"> == Introduction== In this tutorial, we will go through the steps needed to control Stag..."</p>
<hr />
<div>This tutorial applies to all different OS and MXWendler versions.<br />
<div class="noprint"><br />
== Introduction==<br />
In this tutorial, we will go through the steps needed to control StageDesigner and FXServer from a Barco Image Processor e2 or S3 via TCP.<br />
== Files and Formats ==<br />
<br />
All the standard audio file formats and codecs can be played with the software. In order to get the best results, we suggest using the following formats for rendering your audio output (either as an extra audio file or in your video output):<br />
:'''Sample Rate:''' 48.000 Khz<br />
:'''Bitrate:''' 320 Kbps or lossless <br />
:'''Bit Depth:''' 24<br />
:'''Codec:''' Preferably Aac<br />
<br />
''Tip: It is always better to have an extra file for the audio output for the shows since it gives you more flexibility to tweak and solve possible issues.'' <br><br />
''Tip: You can use different sample rates in different situations, but for best performance results you have to always remember to use the same sample rate in your output, in software and windows settings.''<br />
<br />
<br />
{{#mpdftags: pagebreak}}<br />
== Settings in Windows ==<br />
<br />
1. Right-click on the 'Audio' sign in 'Taskbar' and select 'Sounds'. (''Or: Click on Win and type mmsys.cpl and hit enter'') '''(A)'''<br />
<br />
2. Go to the Playback tab and find the right audio playback device. (In most cases called 'Speakers Realtek High Definition Audio')<br />
<br />
3. Right-click on it and select 'Enable', 'Set as Default Device' and 'Set as Default Communication Device'. '''(B)'''<br />
<br />
4. Right-click on it again and select 'Properties' and go to the Advanced tab.<br />
<br />
5. Open the drop-down menu from Default Format and select 24bit and 48.000 Khz and click 'Apply'. (You can do a test if you have signal in the output by clicking on test) '''(C)'''<br />
<br />
[[File:Audio-1.png|728px]]<br />
<br />
{{#mpdftags: pagebreak}}<br />
<br />
== Settings in MXWendler ==<br />
<br />
1. Open MXWendler and go to audio settings<br />
:'''Settings &rarr; Input and Output &rarr; Audio Devices''' '''(A)'''<br />
2. From the drop-down menu of Device choose the proper output device you're using. '''(B)'''<br />
:''In most cases, it is 'Speakers Realtek High Definition Audio'''.<br />
:''It is always preferred to use the 'MME' drivers rather than the 'Windows Directsound' drivers.<br />
3. From the drop-down menu of In-Devices choose the proper output device you're using. '''(C)'''<br />
:''In most cases, it is 'Stereo Mix Realtek High Definition Audio'''.<br />
:''It is always preferred to use the 'MME' drivers rather than the 'Windows Directsound' drivers.<br />
4. Set the sample rate to 48000Khz and latency to something around 64ms. '''(D)'''<br />
<br />
5. Click on 'Reopen' and then Ok to close the window. '''(E)'''<br />
<br />
Audio should be ready to use and you should be able to playback audio files with no trouble. <br><br />
''Tip: It is always preferred to use an external audio interface for better sound quality or more stable playback.'' <br><br />
''Tip: If you have dropouts or glitches in the audio, try bringing the latency to a higher value, until the playback works well.''<br />
<br />
[[File:Audio-2.png|728px]]</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Tutorials&diff=6043Tutorials2024-02-08T15:52:12Z<p>Hwendler: /* IO Devices */</p>
<hr />
<div>{{#mpdftags:<br />
pagebreak orientation="L"<br />
}}<br />
<br />
==General==<br />
*[[Tutorial Opening Different Media]]<br />
*[[Tutorial Setting up Stage Designer Output Windows]]<br />
*[[Tutorial Triggering Four Media with the Keyboard]]<br />
*[[Tutorial Coupling Video with Effects and Audio Signals]]<br />
*[[Tutorial Creating Predefined Layer Position]]<br />
*[[Tutorial Feedback]]<br />
*[[Tutorial Creating an I/O Event]]<br />
*[[Tutorial Creating an Autostart Showfile]]<br />
*[[Tutorial Creating Compositions (Sets and Patches)]]<br />
*[[Tutorial Creating Multiple Compositions and Patches]]<br />
*[[Tutorial Creating and Playing an RTF Text File]]<br />
*[[Tutorial Licensing New Features]]<br />
*[[Tutorial Loading and Using JavaScripts in MXWendler]]<br />
*[[Tutorial Configuring a Virtual Camera]]<br />
<br />
==Playlist==<br />
*[[Tutorial Creating Playlists (Cue Lists)]]<br />
*[[Tutorial Playlists with Images and Keystone Correction]]<br />
*[[Tutorial Playlists with Timeline]]<br />
*[[Tutorial Playlists with Multi-Timeline]]<br />
*[[Tutorial Playlists with Time and Date Conditions]]<br />
*[[Tutorial Playlists with Timecode]]<br />
*[[Tutorial Playlists with Subtitles]]<br />
*[[Tutorial Playlists with IO - Commands]]<br />
*[[Tutorial Playlists with PDF and Frame Step]]<br />
*[[Tutorial Resetting Runtime Counter with IO Commands in Playlist]]<br />
*[[Tutorial Playlists with Fade Clip]]<br />
*[[Tutorial Playlists with Auto Step]]<br />
*[[Tutorial Playlists with Reset Counter]]<br />
*[[Tutorial Playlists with Shutdown]]<br />
*[[Tutorial Playlists with Load Show]]<br />
*[[Tutorial Playlists with OSC Command]]<br />
*[[Tutorial Playlists with Sys Command]]<br />
*[[Tutorial Playlists with PJlink Command]]<br />
*[[Tutorial Playlists in Rehearsal Mode]]<br />
*[[Tutorial Creating an Automated Show with Daily Event and Playlist Conditions]]<br />
<br />
==Keystone==<br />
*[[Tutorial Simultaneous Playback of two Videos with two Video Projectors]]<br />
*[[Tutorial Mapping with UV View]]<br />
*[[Tutorial Masked Output]]<br />
*[[Tutorial Colored Output with Animations]]<br />
*[[Tutorial Capture Output Sections with Artnet DMX and Network Grabbers]]<br />
*[[Tutorial SVG Mapping with the MXWendler Automatic Calibration]]<br />
<br />
<br />
==IO Devices==<br />
*[[Reference Open Sound Control - OSC]]<br />
*[[Reference JavaScript]]<br />
*[[Tutorial Using the Akai APC Mini (Note On/Off)]]<br />
*[[Tutorial Connecting the grandMA 2Port Node with MXWendler via Art-Net]]<br />
*[[Tutorial Connecting Jands Vista2 with MXWendler via Art-Net]]<br />
*[[Tutorial Set up the CITP Footage Library on the Media Server]]<br />
*[[Tutorial Time-sync and sending IO Commands over OSC Protocol]]<br />
*[[Tutorial Connecting a Wiimote to MXWendler]]<br />
*[[Tutorial Controlling MXWendler via TouchOSC]]<br />
*[[Tutorial Optimum Audio Settings with an Integrated Audio Interface]]<br />
*[[Tutorial Optimum Audio Settings with an External Audio Interface]]<br />
<!-- *[[Tutorial Controlling MXWendler with Elgato Streamdeck XL]] --><br />
*[[Tutorial Controlling MXWendler Barco e2 or Barco S3 Image Processor]]<br />
<br />
==FXServer==<br />
*[[Tutorial FXServer Output Windows]]<br />
<br />
*[[Tutorial How to Setup a Datapath Fx4 for MXWendler with the Wall Designer Software]]<br />
<br />
*[[Tutorial How to Optimize Video Footages With Blender]]<br />
<br />
==Standalone Encoder==<br />
*[[Tutorial Standalone Encoder / Video Batch Encoder]]<br />
<br />
==EDID Manager==<br />
*[[Tutorial MXWendler EDID Manager]]<br />
<br />
==NDI Tools==<br />
*[[Tutorial NDI Tools ]]<br />
*[[Tutorial Sending and Receiving Multiple Video Streams with NDI]]<br />
<br />
==Spout==<br />
*[[Tutorial Sending and Receiving Media Through Spout]]<br />
*[[Tutorial Connecting Winamp Generative Visuals with MXWendler via Spout]]</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Tutorials&diff=6042Tutorials2024-02-08T15:51:10Z<p>Hwendler: /* IO Devices */</p>
<hr />
<div>{{#mpdftags:<br />
pagebreak orientation="L"<br />
}}<br />
<br />
==General==<br />
*[[Tutorial Opening Different Media]]<br />
*[[Tutorial Setting up Stage Designer Output Windows]]<br />
*[[Tutorial Triggering Four Media with the Keyboard]]<br />
*[[Tutorial Coupling Video with Effects and Audio Signals]]<br />
*[[Tutorial Creating Predefined Layer Position]]<br />
*[[Tutorial Feedback]]<br />
*[[Tutorial Creating an I/O Event]]<br />
*[[Tutorial Creating an Autostart Showfile]]<br />
*[[Tutorial Creating Compositions (Sets and Patches)]]<br />
*[[Tutorial Creating Multiple Compositions and Patches]]<br />
*[[Tutorial Creating and Playing an RTF Text File]]<br />
*[[Tutorial Licensing New Features]]<br />
*[[Tutorial Loading and Using JavaScripts in MXWendler]]<br />
*[[Tutorial Configuring a Virtual Camera]]<br />
<br />
==Playlist==<br />
*[[Tutorial Creating Playlists (Cue Lists)]]<br />
*[[Tutorial Playlists with Images and Keystone Correction]]<br />
*[[Tutorial Playlists with Timeline]]<br />
*[[Tutorial Playlists with Multi-Timeline]]<br />
*[[Tutorial Playlists with Time and Date Conditions]]<br />
*[[Tutorial Playlists with Timecode]]<br />
*[[Tutorial Playlists with Subtitles]]<br />
*[[Tutorial Playlists with IO - Commands]]<br />
*[[Tutorial Playlists with PDF and Frame Step]]<br />
*[[Tutorial Resetting Runtime Counter with IO Commands in Playlist]]<br />
*[[Tutorial Playlists with Fade Clip]]<br />
*[[Tutorial Playlists with Auto Step]]<br />
*[[Tutorial Playlists with Reset Counter]]<br />
*[[Tutorial Playlists with Shutdown]]<br />
*[[Tutorial Playlists with Load Show]]<br />
*[[Tutorial Playlists with OSC Command]]<br />
*[[Tutorial Playlists with Sys Command]]<br />
*[[Tutorial Playlists with PJlink Command]]<br />
*[[Tutorial Playlists in Rehearsal Mode]]<br />
*[[Tutorial Creating an Automated Show with Daily Event and Playlist Conditions]]<br />
<br />
==Keystone==<br />
*[[Tutorial Simultaneous Playback of two Videos with two Video Projectors]]<br />
*[[Tutorial Mapping with UV View]]<br />
*[[Tutorial Masked Output]]<br />
*[[Tutorial Colored Output with Animations]]<br />
*[[Tutorial Capture Output Sections with Artnet DMX and Network Grabbers]]<br />
*[[Tutorial SVG Mapping with the MXWendler Automatic Calibration]]<br />
<br />
<br />
==IO Devices==<br />
*[[Reference Open Sound Control - OSC]]<br />
*[[Reference JavaScript]]<br />
*[[Tutorial Using the Akai APC Mini (Note On/Off)]]<br />
*[[Tutorial Connecting the grandMA 2Port Node with MXWendler via Art-Net]]<br />
*[[Tutorial Connecting Jands Vista2 with MXWendler via Art-Net]]<br />
*[[Tutorial Set up the CITP Footage Library on the Media Server]]<br />
*[[Tutorial Time-sync and sending IO Commands over OSC Protocol]]<br />
*[[Tutorial Connecting a Wiimote to MXWendler]]<br />
*[[Tutorial Controlling MXWendler via TouchOSC]]<br />
*[[Tutorial Avolites Titan Art-Net and CITP]]<br />
*[[Tutorial Optimum Audio Settings with an Integrated Audio Interface]]<br />
*[[Tutorial Optimum Audio Settings with an External Audio Interface]]<br />
<!-- *[[Tutorial Controlling MXWendler with Elgato Streamdeck XL]] --><br />
*[[Tutorial Controlling MXWendler Barco e2 or Barco S3 Image Processor]]<br />
<br />
==FXServer==<br />
*[[Tutorial FXServer Output Windows]]<br />
<br />
*[[Tutorial How to Setup a Datapath Fx4 for MXWendler with the Wall Designer Software]]<br />
<br />
*[[Tutorial How to Optimize Video Footages With Blender]]<br />
<br />
==Standalone Encoder==<br />
*[[Tutorial Standalone Encoder / Video Batch Encoder]]<br />
<br />
==EDID Manager==<br />
*[[Tutorial MXWendler EDID Manager]]<br />
<br />
==NDI Tools==<br />
*[[Tutorial NDI Tools ]]<br />
*[[Tutorial Sending and Receiving Multiple Video Streams with NDI]]<br />
<br />
==Spout==<br />
*[[Tutorial Sending and Receiving Media Through Spout]]<br />
*[[Tutorial Connecting Winamp Generative Visuals with MXWendler via Spout]]</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Tutorials&diff=6041Tutorials2024-02-08T15:08:51Z<p>Hwendler: /* IO Devices */</p>
<hr />
<div>{{#mpdftags:<br />
pagebreak orientation="L"<br />
}}<br />
<br />
==General==<br />
*[[Tutorial Opening Different Media]]<br />
*[[Tutorial Setting up Stage Designer Output Windows]]<br />
*[[Tutorial Triggering Four Media with the Keyboard]]<br />
*[[Tutorial Coupling Video with Effects and Audio Signals]]<br />
*[[Tutorial Creating Predefined Layer Position]]<br />
*[[Tutorial Feedback]]<br />
*[[Tutorial Creating an I/O Event]]<br />
*[[Tutorial Creating an Autostart Showfile]]<br />
*[[Tutorial Creating Compositions (Sets and Patches)]]<br />
*[[Tutorial Creating Multiple Compositions and Patches]]<br />
*[[Tutorial Creating and Playing an RTF Text File]]<br />
*[[Tutorial Licensing New Features]]<br />
*[[Tutorial Loading and Using JavaScripts in MXWendler]]<br />
*[[Tutorial Configuring a Virtual Camera]]<br />
<br />
==Playlist==<br />
*[[Tutorial Creating Playlists (Cue Lists)]]<br />
*[[Tutorial Playlists with Images and Keystone Correction]]<br />
*[[Tutorial Playlists with Timeline]]<br />
*[[Tutorial Playlists with Multi-Timeline]]<br />
*[[Tutorial Playlists with Time and Date Conditions]]<br />
*[[Tutorial Playlists with Timecode]]<br />
*[[Tutorial Playlists with Subtitles]]<br />
*[[Tutorial Playlists with IO - Commands]]<br />
*[[Tutorial Playlists with PDF and Frame Step]]<br />
*[[Tutorial Resetting Runtime Counter with IO Commands in Playlist]]<br />
*[[Tutorial Playlists with Fade Clip]]<br />
*[[Tutorial Playlists with Auto Step]]<br />
*[[Tutorial Playlists with Reset Counter]]<br />
*[[Tutorial Playlists with Shutdown]]<br />
*[[Tutorial Playlists with Load Show]]<br />
*[[Tutorial Playlists with OSC Command]]<br />
*[[Tutorial Playlists with Sys Command]]<br />
*[[Tutorial Playlists with PJlink Command]]<br />
*[[Tutorial Playlists in Rehearsal Mode]]<br />
*[[Tutorial Creating an Automated Show with Daily Event and Playlist Conditions]]<br />
<br />
==Keystone==<br />
*[[Tutorial Simultaneous Playback of two Videos with two Video Projectors]]<br />
*[[Tutorial Mapping with UV View]]<br />
*[[Tutorial Masked Output]]<br />
*[[Tutorial Colored Output with Animations]]<br />
*[[Tutorial Capture Output Sections with Artnet DMX and Network Grabbers]]<br />
*[[Tutorial SVG Mapping with the MXWendler Automatic Calibration]]<br />
<br />
<br />
==IO Devices==<br />
*[[Reference Open Sound Control - OSC]]<br />
*[[Reference JavaScript]]<br />
*[[Tutorial Using the Akai APC Mini (Note On/Off)]]<br />
*[[Tutorial Connecting the grandMA 2Port Node with MXWendler via Art-Net]]<br />
*[[Tutorial Connecting Jands Vista2 with MXWendler via Art-Net]]<br />
*[[Tutorial Set up the CITP Footage Library on the Media Server]]<br />
*[[Tutorial Time-sync and sending IO Commands over OSC Protocol]]<br />
*[[Tutorial Connecting a Wiimote to MXWendler]]<br />
*[[Tutorial Controlling MXWendler via TouchOSC]]<br />
*[[Tutorial Avolites Titan Art-Net and CITP]]<br />
*[[Tutorial Optimum Audio Settings with an Integrated Audio Interface]]<br />
*[[Tutorial Optimum Audio Settings with an External Audio Interface]]<br />
<!-- *[[Tutorial Controlling MXWendler with Elgato Streamdeck XL]] --><br />
*[[Tutorial Controlling MXWendler Barco e2 os Barco s3 Image Processor]]<br />
<br />
==FXServer==<br />
*[[Tutorial FXServer Output Windows]]<br />
<br />
*[[Tutorial How to Setup a Datapath Fx4 for MXWendler with the Wall Designer Software]]<br />
<br />
*[[Tutorial How to Optimize Video Footages With Blender]]<br />
<br />
==Standalone Encoder==<br />
*[[Tutorial Standalone Encoder / Video Batch Encoder]]<br />
<br />
==EDID Manager==<br />
*[[Tutorial MXWendler EDID Manager]]<br />
<br />
==NDI Tools==<br />
*[[Tutorial NDI Tools ]]<br />
*[[Tutorial Sending and Receiving Multiple Video Streams with NDI]]<br />
<br />
==Spout==<br />
*[[Tutorial Sending and Receiving Media Through Spout]]<br />
*[[Tutorial Connecting Winamp Generative Visuals with MXWendler via Spout]]</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Tutorials&diff=6040Tutorials2024-02-08T15:07:01Z<p>Hwendler: /* IO Devices */</p>
<hr />
<div>{{#mpdftags:<br />
pagebreak orientation="L"<br />
}}<br />
<br />
==General==<br />
*[[Tutorial Opening Different Media]]<br />
*[[Tutorial Setting up Stage Designer Output Windows]]<br />
*[[Tutorial Triggering Four Media with the Keyboard]]<br />
*[[Tutorial Coupling Video with Effects and Audio Signals]]<br />
*[[Tutorial Creating Predefined Layer Position]]<br />
*[[Tutorial Feedback]]<br />
*[[Tutorial Creating an I/O Event]]<br />
*[[Tutorial Creating an Autostart Showfile]]<br />
*[[Tutorial Creating Compositions (Sets and Patches)]]<br />
*[[Tutorial Creating Multiple Compositions and Patches]]<br />
*[[Tutorial Creating and Playing an RTF Text File]]<br />
*[[Tutorial Licensing New Features]]<br />
*[[Tutorial Loading and Using JavaScripts in MXWendler]]<br />
*[[Tutorial Configuring a Virtual Camera]]<br />
<br />
==Playlist==<br />
*[[Tutorial Creating Playlists (Cue Lists)]]<br />
*[[Tutorial Playlists with Images and Keystone Correction]]<br />
*[[Tutorial Playlists with Timeline]]<br />
*[[Tutorial Playlists with Multi-Timeline]]<br />
*[[Tutorial Playlists with Time and Date Conditions]]<br />
*[[Tutorial Playlists with Timecode]]<br />
*[[Tutorial Playlists with Subtitles]]<br />
*[[Tutorial Playlists with IO - Commands]]<br />
*[[Tutorial Playlists with PDF and Frame Step]]<br />
*[[Tutorial Resetting Runtime Counter with IO Commands in Playlist]]<br />
*[[Tutorial Playlists with Fade Clip]]<br />
*[[Tutorial Playlists with Auto Step]]<br />
*[[Tutorial Playlists with Reset Counter]]<br />
*[[Tutorial Playlists with Shutdown]]<br />
*[[Tutorial Playlists with Load Show]]<br />
*[[Tutorial Playlists with OSC Command]]<br />
*[[Tutorial Playlists with Sys Command]]<br />
*[[Tutorial Playlists with PJlink Command]]<br />
*[[Tutorial Playlists in Rehearsal Mode]]<br />
*[[Tutorial Creating an Automated Show with Daily Event and Playlist Conditions]]<br />
<br />
==Keystone==<br />
*[[Tutorial Simultaneous Playback of two Videos with two Video Projectors]]<br />
*[[Tutorial Mapping with UV View]]<br />
*[[Tutorial Masked Output]]<br />
*[[Tutorial Colored Output with Animations]]<br />
*[[Tutorial Capture Output Sections with Artnet DMX and Network Grabbers]]<br />
*[[Tutorial SVG Mapping with the MXWendler Automatic Calibration]]<br />
<br />
<br />
==IO Devices==<br />
*[[Reference Open Sound Control - OSC]]<br />
*[[Reference JavaScript]]<br />
*[[Tutorial Using the Akai APC Mini (Note On/Off)]]<br />
*[[Tutorial Connecting the grandMA 2Port Node with MXWendler via Art-Net]]<br />
*[[Tutorial Connecting Jands Vista2 with MXWendler via Art-Net]]<br />
*[[Tutorial Set up the CITP Footage Library on the Media Server]]<br />
*[[Tutorial Time-sync and sending IO Commands over OSC Protocol]]<br />
*[[Tutorial Connecting a Wiimote to MXWendler]]<br />
*[[Tutorial Controlling MXWendler via TouchOSC]]<br />
*[[Tutorial Avolites Titan Art-Net and CITP]]<br />
*[[Tutorial Optimum Audio Settings with an Integrated Audio Interface]]<br />
*[[Tutorial Optimum Audio Settings with an External Audio Interface]]<br />
*[[Tutorial Controlling MXWendler with Elgato Streamdeck XL]]<br />
*[[Tutorial Controlling MXWendler Barco e2 os Barco s3 Image Processor]]<br />
<br />
==FXServer==<br />
*[[Tutorial FXServer Output Windows]]<br />
<br />
*[[Tutorial How to Setup a Datapath Fx4 for MXWendler with the Wall Designer Software]]<br />
<br />
*[[Tutorial How to Optimize Video Footages With Blender]]<br />
<br />
==Standalone Encoder==<br />
*[[Tutorial Standalone Encoder / Video Batch Encoder]]<br />
<br />
==EDID Manager==<br />
*[[Tutorial MXWendler EDID Manager]]<br />
<br />
==NDI Tools==<br />
*[[Tutorial NDI Tools ]]<br />
*[[Tutorial Sending and Receiving Multiple Video Streams with NDI]]<br />
<br />
==Spout==<br />
*[[Tutorial Sending and Receiving Media Through Spout]]<br />
*[[Tutorial Connecting Winamp Generative Visuals with MXWendler via Spout]]</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Python_Reference&diff=6039Python Reference2023-12-04T13:24:22Z<p>Hwendler: Undo revision 6038 by Hwendler (talk)</p>
<hr />
<div>== Introduction ==<br />
This document describes the MXWendler (MXW) Python command interface through an overview of the programming structure, with practical examples of automation and internal scripting. The presented Python commands are for most part supported in version 7.2.<br />
<br />
== What is Python? ==<br />
Python is a standardized interpreted, high level programming language. It is used in many applications, mainly in AI and generative tasks. The amount of available libraries is outstanding.<br />
<br />
<br />
<br />
== Contents ==<br />
{|<br />
|-<br />
| style="padding: 10px" | [[1. Controlling MXW through Python]] <br />
|-<br />
| style="padding: 10px" | [[3. Python command reference | 2. Python command reference]] <br />
|-<br />
|}</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Python_Reference&diff=6038Python Reference2023-12-04T13:23:54Z<p>Hwendler: </p>
<hr />
<div>== Introduction ==<br />
This document describes the MXWendler (MXW) Python command interface through an overview of the programming structure, with practical examples of automation and internal scripting. The presented Python commands are for most part supported in version 7.2.<br />
<br />
== What is Python? ==<br />
Python is a standardized interpreted, high level programming language. It is used in many applications, mainly in AI and generative tasks. The amount of available libraries is outstanding.<br />
<br />
<br />
<br />
== Contents ==<br />
[[Controlling MXW through Python]] <br />
[[Python command reference]]</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=Python_Reference&diff=6037Python Reference2023-12-04T13:22:56Z<p>Hwendler: </p>
<hr />
<div>== Introduction ==<br />
This document describes the MXWendler (MXW) Python command interface through an overview of the programming structure, with practical examples of automation and internal scripting. The presented Python commands are for most part supported in version 7.2.<br />
<br />
== What is Python? ==<br />
Python is a standardized interpreted, high level programming language. It is used in many applications, mainly in AI and generative tasks. The amount of available libraries is outstanding.<br />
<br />
<br />
<br />
== Contents ==<br />
{|<br />
|-<br />
| style="padding: 10px" | [[1. Controlling MXW through Python]] <br />
|-<br />
| style="padding: 10px" | [[3. Python command reference | 2. Python command reference]] <br />
|-<br />
|}</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=1._Controlling_MXW_through_Python&diff=60361. Controlling MXW through Python2023-12-03T22:31:49Z<p>Hwendler: </p>
<hr />
<div>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.<br />
<br />
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:<br />
<br />
* '''(Program folder)/plugins/playlist/python/'''<br />
* '''~.StageDesigner/plugins/playlist/python/ (Unix)'''<br />
* '''~.StageDesigner/plugins/playlist/python/ (Windows)'''<br />
<br />
Each plugin resides in a folder. Inside this folder, two files have to be present,<br />
<br />
* '''mxw_plugin.ini'''<br />
* '''mxw_main.py'''<br />
<br />
The file '''mxw_plugin.ini''' defines the registration of the plugin. The following fields are valid:<br />
{| class="wikitable" style="margin-left: 0px;"<br />
|+ Fields<br />
|-<br />
! Tag !! Use !! Values/Example<br />
|-<br />
| plugin_version || Plugin Version || 1<br />
|-<br />
| plugin_script_language || Plugin Script Language || Python<br />
|-<br />
| plugin_action_level || Plugin Activity Switch || disabled = not visible<br />
|-<br />
| plugin_menu_parent || Top level parent in playlist menu || "AI", "IO" ..<br />
|-<br />
| plugin_menu_name || Playlist menu entry || "Face detection"<br />
|-<br />
| plugin_grid_name || Default name in grid (may be completed via script) || "Face detect"<br />
|-<br />
| 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)<br />
|-<br />
| plugin_tooltip || Tool tip in grid and panel || "This plugin triggers the playlist when it finds a face"<br />
|}<br />
<br />
<br />
An example mxw_plugin.ini looks like this:<br />
<br />
<syntaxhighlight lang="ini" line><br />
[mxw_plugin] ; must be here<br />
plugin_version = 1 ; must be V1 (as of V7.2)<br />
plugin_script_language = Python ; must be Python (as of V7.2)<br />
plugin_menu_parent = AI<br />
plugin_menu_name = NeuronalNet(Dlib) Face Detect Plugin<br />
plugin_grid_name = Face Detect Plugin<br />
plugin_grid_bg_color = 0.950000 0.050000 0.450000 1.000000 ; set plugin color.<br />
plugin_tooltip = This plugin triggers the playlist when it finds a Face using a neuronal net (Dlib)<br />
</syntaxhighlight><br />
<br />
<br />
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:<br />
<br />
{| class="wikitable" style="margin-left: 0px;"<br />
|+ Fields<br />
|-<br />
! Function Name !! Details<br />
|-<br />
| '''onCreate()''' || Called when the plugin item is created<br />
|-<br />
| '''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<br />
|-<br />
| '''getColorBG()''' || Get background color, called each render cycle<br />
|-<br />
| '''onAction()''' || Called when cue is entered<br />
|-<br />
| '''onPostAction()''' || Called when the cue is left<br />
|-<br />
| '''onPreparePlayback()''' || Called when the playlist gets a preloading command (e.g. when the GoToStart button is pressed)<br />
|-<br />
| '''onActivateInUI()''' || Called when the item is selected in the ui<br />
|-<br />
| '''onActiveCueChange()''' || Called when the playlist seeks<br />
|-<br />
| '''getDuration()''' || Get action duration<br />
|-<br />
| '''getText()''' || Get grid text, called each render cycle (may display some information)<br />
|-<br />
| '''onCleanup()''' || Called when the playlist aborts or seeks<br />
|-<br />
| '''getTimeSinceOnActionIssued()''' ||Get action duration, called each render cycle (may display a countdown)<br />
|-<br />
| '''onPause()''' || Called when the playlist goes paused<br />
|}<br />
<br />
Note that not all of the interface functions need to be implemented. If a function is not defined, it is probed but not called.<br />
<br />
<br />
This is a minimal example of video writing and placing the recorded video into the first preload:<br />
<br />
<syntaxhighlight lang="Python" line><br />
import tempfile<br />
import mxw, mxw_imgui # for mxw interaction, mxw ui interaction<br />
import cv2 # image processing<br />
import numpy as np # math<br />
<br />
capture_device=""<br />
videosize = (640,480)<br />
f = object()<br />
out = object()<br />
<br />
def onCreate():<br />
global capture_device<br />
dev = mxw.media().get_capture_device_names()<br />
capture_device = dev[1]<br />
return<br />
<br />
def onAction():<br />
global capture_device, out, f<br />
f = tempfile.NamedTemporaryFile(suffix='.avi')<br />
f.close()<br />
fourcc = cv2.VideoWriter_fourcc('M','P','4','V')<br />
out = cv2.VideoWriter(f.name, fourcc, mxw.fps, videosize)<br />
m = mxw.media(capture_device)<br />
if(m.isvalid()):<br />
m.reference(True)<br />
return<br />
<br />
def onPostAction():<br />
global capture_device, out, f<br />
out.release()<br />
mxw.preload(1).set_media(f.name)<br />
m = mxw.media(capture_device)<br />
if(m.isvalid()):<br />
m.reference(False)<br />
return<br />
<br />
def onNewFrameInPlayoutCue():<br />
global capture_device, out, f<br />
m = mxw.media(capture_device)<br />
if(m.isvalid()):<br />
img = m.get_image_sample_cvmat(videosize[0],videosize[1])<br />
img = np.array(img, copy=False)<br />
img = cv2.flip(img, 0)<br />
out.write(img)<br />
return<br />
<br />
# render in panel for settings etc<br />
def onRenderPanel():<br />
mxw_imgui.text_unformatted("This plugin records a camera")<br />
return<br />
</syntaxhighlight></div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=1._Controlling_MXW_through_Python&diff=60351. Controlling MXW through Python2023-12-03T22:29:17Z<p>Hwendler: </p>
<hr />
<div>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.<br />
<br />
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:<br />
<br />
* '''(Program folder)/plugins/playlist/python/'''<br />
* '''~.StageDesigner/plugins/playlist/python/ (Unix)'''<br />
* '''~.StageDesigner/plugins/playlist/python/ (Windows)'''<br />
<br />
Each plugin resides in a folder. Inside this folder, two files have to be present,<br />
<br />
* '''mxw_plugin.ini'''<br />
* '''mxw_main.py'''<br />
<br />
The file '''mxw_plugin.ini''' defines the registration of the plugin. The following fields are valid:<br />
{| class="wikitable" style="margin-left: 0px;"<br />
|+ Fields<br />
|-<br />
! Tag !! Use !! Values/Example<br />
|-<br />
| plugin_version || Plugin Version || 1<br />
|-<br />
| plugin_script_language || Plugin Script Language || Python<br />
|-<br />
| plugin_action_level || Plugin Activity Switch || disabled = not visible<br />
|-<br />
| plugin_menu_parent || Top level parent in playlist menu || "AI", "IO" ..<br />
|-<br />
| plugin_menu_name || Playlist menu entry || "Face detection"<br />
|-<br />
| plugin_grid_name || Default name in grid (may be completed via script) || "Face detect"<br />
|-<br />
| 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)<br />
|-<br />
| plugin_tooltip || Tool tip in grid and panel || "This plugin triggers the playlist when it finds a Face"<br />
|}<br />
<br />
<br />
An example mxw_plugin.ini looks like this:<br />
<br />
<syntaxhighlight lang="ini" line><br />
[mxw_plugin] ; must be here<br />
plugin_version = 1 ; must be V1 (as of V7.2)<br />
plugin_script_language = Python ; must be Python (as of V7.2)<br />
plugin_menu_parent = AI<br />
plugin_menu_name = NeuronalNet(Dlib) Face Detect Plugin<br />
plugin_grid_name = Face Detect Plugin<br />
plugin_grid_bg_color = 0.950000 0.050000 0.450000 1.000000 ; set plugin color.<br />
plugin_tooltip = This plugin triggers the playlist when it finds a Face using a neuronal net (Dlib)<br />
</syntaxhighlight><br />
<br />
<br />
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:<br />
<br />
{| class="wikitable" style="margin-left: 0px;"<br />
|+ Fields<br />
|-<br />
! Function Name !! Details<br />
|-<br />
| '''onCreate()''' || Called when the plugin item is created<br />
|-<br />
| '''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<br />
|-<br />
| '''getColorBG()''' || Get background color, called each render cycle<br />
|-<br />
| '''onAction()''' || Called when cue is entered<br />
|-<br />
| '''onPostAction()''' || Called when the cue is left<br />
|-<br />
| '''onPreparePlayback()''' || Called when the playlist gets a preloading command (e.g. when the GoToStart button is pressed)<br />
|-<br />
| '''onActivateInUI()''' || Called when the item is selected in the ui<br />
|-<br />
| '''onActiveCueChange()''' || Called when the playlist seeks<br />
|-<br />
| '''getDuration()''' || Get action duration<br />
|-<br />
| '''getText()''' || Get grid text, called each render cycle (may display some information)<br />
|-<br />
| '''onCleanup()''' || Called when the playlist aborts or seeks<br />
|-<br />
| '''getTimeSinceOnActionIssued()''' ||Get action duration, called each render cycle (may display a countdown)<br />
|-<br />
| '''onPause()''' || Called when the playlist goes paused<br />
|}<br />
<br />
Note that not all of the interface functions need to be implemented. If a function is not defined, it is probed but not called.<br />
<br />
<br />
This is a minimal example of video writing and placing the recorded video into the first preload:<br />
<br />
<syntaxhighlight lang="Python" line><br />
import tempfile<br />
import mxw, mxw_imgui # for mxw interaction, mxw ui interaction<br />
import cv2 # image processing<br />
import numpy as np # math<br />
<br />
capture_device=""<br />
videosize = (640,480)<br />
f = object()<br />
out = object()<br />
<br />
def onCreate():<br />
global capture_device<br />
dev = mxw.media().get_capture_device_names()<br />
capture_device = dev[1]<br />
return<br />
<br />
def onAction():<br />
global capture_device, out, f<br />
f = tempfile.NamedTemporaryFile(suffix='.avi')<br />
f.close()<br />
fourcc = cv2.VideoWriter_fourcc('M','P','4','V')<br />
out = cv2.VideoWriter(f.name, fourcc, mxw.fps, videosize)<br />
m = mxw.media(capture_device)<br />
if(m.isvalid()):<br />
m.reference(True)<br />
return<br />
<br />
def onPostAction():<br />
global capture_device, out, f<br />
out.release()<br />
mxw.preload(1).set_media(f.name)<br />
m = mxw.media(capture_device)<br />
if(m.isvalid()):<br />
m.reference(False)<br />
return<br />
<br />
def onNewFrameInPlayoutCue():<br />
global capture_device, out, f<br />
m = mxw.media(capture_device)<br />
if(m.isvalid()):<br />
img = m.get_image_sample_cvmat(videosize[0],videosize[1])<br />
img = np.array(img, copy=False)<br />
img = cv2.flip(img, 0)<br />
out.write(img)<br />
return<br />
<br />
# render in panel for settings etc<br />
def onRenderPanel():<br />
mxw_imgui.text_unformatted("This plugin records a camera")<br />
return<br />
</syntaxhighlight></div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=1._Controlling_MXW_through_Python&diff=60341. Controlling MXW through Python2023-12-03T22:28:58Z<p>Hwendler: </p>
<hr />
<div>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.<br />
<br />
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:<br />
<br />
* '''(Program folder)/plugins/playlist/python/'''<br />
* '''~.StageDesigner/plugins/playlist/python/ (Unix)'''<br />
* '''~.StageDesigner/plugins/playlist/python/ (Windows)'''<br />
<br />
Each plugin resides in a folder. Inside this folder, two files have to be present,<br />
<br />
* '''mxw_plugin.ini'''<br />
* '''mxw_main.py'''<br />
<br />
The file '''mxw_plugin.ini''' defines the registration of the plugin. The following fields are valid:<br />
{| class="wikitable" style="margin-left: 0px;"<br />
|+ Fields<br />
|-<br />
! Tag !! Use !! Values/Example<br />
|-<br />
| plugin_version || Plugin Version || 1<br />
|-<br />
| plugin_script_language || Plugin Script Language || Python<br />
|-<br />
| plugin_action_level || Plugin Activity Switch || disabled = not visible<br />
|-<br />
| plugin_menu_parent || Top level parent in playlist menu || "AI", "IO" ..<br />
|-<br />
| plugin_menu_name || Playlist menu entry || "Face detection"<br />
|-<br />
| plugin_grid_name || Default name in grid (may be completed via script) || "Face detect"<br />
|-<br />
| 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)<br />
|-<br />
| plugin_tooltip || Tool tip in grid and panel || "This plugin triggers the playlist when it finds a Face"<br />
|}<br />
<br />
<br />
An example mxw_plugin.ini looks like this:<br />
<br />
<syntaxhighlight lang="ini" line><br />
[mxw_plugin] ; must be here<br />
plugin_version = 1 ; must be V1 (as of V7.2)<br />
plugin_script_language = Python ; must be Python (as of V7.2)<br />
plugin_menu_parent = AI<br />
plugin_menu_name = NeuronalNet(Dlib) Face Detect Plugin<br />
plugin_grid_name = Face Detect Plugin<br />
plugin_grid_bg_color = 0.950000 0.050000 0.450000 1.000000 ; set plugin color.<br />
plugin_tooltip = This plugin triggers the playlist when it finds a Face using a neuronal net (Dlib)<br />
</syntaxhighlight><br />
<br />
<br />
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:<br />
<br />
{| class="wikitable" style="margin:auto"<br />
|+ Fields<br />
|-<br />
! Function Name !! Details<br />
|-<br />
| '''onCreate()''' || Called when the plugin item is created<br />
|-<br />
| '''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<br />
|-<br />
| '''getColorBG()''' || Get background color, called each render cycle<br />
|-<br />
| '''onAction()''' || Called when cue is entered<br />
|-<br />
| '''onPostAction()''' || Called when the cue is left<br />
|-<br />
| '''onPreparePlayback()''' || Called when the playlist gets a preloading command (e.g. when the GoToStart button is pressed)<br />
|-<br />
| '''onActivateInUI()''' || Called when the item is selected in the ui<br />
|-<br />
| '''onActiveCueChange()''' || Called when the playlist seeks<br />
|-<br />
| '''getDuration()''' || Get action duration<br />
|-<br />
| '''getText()''' || Get grid text, called each render cycle (may display some information)<br />
|-<br />
| '''onCleanup()''' || Called when the playlist aborts or seeks<br />
|-<br />
| '''getTimeSinceOnActionIssued()''' ||Get action duration, called each render cycle (may display a countdown)<br />
|-<br />
| '''onPause()''' || Called when the playlist goes paused<br />
|}<br />
<br />
Note that not all of the interface functions need to be implemented. If a function is not defined, it is probed but not called.<br />
<br />
<br />
This is a minimal example of video writing and placing the recorded video into the first preload:<br />
<br />
<syntaxhighlight lang="Python" line><br />
import tempfile<br />
import mxw, mxw_imgui # for mxw interaction, mxw ui interaction<br />
import cv2 # image processing<br />
import numpy as np # math<br />
<br />
capture_device=""<br />
videosize = (640,480)<br />
f = object()<br />
out = object()<br />
<br />
def onCreate():<br />
global capture_device<br />
dev = mxw.media().get_capture_device_names()<br />
capture_device = dev[1]<br />
return<br />
<br />
def onAction():<br />
global capture_device, out, f<br />
f = tempfile.NamedTemporaryFile(suffix='.avi')<br />
f.close()<br />
fourcc = cv2.VideoWriter_fourcc('M','P','4','V')<br />
out = cv2.VideoWriter(f.name, fourcc, mxw.fps, videosize)<br />
m = mxw.media(capture_device)<br />
if(m.isvalid()):<br />
m.reference(True)<br />
return<br />
<br />
def onPostAction():<br />
global capture_device, out, f<br />
out.release()<br />
mxw.preload(1).set_media(f.name)<br />
m = mxw.media(capture_device)<br />
if(m.isvalid()):<br />
m.reference(False)<br />
return<br />
<br />
def onNewFrameInPlayoutCue():<br />
global capture_device, out, f<br />
m = mxw.media(capture_device)<br />
if(m.isvalid()):<br />
img = m.get_image_sample_cvmat(videosize[0],videosize[1])<br />
img = np.array(img, copy=False)<br />
img = cv2.flip(img, 0)<br />
out.write(img)<br />
return<br />
<br />
# render in panel for settings etc<br />
def onRenderPanel():<br />
mxw_imgui.text_unformatted("This plugin records a camera")<br />
return<br />
</syntaxhighlight></div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=1._Controlling_MXW_through_Python&diff=60331. Controlling MXW through Python2023-12-03T22:28:37Z<p>Hwendler: </p>
<hr />
<div>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.<br />
<br />
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:<br />
<br />
* '''(Program folder)/plugins/playlist/python/'''<br />
* '''~.StageDesigner/plugins/playlist/python/ (Unix)'''<br />
* '''~.StageDesigner/plugins/playlist/python/ (Windows)'''<br />
<br />
Each plugin resides in a folder. Inside this folder, two files have to be present,<br />
<br />
* '''mxw_plugin.ini'''<br />
* '''mxw_main.py'''<br />
<br />
The file '''mxw_plugin.ini''' defines the registration of the plugin. The following fields are valid:<br />
{| class="wikitable" style="margin-left: 0px; margin-right: 0px;"<br />
|+ Fields<br />
|-<br />
! Tag !! Use !! Values/Example<br />
|-<br />
| plugin_version || Plugin Version || 1<br />
|-<br />
| plugin_script_language || Plugin Script Language || Python<br />
|-<br />
| plugin_action_level || Plugin Activity Switch || disabled = not visible<br />
|-<br />
| plugin_menu_parent || Top level parent in playlist menu || "AI", "IO" ..<br />
|-<br />
| plugin_menu_name || Playlist menu entry || "Face detection"<br />
|-<br />
| plugin_grid_name || Default name in grid (may be completed via script) || "Face detect"<br />
|-<br />
| 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)<br />
|-<br />
| plugin_tooltip || Tool tip in grid and panel || "This plugin triggers the playlist when it finds a Face"<br />
|}<br />
<br />
<br />
An example mxw_plugin.ini looks like this:<br />
<br />
<syntaxhighlight lang="ini" line><br />
[mxw_plugin] ; must be here<br />
plugin_version = 1 ; must be V1 (as of V7.2)<br />
plugin_script_language = Python ; must be Python (as of V7.2)<br />
plugin_menu_parent = AI<br />
plugin_menu_name = NeuronalNet(Dlib) Face Detect Plugin<br />
plugin_grid_name = Face Detect Plugin<br />
plugin_grid_bg_color = 0.950000 0.050000 0.450000 1.000000 ; set plugin color.<br />
plugin_tooltip = This plugin triggers the playlist when it finds a Face using a neuronal net (Dlib)<br />
</syntaxhighlight><br />
<br />
<br />
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:<br />
<br />
{| class="wikitable" style="margin:auto"<br />
|+ Fields<br />
|-<br />
! Function Name !! Details<br />
|-<br />
| '''onCreate()''' || Called when the plugin item is created<br />
|-<br />
| '''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<br />
|-<br />
| '''getColorBG()''' || Get background color, called each render cycle<br />
|-<br />
| '''onAction()''' || Called when cue is entered<br />
|-<br />
| '''onPostAction()''' || Called when the cue is left<br />
|-<br />
| '''onPreparePlayback()''' || Called when the playlist gets a preloading command (e.g. when the GoToStart button is pressed)<br />
|-<br />
| '''onActivateInUI()''' || Called when the item is selected in the ui<br />
|-<br />
| '''onActiveCueChange()''' || Called when the playlist seeks<br />
|-<br />
| '''getDuration()''' || Get action duration<br />
|-<br />
| '''getText()''' || Get grid text, called each render cycle (may display some information)<br />
|-<br />
| '''onCleanup()''' || Called when the playlist aborts or seeks<br />
|-<br />
| '''getTimeSinceOnActionIssued()''' ||Get action duration, called each render cycle (may display a countdown)<br />
|-<br />
| '''onPause()''' || Called when the playlist goes paused<br />
|}<br />
<br />
Note that not all of the interface functions need to be implemented. If a function is not defined, it is probed but not called.<br />
<br />
<br />
This is a minimal example of video writing and placing the recorded video into the first preload:<br />
<br />
<syntaxhighlight lang="Python" line><br />
import tempfile<br />
import mxw, mxw_imgui # for mxw interaction, mxw ui interaction<br />
import cv2 # image processing<br />
import numpy as np # math<br />
<br />
capture_device=""<br />
videosize = (640,480)<br />
f = object()<br />
out = object()<br />
<br />
def onCreate():<br />
global capture_device<br />
dev = mxw.media().get_capture_device_names()<br />
capture_device = dev[1]<br />
return<br />
<br />
def onAction():<br />
global capture_device, out, f<br />
f = tempfile.NamedTemporaryFile(suffix='.avi')<br />
f.close()<br />
fourcc = cv2.VideoWriter_fourcc('M','P','4','V')<br />
out = cv2.VideoWriter(f.name, fourcc, mxw.fps, videosize)<br />
m = mxw.media(capture_device)<br />
if(m.isvalid()):<br />
m.reference(True)<br />
return<br />
<br />
def onPostAction():<br />
global capture_device, out, f<br />
out.release()<br />
mxw.preload(1).set_media(f.name)<br />
m = mxw.media(capture_device)<br />
if(m.isvalid()):<br />
m.reference(False)<br />
return<br />
<br />
def onNewFrameInPlayoutCue():<br />
global capture_device, out, f<br />
m = mxw.media(capture_device)<br />
if(m.isvalid()):<br />
img = m.get_image_sample_cvmat(videosize[0],videosize[1])<br />
img = np.array(img, copy=False)<br />
img = cv2.flip(img, 0)<br />
out.write(img)<br />
return<br />
<br />
# render in panel for settings etc<br />
def onRenderPanel():<br />
mxw_imgui.text_unformatted("This plugin records a camera")<br />
return<br />
</syntaxhighlight></div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=3._Python_command_reference&diff=60323. Python command reference2023-12-03T22:10:30Z<p>Hwendler: /* Set Reference */</p>
<hr />
<div>Here are listed the main commands that can be used for scripting with Python.<br />
<br />
=== Legend ===<br />
<div> <br />
<br />
The standard used to represent the available values for each command is:<br />
<br />
<br />
''FLOATS'' are represented with one decimal:<br />
<br />
<code>0.0 .. 1.0</code> &rarr; all float values between 0 and 1 included<br />
<br />
<br />
''INTEGERS'' are represented with numbers or descriptions:<br />
<br />
<code>1 .. 5</code> &rarr; all integers between 1 and 5 included ( 1 , 2 , 3 , 4 , 5 ) <br><br />
<code>1 .. (MAX n layers)</code> &rarr; all the integers between 1 and the maximum index of layers in MXW (e.g. if 6 layers are being used the values are integers between 1 and 6 included)<br />
<br />
When only one number is indicated it means that only one option is given. This is found in addresses of buttons, checkboxes and in the options where "0" or "1" are the only significant values<br />
<br />
<br />
''STRINGS'' are represented between double quotation marks:<br />
<br />
<code>/mxw/set info </code><br />
<br />
When <code>“name”</code> is contained in the available string variable, then the content is to be substituted with the actual name.<br />
<br />
E.G. : to select and play a patch called “patch_one” from its name, the address <code>/mxw/set</code> with tokens <code>"play" "name_of_patch"</code> has to be used, resulting in this OSC command:<br />
<br />
<code>/mxw/set play patch_one</code><br />
<br />
<br />
When <u>OR</u> is found it means that two options can deliver a similar result. One of the two formats has to be used at one time.<br />
<br />
Here are listed all the commands that MXW recognizes.<br />
<br />
=== Legend ===<br />
<div> <br />
<br />
The standard used to represent the available values for each command is:<br />
<br />
<br />
''FLOATS'' are represented with one decimal:<br />
<br />
<code>0.0 .. 1.0</code> &rarr; all float values between 0 and 1 included<br />
<br />
<br />
''INTEGERS'' are represented with numbers or descriptions:<br />
<br />
<code>1 .. 5</code> &rarr; all integers between 1 and 5 included ( 1 , 2 , 3 , 4 , 5 ) <br><br />
<code>1 .. (MAX n layers)</code> &rarr; all the integers between 1 and the maximum index of layers in MXW (e.g. if 6 layers are being used the values are integers between 1 and 6 included)<br />
<br />
When only one number is indicated it means that only one option is given. This is found in addresses of buttons, checkboxes and in the options where "0" or "1" are the only significant values<br />
<br />
<br />
''STRINGS'' are represented between double quotation marks:<br />
<br />
<code>/mxw/set info </code><br />
<br />
When <code>“name”</code> is contained in the available string variable, then the content is to be substituted with the actual name.<br />
<br />
E.G. : to select and play a patch called “patch_one” from its name, the address <code>/mxw/set</code> with tokens <code>"play" "name_of_patch"</code> has to be used, resulting in this OSC command:<br />
<br />
<code>/mxw/set play patch_one</code><br />
<br />
<br />
When <u>OR</u> is found it means that two options can deliver a similar result. One of the two formats has to be used at one time.<br />
<br />
<br />
===Set Reference===<br />
<br />
{| class="wikitable"<br />
|-<br />
! PYTHON COMMAND/SYMBOL !! DESCRIPTION !! EXAMPLE<br />
|-<br />
!colspan="3" |Software Info<br />
|-<br />
|<code>mxw.millis</code>|| returns the amount of milliseconds passed since opening the software|| <code>mxw.print_console("current passed time is" + str(mxw.millis) );</code> <br />
|-<br />
|<code>mxw.width</code>||returns the current frame width in px|| <code>mxw.print_console("frame width is" + str(mxw.width) );</code><br />
|-<br />
|<code>mxw.height</code>||returns the current frame height in px|| <code>mxw.print_console("frame height is" + str(mxw.height));</code><br />
|-<br />
|<code>mxw.outwidth</code>||returns current output width|| <code>mxw.print_console("output height is" + str(mxw.outwidth));</code><br />
|-<br />
|<code>mxw.outheight</code>||returns the current output height|| <code>mxw.print_console("output width is" + str(mxw.outheight));</code> <br />
|-<br />
|<code>mxw.framecounter</code>||returns the amount of frames rendered since opening the software|| <code>mxw.print_console("total number of frames rendered is" + str(mxw.framecounter));</code> <br />
|-<br />
|<code>mxw.print_console("text" + mxw.widget("/mxw/path").getStringValue())</code> || prints the name of the desired playlist cue || <code>mxw.print_console("The clip name in the second cue is" + mxw.widget("/mxw/playlist/container/1/column/0/row/1").getStringValue());</code><br />
|-<br />
|<code>mxw.print_statusline("text")</code> || print text on the status line|| <code>print text on status line()</code><br />
|-<br />
!colspan="3" | I/O<br />
|-<br />
|<code>mxw.dmx()</code> ||returns the DMX value received from the specified universe and channel|| <code>mxw.print_console("DMX value in u. 1, ch. 4 is" + mxw.dmx(1,4));</code><br />
|-<br />
|<code>mxw.midi()</code>||returns the MIDI value received from the specified device and channel|| <code>mxw.print_console("MIDI value in dev. 1, ch. 6 is" + mxw.midi(1,6));</code> <br />
|-<br />
|<code>mxw.keyboard("ASCII_code")</code> || returns if the specified key is pressed or not || <code>mxw.keyboard(65)</code><br />
|-<br />
|<code>mxw.io.pjlink("on", "IP_ADDRESS", "pj_password")</code> || sends a.io.pjlink command to the selected projector and turns it on || <code>mxw.io.pjlink("on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.io.pjlink("off", "IP_ADDRESS", "pj_password")</code> || sends a.io.pjlink command to the selected projector and turns it off|| <code>mxw.io.pjlink("off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.io.pjlink("avmute_on", "IP_ADDRESS", "pj_password")</code> || sends a.io.pjlink command to the selected projector and mutes audio and video || <code>mxw.io.pjlink("avmute_on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.io.pjlink("avmute_off", "IP_ADDRESS", "pj_password")</code> || sends a.io.pjlink command to the selected projector and unmutes audio and video || <code>mxw.io.pjlink("avmute_off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.io.pjlink("vmute_on", "IP_ADDRESS", "pj_password")</code> || sends a.io.pjlink command to the selected projector and mutes video || <code>mxw.io.pjlink("vmute_on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.io.pjlink("vmute_off", "IP_ADDRESS", "pj_password")</code> || sends a.io.pjlink command to the selected projector and unmutes video || <code>mxw.io.pjlink("vmute_off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_is_supported")</code> || control if a NDI Camera supports PTZ || <code>mxw.media("USB Cam").ptz("ptz_is_supported")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_zoom", value)</code> || control the zoom of a NDI PTZ Camera, values from 0(zoomed in) to 1(zoomed out) || <code>mxw.media("USB Cam").ptz("ptz_zoom", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_pan_tilt", value_pan, value_tilt)</code> || control the pan and tilting of a NDI PTZ Camera (values from -1 to 1) || <code><code>mxw.media("USB Cam").ptz("ptz_pan_tilt", -0.5, 0.2)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_zoom_speed", value)</code> || control the zoom speed a NDI PTZ Camera, values from -1(zoom outwards) to 1 (zoom inwards) || <code><code>mxw.media("USB Cam").ptz("ptz_zoom", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_pan_tilt_speed", pan_speed, tilt_speed)</code> || control the pan and tilt speed a NDI PTZ Camera, values -1 (move right/down) to 1 (move left/up) || <code>mxw.media("USB Cam").ptz("ptz_pan_tilt_speed", -0.3, 0.8)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_store_preset", preset_number)</code> || store current position, focus, zoom, values 0 to 99 || <code>mxw.media("USB Cam").ptz("ptz_store_preset", 75)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_recall_preset",preset_number, speed)</code> || recalls a previously stored preset,values 0 to 99 and changes to it at a specific speed (values 0 to 1) || <code>mxw.media("USB Cam").ptz("ptz_recall_preset", 4, 0.5 )</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_auto_focus")</code> || activates or deactivates the camera in auto-focus || <code>mxw.media("USB Cam").ptz("ptz.autofocus")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_focus", focus_value)</code> || focus to absolute value (0= focused to infinity, 1= focus the closest possible)|| <code>mxw.media("USB Cam").ptz("ptz_focus", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_focus_speed", speed_value)</code> || focus at a particular speed, values from -1(outwards), to 1 (inwards)|| <code>mxw.media("USB Cam").ptz("ptz_focus_speed", -0.2)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_auto")</code> || put the camera in auto white-balance mode || <code>mxw.media("USB Cam").ptz("ptz_white_balance_auto")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_indoor")</code> || put the camera in indoor white balance || <code> mxw.media("USB Cam").ptz("ptz_white_balance_indoor")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_outdoor")</code> || put the camera in outdoor white balance || <code> mxw.media("USB Cam").ptz("ptz_white_balance_outdoor")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_oneshot")</code> ||use the current brightness to automatically set the current white balance|| <code>mxw.media("USB_Cam").ptz("ptz_white_balance_oneshot")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_manual", red value, blue value)</code> || Set the manual camera white balance using the R, B values, (0.0 = not red/not blue , 1.0 = very red/very blue)|| <code>mxw.media("camera_name").ptz("ptz_white_balance_manual", 0.1, 0.7)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_auto")</code> || put the camera in auto-exposure mode || <code>mxw.media("USB_Cam").ptz("ptz_exposure_auto")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_manual", exposure_level)</code> || manually set the camera exposure iris, values from 0.0(dark) to 1.0(light)|| <code>mxw.media("USB_Cam").ptz("ptz_exposure_manual", 0.4)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_manual_v2", iris_level, gain_level, shutter_speed)</code> || Manually set the camera exposure parameters, values iris from 0.0(dark) to 1.0(light), values gain from 0.0(dark) to 1.0(light), values shutter_speed from 0.0(slow) to 1.0(fast) || <code> mxw.media("USB_Cam").ptz("ptz_exposure_manual_v2", 0.4, 0.2, 0.5) </code><br />
|-<br />
!colspan="3" |Playlist Control<br />
|-<br />
|<code>mxw.playlist.preload_media()</code> || preload used media || <code>mxw.playlist.preload_media()</code><br />
|-<br />
|<code>mxw.playlist.pause()</code> || pause the playlists or restart if already paused|| <code>mxw.playlist.pause()</code><br />
|-<br />
|<code>mxw.playlist.play()</code> || play the playlist || <code>mxw.playlist.play()</code><br />
|-<br />
|<code>mxw.playlist.go_pause()( true/false )</code> || pause the playlist (when true), unpause the playlist (when false) || <code>mxw.playlist.go_pause()(true)</code><br />
|-<br />
|<code>mxw.playlist.skiptonext()</code> || skip to the next cue || <code>mxw.playlist.skiptonext()</code><br />
|-<br />
|<code>mxw.playlist.go_next()</code> || go to the next cue without playing || <code>mxw.playlist.go_next()</code><br />
|-<br />
|<code>mxw.playlist.go_prev()</code> || go to previous cue || <code>mxw.playlist.go_prev()</code><br />
|-<br />
|<code>mxw.playlist.go_first()</code> || go to the first cue || <code>mxw.playlist.go_first()</code><br />
|-<br />
|<code>mxw.playlist.navigate_index(index_value)</code> || go to the specified cue index|| <code>mxw.playlist.navigate_index(2)</code><br />
|-<br />
|<code>mxw.playlist.navigate_string("index_string")</code> || go to the specified cue string|| <code>mxw.playlist.navigate_string("BG_video2")</code><br />
|-<br />
!colspan="3" |Preload Control<br />
|-<br />
|<code>mxw.preload(preload_number).clear()</code> || clears the selected preload || <code>mxw.preload(2).clear()</code><br />
|-<br />
|<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><br />
|-<br />
|<code>mxw.preload(preload_number).set_name("new_media_name")</code> || renames a preload || <code>mxw.preload(2).set_name("new_background")</code><br />
|-<br />
|<code>mxw.preload(preload_number).add_preload()</code> || load a preload in the layers || <code>mxw.preload(2).add_preload()</code><br />
|-<br />
|<code>mxw.preload(preload_number).trigger_preload()</code> || trigger a layer from the preload || <code>mxw.preload(2).trigger_preload()</code><br />
|-<br />
|<code>mxw.preload(preload_number).get_activated()</code> || requests if the preload is editable || <code>mxw.preload(2).get_activated()</code><br />
|-<br />
|<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><br />
|-<br />
|<code>mxw.preload(preload_number).get_layer_position()</code> || returns the layer index of the preload|| <code>mxw.preload(2).get_layer_position()</code><br />
|-<br />
|<code>mxw.preload(preload_number).get_track_position()</code> || returns the track index of the preload|| <code>mxw.preload(2).get_track_position()</code><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
<br />
|}</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=3._Python_command_reference&diff=60313. Python command reference2023-12-03T22:08:02Z<p>Hwendler: /* Set Reference */</p>
<hr />
<div>Here are listed the main commands that can be used for scripting with Python.<br />
<br />
=== Legend ===<br />
<div> <br />
<br />
The standard used to represent the available values for each command is:<br />
<br />
<br />
''FLOATS'' are represented with one decimal:<br />
<br />
<code>0.0 .. 1.0</code> &rarr; all float values between 0 and 1 included<br />
<br />
<br />
''INTEGERS'' are represented with numbers or descriptions:<br />
<br />
<code>1 .. 5</code> &rarr; all integers between 1 and 5 included ( 1 , 2 , 3 , 4 , 5 ) <br><br />
<code>1 .. (MAX n layers)</code> &rarr; all the integers between 1 and the maximum index of layers in MXW (e.g. if 6 layers are being used the values are integers between 1 and 6 included)<br />
<br />
When only one number is indicated it means that only one option is given. This is found in addresses of buttons, checkboxes and in the options where "0" or "1" are the only significant values<br />
<br />
<br />
''STRINGS'' are represented between double quotation marks:<br />
<br />
<code>/mxw/set info </code><br />
<br />
When <code>“name”</code> is contained in the available string variable, then the content is to be substituted with the actual name.<br />
<br />
E.G. : to select and play a patch called “patch_one” from its name, the address <code>/mxw/set</code> with tokens <code>"play" "name_of_patch"</code> has to be used, resulting in this OSC command:<br />
<br />
<code>/mxw/set play patch_one</code><br />
<br />
<br />
When <u>OR</u> is found it means that two options can deliver a similar result. One of the two formats has to be used at one time.<br />
<br />
Here are listed all the commands that MXW recognizes.<br />
<br />
=== Legend ===<br />
<div> <br />
<br />
The standard used to represent the available values for each command is:<br />
<br />
<br />
''FLOATS'' are represented with one decimal:<br />
<br />
<code>0.0 .. 1.0</code> &rarr; all float values between 0 and 1 included<br />
<br />
<br />
''INTEGERS'' are represented with numbers or descriptions:<br />
<br />
<code>1 .. 5</code> &rarr; all integers between 1 and 5 included ( 1 , 2 , 3 , 4 , 5 ) <br><br />
<code>1 .. (MAX n layers)</code> &rarr; all the integers between 1 and the maximum index of layers in MXW (e.g. if 6 layers are being used the values are integers between 1 and 6 included)<br />
<br />
When only one number is indicated it means that only one option is given. This is found in addresses of buttons, checkboxes and in the options where "0" or "1" are the only significant values<br />
<br />
<br />
''STRINGS'' are represented between double quotation marks:<br />
<br />
<code>/mxw/set info </code><br />
<br />
When <code>“name”</code> is contained in the available string variable, then the content is to be substituted with the actual name.<br />
<br />
E.G. : to select and play a patch called “patch_one” from its name, the address <code>/mxw/set</code> with tokens <code>"play" "name_of_patch"</code> has to be used, resulting in this OSC command:<br />
<br />
<code>/mxw/set play patch_one</code><br />
<br />
<br />
When <u>OR</u> is found it means that two options can deliver a similar result. One of the two formats has to be used at one time.<br />
<br />
<br />
===Set Reference===<br />
<br />
{| class="wikitable"<br />
|-<br />
! PYTHON COMMAND/SYMBOL !! DESCRIPTION !! EXAMPLE<br />
|-<br />
!colspan="3" |Software Info<br />
|-<br />
|<code>mxw.millis</code>|| returns the amount of milliseconds passed since opening the software|| <code>mxw.print_console("current passed time is" + str(mxw.millis) );</code> <br />
|-<br />
|<code>mxw.width</code>||returns the current frame width in px|| <code>mxw.print_console("frame width is" + str(mxw.width) );</code><br />
|-<br />
|<code>mxw.height</code>||returns the current frame height in px|| <code>mxw.print_console("frame height is" + str(mxw.height));</code><br />
|-<br />
|<code>mxw.outwidth</code>||returns current output width|| <code>mxw.print_console("output height is" + str(mxw.outwidth));</code><br />
|-<br />
|<code>mxw.outheight</code>||returns the current output height|| <code>mxw.print_console("output width is" + str(mxw.outheight));</code> <br />
|-<br />
|<code>mxw.framecounter</code>||returns the amount of frames rendered since opening the software|| <code>mxw.print_console("total number of frames rendered is" + str(mxw.framecounter));</code> <br />
|-<br />
|<code>mxw.print_console("text" + mxw.widget("/mxw/path").getStringValue())</code> || prints the name of the desired playlist cue || <code>mxw.print_console("The clip name in the second cue is" + mxw.widget("/mxw/playlist/container/1/column/0/row/1").getStringValue());</code><br />
|-<br />
|<code>mxw.print_statusline("text")</code> || print text on the status line|| <code>print text on status line()</code><br />
|-<br />
!colspan="3" | I/O<br />
|-<br />
|<code>mxw.dmx()</code> ||returns the DMX value received from the specified universe and channel|| <code>mxw.print_console("DMX value in u. 1, ch. 4 is" + mxw.dmx(1,4));</code><br />
|-<br />
|<code>mxw.midi()</code>||returns the MIDI value received from the specified device and channel|| <code>mxw.print_console("MIDI value in dev. 1, ch. 6 is" + mxw.midi(1,6));</code> <br />
|-<br />
|<code>mxw.keyboard("ASCII_code")</code> || returns if the specified key is pressed or not || <code>mxw.keyboard(65)</code><br />
|-<br />
|<code>mxw.io.pjlink("on", "IP_ADDRESS", "pj_password")</code> || sends a.io.pjlink command to the selected projector and turns it on || <code>mxw.io.pjlink("on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.io.pjlink("off", "IP_ADDRESS", "pj_password")</code> || sends a.io.pjlink command to the selected projector and turns it off|| <code>mxw.io.pjlink("off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.io.pjlink("avmute_on", "IP_ADDRESS", "pj_password")</code> || sends a.io.pjlink command to the selected projector and mutes audio and video || <code>mxw.io.pjlink("avmute_on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.io.pjlink("avmute_off", "IP_ADDRESS", "pj_password")</code> || sends a.io.pjlink command to the selected projector and unmutes audio and video || <code>mxw.io.pjlink("avmute_off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.io.pjlink("vmute_on", "IP_ADDRESS", "pj_password")</code> || sends a.io.pjlink command to the selected projector and mutes video || <code>mxw.io.pjlink("vmute_on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.io.pjlink("vmute_off", "IP_ADDRESS", "pj_password")</code> || sends a.io.pjlink command to the selected projector and unmutes video || <code>mxw.io.pjlink("vmute_off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_is_supported")</code> || control if a NDI Camera supports PTZ || <code>mxw.media("USB Cam").ptz("ptz_is_supported")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_zoom", value)</code> || control the zoom of a NDI PTZ Camera, values from 0(zoomed in) to 1(zoomed out) || <code>mxw.media("USB Cam").ptz("ptz_zoom", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_pan_tilt", value_pan, value_tilt)</code> || control the pan and tilting of a NDI PTZ Camera (values from -1 to 1) || <code><code>mxw.media("USB Cam").ptz("ptz_pan_tilt", -0.5, 0.2)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_zoom_speed", value)</code> || control the zoom speed a NDI PTZ Camera, values from -1(zoom outwards) to 1 (zoom inwards) || <code><code>mxw.media("USB Cam").ptz("ptz_zoom", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_pan_tilt_speed", pan_speed, tilt_speed)</code> || control the pan and tilt speed a NDI PTZ Camera, values -1 (move right/down) to 1 (move left/up) || <code>mxw.media("USB Cam").ptz("ptz_pan_tilt_speed", -0.3, 0.8)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_store_preset", preset_number)</code> || store current position, focus, zoom, values 0 to 99 || <code>mxw.media("USB Cam").ptz("ptz_store_preset", 75)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_recall_preset",preset_number, speed)</code> || recalls a previously stored preset,values 0 to 99 and changes to it at a specific speed (values 0 to 1) || <code>mxw.media("USB Cam").ptz("ptz_recall_preset", 4, 0.5 )</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_auto_focus")</code> || activates or deactivates the camera in auto-focus || <code>mxw.media("USB Cam").ptz("ptz.autofocus")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_focus", focus_value)</code> || focus to absolute value (0= focused to infinity, 1= focus the closest possible)|| <code>mxw.media("USB Cam").ptz("ptz_focus", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_focus_speed", speed_value)</code> || focus at a particular speed, values from -1(outwards), to 1 (inwards)|| <code>mxw.media("USB Cam").ptz("ptz_focus_speed", -0.2)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_auto")</code> || put the camera in auto white-balance mode || <code>mxw.media("USB Cam").ptz("ptz_white_balance_auto")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_indoor")</code> || put the camera in indoor white balance || <code> mxw.media("USB Cam").ptz("ptz_white_balance_indoor")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_outdoor")</code> || put the camera in outdoor white balance || <code> mxw.media("USB Cam").ptz("ptz_white_balance_outdoor")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_oneshot")</code> ||use the current brightness to automatically set the current white balance|| <code>mxw.media("USB_Cam").ptz("ptz_white_balance_oneshot")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_manual", red value, blue value)</code> || Set the manual camera white balance using the R, B values, (0.0 = not red/not blue , 1.0 = very red/very blue)|| <code>mxw.media("camera_name").ptz("ptz_white_balance_manual", 0.1, 0.7)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_auto")</code> || put the camera in auto-exposure mode || <code>mxw.media("USB_Cam").ptz("ptz_exposure_auto")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_manual", exposure_level)</code> || manually set the camera exposure iris, values from 0.0(dark) to 1.0(light)|| <code>mxw.media("USB_Cam").ptz("ptz_exposure_manual", 0.4)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_manual_v2", iris_level, gain_level, shutter_speed)</code> || Manually set the camera exposure parameters, values iris from 0.0(dark) to 1.0(light), values gain from 0.0(dark) to 1.0(light), values shutter_speed from 0.0(slow) to 1.0(fast) || <code> mxw.media("USB_Cam").ptz("ptz_exposure_manual_v2", 0.4, 0.2, 0.5) </code><br />
|-<br />
!colspan="3" |Playlist Control<br />
|-<br />
|<code>mxw.playlist.preload_media()</code> || preload used media || <code>mxw.playlist.preload_media()</code><br />
|-<br />
|<code>mxw.playlist.pause()</code> || pause the playlists or restart if already paused|| <code>mxw.playlist.pause()</code><br />
|-<br />
|<code>mxw.playlist.play()</code> || play the playlist || <code>mxw.playlist.play()</code><br />
|-<br />
|<code>mxw.playlist.go_pause()( true/false )</code> || pause the playlist (when true), unpause the playlist (when false) || <code>mxw.playlist.go_pause()(true)</code><br />
|-<br />
|<code>mxw.playlist.skiptonext()</code> || skip to the next cue || <code>mxw.playlist.skiptonext()</code><br />
|-<br />
|<code>mxw.playlist.go_next()</code> || go to the next cue without playing || <code>mxw.playlist.go_next()</code><br />
|-<br />
|<code>mxw.playlist.go_prev()</code> || go to previous cue || <code>mxw.playlist.go_prev()</code><br />
|-<br />
|<code>mxw.playlist.go_first()</code> || go to the first cue || <code>mxw.playlist.go_first()</code><br />
|-<br />
|<code>mxw.playlist.navigate_index(index_value)</code> || go to the specified cue index|| <code>mxw.playlist.navigate_index(2)</code><br />
|-<br />
|<code>mxw.playlist.navigate_string("index_string")</code> || go to the specified cue string|| <code>mxw.playlist.navigate_string("BG_video2")</code><br />
|-<br />
!colspan="3" |Preload Control<br />
|-<br />
|<code>mxw.preload(preload_number).clear()</code> || clears the selected preload || <code>mxw.preload(2).clear()</code><br />
|-<br />
|<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><br />
|-<br />
|<code>mxw.preload(preload_number).set_name("new_media_name")</code> || renames a preload || <code>mxw.preload(4).set_name("new_background")</code><br />
|-<br />
|<code>mxw.preload(preload_number).add_preload()</code> || load a preload in the layers || <code>mxw.preload(3).add_preload()</code><br />
|-<br />
|<code>mxw.preload(preload_number).trigger_preload()</code> || trigger a layer from the preload || <code>mxw.preload(5).trigger_preload()</code><br />
|-<br />
|<code>mxw.preload(preload_number).get_activated()</code> || requests if the preload is editable || <code>mxw.preload(9).get_activated()</code><br />
|-<br />
|<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><br />
|-<br />
|<code>mxw.preload(preload_number).get_layer_position()</code> || returns the layer index of the preload|| <code>mxw.preload(1).get_layer_position()</code><br />
|-<br />
|<code>mxw.preload(preload_number).get_track_position()</code> || returns the track index of the preload|| <code>mxw.preload(8).get_track_position()</code><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
<br />
|}</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=3._Python_command_reference&diff=60303. Python command reference2023-12-03T22:04:59Z<p>Hwendler: /* Set Reference */</p>
<hr />
<div>Here are listed the main commands that can be used for scripting with Python.<br />
<br />
=== Legend ===<br />
<div> <br />
<br />
The standard used to represent the available values for each command is:<br />
<br />
<br />
''FLOATS'' are represented with one decimal:<br />
<br />
<code>0.0 .. 1.0</code> &rarr; all float values between 0 and 1 included<br />
<br />
<br />
''INTEGERS'' are represented with numbers or descriptions:<br />
<br />
<code>1 .. 5</code> &rarr; all integers between 1 and 5 included ( 1 , 2 , 3 , 4 , 5 ) <br><br />
<code>1 .. (MAX n layers)</code> &rarr; all the integers between 1 and the maximum index of layers in MXW (e.g. if 6 layers are being used the values are integers between 1 and 6 included)<br />
<br />
When only one number is indicated it means that only one option is given. This is found in addresses of buttons, checkboxes and in the options where "0" or "1" are the only significant values<br />
<br />
<br />
''STRINGS'' are represented between double quotation marks:<br />
<br />
<code>/mxw/set info </code><br />
<br />
When <code>“name”</code> is contained in the available string variable, then the content is to be substituted with the actual name.<br />
<br />
E.G. : to select and play a patch called “patch_one” from its name, the address <code>/mxw/set</code> with tokens <code>"play" "name_of_patch"</code> has to be used, resulting in this OSC command:<br />
<br />
<code>/mxw/set play patch_one</code><br />
<br />
<br />
When <u>OR</u> is found it means that two options can deliver a similar result. One of the two formats has to be used at one time.<br />
<br />
Here are listed all the commands that MXW recognizes.<br />
<br />
=== Legend ===<br />
<div> <br />
<br />
The standard used to represent the available values for each command is:<br />
<br />
<br />
''FLOATS'' are represented with one decimal:<br />
<br />
<code>0.0 .. 1.0</code> &rarr; all float values between 0 and 1 included<br />
<br />
<br />
''INTEGERS'' are represented with numbers or descriptions:<br />
<br />
<code>1 .. 5</code> &rarr; all integers between 1 and 5 included ( 1 , 2 , 3 , 4 , 5 ) <br><br />
<code>1 .. (MAX n layers)</code> &rarr; all the integers between 1 and the maximum index of layers in MXW (e.g. if 6 layers are being used the values are integers between 1 and 6 included)<br />
<br />
When only one number is indicated it means that only one option is given. This is found in addresses of buttons, checkboxes and in the options where "0" or "1" are the only significant values<br />
<br />
<br />
''STRINGS'' are represented between double quotation marks:<br />
<br />
<code>/mxw/set info </code><br />
<br />
When <code>“name”</code> is contained in the available string variable, then the content is to be substituted with the actual name.<br />
<br />
E.G. : to select and play a patch called “patch_one” from its name, the address <code>/mxw/set</code> with tokens <code>"play" "name_of_patch"</code> has to be used, resulting in this OSC command:<br />
<br />
<code>/mxw/set play patch_one</code><br />
<br />
<br />
When <u>OR</u> is found it means that two options can deliver a similar result. One of the two formats has to be used at one time.<br />
<br />
<br />
===Set Reference===<br />
<br />
{| class="wikitable"<br />
|-<br />
! PYTHON COMMAND/SYMBOL !! DESCRIPTION !! EXAMPLE<br />
|-<br />
!colspan="3" |Software Info<br />
|-<br />
|<code>mxw.millis</code>|| returns the amount of milliseconds passed since opening the software|| <code>mxw.print_console("current passed time is" + str(mxw.millis) );</code> <br />
|-<br />
|<code>mxw.width</code>||returns the current frame width in px|| <code>mxw.print_console("frame width is" + str(mxw.width) );</code><br />
|-<br />
|<code>mxw.height</code>||returns the current frame height in px|| <code>mxw.print_console("frame height is" + str(mxw.height));</code><br />
|-<br />
|<code>mxw.outwidth</code>||returns current output width|| <code>mxw.print_console("output height is" + str(mxw.outwidth));</code><br />
|-<br />
|<code>mxw.outheight</code>||returns the current output height|| <code>mxw.print_console("output width is" + str(mxw.outheight));</code> <br />
|-<br />
|<code>mxw.framecounter</code>||returns the amount of frames rendered since opening the software|| <code>mxw.print_console("total number of frames rendered is" + str(mxw.framecounter));</code> <br />
|-<br />
|<code>mxw.print_console("text" + mxw.widget("/mxw/path").getStringValue())</code> || prints the name of the desired playlist cue || <code>mxw.print_console("The clip name in the second cue is" + mxw.widget("/mxw/playlist/container/1/column/0/row/1").getStringValue());</code><br />
|-<br />
|<code>mxw.print_statusline("text")</code> || print text on the status line|| <code>print text on status line()</code><br />
|-<br />
!colspan="3" | I/O<br />
|-<br />
|<code>mxw.dmx()</code> ||returns the DMX value received from the specified universe and channel|| <code>mxw.print_console("DMX value in u. 1, ch. 4 is" + mxw.dmx(1,4));</code><br />
|-<br />
|<code>mxw.midi()</code>||returns the MIDI value received from the specified device and channel|| <code>mxw.print_console("MIDI value in dev. 1, ch. 6 is" + mxw.midi(1,6));</code> <br />
|-<br />
|<code>mxw.keyboard("ASCII_code")</code> || returns if the specified key is pressed or not || <code>mxw.keyboard(65)</code><br />
|-<br />
|<code>mxw.pjlink("on", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and turns it on || <code>mxw.pjlink("on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.pjlink("off", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and turns it off|| <code>mxw.pjlink("off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.pjlink("avmute_on", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and mutes audio and video || <code>mxw.pjlink("avmute_on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.pjlink("avmute_off", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and unmutes audio and video || <code>mxw.pjlink("avmute_off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.pjlink("vmute_on", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and mutes video || <code>mxw.pjlink("vmute_on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.pjlink("vmute_off", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and unmutes video || <code>mxw.pjlink("vmute_off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_is_supported")</code> || control if a NDI Camera supports PTZ || <code>mxw.media("USB Cam").ptz("ptz_is_supported")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_zoom", value)</code> || control the zoom of a NDI PTZ Camera, values from 0(zoomed in) to 1(zoomed out) || <code>mxw.media("USB Cam").ptz("ptz_zoom", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_pan_tilt", value_pan, value_tilt)</code> || control the pan and tilting of a NDI PTZ Camera (values from -1 to 1) || <code><code>mxw.media("USB Cam").ptz("ptz_pan_tilt", -0.5, 0.2)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_zoom_speed", value)</code> || control the zoom speed a NDI PTZ Camera, values from -1(zoom outwards) to 1 (zoom inwards) || <code><code>mxw.media("USB Cam").ptz("ptz_zoom", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_pan_tilt_speed", pan_speed, tilt_speed)</code> || control the pan and tilt speed a NDI PTZ Camera, values -1 (move right/down) to 1 (move left/up) || <code>mxw.media("USB Cam").ptz("ptz_pan_tilt_speed", -0.3, 0.8)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_store_preset", preset_number)</code> || store current position, focus, zoom, values 0 to 99 || <code>mxw.media("USB Cam").ptz("ptz_store_preset", 75)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_recall_preset",preset_number, speed)</code> || recalls a previously stored preset,values 0 to 99 and changes to it at a specific speed (values 0 to 1) || <code>mxw.media("USB Cam").ptz("ptz_recall_preset", 4, 0.5 )</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_auto_focus")</code> || activates or deactivates the camera in auto-focus || <code>mxw.media("USB Cam").ptz("ptz.autofocus")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_focus", focus_value)</code> || focus to absolute value (0= focused to infinity, 1= focus the closest possible)|| <code>mxw.media("USB Cam").ptz("ptz_focus", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_focus_speed", speed_value)</code> || focus at a particular speed, values from -1(outwards), to 1 (inwards)|| <code>mxw.media("USB Cam").ptz("ptz_focus_speed", -0.2)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_auto")</code> || put the camera in auto white-balance mode || <code>mxw.media("USB Cam").ptz("ptz_white_balance_auto")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_indoor")</code> || put the camera in indoor white balance || <code> mxw.media("USB Cam").ptz("ptz_white_balance_indoor")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_outdoor")</code> || put the camera in outdoor white balance || <code> mxw.media("USB Cam").ptz("ptz_white_balance_outdoor")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_oneshot")</code> ||use the current brightness to automatically set the current white balance|| <code>mxw.media("USB_Cam").ptz("ptz_white_balance_oneshot")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_manual", red value, blue value)</code> || Set the manual camera white balance using the R, B values, (0.0 = not red/not blue , 1.0 = very red/very blue)|| <code>mxw.media("camera_name").ptz("ptz_white_balance_manual", 0.1, 0.7)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_auto")</code> || put the camera in auto-exposure mode || <code>mxw.media("USB_Cam").ptz("ptz_exposure_auto")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_manual", exposure_level)</code> || manually set the camera exposure iris, values from 0.0(dark) to 1.0(light)|| <code>mxw.media("USB_Cam").ptz("ptz_exposure_manual", 0.4)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_manual_v2", iris_level, gain_level, shutter_speed)</code> || Manually set the camera exposure parameters, values iris from 0.0(dark) to 1.0(light), values gain from 0.0(dark) to 1.0(light), values shutter_speed from 0.0(slow) to 1.0(fast) || <code> mxw.media("USB_Cam").ptz("ptz_exposure_manual_v2", 0.4, 0.2, 0.5) </code><br />
|-<br />
!colspan="3" |Playlist Control<br />
|-<br />
|<code>mxw.playlist.preload_media()</code> || preload used media || <code>mxw.playlist.preload_media()</code><br />
|-<br />
|<code>mxw.playlist.pause()</code> || pause the playlists or restart if already paused|| <code>mxw.playlist.pause()</code><br />
|-<br />
|<code>mxw.playlist.play()</code> || play the playlist || <code>mxw.playlist.play()</code><br />
|-<br />
|<code>mxw.playlist.go_pause()( true/false )</code> || pause the playlist (when true), unpause the playlist (when false) || <code>mxw.playlist.go_pause()(true)</code><br />
|-<br />
|<code>mxw.playlist.skiptonext()</code> || skip to the next cue || <code>mxw.playlist.skiptonext()</code><br />
|-<br />
|<code>mxw.playlist.go_next()</code> || go to the next cue without playing || <code>mxw.playlist.go_next()</code><br />
|-<br />
|<code>mxw.playlist.go_prev()</code> || go to previous cue || <code>mxw.playlist.go_prev()</code><br />
|-<br />
|<code>mxw.playlist.go_first()</code> || go to the first cue || <code>mxw.playlist.go_first()</code><br />
|-<br />
|<code>mxw.playlist.navigate_index(index_value)</code> || go to the specified cue index|| <code>mxw.playlist.navigate_index(2)</code><br />
|-<br />
|<code>mxw.playlist.navigate_string("index_string")</code> || go to the specified cue string|| <code>mxw.playlist.navigate_string("BG_video2")</code><br />
|-<br />
!colspan="3" |Preload Control<br />
|-<br />
|<code>mxw.preload(preload_number).clear()</code> || clears the selected preload || <code>mxw.preload(2).clear()</code><br />
|-<br />
|<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><br />
|-<br />
|<code>mxw.preload(preload_number).set_name("new_media_name")</code> || renames a preload || <code>mxw.preload(4).set_name("new_background")</code><br />
|-<br />
|<code>mxw.preload(preload_number).add_preload()</code> || load a preload in the layers || <code>mxw.preload(3).add_preload()</code><br />
|-<br />
|<code>mxw.preload(preload_number).trigger_preload()</code> || trigger a layer from the preload || <code>mxw.preload(5).trigger_preload()</code><br />
|-<br />
|<code>mxw.preload(preload_number).get_activated()</code> || requests if the preload is editable || <code>mxw.preload(9).get_activated()</code><br />
|-<br />
|<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><br />
|-<br />
|<code>mxw.preload(preload_number).get_layer_position()</code> || returns the layer index of the preload|| <code>mxw.preload(1).get_layer_position()</code><br />
|-<br />
|<code>mxw.preload(preload_number).get_track_position()</code> || returns the track index of the preload|| <code>mxw.preload(8).get_track_position()</code><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
<br />
|}</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=3._Python_command_reference&diff=60293. Python command reference2023-12-03T22:03:48Z<p>Hwendler: /* Set Reference */</p>
<hr />
<div>Here are listed the main commands that can be used for scripting with Python.<br />
<br />
=== Legend ===<br />
<div> <br />
<br />
The standard used to represent the available values for each command is:<br />
<br />
<br />
''FLOATS'' are represented with one decimal:<br />
<br />
<code>0.0 .. 1.0</code> &rarr; all float values between 0 and 1 included<br />
<br />
<br />
''INTEGERS'' are represented with numbers or descriptions:<br />
<br />
<code>1 .. 5</code> &rarr; all integers between 1 and 5 included ( 1 , 2 , 3 , 4 , 5 ) <br><br />
<code>1 .. (MAX n layers)</code> &rarr; all the integers between 1 and the maximum index of layers in MXW (e.g. if 6 layers are being used the values are integers between 1 and 6 included)<br />
<br />
When only one number is indicated it means that only one option is given. This is found in addresses of buttons, checkboxes and in the options where "0" or "1" are the only significant values<br />
<br />
<br />
''STRINGS'' are represented between double quotation marks:<br />
<br />
<code>/mxw/set info </code><br />
<br />
When <code>“name”</code> is contained in the available string variable, then the content is to be substituted with the actual name.<br />
<br />
E.G. : to select and play a patch called “patch_one” from its name, the address <code>/mxw/set</code> with tokens <code>"play" "name_of_patch"</code> has to be used, resulting in this OSC command:<br />
<br />
<code>/mxw/set play patch_one</code><br />
<br />
<br />
When <u>OR</u> is found it means that two options can deliver a similar result. One of the two formats has to be used at one time.<br />
<br />
Here are listed all the commands that MXW recognizes.<br />
<br />
=== Legend ===<br />
<div> <br />
<br />
The standard used to represent the available values for each command is:<br />
<br />
<br />
''FLOATS'' are represented with one decimal:<br />
<br />
<code>0.0 .. 1.0</code> &rarr; all float values between 0 and 1 included<br />
<br />
<br />
''INTEGERS'' are represented with numbers or descriptions:<br />
<br />
<code>1 .. 5</code> &rarr; all integers between 1 and 5 included ( 1 , 2 , 3 , 4 , 5 ) <br><br />
<code>1 .. (MAX n layers)</code> &rarr; all the integers between 1 and the maximum index of layers in MXW (e.g. if 6 layers are being used the values are integers between 1 and 6 included)<br />
<br />
When only one number is indicated it means that only one option is given. This is found in addresses of buttons, checkboxes and in the options where "0" or "1" are the only significant values<br />
<br />
<br />
''STRINGS'' are represented between double quotation marks:<br />
<br />
<code>/mxw/set info </code><br />
<br />
When <code>“name”</code> is contained in the available string variable, then the content is to be substituted with the actual name.<br />
<br />
E.G. : to select and play a patch called “patch_one” from its name, the address <code>/mxw/set</code> with tokens <code>"play" "name_of_patch"</code> has to be used, resulting in this OSC command:<br />
<br />
<code>/mxw/set play patch_one</code><br />
<br />
<br />
When <u>OR</u> is found it means that two options can deliver a similar result. One of the two formats has to be used at one time.<br />
<br />
<br />
===Set Reference===<br />
<br />
{| class="wikitable"<br />
|-<br />
! PYTHON COMMAND/SYMBOL !! DESCRIPTION !! EXAMPLE<br />
|-<br />
!colspan="3" |Software Info<br />
|-<br />
|<code>mxw.millis</code>|| returns the amount of milliseconds passed since opening the software|| <code>mxw.print_console("current passed time is" + str(mxw.millis) );</code> <br />
|-<br />
|<code>mxw.width</code>||returns the current frame width in px|| <code>mxw.print_console("frame width is" + str(mxw.width) );</code><br />
|-<br />
|<code>mxw.height</code>||returns the current frame height in px|| <code>mxw.print_console("frame height is" + str(mxw.height));</code><br />
|-<br />
|<code>mxw.outwidth</code>||returns current output width|| <code>mxw.print_console("output height is" + str(mxw.outwidth));</code><br />
|-<br />
|<code>mxw.outheight</code>||returns the current output height|| <code>mxw.print_console("output width is" + str(mxw.outheight));</code> <br />
|-<br />
|<code>mxw.framecounter</code>||returns the amount of frames rendered since opening the software|| <code>mxw.print_console("total number of frames rendered is" + str(mxw.framecounter));</code> <br />
|-<br />
|<code>mxw.print_console("text" + mxw.widget("/mxw/path").getStringValue())</code> || prints the name of the desired playlist cue || <code>mxw.print_console("The clip name in the second cue is" + mxw.widget("/mxw/playlist/container/1/column/0/row/1").getStringValue());</code><br />
|-<br />
|<code>print_statusline("text")</code> || print text on the status line|| <code>print text on status line()</code><br />
|-<br />
!colspan="3" | I/O<br />
|-<br />
|<code>mxw.dmx()</code> ||returns the DMX value received from the specified universe and channel|| <code>mxw.print_console("DMX value in u. 1, ch. 4 is" + mxw.dmx(1,4));</code><br />
|-<br />
|<code>mxw.midi()</code>||returns the MIDI value received from the specified device and channel|| <code>mxw.print_console("MIDI value in dev. 1, ch. 6 is" + mxw.midi(1,6));</code> <br />
|-<br />
|<code>mxw.keyboard("ASCII_code")</code> || returns if the specified key is pressed or not || <code>mxw.keyboard(65)</code><br />
|-<br />
|<code>mxw.pjlink("on", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and turns it on || <code>mxw.pjlink("on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.pjlink("off", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and turns it off|| <code>mxw.pjlink("off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.pjlink("avmute_on", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and mutes audio and video || <code>mxw.pjlink("avmute_on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.pjlink("avmute_off", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and unmutes audio and video || <code>mxw.pjlink("avmute_off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.pjlink("vmute_on", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and mutes video || <code>mxw.pjlink("vmute_on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.pjlink("vmute_off", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and unmutes video || <code>mxw.pjlink("vmute_off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_is_supported")</code> || control if a NDI Camera supports PTZ || <code>mxw.media("USB Cam").ptz("ptz_is_supported")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_zoom", value)</code> || control the zoom of a NDI PTZ Camera, values from 0(zoomed in) to 1(zoomed out) || <code>mxw.media("USB Cam").ptz("ptz_zoom", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_pan_tilt", value_pan, value_tilt)</code> || control the pan and tilting of a NDI PTZ Camera (values from -1 to 1) || <code><code>mxw.media("USB Cam").ptz("ptz_pan_tilt", -0.5, 0.2)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_zoom_speed", value)</code> || control the zoom speed a NDI PTZ Camera, values from -1(zoom outwards) to 1 (zoom inwards) || <code><code>mxw.media("USB Cam").ptz("ptz_zoom", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_pan_tilt_speed", pan_speed, tilt_speed)</code> || control the pan and tilt speed a NDI PTZ Camera, values -1 (move right/down) to 1 (move left/up) || <code>mxw.media("USB Cam").ptz("ptz_pan_tilt_speed", -0.3, 0.8)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_store_preset", preset_number)</code> || store current position, focus, zoom, values 0 to 99 || <code>mxw.media("USB Cam").ptz("ptz_store_preset", 75)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_recall_preset",preset_number, speed)</code> || recalls a previously stored preset,values 0 to 99 and changes to it at a specific speed (values 0 to 1) || <code>mxw.media("USB Cam").ptz("ptz_recall_preset", 4, 0.5 )</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_auto_focus")</code> || activates or deactivates the camera in auto-focus || <code>mxw.media("USB Cam").ptz("ptz.autofocus")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_focus", focus_value)</code> || focus to absolute value (0= focused to infinity, 1= focus the closest possible)|| <code>mxw.media("USB Cam").ptz("ptz_focus", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_focus_speed", speed_value)</code> || focus at a particular speed, values from -1(outwards), to 1 (inwards)|| <code>mxw.media("USB Cam").ptz("ptz_focus_speed", -0.2)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_auto")</code> || put the camera in auto white-balance mode || <code>mxw.media("USB Cam").ptz("ptz_white_balance_auto")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_indoor")</code> || put the camera in indoor white balance || <code> mxw.media("USB Cam").ptz("ptz_white_balance_indoor")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_outdoor")</code> || put the camera in outdoor white balance || <code> mxw.media("USB Cam").ptz("ptz_white_balance_outdoor")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_oneshot")</code> ||use the current brightness to automatically set the current white balance|| <code>mxw.media("USB_Cam").ptz("ptz_white_balance_oneshot")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_manual", red value, blue value)</code> || Set the manual camera white balance using the R, B values, (0.0 = not red/not blue , 1.0 = very red/very blue)|| <code>mxw.media("camera_name").ptz("ptz_white_balance_manual", 0.1, 0.7)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_auto")</code> || put the camera in auto-exposure mode || <code>mxw.media("USB_Cam").ptz("ptz_exposure_auto")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_manual", exposure_level)</code> || manually set the camera exposure iris, values from 0.0(dark) to 1.0(light)|| <code>mxw.media("USB_Cam").ptz("ptz_exposure_manual", 0.4)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_manual_v2", iris_level, gain_level, shutter_speed)</code> || Manually set the camera exposure parameters, values iris from 0.0(dark) to 1.0(light), values gain from 0.0(dark) to 1.0(light), values shutter_speed from 0.0(slow) to 1.0(fast) || <code> mxw.media("USB_Cam").ptz("ptz_exposure_manual_v2", 0.4, 0.2, 0.5) </code><br />
|-<br />
!colspan="3" |Playlist Control<br />
|-<br />
|<code>mxw.playlist.preload_media()</code> || preload used media || <code>mxw.playlist.preload_media()</code><br />
|-<br />
|<code>mxw.playlist.pause()</code> || pause the playlists or restart if already paused|| <code>mxw.playlist.pause()</code><br />
|-<br />
|<code>mxw.playlist.play()</code> || play the playlist || <code>mxw.playlist.play()</code><br />
|-<br />
|<code>mxw.playlist.go_pause()( true/false )</code> || pause the playlist (when true), unpause the playlist (when false) || <code>mxw.playlist.go_pause()(true)</code><br />
|-<br />
|<code>mxw.playlist.skiptonext()</code> || skip to the next cue || <code>mxw.playlist.skiptonext()</code><br />
|-<br />
|<code>mxw.playlist.go_next()</code> || go to the next cue without playing || <code>mxw.playlist.go_next()</code><br />
|-<br />
|<code>mxw.playlist.go_prev()</code> || go to previous cue || <code>mxw.playlist.go_prev()</code><br />
|-<br />
|<code>mxw.playlist.go_first()</code> || go to the first cue || <code>mxw.playlist.go_first()</code><br />
|-<br />
|<code>mxw.playlist.navigate_index(index_value)</code> || go to the specified cue index|| <code>mxw.playlist.navigate_index(2)</code><br />
|-<br />
|<code>mxw.playlist.navigate_string("index_string")</code> || go to the specified cue string|| <code>mxw.playlist.navigate_string("BG_video2")</code><br />
|-<br />
!colspan="3" |Preload Control<br />
|-<br />
|<code>mxw.preload(preload_number).clear()</code> || clears the selected preload || <code>mxw.preload(2).clear()</code><br />
|-<br />
|<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><br />
|-<br />
|<code>mxw.preload(preload_number).set_name("new_media_name")</code> || renames a preload || <code>mxw.preload(4).set_name("new_background")</code><br />
|-<br />
|<code>mxw.preload(preload_number).add_preload()</code> || load a preload in the layers || <code>mxw.preload(3).add_preload()</code><br />
|-<br />
|<code>mxw.preload(preload_number).trigger_preload()</code> || trigger a layer from the preload || <code>mxw.preload(5).trigger_preload()</code><br />
|-<br />
|<code>mxw.preload(preload_number).get_activated()</code> || requests if the preload is editable || <code>mxw.preload(9).get_activated()</code><br />
|-<br />
|<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><br />
|-<br />
|<code>mxw.preload(preload_number).get_layer_position()</code> || returns the layer index of the preload|| <code>mxw.preload(1).get_layer_position()</code><br />
|-<br />
|<code>mxw.preload(preload_number).get_track_position()</code> || returns the track index of the preload|| <code>mxw.preload(8).get_track_position()</code><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
<br />
|}</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=3._Python_command_reference&diff=60283. Python command reference2023-12-03T21:53:32Z<p>Hwendler: /* Set Reference */</p>
<hr />
<div>Here are listed the main commands that can be used for scripting with Python.<br />
<br />
=== Legend ===<br />
<div> <br />
<br />
The standard used to represent the available values for each command is:<br />
<br />
<br />
''FLOATS'' are represented with one decimal:<br />
<br />
<code>0.0 .. 1.0</code> &rarr; all float values between 0 and 1 included<br />
<br />
<br />
''INTEGERS'' are represented with numbers or descriptions:<br />
<br />
<code>1 .. 5</code> &rarr; all integers between 1 and 5 included ( 1 , 2 , 3 , 4 , 5 ) <br><br />
<code>1 .. (MAX n layers)</code> &rarr; all the integers between 1 and the maximum index of layers in MXW (e.g. if 6 layers are being used the values are integers between 1 and 6 included)<br />
<br />
When only one number is indicated it means that only one option is given. This is found in addresses of buttons, checkboxes and in the options where "0" or "1" are the only significant values<br />
<br />
<br />
''STRINGS'' are represented between double quotation marks:<br />
<br />
<code>/mxw/set info </code><br />
<br />
When <code>“name”</code> is contained in the available string variable, then the content is to be substituted with the actual name.<br />
<br />
E.G. : to select and play a patch called “patch_one” from its name, the address <code>/mxw/set</code> with tokens <code>"play" "name_of_patch"</code> has to be used, resulting in this OSC command:<br />
<br />
<code>/mxw/set play patch_one</code><br />
<br />
<br />
When <u>OR</u> is found it means that two options can deliver a similar result. One of the two formats has to be used at one time.<br />
<br />
Here are listed all the commands that MXW recognizes.<br />
<br />
=== Legend ===<br />
<div> <br />
<br />
The standard used to represent the available values for each command is:<br />
<br />
<br />
''FLOATS'' are represented with one decimal:<br />
<br />
<code>0.0 .. 1.0</code> &rarr; all float values between 0 and 1 included<br />
<br />
<br />
''INTEGERS'' are represented with numbers or descriptions:<br />
<br />
<code>1 .. 5</code> &rarr; all integers between 1 and 5 included ( 1 , 2 , 3 , 4 , 5 ) <br><br />
<code>1 .. (MAX n layers)</code> &rarr; all the integers between 1 and the maximum index of layers in MXW (e.g. if 6 layers are being used the values are integers between 1 and 6 included)<br />
<br />
When only one number is indicated it means that only one option is given. This is found in addresses of buttons, checkboxes and in the options where "0" or "1" are the only significant values<br />
<br />
<br />
''STRINGS'' are represented between double quotation marks:<br />
<br />
<code>/mxw/set info </code><br />
<br />
When <code>“name”</code> is contained in the available string variable, then the content is to be substituted with the actual name.<br />
<br />
E.G. : to select and play a patch called “patch_one” from its name, the address <code>/mxw/set</code> with tokens <code>"play" "name_of_patch"</code> has to be used, resulting in this OSC command:<br />
<br />
<code>/mxw/set play patch_one</code><br />
<br />
<br />
When <u>OR</u> is found it means that two options can deliver a similar result. One of the two formats has to be used at one time.<br />
<br />
<br />
===Set Reference===<br />
<br />
{| class="wikitable"<br />
|-<br />
! PYTHON COMMAND/SYMBOL !! DESCRIPTION !! EXAMPLE<br />
|-<br />
!colspan="3" |Software Info<br />
|-<br />
|<code>mxw.millis</code>|| returns the amount of milliseconds passed since opening the software|| <code>print_console("current passed time is" + mxw.millis );</code> <br />
|-<br />
|<code>mxw.width</code>||returns the current frame width in px|| <code>print_console("frame width is" + mxw.width );</code><br />
|-<br />
|<code>mxw.height</code>||returns the current frame height in px|| <code>print_console("frame height is" + mxw.height);</code><br />
|-<br />
|<code>mxw.outwidth</code>||returns current output width|| <code>print_console("output height is" + outwidth);</code><br />
|-<br />
|<code>mxw.outheight</code>||returns the current output height|| <code>print_console("output width is" + mxw.outheight);</code> <br />
|-<br />
|<code>mxw.framecounter</code>||returns the amount of frames rendered since opening the software|| <code>print_console("total number of frames rendered is" + mxw.framecounter);</code> <br />
|-<br />
|<code>print_console("text" + mxw.widget("/mxw/path").getStringValue())</code> || prints the name of the desired playlist cue || <code>print_console("The clip name in the second cue is" + mxw.widget("/mxw/playlist/container/1/column/0/row/1").getStringValue());</code><br />
|-<br />
|<code>print_statusline("text")</code> || print text on the status line|| <code>print text on status line()</code><br />
|-<br />
!colspan="3" | I/O<br />
|-<br />
|<code>mxw.dmx()</code> ||returns the DMX value received from the specified universe and channel|| <code>print_console("DMX value in u. 1, ch. 4 is" + mxw.dmx(1,4));</code><br />
|-<br />
|<code>mxw.midi()</code>||returns the MIDI value received from the specified device and channel|| <code>print_console("MIDI value in dev. 1, ch. 6 is" + mxw.midi(1,6));</code> <br />
|-<br />
|<code>mxw.keyboard("ASCII_code")</code> || returns if the specified key is pressed or not || <code>mxw.keyboard(65)</code><br />
|-<br />
|<code>mxw.pjlink("on", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and turns it on || <code>mxw.pjlink("on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.pjlink("off", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and turns it off|| <code>mxw.pjlink("off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.pjlink("avmute_on", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and mutes audio and video || <code>mxw.pjlink("avmute_on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.pjlink("avmute_off", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and unmutes audio and video || <code>mxw.pjlink("avmute_off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.pjlink("vmute_on", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and mutes video || <code>mxw.pjlink("vmute_on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.pjlink("vmute_off", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and unmutes video || <code>mxw.pjlink("vmute_off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_is_supported")</code> || control if a NDI Camera supports PTZ || <code>mxw.media("USB Cam").ptz("ptz_is_supported")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_zoom", value)</code> || control the zoom of a NDI PTZ Camera, values from 0(zoomed in) to 1(zoomed out) || <code>mxw.media("USB Cam").ptz("ptz_zoom", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_pan_tilt", value_pan, value_tilt)</code> || control the pan and tilting of a NDI PTZ Camera (values from -1 to 1) || <code><code>mxw.media("USB Cam").ptz("ptz_pan_tilt", -0.5, 0.2)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_zoom_speed", value)</code> || control the zoom speed a NDI PTZ Camera, values from -1(zoom outwards) to 1 (zoom inwards) || <code><code>mxw.media("USB Cam").ptz("ptz_zoom", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_pan_tilt_speed", pan_speed, tilt_speed)</code> || control the pan and tilt speed a NDI PTZ Camera, values -1 (move right/down) to 1 (move left/up) || <code>mxw.media("USB Cam").ptz("ptz_pan_tilt_speed", -0.3, 0.8)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_store_preset", preset_number)</code> || store current position, focus, zoom, values 0 to 99 || <code>mxw.media("USB Cam").ptz("ptz_store_preset", 75)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_recall_preset",preset_number, speed)</code> || recalls a previously stored preset,values 0 to 99 and changes to it at a specific speed (values 0 to 1) || <code>mxw.media("USB Cam").ptz("ptz_recall_preset", 4, 0.5 )</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_auto_focus")</code> || activates or deactivates the camera in auto-focus || <code>mxw.media("USB Cam").ptz("ptz.autofocus")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_focus", focus_value)</code> || focus to absolute value (0= focused to infinity, 1= focus the closest possible)|| <code>mxw.media("USB Cam").ptz("ptz_focus", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_focus_speed", speed_value)</code> || focus at a particular speed, values from -1(outwards), to 1 (inwards)|| <code>mxw.media("USB Cam").ptz("ptz_focus_speed", -0.2)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_auto")</code> || put the camera in auto white-balance mode || <code>mxw.media("USB Cam").ptz("ptz_white_balance_auto")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_indoor")</code> || put the camera in indoor white balance || <code> mxw.media("USB Cam").ptz("ptz_white_balance_indoor")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_outdoor")</code> || put the camera in outdoor white balance || <code> mxw.media("USB Cam").ptz("ptz_white_balance_outdoor")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_oneshot")</code> ||use the current brightness to automatically set the current white balance|| <code>mxw.media("USB_Cam").ptz("ptz_white_balance_oneshot")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_manual", red value, blue value)</code> || Set the manual camera white balance using the R, B values, (0.0 = not red/not blue , 1.0 = very red/very blue)|| <code>mxw.media("camera_name").ptz("ptz_white_balance_manual", 0.1, 0.7)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_auto")</code> || put the camera in auto-exposure mode || <code>mxw.media("USB_Cam").ptz("ptz_exposure_auto")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_manual", exposure_level)</code> || manually set the camera exposure iris, values from 0.0(dark) to 1.0(light)|| <code>mxw.media("USB_Cam").ptz("ptz_exposure_manual", 0.4)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_manual_v2", iris_level, gain_level, shutter_speed)</code> || Manually set the camera exposure parameters, values iris from 0.0(dark) to 1.0(light), values gain from 0.0(dark) to 1.0(light), values shutter_speed from 0.0(slow) to 1.0(fast) || <code> mxw.media("USB_Cam").ptz("ptz_exposure_manual_v2", 0.4, 0.2, 0.5) </code><br />
|-<br />
!colspan="3" |Playlist Control<br />
|-<br />
|<code>mxw.playlist.preload_media()</code> || preload used media || <code>mxw.playlist.preload_media()</code><br />
|-<br />
|<code>mxw.playlist.pause()</code> || pause the playlists or restart if already paused|| <code>mxw.playlist.pause()</code><br />
|-<br />
|<code>mxw.playlist.play()</code> || play the playlist || <code>mxw.playlist.play()</code><br />
|-<br />
|<code>mxw.playlist.go_pause()( true/false )</code> || pause the playlist (when true), unpause the playlist (when false) || <code>mxw.playlist.go_pause()(true)</code><br />
|-<br />
|<code>mxw.playlist.skiptonext()</code> || skip to the next cue || <code>mxw.playlist.skiptonext()</code><br />
|-<br />
|<code>mxw.playlist.go_next()</code> || go to the next cue without playing || <code>mxw.playlist.go_next()</code><br />
|-<br />
|<code>mxw.playlist.go_prev()</code> || go to previous cue || <code>mxw.playlist.go_prev()</code><br />
|-<br />
|<code>mxw.playlist.go_first()</code> || go to the first cue || <code>mxw.playlist.go_first()</code><br />
|-<br />
|<code>mxw.playlist.navigate_index(index_value)</code> || go to the specified cue index|| <code>mxw.playlist.navigate_index(2)</code><br />
|-<br />
|<code>mxw.playlist.navigate_string("index_string")</code> || go to the specified cue string|| <code>mxw.playlist.navigate_string("BG_video2")</code><br />
|-<br />
!colspan="3" |Preload Control<br />
|-<br />
|<code>mxw.preload(preload_number).clear()</code> || clears the selected preload || <code>mxw.preload(2).clear()</code><br />
|-<br />
|<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><br />
|-<br />
|<code>mxw.preload(preload_number).set_name("new_media_name")</code> || renames a preload || <code>mxw.preload(4).set_name("new_background")</code><br />
|-<br />
|<code>mxw.preload(preload_number).add_preload()</code> || load a preload in the layers || <code>mxw.preload(3).add_preload()</code><br />
|-<br />
|<code>mxw.preload(preload_number).trigger_preload()</code> || trigger a layer from the preload || <code>mxw.preload(5).trigger_preload()</code><br />
|-<br />
|<code>mxw.preload(preload_number).get_activated()</code> || requests if the preload is editable || <code>mxw.preload(9).get_activated()</code><br />
|-<br />
|<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><br />
|-<br />
|<code>mxw.preload(preload_number).get_layer_position()</code> || returns the layer index of the preload|| <code>mxw.preload(1).get_layer_position()</code><br />
|-<br />
|<code>mxw.preload(preload_number).get_track_position()</code> || returns the track index of the preload|| <code>mxw.preload(8).get_track_position()</code><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
<br />
|}</div>Hwendlerhttps://wiki.mxwendler.net/index.php?title=3._Python_command_reference&diff=60273. Python command reference2023-12-03T21:52:31Z<p>Hwendler: Created page with "Here are listed the main commands that can be used for scripting with Python. === Legend === <div> The standard used to represent the available values for each command is:..."</p>
<hr />
<div>Here are listed the main commands that can be used for scripting with Python.<br />
<br />
=== Legend ===<br />
<div> <br />
<br />
The standard used to represent the available values for each command is:<br />
<br />
<br />
''FLOATS'' are represented with one decimal:<br />
<br />
<code>0.0 .. 1.0</code> &rarr; all float values between 0 and 1 included<br />
<br />
<br />
''INTEGERS'' are represented with numbers or descriptions:<br />
<br />
<code>1 .. 5</code> &rarr; all integers between 1 and 5 included ( 1 , 2 , 3 , 4 , 5 ) <br><br />
<code>1 .. (MAX n layers)</code> &rarr; all the integers between 1 and the maximum index of layers in MXW (e.g. if 6 layers are being used the values are integers between 1 and 6 included)<br />
<br />
When only one number is indicated it means that only one option is given. This is found in addresses of buttons, checkboxes and in the options where "0" or "1" are the only significant values<br />
<br />
<br />
''STRINGS'' are represented between double quotation marks:<br />
<br />
<code>/mxw/set info </code><br />
<br />
When <code>“name”</code> is contained in the available string variable, then the content is to be substituted with the actual name.<br />
<br />
E.G. : to select and play a patch called “patch_one” from its name, the address <code>/mxw/set</code> with tokens <code>"play" "name_of_patch"</code> has to be used, resulting in this OSC command:<br />
<br />
<code>/mxw/set play patch_one</code><br />
<br />
<br />
When <u>OR</u> is found it means that two options can deliver a similar result. One of the two formats has to be used at one time.<br />
<br />
Here are listed all the commands that MXW recognizes.<br />
<br />
=== Legend ===<br />
<div> <br />
<br />
The standard used to represent the available values for each command is:<br />
<br />
<br />
''FLOATS'' are represented with one decimal:<br />
<br />
<code>0.0 .. 1.0</code> &rarr; all float values between 0 and 1 included<br />
<br />
<br />
''INTEGERS'' are represented with numbers or descriptions:<br />
<br />
<code>1 .. 5</code> &rarr; all integers between 1 and 5 included ( 1 , 2 , 3 , 4 , 5 ) <br><br />
<code>1 .. (MAX n layers)</code> &rarr; all the integers between 1 and the maximum index of layers in MXW (e.g. if 6 layers are being used the values are integers between 1 and 6 included)<br />
<br />
When only one number is indicated it means that only one option is given. This is found in addresses of buttons, checkboxes and in the options where "0" or "1" are the only significant values<br />
<br />
<br />
''STRINGS'' are represented between double quotation marks:<br />
<br />
<code>/mxw/set info </code><br />
<br />
When <code>“name”</code> is contained in the available string variable, then the content is to be substituted with the actual name.<br />
<br />
E.G. : to select and play a patch called “patch_one” from its name, the address <code>/mxw/set</code> with tokens <code>"play" "name_of_patch"</code> has to be used, resulting in this OSC command:<br />
<br />
<code>/mxw/set play patch_one</code><br />
<br />
<br />
When <u>OR</u> is found it means that two options can deliver a similar result. One of the two formats has to be used at one time.<br />
<br />
<br />
===Set Reference===<br />
<br />
{| class="wikitable"<br />
|-<br />
! JS COMMAND !! DESCRIPTION !! EXAMPLE<br />
|-<br />
!colspan="3" |Software Info<br />
|-<br />
|<code>mxw.millis</code>|| returns the amount of milliseconds passed since opening the software|| <code>print_console("current passed time is" + mxw.millis );</code> <br />
|-<br />
|<code>mxw.width</code>||returns the current frame width in px|| <code>print_console("frame width is" + mxw.width );</code><br />
|-<br />
|<code>mxw.height</code>||returns the current frame height in px|| <code>print_console("frame height is" + mxw.height);</code><br />
|-<br />
|<code>mxw.outwidth</code>||returns current output width|| <code>print_console("output height is" + outwidth);</code><br />
|-<br />
|<code>mxw.outheight</code>||returns the current output height|| <code>print_console("output width is" + mxw.outheight);</code> <br />
|-<br />
|<code>mxw.framecounter</code>||returns the amount of frames rendered since opening the software|| <code>print_console("total number of frames rendered is" + mxw.framecounter);</code> <br />
|-<br />
|<code>print_console("text" + mxw.widget("/mxw/path").getStringValue())</code> || prints the name of the desired playlist cue || <code>print_console("The clip name in the second cue is" + mxw.widget("/mxw/playlist/container/1/column/0/row/1").getStringValue());</code><br />
|-<br />
|<code>print_statusline("text")</code> || print text on the status line|| <code>print text on status line()</code><br />
|-<br />
!colspan="3" | I/O<br />
|-<br />
|<code>mxw.dmx()</code> ||returns the DMX value received from the specified universe and channel|| <code>print_console("DMX value in u. 1, ch. 4 is" + mxw.dmx(1,4));</code><br />
|-<br />
|<code>mxw.midi()</code>||returns the MIDI value received from the specified device and channel|| <code>print_console("MIDI value in dev. 1, ch. 6 is" + mxw.midi(1,6));</code> <br />
|-<br />
|<code>mxw.keyboard("ASCII_code")</code> || returns if the specified key is pressed or not || <code>mxw.keyboard(65)</code><br />
|-<br />
|<code>mxw.pjlink("on", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and turns it on || <code>mxw.pjlink("on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.pjlink("off", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and turns it off|| <code>mxw.pjlink("off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.pjlink("avmute_on", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and mutes audio and video || <code>mxw.pjlink("avmute_on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.pjlink("avmute_off", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and unmutes audio and video || <code>mxw.pjlink("avmute_off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.pjlink("vmute_on", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and mutes video || <code>mxw.pjlink("vmute_on", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.pjlink("vmute_off", "IP_ADDRESS", "pj_password")</code> || sends a pjlink command to the selected projector and unmutes video || <code>mxw.pjlink("vmute_off", "192.168.1.2", "panasonic")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_is_supported")</code> || control if a NDI Camera supports PTZ || <code>mxw.media("USB Cam").ptz("ptz_is_supported")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_zoom", value)</code> || control the zoom of a NDI PTZ Camera, values from 0(zoomed in) to 1(zoomed out) || <code>mxw.media("USB Cam").ptz("ptz_zoom", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_pan_tilt", value_pan, value_tilt)</code> || control the pan and tilting of a NDI PTZ Camera (values from -1 to 1) || <code><code>mxw.media("USB Cam").ptz("ptz_pan_tilt", -0.5, 0.2)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_zoom_speed", value)</code> || control the zoom speed a NDI PTZ Camera, values from -1(zoom outwards) to 1 (zoom inwards) || <code><code>mxw.media("USB Cam").ptz("ptz_zoom", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_pan_tilt_speed", pan_speed, tilt_speed)</code> || control the pan and tilt speed a NDI PTZ Camera, values -1 (move right/down) to 1 (move left/up) || <code>mxw.media("USB Cam").ptz("ptz_pan_tilt_speed", -0.3, 0.8)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_store_preset", preset_number)</code> || store current position, focus, zoom, values 0 to 99 || <code>mxw.media("USB Cam").ptz("ptz_store_preset", 75)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_recall_preset",preset_number, speed)</code> || recalls a previously stored preset,values 0 to 99 and changes to it at a specific speed (values 0 to 1) || <code>mxw.media("USB Cam").ptz("ptz_recall_preset", 4, 0.5 )</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_auto_focus")</code> || activates or deactivates the camera in auto-focus || <code>mxw.media("USB Cam").ptz("ptz.autofocus")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_focus", focus_value)</code> || focus to absolute value (0= focused to infinity, 1= focus the closest possible)|| <code>mxw.media("USB Cam").ptz("ptz_focus", 0.5)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_focus_speed", speed_value)</code> || focus at a particular speed, values from -1(outwards), to 1 (inwards)|| <code>mxw.media("USB Cam").ptz("ptz_focus_speed", -0.2)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_auto")</code> || put the camera in auto white-balance mode || <code>mxw.media("USB Cam").ptz("ptz_white_balance_auto")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_indoor")</code> || put the camera in indoor white balance || <code> mxw.media("USB Cam").ptz("ptz_white_balance_indoor")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_outdoor")</code> || put the camera in outdoor white balance || <code> mxw.media("USB Cam").ptz("ptz_white_balance_outdoor")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_oneshot")</code> ||use the current brightness to automatically set the current white balance|| <code>mxw.media("USB_Cam").ptz("ptz_white_balance_oneshot")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_white_balance_manual", red value, blue value)</code> || Set the manual camera white balance using the R, B values, (0.0 = not red/not blue , 1.0 = very red/very blue)|| <code>mxw.media("camera_name").ptz("ptz_white_balance_manual", 0.1, 0.7)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_auto")</code> || put the camera in auto-exposure mode || <code>mxw.media("USB_Cam").ptz("ptz_exposure_auto")</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_manual", exposure_level)</code> || manually set the camera exposure iris, values from 0.0(dark) to 1.0(light)|| <code>mxw.media("USB_Cam").ptz("ptz_exposure_manual", 0.4)</code><br />
|-<br />
|<code>mxw.media("camera_name").ptz("ptz_exposure_manual_v2", iris_level, gain_level, shutter_speed)</code> || Manually set the camera exposure parameters, values iris from 0.0(dark) to 1.0(light), values gain from 0.0(dark) to 1.0(light), values shutter_speed from 0.0(slow) to 1.0(fast) || <code> mxw.media("USB_Cam").ptz("ptz_exposure_manual_v2", 0.4, 0.2, 0.5) </code><br />
|-<br />
!colspan="3" |Playlist Control<br />
|-<br />
|<code>mxw.playlist.preload_media()</code> || preload used media || <code>mxw.playlist.preload_media()</code><br />
|-<br />
|<code>mxw.playlist.pause()</code> || pause the playlists or restart if already paused|| <code>mxw.playlist.pause()</code><br />
|-<br />
|<code>mxw.playlist.play()</code> || play the playlist || <code>mxw.playlist.play()</code><br />
|-<br />
|<code>mxw.playlist.go_pause()( true/false )</code> || pause the playlist (when true), unpause the playlist (when false) || <code>mxw.playlist.go_pause()(true)</code><br />
|-<br />
|<code>mxw.playlist.skiptonext()</code> || skip to the next cue || <code>mxw.playlist.skiptonext()</code><br />
|-<br />
|<code>mxw.playlist.go_next()</code> || go to the next cue without playing || <code>mxw.playlist.go_next()</code><br />
|-<br />
|<code>mxw.playlist.go_prev()</code> || go to previous cue || <code>mxw.playlist.go_prev()</code><br />
|-<br />
|<code>mxw.playlist.go_first()</code> || go to the first cue || <code>mxw.playlist.go_first()</code><br />
|-<br />
|<code>mxw.playlist.navigate_index(index_value)</code> || go to the specified cue index|| <code>mxw.playlist.navigate_index(2)</code><br />
|-<br />
|<code>mxw.playlist.navigate_string("index_string")</code> || go to the specified cue string|| <code>mxw.playlist.navigate_string("BG_video2")</code><br />
|-<br />
!colspan="3" |Preload Control<br />
|-<br />
|<code>mxw.preload(preload_number).clear()</code> || clears the selected preload || <code>mxw.preload(2).clear()</code><br />
|-<br />
|<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><br />
|-<br />
|<code>mxw.preload(preload_number).set_name("new_media_name")</code> || renames a preload || <code>mxw.preload(4).set_name("new_background")</code><br />
|-<br />
|<code>mxw.preload(preload_number).add_preload()</code> || load a preload in the layers || <code>mxw.preload(3).add_preload()</code><br />
|-<br />
|<code>mxw.preload(preload_number).trigger_preload()</code> || trigger a layer from the preload || <code>mxw.preload(5).trigger_preload()</code><br />
|-<br />
|<code>mxw.preload(preload_number).get_activated()</code> || requests if the preload is editable || <code>mxw.preload(9).get_activated()</code><br />
|-<br />
|<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><br />
|-<br />
|<code>mxw.preload(preload_number).get_layer_position()</code> || returns the layer index of the preload|| <code>mxw.preload(1).get_layer_position()</code><br />
|-<br />
|<code>mxw.preload(preload_number).get_track_position()</code> || returns the track index of the preload|| <code>mxw.preload(8).get_track_position()</code><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
|<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><br />
|-<br />
<br />
|}</div>Hwendler