OSC API for AC3Jack
The default OSC server port for ac3jack is 12314. It may be changed on the command line.
PING Engine
/ping s:return_path [s:return_url]
If engine is there, it will respond with to the given URL (or the sending port if not specified) and PATH
with an OSC message with arguments:
s:hosturl s:version i:loopcount
Read/Write Parameters
To GET the current values of these params, send an OSC message with the following form:
/param/NAME return_path [optional_return_uri]
If no return uri is specified it will send the response back to the host and port that made the request.
The response will look like:
[return_path] NAME <value>
To SET a writable parameter, send a message with the following form:
/param/NAME <value>
The following list of parameters are available:
channels [integer] Number of surround input channels (1-5)
lfe [int/bool] Enable LFE channel
encoder/bitrate [integer] Bitrate of AC3 output stream (32-640)
file_output [int/bool] Flag to enable file output
outfile_name [string] Filename to output AC3 file
duration [double] Duration of file output in seconds
input_connectable_ports [string] List of newline separated jack port names from all applications that may be connected
input_connections/center [string] A comma separated list of currently connected ports to our center channel input
input_connections/left [string] A comma separated list of currently connected ports to our left channel input
input_connections/left_surround [string] A comma separated list of currently connected ports to our left surround channel input
input_connections/lfe [string] A comma separated list of currently connected ports to our LFE channel input
input_connections/right [string] A comma separated list of currently connected ports to our right channel input
input_connections/right_surround [string] A comma separated list of currently connected ports to our right surround channel input
jack_out [int/bool] Enables raw ac3 spdif output via Jack output ports
jack_transport [int/bool] Only output ac3 file when jack transport is rolling
spdif_card [string] Card name for SPDIF output
spdif_devices [string] Comma separated list of SPDIF devices
spdif_out [int/bool] Enable SPDIF output
spdif_pcm [int/bool] Allow any audio output for SPDIF output to show up in spdif_devices list
spdif_status [string] Current status of SPDIF output
Read-only parameters
curr_file_duration [double] Seconds collected to output file
curr_file_size [int64] Current file size of output file
Register for Updates
/register s:retpath [ s:returl ]
/unregister s:retpath [ s:returl ]
If no return URL is passed the senders host and port will be used. All parameter changes will then be sent to
the specified retpath just as if the parameter was requested as described above.
/params_all return_path [return_url]
will cause all parameters to be sent back.