jmod.sur.vbap~

Vector base amplitude panning (VBAP) of multiple sources for multiple speakers.

Table of Contents | Index of Modules | Credits | Donate | Jamoma.org

Configuration

Module Type: control
Algorithm Type: default

Interface Size: 300x70 pixels

Number of signal inlets: 0
Number of signal outlets: 0

Parameters

/name /type /range /clipmode /ramp/drive /ramp/function /dataspace /unit /repetitions/filter /description
audio/gain decimal 0 127 none scheduler linear gain midi 1 Set gain (as MIDI value by default).
audio/mute boolean 0 1 none none linear none none 1 When active, this attribute turns off the module's processing algorithm to save CPU
dimensions integer 2 3 both none linear none none 1 Dimension of the loudspeaker setup (2D or 3D).
interpolationTime integer 10 2000 low none linear time ms 1 Sets the interpolation time in [ms] for the maitrix~ object. default value is 10 ms
numSources integer 1 32 both none linear none none 1 Number of incomming mono sources to pan.
numSpeakers integer 2 32 both none linear none none 1 Number of speakers that signals are distributed to.
view/freeze boolean 0 1 none none linear none none 1 Turn off the updating of user interface elements when parameters change. This may be done to conserve CPU resources.
view/highlight string 0 1 none none linear none none 1 Highlight the module with a color tint such as red, green, or similar.

 

Messages

/name /type /range /clipmode /ramp/drive /ramp/function /dataspace /unit /repetitions/filter /description
documentation/generate generic 0 1 none none linear none none 1 Generate a html documentation page for this module and save it to disk. The argument 'tex' creates a Latex document.
init none 0 1 none none linear none none 1 Initialize a module completely to the original state.
preset/clear none 0 1 none none linear none none 1 Clears all presets, providing a blank slate for saving new presets.
preset/copy generic 0 1 none none linear none none 1 Create a new preset (2nd argument) by copying the contents of another preset (1st argument)
preset/default none 0 1 none none linear none none 1 Open the default preset file and recall the first preset in that file.
preset/dump none 0 1 none none linear none none 1 Dump all preset names.
preset/interpolate generic 0 1 none none linear none none 1 Interpolate between two named presets (argument 1 and 2) using a ratio (float in the range [0.0, 1.0]) specified as the third argument.
preset/mix generic 0 1 none none linear none none 1 Mix list of pairs of (preset name, mix value) using a ratio (float).
preset/post none 0 1 none none linear none none 1 Post all presets to the Max window.
preset/read generic 0 1 none none linear none none 1 Open an xml-preset file and recall the first preset in that file. An optional argument defines the file to open.
preset/recall generic 0 1 none none linear none none 1 Recall a preset by number - you can also choose presets from the module menu.
preset/store generic 0 1 none none linear none none 1 Store a preset by number in memory. All presets present in memory will be written to disk when you send a /preset/write message to the module.
preset/storecurrent none 0 1 none none linear none none 1 Store on the last recalled or stored preset
preset/storenext none 0 1 none none linear none none 1 Store a preset in the next preset slot. Handy so that you do not need to specify a preset number manually.
preset/write generic 0 1 none none linear none none 1 Write an xml-preset file to disk. An optional argument defines the file to open.
preset/writeagain none 0 1 none none linear none none 1 Write on same xml-preset file.
source.1/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.1/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.1/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.1/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.10/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.10/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.10/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.10/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.11/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.11/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.11/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.11/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.12/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.12/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.12/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.12/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.13/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.13/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.13/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.13/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.14/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.14/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.14/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.14/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.15/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.15/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.15/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.15/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.16/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.16/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.16/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.16/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.17/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.17/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.17/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.17/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.18/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.18/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.18/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.18/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.19/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.19/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.19/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.19/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.2/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.2/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.2/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.2/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.20/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.20/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.20/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.20/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.21/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.21/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.21/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.21/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.22/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.22/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.22/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.22/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.23/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.23/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.23/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.23/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.24/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.24/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.24/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.24/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.25/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.25/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.25/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.25/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.26/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.26/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.26/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.26/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.27/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.27/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.27/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.27/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.28/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.28/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.28/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.28/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.29/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.29/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.29/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.29/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.3/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.3/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.3/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.3/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.30/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.30/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.30/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.30/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.31/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.31/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.31/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.31/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.32/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.32/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.32/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.32/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.4/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.4/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.4/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.4/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.5/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.5/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.5/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.5/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.6/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.6/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.6/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.6/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.7/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.7/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.7/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.7/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.8/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.8/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.8/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.8/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
source.9/active boolean 0 1 none none linear none none 1 Mute ( /active 0) or unmute (/active 1) the nth source.
source.9/blur decimal 0 100 none none linear none none 1 Set spatial blur of the nth source.
source.9/gain decimal 0 1 none scheduler linear gain linear 1 Input gain for the nth source.
source.9/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.1/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.10/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.11/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.12/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.13/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.14/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.15/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.16/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.17/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.18/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.19/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.2/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.20/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.21/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.22/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.23/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.24/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.25/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.26/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.27/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.28/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.29/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.3/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.30/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.31/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.32/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.4/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.5/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.6/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.7/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.8/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
speaker.9/position decimalArray 0 1 none none linear position xyz 1 Position of the nth source.
view/color/border decimalArray 0 1 both none linear none none 1 The border color of the module in the format RGBA where values range.
view/color/contentBackground decimalArray 0 1 both none linear none none 1 The background color of the module in the format RGBA where values range.
view/color/toolbarBackground decimalArray 0 1 both none linear none none 1 The background color of the module's toolbar in the format RGBA where values range.
view/color/toolbarText decimalArray 0 1 both none linear none none 1 The color of the module's toolbar text in the format RGBA where values range.
view/internals none 0 1 none none linear none none 1 Attempts to open the internal algorithm for viewing. This works for most modules. Some modules may choose to cloak the algorithms - preventing this message from functioning.
view/refresh none 0 1 none none linear none none 1 Update displayed values for module to reflect current state.
view/script generic 0 1 none none linear none none 1 Low-level module hacking. Any arguments arguments to this message will be interpreted as patcher scripting for the top-level patcher of the module.
view/size generic 0 1 none none linear none none 1 The size of the module's UI: [Width Height]

 

Return

/name /type /range /clipmode /ramp/drive /ramp/function /dataspace /unit /repetitions/filter /enable /description

 

About Jamoma

Jamoma is a system for creating and exchanging structured Max patches. It consists of both a set of guidelines and an implementation of those guidelines. For more information please visit jamoma.org.