ABCDEFGHIJKLMNOPQRSTUVWXYZAA
1
SPAT Revolution OSC Table and Guideline
2
Available in VersionCategoryParameter NameSPAT MessageValuesMinimumMaximumDefaultFormatDescriptionCommentaryADM-OSC (official)ADM-OSC (supported)
3
FLUX:: SPAT Revolution supports by default 3 input grammars: FLUX:: OSC grammar, ADM-OSC grammar and IRCAM ADMix positional grammar.
  
4
For position / radiation messages such as XYZ and AED, it supports indivual messages, abbrievated individual messages, packed messages (XYZ or AED) or partially packed messages (XY or AE or AD).
 
5
On OSC Output, various OSC connections options are available to configure a custom OSC output.
       
6
1) AED or/and XYZ packing can be forced on output 2) Auto-Bundle feature of OSC can be enabled or disabled. 3) Message can be sent with Index as Argument rather then in the message (aka /source/aed, [1, 45, 45, 2] instead of /source/1/aed, [45, 45, 2] )
7
4) Ping-Pong feature will force send messages coming from an OSC source back to it (by default, we send all message incoming to all output destination except destination that are the source of the message. The destination which is defined as the source are the output with same IP address and a port number in the range of [input OSC port / input OSC port +10]. Example : for Input 127.0.01 Port 8000, Output 127.0.0.1 Port 8009 is considered as the same device, Port 8011 as another device)
8
5) Touch/Release messages are used to nicely integrate with DAW Automation features, this can de disabled on output if required or if messages are not supported by destination.
 
9
6) Alternatively, ADM-OSC grammar can be used on output rather the the standard FLUX:: OSC grammar.
       
10
                          
11
- Remote number wild card (*) OSC Messages with the remote number * will apply message on all elements
      
12
- Remote number (-1). Currently selected source(s): Will apply message on the current selection. By default, no messages are sent for the current selection. It can be enabled on the Preferences, enabling "Send current selection messages" on the OSC Main panel.
13
- Interpollation Time (XFade time) Add Argument to any messages to define the time the interpolation time. For example, /source/1/azim 20.0 2.0 will interpolate the azimuth of the source one to 20°, on 2 seconds.
 
14
- Relative OSC. OSC message with a /relative after the remote number will add the value given in argument. For example, /source/2/relative/gain 1.0 will add 1dB to the gain of the source 2. This allow work with timing: /source/2/relative/dist 2.0 3.0 will add 2 meters to the distance of the source 2.
15
- Range. OSC message with remote number as a range like 1-5 or [3-7] will apply the message on the specified range
      
