This section has documentation on optional features that are in protoPixel Create, but not yet stable to be a in a regular part of the documentation. You can use them, if something breaks please report it to us!
The functionality documented in this section is still experimental.
ProtoPixel has a native Open Sound Control interface exposed in the port 2345.
You can affect contents in your project by sending OSC messages to this port. The OSC address schema is like follows:
/<type>/<name>/<param> <value> /<type>/<name>/<param>
With those parameters:
<type>is the entity type, and at the moment it can only be
<name>is the name of the entity.
<param>is the parameter of the entity to be modified. You can see those parameters names by accessing to the Content section in the WebApp. If the parameter is inside a parameter group, you can use
/to separate group from parameter name. See the examples.
<value>is the new value of the parameter. It can be omitted if the parameter is a button.
OSC Messages Examples¶
# enable content /Content/mycontent/enabled 1 # disable content /Content/mycontent/enabled 0 # play video content /Content/rainbow.mp4/params/play # stop video content /Content/rainbow.mp4/params/stop # change color for a color content (R, G, B, A) /Content/color/params/color 255 100 100 255
Custom OSC bindings¶
Custom OSC bindings are also available in scripts. See
custom_osc.py example in the
examples/scripting folder for more details.
There is also a UDP interface in the port 2344. The mechanics are the same as the OSC Interface. The messages are composed like the following:
/<type>/<name>/<param> <JSON-encoded value>
# enable content /Content/mycontent/enabled 1 # change color for a color content (R, G, B, A) /Content/color/params/color [255 100 100 255]