AVOSUPPORT

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
Web API example

====== 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.

**Also this solves the mystery about the 'separate programmer'.**

^ author, date            | Sebastian Beutel, February 2022 |
^ published               | here, [[https://www.youtube.com/watch?v=ONCxJuQbYW4|Youtube]] |
^ prog. lang./ framework  | simple text editor (I used the [[webapi:examples:webapidemo|]] to play with the requests)|
^ description             | collection of http requests used to program simple cues. |
^ other requirements      | This is essentially just a collection of requests. You can send them with a web browser or with other tools. |

===== Screenshots =====

{{:webapi:examples:api_demo_1.png?400|}} {{:webapi:examples:api_demo_2.png?400|}}

----

===== Video =====

{{youtube>ONCxJuQbYW4?medium}}

----

===== Separate Programmer =====

By default the Web API is available on network port 4430 (hence the requests start with something like 'http://localhost:4430/...'. Also, actions on the user interface, e.g. changing pages or selecting fixtures, do not reflect in the Web API. In turn anything done in the API doesn't reflect in the normal user interface, e.g. if you select fixtures or set a level you won't see it in Titan. This is pretty much like the blind mode or another user. Unfortunately this makes it really hard to debug any API requests as you see the outcome only when everything is correct and you did succeed programming something.

However there is a solution: you can tell Titan to also listen on another port, with the user and interface you see directly in Titan. In order to do this you need to set specific parameters:
  * open the .exe.config file of the Titan application you are using (e.g. ''C:\Program Files\Avolites\Titan Mobile\Mobile.exe.config'')
  * find the ''<appSettings>'' part
  * add these lines:

      <add key="webapi.enabled" value="true" />
      <add key="webapi.port" value="4431" />

  * maybe these lines already exist but you need to change ''false'' to ''true''
  * restart the Titan software. Now, the Web API is available on both, port 4430 with the traditional separate user, and port 4431 with the same user and interface you see in Titan.

In order to make it easier to work with these settings the [[https://www.avolites.de/downloads/webapi/index.htm|WebAPI test page]] now also features a port toggle button where you can switch between port 4430 and 4431:

{{:webapi:examples:porttoggle.png|}}

----

===== API 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:

  * **Clear** the programmer
  * **Select** one or more fixtures
  * **Set a dimmer level**, or more generally, set a certain level of an attribute of the selected fixtures
  * **Record** the contents of the programmer to a certain playback handle e.g. on a playback fader or a buttom in the playbacks window
  * **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]]