Ctrl+K

runCsd

Contents

runCsd#

csoundengine.csoundlib.runCsd(csdfile, outdev='', indev='', backend='', nodisplay=False, nomessages=False, comment='', piped=False, extra=None)[source]#

Run the given .csd as a csound subprocess

Parameters:

  • csdfile (str) – the path to a .csd file

  • outdev – “dac” to output to the default device, the label of the device (dac0, dac1, …), or a filename to render offline (-o option)

  • indev – The input to use (for realtime) (-i option)

  • backend – The name of the backend to use. If no backend is given, the default for the platform is used (this is only meaningful if running in realtime)

  • nodisplay – if True, eliminates debugging info from output

  • nomessages – if True, suppress debugging messages

  • piped – if True, the output of the csound process is piped and can be accessed through the Popen object (.stdout, .stderr)

  • extra (list[str] | None) – a list of extraOptions arguments to be passed to csound

  • comment – if given, will be added to the generated output as comment metadata (when running offline)

Return type:

Popen

Returns:

the subprocess.Popen object. In order to wait until rendering is finished in offline mode, call .wait on the returned process

See also

Contents