Csound API  6.18
Attributes

Functions

PUBLIC MYFLT csoundGetSr (CSOUND *)
 Returns the number of audio sample frames per second. More...
 
PUBLIC MYFLT csoundGetKr (CSOUND *)
 Returns the number of control samples per second. More...
 
PUBLIC uint32_t csoundGetKsmps (CSOUND *)
 Returns the number of audio sample frames per control sample. More...
 
PUBLIC uint32_t csoundGetNchnls (CSOUND *)
 Returns the number of audio output channels. More...
 
PUBLIC uint32_t csoundGetNchnlsInput (CSOUND *csound)
 Returns the number of audio input channels. More...
 
PUBLIC MYFLT csoundGet0dBFS (CSOUND *)
 Returns the 0dBFS level of the spin/spout buffers. More...
 
PUBLIC MYFLT csoundGetA4 (CSOUND *)
 Returns the A4 frequency reference. More...
 
PUBLIC int64_t csoundGetCurrentTimeSamples (CSOUND *csound)
 Return the current performance time in samples. More...
 
PUBLIC int csoundGetSizeOfMYFLT (void)
 Return the size of MYFLT in bytes. More...
 
PUBLIC void * csoundGetHostData (CSOUND *)
 Returns host data. More...
 
PUBLIC void csoundSetHostData (CSOUND *, void *hostData)
 Sets host data. More...
 
PUBLIC int csoundSetOption (CSOUND *csound, const char *option)
 Set a single csound option (flag). More...
 
PUBLIC void csoundSetParams (CSOUND *csound, CSOUND_PARAMS *p)
 Configure Csound with a given set of parameters defined in the CSOUND_PARAMS structure. More...
 
PUBLIC void csoundGetParams (CSOUND *csound, CSOUND_PARAMS *p)
 Get the current set of parameters from a CSOUND instance in a CSOUND_PARAMS structure. More...
 
PUBLIC int csoundGetDebug (CSOUND *)
 Returns whether Csound is set to print debug messages sent through the DebugMsg() internal API function. More...
 
PUBLIC void csoundSetDebug (CSOUND *, int debug)
 Sets whether Csound prints debug messages from the DebugMsg() internal API function. More...
 
PUBLIC MYFLT csoundSystemSr (CSOUND *csound, MYFLT val)
 If val > 0, sets the internal variable holding the system HW sr. More...
 

Detailed Description

Function Documentation

◆ csoundGet0dBFS()

PUBLIC MYFLT csoundGet0dBFS ( CSOUND )

Returns the 0dBFS level of the spin/spout buffers.

◆ csoundGetA4()

PUBLIC MYFLT csoundGetA4 ( CSOUND )

Returns the A4 frequency reference.

◆ csoundGetCurrentTimeSamples()

PUBLIC int64_t csoundGetCurrentTimeSamples ( CSOUND csound)

Return the current performance time in samples.

◆ csoundGetDebug()

PUBLIC int csoundGetDebug ( CSOUND )

Returns whether Csound is set to print debug messages sent through the DebugMsg() internal API function.

Anything different to 0 means true.

◆ csoundGetHostData()

PUBLIC void* csoundGetHostData ( CSOUND )

Returns host data.

◆ csoundGetKr()

PUBLIC MYFLT csoundGetKr ( CSOUND )

Returns the number of control samples per second.

◆ csoundGetKsmps()

PUBLIC uint32_t csoundGetKsmps ( CSOUND )

Returns the number of audio sample frames per control sample.

◆ csoundGetNchnls()

PUBLIC uint32_t csoundGetNchnls ( CSOUND )

Returns the number of audio output channels.

Set through the nchnls header variable in the csd file.

◆ csoundGetNchnlsInput()

PUBLIC uint32_t csoundGetNchnlsInput ( CSOUND csound)

Returns the number of audio input channels.

Set through the nchnls_i header variable in the csd file. If this variable is not set, the value is taken from nchnls.

◆ csoundGetParams()

PUBLIC void csoundGetParams ( CSOUND csound,
CSOUND_PARAMS p 
)

Get the current set of parameters from a CSOUND instance in a CSOUND_PARAMS structure.

See csoundSetParams().

◆ csoundGetSizeOfMYFLT()

PUBLIC int csoundGetSizeOfMYFLT ( void  )

Return the size of MYFLT in bytes.

◆ csoundGetSr()

PUBLIC MYFLT csoundGetSr ( CSOUND )

Returns the number of audio sample frames per second.

◆ csoundSetDebug()

PUBLIC void csoundSetDebug ( CSOUND ,
int  debug 
)

Sets whether Csound prints debug messages from the DebugMsg() internal API function.

Anything different to 0 means true.

◆ csoundSetHostData()

PUBLIC void csoundSetHostData ( CSOUND ,
void *  hostData 
)

Sets host data.

◆ csoundSetOption()

PUBLIC int csoundSetOption ( CSOUND csound,
const char *  option 
)

Set a single csound option (flag).

Returns CSOUND_SUCCESS on success. NB: blank spaces are not allowed

◆ csoundSetParams()

PUBLIC void csoundSetParams ( CSOUND csound,
CSOUND_PARAMS p 
)

Configure Csound with a given set of parameters defined in the CSOUND_PARAMS structure.

These parameters are the part of the OPARMS struct that are configurable through command line flags. The CSOUND_PARAMS structure can be obtained using csoundGetParams(). These options should only be changed before performance has started.

◆ csoundSystemSr()

PUBLIC MYFLT csoundSystemSr ( CSOUND csound,
MYFLT  val 
)

If val > 0, sets the internal variable holding the system HW sr.

Returns the stored value containing the system HW sr.