OSC commands defined in BRT
Part of the BRT components is the definition of a set of OSC commands which the BRT Renderer application understands to dynamically configure the virtual scene. This is a complete list of all commands:
OSC Control Commands
/control/actionResult: Retrieve the result of the action performed in another application after receiving an OSC command./control/bufferFrames: Query the number of buffered audio frames./control/connect: Establish a connection with an IP and port./control/disconnect: Terminate the connection and unsubscribe from updates./control/frameSize: Request the audio frame size per channel./control/ping: Check if BeRTA is listening by sending an echo./control/sampleRate: Request the current audio sample rate./control/version: Retrieve the current BeRTA version./control/playCalibration: Start the calibration process./control/setCalibration: Set the calibration values./control/playCalibrationTest: Play the calibration test sound at a specified volume./control/stopCalibrationTest: Stop the calibration test sound playback./control/getSoundLevel: Get the current sound level./control/setSoundLevelLimit: Set the sound level limit to a specified volume./control/soundLevelAlert: Alert sent when the output sound level exceeds the threshold set in the limiter.
OSC Overall Commands
/play: Starts playback of file sources and streaming from input channels./pause: Pauses file sources and stops streaming from input channels./stop: Stops playback of file sources and streaming from input channels./removeAllSources: Removes all sound sources./playAndRecord: Records spatialized sound and data during playback./record: Records spatialised sound and data without real-time playback./enableModel: Enables or disables a model./modelGain: Sets the output gain of the model in dB.
Resources Commands
/resources/enableWoodworthITD: Enables or disables the calculation of the ITD using the Woodworth formula./resources/getBRIRInfo: Gets information about one of the loaded Binaural Room Impulse Responses (BRIR)./resources/getDirectivityTFInfo: Gets information about one of the loaded Directivity Transfer Functions./resources/getHRTFHeadRadius: Retrieves the head radius of one of the loaded HRTFs./resources/getHRTFInfo: Gets information about one of the loaded HRTFs./resources/getSOSFiltersInfo: Gets information about one of the loaded sets of Near Field Compensation filters./resources/loadBRIR: Loads a new Binaural Room Impulse Response from a SOFA file./resources/loadDirectivityTF: Loads a Directivity Transfer Function from a SOFA file./resources/loadHRTF: Loads a new HRTF from a SOFA file and assigns an identifier./resources/loadSOSFilters: Loads a set of Second Order Section filters from a SOFA file./resources/removeBRIR: Removes a Binaural Room Impulse Response from the loaded resources./resources/removeDirectivityTF: Removes a Directivity Transfer Function from the loaded resources./resources/removeHRTF: Removes an HRTF from the loaded resources./resources/removeSOSFilters: Removes a set of Near Field Compensation filters from the loaded resources./resources/restoreHRTFHeadRadius: Sets the HRTF head radius to the value stored in the SOFA file./resources/setHRTFHeadRadius: Sets the head radius to be stored in the HRTF.
Source Models Commands
/source/addLineIn: Adds a new source from an audio input channel./source/enableDirectivity: Enable or disable the directivity of a sound source./source/gain: Set the gain of a sound source in dB./source/location: Set the global location of a sound source./source/loadSource: Loads a new sound file and assigns an identifier./source/loop: Set loop mode for a sound source./source/mute: Mutes a specific sound source./source/orientation: Set the orientation (yaw, pitch, roll) of a sound source./source/pause: Pauses a specific sound source./source/play: Plays a specific sound source./source/playAndRecord: Record a file of specified duration with the source's audio and spatial information./source/record: Record a file of specified duration with the source's audio and spatial information without real-time playback./source/removeSource: Removes a sound source from the system./source/setDirectivity: Assign a directivity to a sound source./source/solo: Mutes all sources except the specified one./source/stop: Stops a specific sound source./source/unmute: Unmutes a previously muted sound source./source/unsolo: Unmute all sources except the specified one.
Listener Models Commands
/listener/enableInterpolation: Enable or disable interpolation among HRIRs./listener/enableITD: Enable or disable the simulation of Interaural Time Difference (ITD)./listener/enableModel: Enable or disable a listener model. (Deprecated, use '/enableModel' instead.)/listener/enableNearFieldEffect: Enable or disable Near Field Compensation (NFC) with HRTF./listener/enableParallaxCorrection: Enable or disable parallax correction for direction of arrival./listener/location: Set the global location of the listener in x, y, z coordinates./listener/orientation: Set the orientation of the listener in yaw, pitch, roll./listener/setAmbisonicsNormalization: Set the Ambisonics normalization type./listener/setAmbisonicsOrder: Set the Ambisonic encoding order./listener/setBRIR: Set a Binaural Room Impulse Response (BRIR) for the listener./listener/setHRTF: Set a Head-Related Transfer Function (HRTF) for the listener./listener/setSOSFilters: Set filters for Near Field Compensation (NFC) after HRTF convolution.
Environment Models Commands
/environment/enableDirectPath: Toggle the direct path source in the environment model./environment/enableModel: Enable or disable a specified environment model. (Deprecated, use '/enableModel' instead.)/environment/enableReverbPath: Toggle the reverb path sources in the environment model./environment/setShoeBoxRoom: Set up a shoebox-shaped room with specified dimensions./environment/setWallAbsorption: Set absorption coefficients for a wall.
Binaural Filters Commands
/binauralFilter/setSOSFilter: Set up sos filter for an specific listener./binauralFilter/enableModel: Enable or disable a specified binaural filter. (Deprecated, use '/enableModel' instead.)