Home

Awesome

sc_sclient

Build Status MIT licensed Join the community on Spectrum

Put options inside a configuration file, path to which you pass into Options at initialization. All of the parameters are optional. If a parameter isn't specified, the default value will be used. The next options are available:

OptionTypeDefaultDescription
addressString127.0.0.1An IP address.
block_sizeUnsigned Integer64The number of samples in one control period.
client_addressString127.0.0.1
client_portUnsigned Integer4243A port number 0-65535.
device_nameStringNoneName of the hardware I/O device. If not provided, the system's default device is used.
input_streams_enable_stringStringNoneAllows turning off input streams that you are not interested in on the device. If the string is 01100, for example, then only the second and third input streams on the device will be enabled. Turning off streams can reduce CPU load.
load_synth_defsBooleantrueIf false, then synth definitions will not be loaded on start up.
max_interconnect_buffersUnsigned Integer64The maximum number of buffers that are allocated for buffers to interconnect unit generators. Sets the limit of complexity of synth defs that can be loaded at runtime. This value will be increased if a more complex synth-def is loaded at start up time, but it cannot be increased once synthesis has begun.
max_loginsUnsigned Integer64Maximum number of named return addresses stored. Also maximum number of tcp connections accepted
max_nodesUnsigned Integer1024Maximum number of nodes
max_synth_defsUnsigned Integer1024Maximum number of synth definitions
num_audio_bus_channelsUnsigned Integer1024Number of audio bus channels. The space allocated for audio buses is: (numchannels * (blocksize + 1) * 4)
num_buffersUnsigned Integer1024Number of sample buffers
num_control_bus_channelsUnsigned Integer16384Number of control bus channels. The space allocated for control buses is: (numchannels * 8)
num_input_bus_channelsUnsigned Integer8Number of audio input bus channels
num_of_threadsUnsigned Integer2Number of audio threads.
num_output_bus_channelsUnsigned Integer8Number of audio output bus channels
output_streams_enable_stringStringNoneAllows turning off output streams that you are not interested in on the device. If the string is 11000, for example, then only the first two output streams on the device will be enabled. Turning off streams can reduce CPU load.
preferred_hardware_buffer_sizeUnsigned Integer0If non-zero, it will attempt to set the hardware buffer frame size.
preferred_sample_rateUnsigned Integer0 for scsynth and 44100 for supernovaIf non-zero, it will attempt to set the hardware sample rate.
publish_to_rendezvousBooleanfalse
random_number_generatorsUnsigned Integer64The number of seedable random number generators.
real_time_memory_sizeUnsigned Integer8192The number of kilobytes of real time memory. This memory is used to allocate synths and any memory that unit generators themselves allocate.
restricted_pathStringNoneIf specified, prevents file-accessing OSC commands from accessing files outside restricted_path.
session_passwordStringNoneWhen using TCP, the session password must be the first command sent. UDP ports never require passwords, so if password protection is desired, use TCP.
tcp_port_numberUnsigned Integer0A port number 0-65535. Only UDP supported. But the server will listen on TCP if you specify this option.
udp_port_numberUnsigned Integer4242A port number 0-65535. Only UDP supported.
ugen_plugins_pathArray of StringsNoneAn array of paths. If specified, standard paths are NOT searched for plugins.
verbosityInteger0Controls the verbosity of server messages. A value of 0 is normal behaviour. -1 suppresses informational messages. -2 suppresses informational and many error messages, as well as messages from Poll.

Note, scsynth has an issue whith setting the same sample rate, which was already set. The workaround is to use supernova or not to set preferred_sample_rate for scsynth (or set it to 0). Also you can set sample rate on your system's settings level.

Status