Csound API  6.18
Instantiation

Functions

PUBLIC int csoundInitialize (int flags)
 Initialise Csound library with specific flags. More...
 
PUBLIC void csoundSetOpcodedir (const char *s)
 Sets an opcodedir override for csoundCreate() More...
 
PUBLIC CSOUNDcsoundCreate (void *hostData)
 Creates an instance of Csound. More...
 
PUBLIC int csoundLoadPlugins (CSOUND *csound, const char *dir)
 Loads all plugins from a given directory. More...
 
PUBLIC void csoundDestroy (CSOUND *)
 Destroys an instance of Csound. More...
 
PUBLIC int csoundGetVersion (void)
 Returns the version number times 1000 (5.00.0 = 5000). More...
 
PUBLIC int csoundGetAPIVersion (void)
 Returns the API version number times 100 (1.00 = 100). More...
 

Detailed Description

Function Documentation

◆ csoundCreate()

PUBLIC CSOUND* csoundCreate ( void *  hostData)

Creates an instance of Csound.

Returns an opaque pointer that must be passed to most Csound API functions. The hostData parameter can be NULL, or it can be a pointer to any sort of data; this pointer can be accessed from the Csound instance that is passed to callback routines.

◆ csoundDestroy()

PUBLIC void csoundDestroy ( CSOUND )

Destroys an instance of Csound.

◆ csoundGetAPIVersion()

PUBLIC int csoundGetAPIVersion ( void  )

Returns the API version number times 100 (1.00 = 100).

◆ csoundGetVersion()

PUBLIC int csoundGetVersion ( void  )

Returns the version number times 1000 (5.00.0 = 5000).

◆ csoundInitialize()

PUBLIC int csoundInitialize ( int  flags)

Initialise Csound library with specific flags.

This function is called internally by csoundCreate(), so there is generally no need to use it explicitly unless you need to avoid default initilization that sets signal handlers and atexit() callbacks. Return value is zero on success, positive if initialisation was done already, and negative on error.

◆ csoundLoadPlugins()

PUBLIC int csoundLoadPlugins ( CSOUND csound,
const char *  dir 
)

Loads all plugins from a given directory.

◆ csoundSetOpcodedir()

PUBLIC void csoundSetOpcodedir ( const char *  s)

Sets an opcodedir override for csoundCreate()