16
- Dump information ex: /source/*/dump, will send all sources parameters to the OSC output slots), /snapshot/2/dump all the parameters of the snapshot remote number 2.
 
17
- Get (?) information: /source/*/azim/? (will send all source azimuth to the OSC out slots), /source/*/azim/get (will request all source azimuth to be sent the OSC output slots)
 
18
                          
19
This table lists all the OSC message in SPAT Revolution. The messages in black color are already implemented in the last public release 23.11. The messages in blue are released with 24.06. Changed with version 25.01 are green (ADM-OSC related)
20
21
Project
These messages are related to project settings. All these messages begin by "/global/"
22
23
1.1.0.48049Global - Config3D Scale in 3D view/global/project/scale 0,110003Metersdefine the scale of the 3D View in Spat Revolution  
24
24.06.50385Source remote numbers/global/project/source/remotenumber/?AnySend a list of the sources remote number
25
24.06.50385Room remote numbers/global/project/room/remotenumber/?AnySend a list of the rooms remote number
26
24.06.50385Master remote numbers/global/project/master/remotenumber/?AnySend a list of the masters remote number
27
24.06.50385Snapshot remote numbers/global/project/snapshot/remotenumber/?AnySend a list of the snapshots remote number
28
24.06.50385Global - ProjectLoad project/global/loadStringPath of the sessionLoad a session
29
24.06.50385Save project/global/saveAnySave the session
30
24.06.50385Global - ViewGo to specified page/global/gotoStringName of the pageNavigate to the specificed page, for example "Snapshots", "Room1", ...
31
24.06.50385Open the sources properties panel/global/sources/panel/openAnyIf in a room page, open the sources properties panel
32
24.06.50385Open the room properties panel/global/room/panel/openAnyIf in a room page, open the room properties panel
33
24.06.50385Open the output properties panel/global/output/panel/openAnyIf in a room page, open the output properties panel
34
24.06.50385Toggle the sources properties panel/glboal.sources/properties/toggleAnyIf in a room page, toggle the output properties panel
35
24.06.50385Global - TransportRecord/global/recordlaunch the record
36
24.06.50385Record/global/stopstop the record
37
                          
38
Sources
These messages are related to the sources' properties.
   
39
All these messages begin by "/source/(k)/". The index (k) has to be replaced by:
 (k) is the remote number
40
- source index if only one source is aiming. For example: "/source/12/azim", -50 will change the azimuth of the source number 12 to -50°.
41
1.1.0.48049GeneralSelect / Unselect/source/(k)/selectbool010On/Offselect or unselect the source depending on the argument  /adm/obj/(k)/select            
42
1.1.0.48049Name/source/(k)/nameString    set the name of the source. /adm/obj/(k)/name             
43
1.1.0.48049Enable/source/(k)/enableBool011On/Offenable or disable the source (same as mute)  /adm/obj/(k)/enable            
44
1.1.0.48049Mute/source/(k)/muteBool010On/Offunmuted or mute a source : 0: muted, 1: unmuted /adm/obj/(k)/mute i             
45
1.1.0.48049Solo/source/(k)/soloBool010On/Offsolo on unsolo a source  /adm/obj/(k)/solo i            
46
2020.10.0N.R./source/(k)/invphBool010On/Offinvert the phase of a source  /adm/obj/(k)/invph i            
47
1.1.0.48049Gain/source/(k)/gainFloat-144,5240Decibelsset the global gain of a source /adm/obj/(k)/gain f
48
1.1.0.48049LFE/source/(k)/lfeFloat-144,524-144,5Decibelsset the LFE gain of a source /adm/obj/(k)/s f             
49
2022.02.50148LFE 2/source/(k)/lfe2Float-144,524-144,5Decibelsset the LFE 2 gain of a source  /adm/obj/(k)/s2 f            
50
2022.02.50148LFE 3/source/(k)/lfe3Float-144,524-144,5Decibelsset the LFE 3 gain of a source  /adm/obj/(k)/s3 f            
51
2022.02.50148LFE 4/source/(k)/lfe4Float-144,524-144,5Decibelsset the LFE 4 gain of a source  /adm/obj/(k)/s4 f            
52
2022.02.50148Room Gain/source/(k)/rg(n)Float-144,524-144,5Decibelsset the room gain for the dedicated room (room number is (n), for example: /source/2/rg4 for the forth room)  /adm/obj/(k)/roomGain(n)            
53
2023.11.50341Color/source/(k)/colorString    set the color of the source. The value is expressed as a string, in the following format (rgba): "#FFFFFFFF"  /adm/obj/(k)/color
54
                          
55
1.1.0.48049Perceptual FactorsPresence/source/(k)/presFloat0120100%set the presence of a source  /adm/obj/(k)/dg f
56
1.1.0.48049Warmth/source/(k)/warmthFloat06030 set the warmth of a source  /adm/obj/(k)/warmth f            
57
1.1.0.48049Brillance/source/(k)/brilFloat06030 set the brillance of a source  /adm/obj/(k)/bril f            
58
1.1.0.48049Room presence/source/(k)/prerFloat012048%set the room presence of a source  /adm/obj/(k)/prer f            
59
1.1.0.48049Running Reverberance/source/(k)/revpFloat05034 set the running reverberance of a source  /adm/obj/(k)/revp f            
60
1.1.0.48049Envelopment/source/(k)/envFloat05025 set the envelopment of a source  /adm/obj/(k)/env f            
61
                          
62
1.1.0.48049ReverbReverb On/source/(k)/reverb/enableBool011On/Offenable or disable the Reverb  /adm/obj/(k)/reverb/enable i             
63
1.1.0.48049Early On/source/(k)/earlyBool011On/Offenable or disable the Reverb Early  /adm/obj/(k)/early i             
64
1.1.0.48049Cluster On/source/(k)/clusterBool011On/Offenable or disable the Reverb Cluster  /adm/obj/(k)/cluster i             
65
1.1.0.48049Tail On/source/(k)/tailBool011On/Offenable or disable the Reverb Tail  /adm/obj/(k)/tail             
66
                          
67
1.1.0.48049Axis EQAxis Gain/source/(k)/axis/G0Float-60100Decibelsset the global gain of axis filter of a source/adm/obj/(k)/axis/G0 f             
68
1.1.0.48049Axis Low Gain/source/(k)/axis/GlFloat-30300Decibels:set the low gain of axis filter of a source  /adm/obj/(k)/axis/Gl f             
69
1.1.0.48049Axis Medium Gain/source/(k)/axis/GmFloat-30300Decibelsset the medium gain of axis filter of a source  /adm/obj/(k)/axis/Gm f             
70
1.1.0.48049Axis High Gain/source/(k)/axis/GhFloat-30300Decibelsset the high gain of axis filter of a source  /adm/obj/(k)/axis/Gh f             
71
1.1.0.48049Axis Low Frequency/source/(k)/axis/flFloat2020000177Hertzset the low/mid crossover frequency of axis filter of a source  /adm/obj/(k)/axis/fl f             
72
1.1.0.48049Axis High Frequency/source/(k)/axis/fhFloat20200005657Hertzset the mid/high crossover frequency of axis filter of a source  /adm/obj/(k)/axis/fh f             
73
1.1.0.48049Axis parameters/source/(k)/axis/params
List of 6 floats
   set all the parameters of axis filter of the source, the previous parameters. Parameters are requested in a list, with the following order: [G0, Gl, Gm, Gh, fl, flh]  /adm/obj/(k)/axis/params             
74
                          
75
1.1.0.48049Omni EQOmni Gain/source/(k)/omni/G0Float-60100Decibelsset the global gain of omni filter of a source/adm/obj/(k)/omni/G0 f             
76
1.1.0.48049Omni Low Gain/source/(k)/omni/GlFloat-30301,7Decibels:set the low gain of omni filter of a source  /adm/obj/(k)/omni/Gl f             
77
1.1.0.48049Omni Medium Gain/source/(k)/omni/GmFloat-30300Decibelsset the medium gain of omni filter of a source  /adm/obj/(k)/omni/Gm f             
78
1.1.0.48049Omni High Gain/source/(k)/omni/GhFloat-3030-3,8Decibelsset the high gain of omni filter of a source  /adm/obj/(k)/omni/Gh f             
79
1.1.0.48049Omni Low Frequency/source/(k)/omni/flFloat2020000177Hertzset the low/mid crossover frequency of omni filter of a source  /adm/obj/(k)/omni/fl f             
80
1.1.0.48049Omni High Frequency/source/(k)/omni/fhFloat20200005657Hertzset the mid/high crossover frequency of omni filter of a source  /adm/obj/(k)/omni/fh f             
81
1.1.0.48049Omni parameters/source/(k)/omni/params
List of 6 floats
   set all the parameters of omni filter of the source, the previous parameters. Parameters are requested in a list, with the following order: [G0, Gl, Gm, Gh, fl, flh]  /adm/obj/(k)/omni/params             
82
                          
83
1.1.0.48049BarycentricRotation X/source/(k)/rotxFloat-1801800Degreesset the x rotationfor Multi-Channel source only or multi-selection /adm/obj/(k)/rotx f             
84
1.1.0.48049Rotation Y/source/(k)/rotyFloat-1801800Degreesset the y rotationfor Multi-Channel source only or multi-selection /adm/obj/(k)/roty f             
85
1.1.0.48049Rotation Z/source/(k)/rotzFloat-1801800Degreesset the z rotationfor Multi-Channel source only or multi-selection /adm/obj/(k)/rotz f             
86
1.1.0.48049Rotation /source/(k)/rotation
List of 3 floats
   set the barycenter rotation on x, y and z, in degrees. Parameters are the previous, requested in a list, with the following order: [rotx, roty, rotz]  /adm/obj/(k)/rotation             
87
1.1.0.48049Scale (Multichannel)/source/(k)/scaleFloat0,11001Metersset the scale of a multichannel sourcefor Multi-Channel source only or multi-selection /adm/obj/(k)/scale f             
88
                          
89
1.1.0.48049RadiationRelative Direction./source/(k)/ocmodBool011On/Offenable/disable the relative direction of a source  /adm/obj/(k)/ocmod i             
90
1.1.0.48049Azimuth/source/(k)/azimFloat-1801800Degreesset the azimuth of a source /adm/obj/(k)/azim f              
91
1.1.0.48049Elevation/source/(k)/elevFloat-90900Degreesset the elevation of a source /adm/obj/(k)/elev f              
92
1.1.0.48049Distance/source/(k)/distFloat0,011002,0Metersset the distance of a source /adm/obj/(k)/dist f              
93
1.1.0.48049AED/source/(k)/aed
List of 3 Floats
   set the azimuth, the elevation and the distance of a source. Parameters are the previous, requested in a list, with the following order: [azim, elev, dist]. It work too with [a, e], [a, d], and [a, d, e]. /adm/obj/(k)/aed f f f              
94
1.1.0.48049Yaw/source/(k)/yawFloat-1801800Degreesset the yaw of a source  /adm/obj/(k)/yaw f             
95
1.1.0.48049Pitch/source/(k)/pitchFloat-90900Degreesset the pitch of a source  /adm/obj/(k)/pitch f             
96
1.1.0.48049Aperture/source/(k)/apertureFloat1018080Degreesset the aperture of a sourc  /adm/obj/(k)/aperture f             
97
2020.10.0Roll/source/(k)/rollFloat-90900Degreesset the roll of a source  /adm/obj/(k)/roll f             
98
                          
99
1.1.0.48049PositionPosition X/source/(k)/xFloat-1001000Metersset the x coordinate of the source using cartesian coordinates /adm/obj/(k)/x f              
100
1.1.0.48049Position Y/source/(k)/yFloat-1001002Metersset the y coordinate of the source using cartesian coordinates /adm/obj/(k)/y f