setCsoundLibrary: Get and set the Csound shared library for accessing Csound's...

In statisfactions/csound: Accessing Csound functionality through R

Get and set the Csound shared library for accessing Csound's functionality.

Description

Functions to get and set the option "csoundlibrary", which is used by all the functions in the package to actually access the functionality of Csound.

Usage

  getCsoundLibrary()

  setCsoundLibrary(path)

  .csoundGetVersion()

Arguments

path	A character string containing the path to the Csound shared library.

Details

The csound package attempts to find the library file automatically on startup and warns if it fails. In this case, you need to find the path to Csound's shared library (often a .so, .dll or .dylib, depending on the system). setCsoundLibrary will only actually set the option if it successfully locates and links to the library; if it fails to link it, it stops with an error.

Hopefully these options won't need to be accessed by most users, but they are provided as a backup.

Value

getCsoundLibrary() returns a pointer to the Csound library, with the path to the library passed as an attribute.

.csoundGetVersion() returns the version of Csound that is linked to; this is useful as a quick check to make sure everything has linked correctly.

See Also

getHeaderInfo

statisfactions/csound documentation built on Jan. 27, 2024, 1:33 p.m.