API Item

It is possible to create items to add to the favorites bar or playlist that execute HTTP requests, send MIDI code to other devices or execute JavaScript code.
This allows executing actions in other programs and devices, such as OBS Studio, lighting program, PTZ cameras, etc., or executing scripts that interact with the program, being able to execute actions or a list of actions programmatically and accurately.
For example, you can create an item that, when executed, changes a scene in your broadcast program, or an item that selects a preset from a PTZ camera on the network, etc.
These actions can be performed by clicking on the item or performed automatically through the program's Triggers functionality.
For example, you can create a trigger so that whenever Holyrics presents the X image in the projection, it automatically changes to the Y scene in your broadcast program.
Or whenever you present a Bible verse, it automatically switches to the Z scene in your broadcast program.
There are many possibilities for automation that facilitate and save the work of the multimedia team.


TUTORIAL

Example of how to create an API item that changes an OBS Studio scene:
  • Tools menu > several > API
    Add button.


  • Set a name for the item and select the option to create a receiver.


  • Create a URL receiver with the name you want.


  • Configure the URL with the IP of the equipment where the OBS Studio program is executed.
    You can set the field to localhost if running on the same computer.
    Change the Type field to OBS Studio WebSocket.
    Configure the OBS Studio webservice password in the settings item.
    The password defined in OBS Studio, Tools menu, item WebSockets WebService Settings.


  • After creating the receiver, go back to the previous window and change the Receiver field of the API item to the receiver you just created.
    Select the Change Scene with Transition item and set the scene name and transition name as desired.


  • After creating the API item, you can add it to the favorites bar or the media playlist.



Note:
It is not necessary to create a receiver for each API item.
If you want to create another API item to control OBS Studio, just select the same receiver.


Example of configuring automation triggers:
In the following example, whenever the Oferta.jpg image is projected, a request will be sent to change the OBS Studio scene to the scene named Oferta.
And whenever you finish the presentation of the image Oferta.jpg in the projection, a request will be sent to change to the scene Cena 1.

Whenever a Bible verse is projected, a request will be sent to change to the Bible scene.
And whenever you remove a verse from the projection, a request will be sent to change to scene Cena 1.



Note:
The list of receivers created for an API item and a trigger item are independent, so you will need to create the receiver again for use in the triggers functionality.
The procedure is the same as previously explained for the API item.