Contact Us

CATEGORIES

Whoops…Nothing found

Try other keywords in your search

Companion

 1 Minute

 0 Likes

 1188 Views

 

Companion provides an interface between, e.g. a Streamdeck and Pixera. This article is about how to connect Companion with Pixera.


 

Setup Companion

 

  1. Download Companion here
  2. After Installing, make sure that you choose the correct Network Interface.
  3. Launch GUI.
  4. Set target IP and Port
  5. Setup Pixera

 

 


 

Setup Pixera

  1. Open Pixera navigate to API and select Input Network Adapter
  2. Make sure your Protocol is Json/Tcp and the same port as selected in Companion

If you want to send commands to Companion, you have to set an API output as described in the Companion settings tab.
The IP will be the chosen network adapter of Companion (localhost 127.0.0.1 in this case). The port is defined by Companion as port 51235 for the UDP connection.

PLEASE NOTE: Only UDP is currently supported for sending data to Companion 

API output in Pixera: 

Set an API output to the chosen IP that Companion is running on and set port the port to 51235. Set protocol to Plain String/UDP. 
 

 


 

Use

Now you should be able to Connect to Pixera in Companion, for example I assigned the Timeline 1 with a play action to the Play button:

If you press the “Test” button, you should be able to already see Pixera executing the command


If you would like to send commands to Companion from a cue:
- create a Cue
- in the cue inspector, scroll down to “Network Command”
- choose the API output you have configured to connect to Companion (API out 1 in the described config, see above)

- set data as described in the Companion settings tab


- for a button press such as “press page 1, button 2” the syntax is: BANK-PRESS 1 2
Don't forget to press “Apply”. You can test send the command via the “Send Command button”. The command will be applied as soon as the now pointer hits this Cue.


 

Use API Command in Companion for Pixera

If you want to send specific commands or run modules in Control then select "Pixera API" as action.


Example for a control module action trigger:

{"jsonrpc":"2.0", "id":19, "method":"PixeraMulti.Timeline.Selected.play"}

Tipp

If you want do call the action with parameters then use it like this: "params":[5,10,15.5]

{"jsonrpc":"2.0", "id":19, "method":"PixeraMulti.Timeline.Selected.fadeInTimeline", "params":[5]}
 

 

It is important that the action is called with it's path. This can be found in Control.

 

To send the right API command, read this article:

May also want to see:

How to get and use handles

 

Pixera 1.9.176 | 09. November 2023

Was this article helpful?