Differences

This shows you the differences between two versions of the page.

--- webapi:examples:programming_playbacks [2022/02/17 14:06] – icke_siegen
+++ webapi:examples:programming_playbacks [2022/03/03 09:46] (current) – icke_siegen
@@ Line 1: / Line 1: @@
 Web API example
-====== Programming playbacks ======
+====== Programming Playbacks ======
 Starting point to programm playbacks using the Web API. Inspired by a project where the customer shall be able to program simple cues. Also this might be the starting point for more sophisticated applications.
@@ Line 48: / Line 48: @@
 ===== API Requests =====
-  * [[:webapi:requests:]]
+The intention of this example is to make it possible to program simple playbacks using the API. Hence the actions and requests are as follows:
-  * [[:webapi:requests:]]
-  * [[:webapi:requests:]]
+  * **Clear** the programmer
-  * [[:webapi:requests:]]
+  * **Select** one or more fixtures
-  * [[:webapi:requests:]]
+  * **Set a dimmer level**, or more generally, set a certain level of an attribute of the selected fixtures
-  * [[:webapi:requests:]]
+  * **Record** the contents of the programmer to a certain playback handle e.g. on a playback fader or a buttom in the playbacks window
-  * [[:webapi:requests:]]
+  * **Clear** the programmer again
+Of course this can be extended to some degree, e.g. set another attribute (if the fixtures have more than just a dimmer channel), record-merge or record-replace if the handle is already in use, delete the playback etc. Please also note the different ways of spedifying a certain item (i.e. the location): some commands refer to the current page of playbacks or of another window while others can work on any page, some commands use the userNumber while others use the location, some indexes are 0-based while others are 1-based... I strongly suggest reading the [[macros:identifiers|macro article on identifiers]] as this is closely related.
+You can download the API demo config here and load it into the Web API Demo Site: {{ :webapi:examples:api_demo_programming_playbacks.txt |}}
+{{:webapi:examples:demoimport.png|}}
+==== Used requests ====
+  * [[:webapi:requests:Programmer_Editor_ClearAll]]
+  * [[:webapi:requests:Selection_Context_Programmer_SelectFixture]]
+  * [[:webapi:requests:Programmer_Editor_Fixtures_SetControlValueByName]]
+  * [[:webapi:requests:Playbacks_StoreCue]]
+  * [[:webapi:requests:Playbacks_ReplacePlaybackCue]]