Skip to content

Custom Messages

maybites edited this page Nov 20, 2022 · 10 revisions

Shows the list of the custom OSC handlers. An OSC handler defines what should happen if an OSC message arrives.

All changes of the OSC handlers will only be applied once the server has been restarted. (This also is true for nodes..)


  • enable: enables/disable the use of this handler
  • RT/X: Direction of message. You can choose between
    • INPUT: only listening to OSC messages with the specified address
    • OUTPUT: only sending OSC messages with the specified address.
    • BOTH: sending and listening.
  • +: copies this handler
  • x: deletes this handler
  • address: OSC address. Using the Python OSC library (toggle next to the Start button) you can also use asterix (*) inside your address.
    • filter: filter condition for specific address or arguments:
      • variable address: received osc address
      • variable addr: array with individual address segments - converted to int or floats if applicable
      • variable args: array with arguments
  • datapath: the blender datapath to be executed. This works for custom properties, function calls and indices.
    • format: format the datapath with specific variables:
      • variable address: received osc address
      • variable addr: array with individual address segments - converted to int or floats if applicable
      • variable args: array with arguments
      • variable length: length of arguments array
      • variable index: index when using Loop
  • arg[idx]: message argument indices define which arguments should be passed on.
    • () all arguments are passed on
    • (2) only arg2 is passed on
    • (0, 1, 2) arg0, arg1 and arg2 are passed on
    • (3, 0, 1, 2) reordering the arguments to arg3 arg0 arg1 arg2
    • Loop: define a loop
  • Create new message handler does as it says.
  • Default address Default address when importing handlers fomr Keying sets
  • Export OSC config Exports the custom OSC handlers for using in another file
  • Import OSC config Imports OSC handlers for using in this file

It is possible and permissible to create multiple OSC handlers and nodes with the same OSC address.