OSC Interface

Protopixel has a native Open Sound Control interface exposed in 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 Content.
• <name> is the name of the entity.
• <param> is the parameter of the entity to be modified. You can see those parameter names by accessing the Content section in the WebApp. If the parameter is inside a parameter group, you can use / to separate the group from the 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.