Overall commands
These commands affects all sound sources and therefore, they don't need the /sourceprefix.
/play
Starts playing back all sources comming from audio files and starts streaming all sources comming form input channels.
Syntax
/play
Return
In case of success, an echo is sent to all subscribers except the sender, using the same syntax as the received message.
Example
BeRTA receives and echoes back to all subscribiers but the sender: /play.
/stop
Stops playing back all sources comming from audio files and also stops streaming all sources comming form input channels.
Syntax
/stop
Return
In case of success, an echo is sent to all subscribers except the sender, using the same syntax as the received message.
Example
BeRTA receives and echoes back to all subscribiers but the sender: /stop.
/pause
Pauses all sources comming from audio files and stops streaming all sources comming form input channels. While file sources will resume with a later play at the same point they were paused, for sources connected to an input channel the effect of /pause is identical to the effect of /stop.
Syntax
/pause
Return
In case of success, an echo is sent to all subscribers except the sender, using the same syntax as the received message.
Example
BeRTA receives and echoes back to all subscribiers but the sender: /pause.
/removeAllSources
Removes all sources.
Syntax
/removeAllSources
Return
In case of success, an echo is sent to all subscribers except the sender, using the same syntax as the received message.
Example
BeRTA receives and echoes back to all subscribiers but the sender:/removeAllSources.
/playAndRecord
Records a file of the specified duration with spatialised sound (wav) and other data (mat) corresponding to the playback of all sources from the beginning. If the type is mat, the produced file will follow the structure of the AnnotatedReceiverAudio SOFA convention. Before starting the recording, all sources are stopped and played back since the begining.
Syntax
/playAndRecord <String filename> <String type> <float time>
filename: indicates the name of the file and must include the path, either relative or absolute. If a relative path is used it will be calculated from the data folder that can be found in the same folder as the BeRTA executable. The extension will be added by the application if necessary. If there is a file with the same name, it’ll not be overwritten, an ordinal number will be added to the end of the new file name.
type: indicates the extension of the file: wav (not implemented yet) or a mat (matlab binary data container).
time: indicates the duration of the recording in seconds. If time is -1 the recording will finish automatically when the source stops.
Return
/control/actionResult /playAndRecord <string filename> <boolean success> <string description>.
The return confirmation refers to the filename, indicating success=true if the action has been successfully performed and set=false if not. In both cases a description is added to give more details.
It sends an echo to all subscribers excepting the sender: /playAndRecord <String filename> <String type> <float time>
Example
BeRTA receives and echoes back to all subscribiers but the sender: /playAndRecord c:/tmp/file.mat mat 10
When the recording is finished (in this example after 10 seconds), BeRTA sends back to all subscribers: /control/actionResult /playAndRecord c:/tmp/file.mat true Recording completed. File saved : c:/tmp/file.mat or /control/actionResult /playAndRecord c:/tmp/file.mat false ERROR:Recording failed. File could not be created.
/record
Available from BeRTA v3.7.0
Generates a file of the specified duration with spatialised sound (wav) and other data (mat) by processing all sources from the beginning without real-time playback. This allows the operation to be executed significantly faster. If the type is mat, the produced file will follow the structure of the AnnotatedReceiverAudio SOFA convention. All sources are stopped and processed from the beginning before the recording starts.
Syntax
/record <String filename> <String type> <float time>
filename: indicates the name of the file and must include the path, either relative or absolute. If a relative path is used it will be calculated from the data folder that can be found in the same folder as the BeRTA executable. The extension will be added by the application if necessary. If there is a file with the same name, it’ll not be overwritten—an ordinal number will be added to the end of the new file name.
type: indicates the extension of the file: wav (not implemented yet) or mat (MATLAB binary data container).
time: indicates the duration of the recording in seconds. This value must be greater than 0. Unlike /playAndRecord, the special value -1 is not allowed.
Return
/control/actionResult /record <string filename> <boolean success> <string description>.
The return confirmation refers to the filename, indicating success=true if the action has been successfully performed and success=false if not. In both cases a description is added to give more details.
It sends an echo to all subscribers except the sender: /record <String filename> <String type> <float time>
Example
BeRTA receives and echoes back to all subscribers except the sender: /record c:/tmp/file.mat mat 10
When the processing is finished (in this example after 10 seconds), BeRTA sends back to all subscribers:
/control/actionResult /record c:/tmp/file.mat true Recording completed. File saved : c:/tmp/file.mat
or
/control/actionResult /record c:/tmp/file.mat false ERROR:Recording failed. File could not be created.
/enableModel
Available from BeRTA v3.6.0
This command enables or disables a model. This function is implemented in all listener, environment models and in all binaural filters. The model to be enabled or disabled is identified by an identifier defined in the configuration file used. When a model is deactivated it does not process the input signal and provides:
- Silence on its output in the case of listener models.
- Let the signal pass through unaltered in the case of environment models and binaural filters.
Syntax
/enableModel <string model_id> <boolean enable>
model_id: identifier assigned to the model.
enable: If true (1), enables the model. If false (0), the model is disabled and its output will be silent.
Return
/control/actionResult /enableModel <string model_id> <bool enable> <string description>
The return confirmation refers to the model_id, indicating enable=true if the model has been enabled and enable=false if not. In both cases a description is added to give more details.
In case of success, an echo is sent to all subscribers except the sender, using the same syntax as the received message.
Example
BeRTA receives and echoes back to all subscribiers but the sender:/enableModel DirectPath true
BeRTA sends back to the sender: /control/actionResult /enableModel DirectPath true "Listener model DirectPath enabled."
/modelGain
Available from BeRTA v3.6.0
This command sets the output gain of the model in dB. This is a gain that is applied to the model output after processing. A gain of 0 dB, default value, indicates that no gain is applied to the output samples after processing. The model to be enabled or disabled is identified by an identifier defined in the used settings file.
Syntax
/modelGain <string model_id> <float gain>
model_id: identifier assigned to the model.
gain: A floating value, expressed in dB, representing the gain. The model output is multiplied by \(10^{gain / 20}\).
Return
/control/actionResult /modelGain <string model_id> <bool setGain> <string description>
The return confirmation refers to the model_id, indicating setGain=true if the action has been successfully performed and setGain=false if not. In both cases a description is added to give more details.
In case of success, an echo is sent to all subscribers except the sender, using the same syntax as the received message.
Example
BeRTA receives and echoes back to all subscribiers but the sender:/modelGain DirectPath -3
BeRTA sends back to the sender: /control/actionResult /modelGain DirectPath true "Listener model DirectPath gain updated to -3dB."