General Information
OSC stands for open sound control, which is a protocol for controlling instruments, devices and applications via network. Every plug-in of the IEM Plug-in Suite comes with OSC functionality, for both receiving and sending OSC data. Every VST parameter can be controlled directly via a user-specified port. And the plug-ins also can send their current parameter values to a specified IP address, e.g. for controlling visuals. Additionally, extra commands have been specified for adjusting several parameters at once and also to load / export Decoders, LoudspeakerLayouts or TransformationMatrices.
For a detailed information about the OSC specifications, see opensoundcontrol.org.
OSC Status Display
The OSC Status Display is located in the lower left of each plug-in, right next to the IEM logo. It displays the current connection status with two circles, the left one for receiving OSC data, the right one for sending.
In case there’s no open connection, both circles are grayed out:
You can open the connection settings by clicking the status display. The following window should appear:
In order to receive OSC data, you have to specify a port number and open that port via the OPEN button. On success, the left circle turns green, indicating that your plug-in is listening to the specified port.
For sending OSC data, you have to specify both the IP address and port number where the data should be sent to. If you want to send the data to your local machine, you can enter 127.0.0.1 as an IP address. Click CONNECT to open the connection, the right circle turns green on success.
As several plug-ins can send OSC data to a single receiver, you might want to give the current instance a unique identifier. You can do that by changing the OSC Address. For example, set it to /Encoder/Voice/ to signal that this is your encoder for a voice signal.
With the interval slider, you can specifiy with which rate the parameter updates are sent. The default value is 100 ms.
As only parameter values which have been changed since the last update will be sent, you can press the Flush Params button to trigger sending out all parameter values.
If the connections have been opened successfully, not only do the circles turn green, but there’s also more information displayed next to the OSC text, showing you the listening port and the address to which the parameter values are sent to.
In case a port is already occupied by another process, an error message will occur and the status circle will turn red.
The plug-ins remember the OSC settings and trie to establish a connection on startup. You can disable the OSC functionality by simply entering none, off or -1 into the port fields and click the OPEN / CONNECT buttons. The status circle will turn gray again.
OSC Messages
An OSC Message consists of an address pattern, that specifies which functionality is concerned, and a list of arguments (e.g. parameter values).
The address patterns in the IEM Plug-in Suite have the following specification: First the name of the plug-in to control, in order to avoid unexpected effects when mistaking the ports, and then the desired command. After that, the list of arguments is appended:
/<PluginName>/<command> <arg1> <arg2> ...
An example message to control the azimuth of the StereoEncoder looks like the following:
/StereoEncoder/azimuth 40.0
You can control each VST parameter by using its internal parameterID for the command part of the OSC Message. The subsequent argument has to be a value in the correspoding range of the parameter. There are additional comands to provide a more intuitve and practical use. A list of all possible commands and ranges is presented below.
Generic commands marked with a * have been overladed, this means that the range might have been adjusted to be more meaningful. E.g. AllRADecoder’s decoderOrder command: VST Parameter Range is [0:6], which has been increased to [1:7] to represent the Ambisonic Order without an offset.
The indicated ranges in the following should be replaced by single numbers. E.g. /StereoEncoder/azimuth[0-63] 90 should become /StereoEncoder/azimuth3 90.
AllRADecoder
Generic Commands
| Command | Range / Arguments | Description | Note |
|---|---|---|---|
| inputOrderSetting | 0 : 8 | Input Ambisonic Order | 0: auto, 1: 0th, 2: 1st, …, 8: 7th |
| useSN3D | 0 : 1 | Input Normalization | 0: N3D, 1: SN3D |
decoderOrder* |
1 : 7 | Decoder Order | 1: 1st, 2: 2nd, … |
| exportDecoder | 0 : 1 | Export Decoder | |
| exportLayout | 0 : 1 | Export Layout |
Additional Commands
| Command | Range / Arguments | Description |
|---|---|---|
| loadFile | absolute path as string | loads configuration file |
| calculate | none | calculates the decoder |
| export | absolute path as string | exports decoder and / or layout to file |
| playNoise | 1 : 64 | plays back a noise burst on the specified channels |
| playEncodedNoise | <azimuth> <elevation> |
encodes a noise burst to the specified direction (in degrees) |
BinauralDecoder
Generic Commands
| Command | Range / Arguments | Description | Note |
|---|---|---|---|
| inputOrderSetting | 0 : 8 | Input Ambisonic Order | 0: auto, 1: 0th, 2: 1st, …, 8: 7th |
| useSN3D | 0 : 1 | Normalization | 0: N3D, 1: SN3D |
| applyHeadphoneEq | 0 : 23 | Headphone Equalization | 0: off |
CoordinateConverter
Generic Commands
| Command | Range / Arguments | Description | Note |
|---|---|---|---|
| azimuth | -180 : 180 | Azimuth Angle | |
| elevation | -180 : 180 | Elevation Angle | |
| radius | 0 : 1 | Radius | |
| xPos | -1 : 1 | X Coordinate | |
| yPos | -1 : 1 | Y Coordinate | |
| zPos | -1 : 1 | Z Coordinate | |
| xReference | -50 : 50 | X Reference | |
| yReference | -50 : 50 | Y Reference | |
| zReference | -50 : 50 | Z Reference | |
| radiusRange | 0.1 : 50 | Radius Range | |
| xRange | 0.1 : 50 | X Range | |
| yRange | 0.1 : 50 | Y Range | |
| zRange | 0.1 : 50 | Z Range | |
| azimuthFlip | 0 : 1 | Invert Azimuth | |
| elevationFlip | 0 : 1 | Invert Elevation | |
| radiusFlip | 0 : 1 | Invert Radius Axis | |
| xFlip | 0 : 1 | Invert X Axis | |
| yFlip | 0 : 1 | Invert Y Axis | |
| zFlip | 0 : 1 | Invert Z Axis |
DirectionalCompressor
Generic Commands
Note: replace [1,2] by 1 or 2 to select the first or second compressor engine.
| Command | Range / Arguments | Description | Note |
|---|---|---|---|
| orderSetting | 0 : 8 | Ambisonics Order | 0: auto, 1: 0th, 2: 1st, …, 8: 7th |
| useSN3D | 0 : 1 | Normalization | 0: N3D, 1: SN3D |
| preGain | -10 : 10 | Input Gain | |
| c[1,2]Enabled | 0 : 1 | Enable Compressor [1, 2] | |
| c[1,2]DrivingSignal | 0 : 2 | Compressor [1, 2] Driving Signal | 0: Full, 1: Masked, 2: Unmasked |
| c[1,2]Apply | 0 : 2 | Apply compression [1, 2] to | 0: Full, 1: Masked, 2: Unmasked |
| c[1,2]Threshold | -50 : 10 | Threshold [1, 2] | |
| c[1,2]Knee | 0 : 10 | Knee [1, 2] | |
| c[1,2]Attack | 0 : 100 | Attack Time [1, 2] | |
| c[1,2]Release | 0 : 500 | Release Time [1, 2] | |
| c[1,2]Ratio | 1 : 16 | Ratio [1, 2] | |
| c[1,2]Makeup | -10 : 20 | MakeUp Gain [1, 2] | |
| azimuth | -180 : 180 | Azimuth of mask | |
| elevation | -180 : 180 | Elevation of mask | |
| width | 10 : 180 | Width of mask | |
| listen | 0 : 2 | Listen to | 0: Full, 1: Masked, 2: Unmasked |
DirectivityShaper
Note: replace [0-3] by 0, 1, 2 or 3 to select the frequency band.
Generic Commands
| Command | Range / Arguments | Description | Note |
|---|---|---|---|
| orderSetting | 0 : 8 | Directivity Order | 0: auto, 1: 0th, 2: 1st, …, 8: 7th |
| useSN3D | 0 : 1 | Directivity Normalization | 0: N3D, 1: SN3D |
| probeAzimuth | -180 : 180 | probe Azimuth | |
| probeElevation | -180 : 180 | probe Elevation | |
| probeRoll | -180 : 180 | probe Roll | |
| probeLock | 0 : 1 | Lock Directions | |
| normalization | 0 : 2 | Energy Normalization | 0: basic decode, 1: on-axis, 2: constant energy |
| filterType[0-3] | 0 : 3 | Filter Type [1-4] | 0: allpass, 1: lowpass, 2: bandpass, 3: highpass |
| filterFrequency[0-3] | 20 : 20000 | Filter Frequency [1-4] | |
| filterQ[0-3] | 0.05 : 10 | Filter Q [1-4] | |
| filterGain[0-3] | -60 : 10 | Filter Gain [1-4] | |
| order[0-3] | 0 : 7 | Order Band [1-4] | 0: 0th, 1: 1st, … |
| shape[0-3] | 0 : 1 | Shape Band [1-4] | 0: basic, 0.5: maxrE, 1.0: inPhase |
| azimuth[0-3] | -180 : 180 | Azimuth Band [1-4] | |
| elevation[0-3] | -180 : 180 | Elevation Band [1-4] |
DistanceCompensator
Note: replace [0-63] by a number to select the channel (1-64, 1 offset).
Generic Commands
| Command | Range / Arguments | Description | Note |
|---|---|---|---|
| inputChannelsSetting | 0 : 64 | Number of input channels | 0: auto |
| enableGains | 0 : 1 | Enable Gain Compensation | |
| enableDelays | 0 : 1 | Enable Delay Compensation | |
| speedOfSound | 330 : 350 | Speed of Sound | |
| distanceExponent | 0.5 : 1.5 | Distance-Gain Exponent | |
| gainNormalization | 0 : 1 | Gain Normalization | 0: attenuation only, 1: zero-mean |
| referenceX | -20 : 20 | Reference position x | |
| referenceY | -20 : 20 | Reference position x | |
| referenceZ | -20 : 20 | Reference position x | |
| enableCompensation[0-63] | 0 : 1 | Enable Compensation of loudspeaker [1-64] | |
| distance[0-63] | 1 : 50 | Distance of loudspeaker [1-64] |
Additional Commands
| Command | Range / Arguments | Description |
|---|---|---|
| loadFile | absolute path as string | loads configuration file |
| updateReference | none | updates the distances according to the reference |
DualDelay
Generic Commands
| Command | Range / Arguments | Description | Note |
|---|---|---|---|
| orderSetting | 0 : 8 | Ambisonics Order | 0: auto, 1: 0th, 2: 1st, …, 8: 7th |
| useSN3D | 0 : 1 | Normalization | 0: N3D, 1: SN3D |
| dryGain | -60 : 0 | Dry amount | |
| wetGainL | -60 : 0 | Wet amount left | |
| wetGainR | -60 : 0 | Wet amount right | |
| delayBPML | 46 : 320 | delay left | |
| delayBPMR | 46 : 320 | delay right | |
| delayMultL | 1 : 16 | delay multiplicator left | |
| delayMultR | 1 : 16 | delay multiplicator right | |
| syncL | 0 : 1 | sync BPM left | |
| syncR | 0 : 1 | sync BPM right | |
| transformModeL | 0 : 1 | transform mode left | |
| transformModeR | 0 : 1 | transform mode right | |
| yawL | -180 : 180 | yaw left | |
| yawR | -180 : 180 | yaw right | |
| pitchL | -180 : 180 | pitch left | |
| pitchR | -180 : 180 | pitch right | |
| rollL | -180 : 180 | roll left | |
| rollR | -180 : 180 | roll right | |
| warpModeAzL | 0 : 1 | Warp mode azimuth left | |
| warpModeElL | 0 : 1 | warp mode elevation left | |
| warpModeAzR | 0 : 1 | Warp mode azimuth right | |
| warpModeElR | 0 : 1 | warp mode elevation right | |
| warpFactorAzL | -0.9 : 0.9 | warp factor azimuth left | |
| warpFactorElL | -0.9 : 0.9 | warp factor elevation left | |
| warpFactorAzR | -0.9 : 0.9 | warp factor azimuth right | |
| warpFactorElR | -0.9 : 0.9 | warp factor elevation right | |
| LPcutOffL | 20 : 20000 | lowpass frequency left | |
| LPcutOffR | 20 : 20000 | lowpass frequency right | |
| HPcutOffL | 20 : 20000 | highpass frequency left | |
| HPcutOffR | 20 : 20000 | highpass frequency right | |
| feedbackL | -60 : 0 | feedback left | |
| feedbackR | -60 : 0 | feedback right | |
| xfeedbackL | -60 : 0 | cross feedback left | |
| xfeedbackR | -60 : 0 | cross feedback right | |
| lfoRateL | 0 : 10 | LFO left rate | |
| lfoRateR | 0 : 10 | LFO right rate | |
| lfoDepthL | 0 : 1 | LFO left depth | |
| lfoDepthR | 0 : 1 | LFO right depth |
EnergyVisualizer
Generic Commands
| Command | Range / Arguments | Description | Note |
|---|---|---|---|
| orderSetting | 0 : 8 | Ambisonics Order | 0: auto, 1: 0th, 2: 1st, …, 8: 7th |
| useSN3D | 0 : 1 | Normalization | 0: N3D, 1: SN3D |
| peakLevel | -50 : 10 | Peak level | in dB |
| dynamicRange | 10 : 60 | Dynamic Range | in dB |
| holdMax | 0 : 1 | Hold maximal RMS value | |
| RMStimeConstant | 10 : 1000 | RMS time constant | in ms |
FdnReverb
Generic Commands
| Command | Range / Arguments | Description | Note |
|---|---|---|---|
| delayLength | 1 : 30 | Room Size | |
| revTime | 0.1 : 9 | Reverberation Time | |
| lowCutoff | 20 : 20000 | Lows Cutoff Frequency | |
| lowQ | 0.01 : 0.9 | Lows Q Factor | |
| lowGain | -80 : 6 | Lows Gain | |
| highCutoff | 20 : 20000 | Highs Cutoff Frequency | |
| highQ | 0.01 : 0.9 | Highs Q Factor | |
| highGain | -80 : 4 | Highs Gain | |
| dryWet | 0 : 1 | Dry/Wet | |
| fadeInTime | 0.0 : 9.0 | Fade-In Time | |
| fdnSize | 0 : 2 | FDN Size (internal) | 0: 16ch, 1: 32ch, 2: 64ch |
GranularEncoder
Generic Commands
| Command | Range / Arguments | Description | Note |
|---|---|---|---|
| orderSetting | 0 : 8 | Ambisonics Order | 0: auto, 1: 0th, 2: 1st, …, 8: 7th |
| useSN3D | 0 : 1 | Normalization | 0: N3D, 1: SN3D |
| qw | -1 : 1 | Quaternion W | |
| qx | -1 : 1 | Quaternion X | |
| qy | -1 : 1 | Quaternion Y | |
| qz | -1 : 1 | Quaternion Z | |
| azimuth | -180 : 180 | Azimuth Angle | |
| elevation | -180 : 180 | Elevation Angle | |
| shape | -10 : 10 | Grain Shape | edgy (-10) –> uniform (0) –> peaky (10) |
| size | 0 : 360 | Size | Maximum spread of the grains in degrees |
| roll | -180 : 180 | Roll Angle | |
| width | -360 : 360 | Stereo Width | |
| deltaTime | 0.001 : 2 | Delta Time | Time between grains in seconds |
| deltaTimeMod | 0 : 100 | Delta Time Modulation | in percent |
| grainLength | 0.001 : 2 | Grain Length | in seconds |
| grainLengthMod | 0 : 100 | Grain Length Modulation | in percent |
| position | 0 : 4 | Read Position in Buffer | in seconds |
| positionMod | 0 : 4 | Read Position Modulation | in seconds |
| pitch | -12 : 12 | Pitch | Pitch of grains in semitones |
| pitchMod | 0 : 12 | Pitch Modulation | in percent |
| windowAttack | 0 : 50 | Grain Attack Time | in percent of the grain length |
| windowAttackMod | 0 : 100 | Attack Time Modulation | in percent |
| windowDecay | 0 : 50 | Grain Decay Time | in percent of the grain length |
| windowDecayMod | 0 : 100 | Decay Time Modulation | in percent |
| mix | 0 : 100 | Mix | Mix between standard encoding (0) and grain encoding (100) |
| sourceProbability | -1 : 1 | Source Probability | |
| freeze | 0 : 1 | Freeze Mode | |
| spatialize2D | 0 : 1 | 2D mode | Distribute grains in 3D (0) or 2D (1) |
| highQuality | 0 : 1 | Sample-wise Panning |
MatrixMultiplier
Commands
| Command | Range / Arguments | Description |
|---|---|---|
| loadFile | absolute path as string | loads configuration file |
MultiBandCompressor
Note: replace [0-3] by a number to select the frequency band (0-3)
Generic Commands
| Command | Range / Arguments | Description | Note |
|---|---|---|---|
| orderSetting | 0 : 8 | Ambisonics Order | 0: auto, 1: 0th, 2: 1st, …, 8: 7th |
| useSN3D | 0 : 1 | Normalization | 0: N3D, 1: SN3D |
| crossover0 | 20 : 20000 | Crossover 0 | in Hz |
| crossover1 | 20 : 20000 | Crossover 1 | in Hz |
| crossover2 | 20 : 20000 | Crossover 2 | in Hz |
| threshold[0-3] | -50 : 10 | Threshold 0 | in dB |
| knee[0-3] | 0 : 30 | Knee Width 0 | in dB |
| attack[0-3] | 0 : 100 | Attack Time 0 | in ms |
| release[0-3] | 0 : 500 | Release Time 0 | in ms |
| ratio[0-3] | 1 : 16 | Ratio 0 | |
| makeUpGain[0-3] | -10 : 20 | MakUp Gain 0 | in dB |
| bypass[0-3] | 0 : 1 | Bypass band 0 | 0: compression enabled, 1: compression bypassed |
| solo[0-3] | 0 : 1 | Solo band 0 | 0: solo disabled, 1: solo enabled |
MultiEncoder
Note: replace [0-63] by a number to select the input channel (1-64, 1 offset).
Generic Commands
| Command | Range / Arguments | Description | Note |
|---|---|---|---|
| inputSetting | 0 : 64 | Number of input channels | 0: auto |
| orderSetting | 0 : 8 | Ambisonics Order | 0: auto, 1: 0th, 2: 1st, …, 8: 7th |
| useSN3D | 0 : 1 | Normalization | 0: N3D, 1: SN3D |
| masterAzimuth | -180 : 180 | Master azimuth angle | |
| masterElevation | -180 : 180 | Master elevation angle | |
| masterRoll | -180 : 180 | Master roll angle | |
| lockedToMaster | 0 : 1 | Lock Directions relative to Master | |
| azimuth[0-63] | -180 : 180 | Azimuth angle [1-64] | |
| elevation[0-63] | -180 : 180 | Elevation angle [1-64] | |
| gain[0-63] | -60 : 10 | Gain [1-64] | |
| mute[0-63] | 0 : 1 | Mute input [1-64] | |
| solo[0-63] | 0 : 1 | Solo input [1-64] |
MultiEQ
| Command | Range / Arguments | Description | Note |
|---|---|---|---|
| inputChannelsSetting | 0 : 64 | Number of input channels | |
| filterEnabled0 | 0 : 1 | Filter Enablement 1 | 0: off, 1: on |
| filterType0 | 0 : 3 | Filter Type 1 | 0: HP (6dB/oct), 1: HP (12dB/oct), 2: HP (24dB/oct), 3: Low-Shelf |
| filterFrequency0 | 20 : 20000 | Filter Frequency 1 | in Hz |
| filterQ0 | 0.05 : 8 | Filter Q 1 | |
| filterGain0 | -60 : 15 | Filter Gain 1 | in dB |
| filterEnabled1 | 0 : 1 | Filter Enablement 2 | 0: off, 1: on |
| filterType1 | 0 : 2 | Filter Type 2 | 0: Low-Shelf, 1: Peak, 2: High-Shelf |
| filterFrequency1 | 20 : 20000 | Filter Frequency 2 | in Hz |
| filterQ1 | 0.05 : 8 | Filter Q 2 | |
| filterGain1 | -60 : 15 | Filter Gain 2 | in dB |
| filterEnabled2 | 0 : 1 | Filter Enablement 3 | 0: off, 1: on |
| filterType2 | 0 : 2 | Filter Type 3 | 0: Low-Shelf, 1: Peak, 2: High-Shelf |
| filterFrequency2 | 20 : 20000 | Filter Frequency 3 | in Hz |
| filterQ2 | 0.05 : 8 | Filter Q 3 | |
| filterGain2 | -60 : 15 | Filter Gain 3 | in dB |
| filterEnabled3 | 0 : 1 | Filter Enablement 4 | 0: off, 1: on |
| filterType3 | 0 : 2 | Filter Type 4 | 0: Low-Shelf, 1: Peak, 2: High-Shelf |
| filterFrequency3 | 20 : 20000 | Filter Frequency 4 | in Hz |
| filterQ3 | 0.05 : 8 | Filter Q 4 | |
| filterGain3 | -60 : 15 | Filter Gain 4 | in dB |
| filterEnabled4 | 0 : 1 | Filter Enablement 5 | 0: off, 1: on |
| filterType4 | 0 : 2 | Filter Type 5 | 0: Low-Shelf, 1: Peak, 2: High-Shelf |
| filterFrequency4 | 20 : 20000 | Filter Frequency 5 | in Hz |
| filterQ4 | 0.05 : 8 | Filter Q 5 | |
| filterGain4 | -60 : 15 | Filter Gain 5 | in dB |
| filterEnabled5 | 0 : 1 | Filter Enablement 6 | 0: off, 1: on |
| filterType5 | 0 : 3 | Filter Type 6 | 0: LP (6dB/oct), 1: LP (12dB/oct), 2: LP (24dB/oct), 3: High-Shelf |
| filterFrequency5 | 20 : 20000 | Filter Frequency 6 | in Hz |
| filterQ5 | 0.05 : 8 | Filter Q 6 | |
| filterGain5 | -60 : 15 | Filter Gain 6 | in dB |
OmniCompressor
Generic Commands
| Command | Range / Arguments | Description | Note |
|---|---|---|---|
| orderSetting | 0 : 8 | Ambisonics Order | 0: auto, 1: 0th, 2: 1st, …, 8: 7th |
| useSN3D | 0 : 1 | Normalization | 0: N3D, 1: SN3D |
| threshold | -50 : 10 | Threshold | |
| knee | 0 : 30 | Knee | |
| attack | 0 : 100 | Attack Time | |
| release | 0 : 500 | Release Time | |
| ratio | 1 : 16 | Ratio | |
| outGain | -10 : 20 | MakeUp Gain | |
| lookAhead | 0 : 1 | LookAhead | |
| reportLatency | 0 : 1 | Report Latency to DAW |
ProbeDecoder
Generic Commands
| Command | Range / Arguments | Description | Note |
|---|---|---|---|
| orderSetting | 0 : 8 | Ambisonics Order | 0: auto, 1: 0th, 2: 1st, …, 8: 7th |
| useSN3D | 0 : 1 | Normalization | 0: N3D, 1: SN3D |
| azimuth | -180 : 180 | Azimuth angle | |
| elevation | -180 : 180 | Elevation angle |
RoomEncoder
Generic Commands
| Command | Range / Arguments | Description | Note |
|---|---|---|---|
| directivityOrderSetting | 0 : 8 | Input Directivity Order | 0: auto, 1: 0th, 2: 1st, …, 8: 7th |
| inputIsSN3D | 0 : 1 | Input Directivity Normalization | 0: N3D, 1: SN3D |
| orderSetting | 0 : 8 | Output Ambisonics Order | 0: auto, 1: 0th, 2: 1st, …, 8: 7th |
| useSN3D | 0 : 1 | Normalization | 0: N3D, 1: SN3D |
| roomX | 1 : 30 | room size x | in m |
| roomY | 1 : 30 | room size y | in m |
| roomZ | 1 : 20 | room size z | in m |
| sourceX | -15 : 15 | source position x | in m |
| sourceY | -15 : 15 | source position y | in m |
| sourceZ | -10 : 10 | source position z | in m |
| listenerX | -15 : 15 | listener position x | in m |
| listenerY | -15 : 15 | listener position y | in m |
| listenerZ | -10 : 10 | listener position z | in m |
| numRefl | 0 : 236 | number of reflections | |
| lowShelfFreq | 20 : 20000 | LowShelf Frequency | in Hz |
| lowShelfGain | -15 : 5 | LowShelf Gain | in dB |
| highShelfFreq | 20 : 20000 | HighShelf Frequency | in Hz |
| highShelfGain | -15 : 5 | HighShelf Gain | in dB |
| reflCoeff | -15 : 0 | Reflection Coefficient | in dB |
| syncChannel | 0 : 4 | Synchronize to Channel | |
| syncRoomSize | 0 : 1 | Synchronize Room Dimensions | 0: sync off, 1: sync on |
| syncReflection | 0 : 1 | Synchronize Reflection Properties | 0: sync off, 1: sync on |
| syncListener | 0 : 1 | Synchronize Listener Position | 0: sync off, 1: sync on |
| renderDirectPath | 0 : 1 | Render Direct Path | |
| wallAttenuationFront | -50 : 0 | Front wall attenuation | in dB |
| wallAttenuationBack | -50 : 0 | Back wall attenuation | in dB |
| wallAttenuationLeft | -50 : 0 | Left wall attenuation | in dB |
| wallAttenuationRight | -50 : 0 | Right wall attenuation | in dB |
| wallAttenuationCeiling | -50 : 0 | Ceiling attenuation | in dB |
| wallAttenuationFloor | -50 : 0 | Floor attenuation | in dB |
SimpleDecoder
Generic Commands
| Command | Range / Arguments | Description | Note |
|---|---|---|---|
| inputOrderSetting | 0 : 8 | Input Ambisonic Order | 0: auto, 1: 0th, 2: 1st, …, 8: 7th |
| useSN3D | 0 : 1 | Normalization | 0: N3D, 1: SN3D |
| lowPassFrequency | 20 : 300 | LowPass Cutoff Frequency | |
| lowPassGain | -20 : 10 | LowPass Gain | |
| highPassFrequency | 20 : 300 | HighPass Cutoff Frequency | |
| swMode | 0 : 2 | Subwoofer Mode | 0: none, 1: discrete, 2: virtual |
| swChannel | 1 : 64 | SW Channel Number |
Additional Commands
| Command | Range / Arguments | Description |
|---|---|---|
| loadFile | absolute path as string | loads configuration file |
SceneRotator
Generic Commands
| Command | Range / Arguments | Description | Note |
|---|---|---|---|
| orderSetting | 0 : 8 | Ambisonics Order | 0: auto, 1: 0th, 2: 1st, …, 8: 7th |
| useSN3D | 0 : 1 | Normalization | 0: N3D, 1: SN3D |
| yaw | -180 : 180 | Yaw Angle | |
| pitch | -180 : 180 | Pitch Angle | |
| roll | -180 : 180 | Roll Angle | |
| qw | -1 : 1 | Quaternion W | |
| qx | -1 : 1 | Quaternion X | |
| qy | -1 : 1 | Quaternion Y | |
| qz | -1 : 1 | Quaternion Z | |
| invertYaw | 0 : 1 | Invert Yaw | 0: false, 1: true |
| invertPitch | 0 : 1 | Invert Pitch | 0: false, 1: true |
| invertRoll | 0 : 1 | Invert Roll | 0: false, 1: true |
| invertQuaternion | 0 : 1 | Invert Quaternion | 0: false, 1: true |
| rotationSequence | 0 : 1 | Sequence of Rotations | 0: Yaw->Pitch->Roll, 1: Roll->Pitch->Yaw |
Additional Commands
| Command | Range / Arguments | Description |
|---|---|---|
| quaternions | qw qx qy qz | sets all quaternion components at once |
| ypr | yaw pitch roll | sets all euler angles at once |
StereoEncoder
Generic Commands
| Command | Range / Arguments | Description | Note |
|---|---|---|---|
| orderSetting | 0 : 8 | Ambisonics Order | 0: auto, 1: 0th, 2: 1st, …, 8: 7th |
| useSN3D | 0 : 1 | Normalization | 0: N3D, 1: SN3D |
| qw | -1 : 1 | Quaternion W | |
| qx | -1 : 1 | Quaternion X | |
| qy | -1 : 1 | Quaternion Y | |
| qz | -1 : 1 | Quaternion Z | |
| azimuth | -180 : 180 | Azimuth Angle | |
| elevation | -180 : 180 | Elevation Angle | |
| roll | -180 : 180 | Roll Angle | |
| width | -360 : 360 | Stereo Width | |
| highQuality | 0 : 1 | Sample-wise Panning |
Additional Commands
| Command | Range / Arguments | Description |
|---|---|---|
| quaternions | qw qx qy qz | sets all quaternion components at once |
ToolBox
Generic Commands
| Command | Range / Arguments | Description | Note |
|---|---|---|---|
| inputOrderSetting | 0 : 8 | Input Ambisonic Order | 0: auto, 1: 0th, 2: 1st, …, 8: 7th |
| useSn3dInput | 0 : 1 | Input Normalization | 0: N3D, 1: SN3D |
| outputOrderSetting | 0 : 8 | Output Ambisonic Order | 0: auto, 1: 0th, 2: 1st, …, 8: 7th |
| useSn3dOutput | 0 : 1 | Output Normalization | 0: N3D, 1: SN3D |
| flipX | 0 : 1 | Flip X axis | |
| flipY | 0 : 1 | Flip Y axis | |
| flipZ | 0 : 1 | Flip Z axis | |
| loaWeights | 0 : 2 | Lower Order Ambisonic Weighting | 0: off, 0: maxrE, 1: inPhase |
| gain | -50 : 24 | Gain | in dB |
