Unify Manual

Your complete reference to PlugInGuru's creative playground!

User Tools

Site Tools


osc-support

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
osc-support [2021/11/12 17:23] – [Overview] shaneosc-support [2023/05/08 18:59] (current) – external edit 127.0.0.1
Line 13: Line 13:
  
 ===== Enabling and Configuring OSC ===== ===== Enabling and Configuring OSC =====
-To set up OSC support in Unify v1.7 and later, you need to first locate the //Unify.settings// file. +To set up OSC support in Unify v1.7 and later, go to the [[settings|Settings view]] and locate the OSC section:
-  * Close all instances of Unify first, so the file won't get overwritten while you're editing it. +
-  * On Windows, open an Explorer window and type ''%appdata%\PlugInGuru'' into the address bar. +
-    * This will open the folder ''C:\Users\''//your user name//''\AppData\Roaming\PlugInGuru''+
-  * On Macintosh, open a Finder window and type ''~/Library/Application Support/PlugInGuru'' into the address bar. +
-    * This will open the folder ''/Users/''//your user name//''/Library/Application Support/PlugInGuru''.+
  
-Within this folder, locate the file //Unify.settings//, and open it in a true text editor such as [[https://notepad-plus-plus.org/|Notepad++]] on Windows or TextEdit //in plain-text mode// on Macintosh. (DO NOT use Microsoft Word or any similar program; see [[midi-controller-files#about_plain-text_files|this discussion of plain-text files]].)+{{::osc-1.png|}}
  
-The //Unify.settings// file is an [[wp>XML|XML file]]. You should ideally know about the structure of XML, and how to ensure that start/end tags and quotation marks are correctly paired. Be VERY careful about typing quotation marksas many text editor programs (even true "text editors") are often configured to convert these into typographical quote-marks, which will cause Unify to be unable to parse the XML correctly.+To enable Unify to listen for OSC commandsthe least you need to do is to check the "Enable" box.
  
-Unify v1.7 will automatically add a well-formed XML //VALUE// tag for OSC configuration, which you will usually find at or near the very bottom of the file: +If you wish, you may also adjust the //portNumber// and/or //ipAddress// settings**You must //disable OSC// (un-check the "Enablebox) before editing these values, then //re-enable OSC// (check the box again) to accept the changes, and finally //re-start Unify// for the changes to take effect.** 
- +  * The default //ipAddress// "0.0.0.0" (shown as "ANY IP"configures Unify to listen on ALL available network interfaces.
-<code XML> +
-  <VALUE name="networkParams"> +
-    <networkParams> +
-      <osc ipAddress="0.0.0.0" portNumber="9001" connectAtStartup="0"/+
-    </networkParams> +
-  </VALUE> +
-</code> +
- +
-To enable Unify to listen for OSC commands, the least you need to do is to change the "0after //connectAtStartup// to "1"+
- +
-If you wishyou may also adjust the //portNumber// and/or //ipAddress// settings+
-  * The default //ipAddress// "0.0.0.0" configures Unify to listen on ALL available network interfaces.+
     * If you want it to listen only for //local// connections, from other programs on the //same computer//, change this to "127.0.0.1".     * If you want it to listen only for //local// connections, from other programs on the //same computer//, change this to "127.0.0.1".
     * If you want it to listen on a specific interface only, enter the IP address to use.     * If you want it to listen on a specific interface only, enter the IP address to use.
   * On most computers, the default //portNumber// 9001 should not interfere with any existing network services.   * On most computers, the default //portNumber// 9001 should not interfere with any existing network services.
     * If you need to change it, you'll need to determine a suitable port number, between 1024 and 65535.     * If you need to change it, you'll need to determine a suitable port number, between 1024 and 65535.
-  * Changes you make will only take effect after you save and close the file, then re-open Unify.+  * Changes you make will only take effect after you quit Unify, then re-start Unify
 + 
 +**On Windows**, the first time you re-start the Unify stand-alone app after enabling OSC, a pop-up window will appear, asking you if it's OK to allow network access: 
 + 
 +{{::osc-2.png|}} 
 + 
 +The recommended setting (allow Unify to communicate on Private networks only) should already be selected. Click the **Allow access** button to confirm it.
  
 ===== OSC message types ===== ===== OSC message types =====
Line 98: Line 87:
  
 Note the reversed byte-order, and how 3-byte MIDI messages are encoded as 4-byte integers. (2-byte MIDI messages are encoded the same way, but the ''byte3'' value will be 0.) Note the reversed byte-order, and how 3-byte MIDI messages are encoded as 4-byte integers. (2-byte MIDI messages are encoded the same way, but the ''byte3'' value will be 0.)
 +
 +==== OSC messages to embedded Unify instances ====
 +**As of Unify v1.9**, it is possible to direct OSC commands to specific embedded Unify instances. The required path syntax is similar to that for sending parameter-update messages to plug-ins, but the word //unify// is used instead of //plugin//, and this is followed by the OSC command to be sent to the Unify instance.
 +
 +For example, to send the command ///master/mixLevel// to an embedded Unify instance on layer INST1, the full OSC path would be ///inst/1/unify/master/mixLevel//.
 +
  
osc-support.1636737831.txt.gz · Last modified: 2023/05/08 18:59 (external edit)