Contact Us

CATEGORIES

Whoops…Nothing found

Try other keywords in your search

Direct API

 1 Minute

 0 Likes

 37 Views

The direct API in PIXERA is used to process tracking data faster and more efficiently. Especially in use with screen movements that need to be updated many times per second, the signal paths within Pixera must also be kept short, which is why this is necessary for tracking.


Modules using the Direct API

Currently, the GUI does not display what Module is using tracking and what is not.
All Tracking Modules and the DirectNetworkOsc Module use the Direct API.


Limitations

Due to the Direct API, many tracking modules are not compatible with all other modules.

It depends on which code is used within the module that is connected after the tracking module.

Things that can't be used:

  • Action with Attribute
    As soon as the connected Module, as a whole, uses at least one Action with Attribute.

Behaviour when incompatible

In case a Tracking Module is connected with incompatible elements, a Lua error like this will be printed in the Log window:
“Local Error: Process failed: Unrecognized Lua element on stack.”

What works:

Custom modules with custom code that don't use any Action with Attribute works completely fine.

You can still use custom code that is located in an action without an attribute. This also applies to all Modules that use only functions which don't interfere with the Direct API. 

Some modules are designed to be compatible with the Direct API.
Compatible by design:

  • extractValues
  • arrayToValues
  • toBool
  • toNumber
  • toString
  • valuesToArray
  • RangeMulti

From Direct API to API

There is a global function which allows getting trigger (not data) out of the Direct API.
 

scCallExtControl("ModuleName.ActionName")

Is a global function that allows to do function calls outside the Direct API. 

Warning

this can not be tested without direct API input, otherwise it will throw an error 

 

Warning

Keep in mind this will use the same frequency as the incoming tracking data, this can if used wrong lead to performance issues.
We recommend using this only in connection with a simple one-time trigger, rather than triggering repeatedly at the same frequency as tracking.

 

Example with one-time trigger:


Additional Resource

A PSN test sender is available for testing the Direct API.
psn_server.exe


PIXERA 25.1 RC 16 | 4. June 2025 | J.B.

Was this article helpful?