Carla Utils API

Classes
struct	CarlaCachedPluginInfo

Typedefs
typedef void *	CarlaPipeClientHandle
typedef void(*	CarlaPipeCallbackFunc) (void *ptr, const char *msg)

Functions
CARLA_PLUGIN_EXPORT uint	carla_get_cached_plugin_count (PluginType ptype, const char *pluginPath)
CARLA_PLUGIN_EXPORT const CarlaCachedPluginInfo *	carla_get_cached_plugin_info (PluginType ptype, uint index)
CARLA_PLUGIN_EXPORT const char *	carla_get_complete_license_text (void)
CARLA_PLUGIN_EXPORT const char *	carla_get_juce_version (void)
CARLA_PLUGIN_EXPORT const char *const *	carla_get_supported_file_extensions (void)
CARLA_PLUGIN_EXPORT const char *const *	carla_get_supported_features (void)
CARLA_PLUGIN_EXPORT const char *	carla_get_library_filename (void)
CARLA_PLUGIN_EXPORT const char *	carla_get_library_folder (void)
CARLA_PLUGIN_EXPORT void	carla_juce_init (void)
CARLA_PLUGIN_EXPORT void	carla_juce_idle (void)
CARLA_PLUGIN_EXPORT void	carla_juce_cleanup (void)
CARLA_PLUGIN_EXPORT CarlaPipeClientHandle	carla_pipe_client_new (const char *argv[], CarlaPipeCallbackFunc callbackFunc, void *callbackPtr)
CARLA_PLUGIN_EXPORT void	carla_pipe_client_idle (CarlaPipeClientHandle handle)
CARLA_PLUGIN_EXPORT bool	carla_pipe_client_is_running (CarlaPipeClientHandle handle)
CARLA_PLUGIN_EXPORT void	carla_pipe_client_lock (CarlaPipeClientHandle handle)
CARLA_PLUGIN_EXPORT void	carla_pipe_client_unlock (CarlaPipeClientHandle handle)
CARLA_PLUGIN_EXPORT const char *	carla_pipe_client_readlineblock (CarlaPipeClientHandle handle, uint timeout)
CARLA_PLUGIN_EXPORT bool	carla_pipe_client_readlineblock_bool (CarlaPipeClientHandle handle, uint timeout)
CARLA_PLUGIN_EXPORT int	carla_pipe_client_readlineblock_int (CarlaPipeClientHandle handle, uint timeout)
CARLA_PLUGIN_EXPORT double	carla_pipe_client_readlineblock_float (CarlaPipeClientHandle handle, uint timeout)
CARLA_PLUGIN_EXPORT bool	carla_pipe_client_write_msg (CarlaPipeClientHandle handle, const char *msg)
CARLA_PLUGIN_EXPORT bool	carla_pipe_client_write_and_fix_msg (CarlaPipeClientHandle handle, const char *msg)
CARLA_PLUGIN_EXPORT bool	carla_pipe_client_flush (CarlaPipeClientHandle handle)
CARLA_PLUGIN_EXPORT bool	carla_pipe_client_flush_and_unlock (CarlaPipeClientHandle handle)
CARLA_PLUGIN_EXPORT void	carla_pipe_client_destroy (CarlaPipeClientHandle handle)
CARLA_PLUGIN_EXPORT void	carla_fflush (bool err)
CARLA_PLUGIN_EXPORT void	carla_fputs (bool err, const char *string)
CARLA_PLUGIN_EXPORT void	carla_set_process_name (const char *name)
CARLA_PLUGIN_EXPORT double	carla_get_desktop_scale_factor (void)
CARLA_PLUGIN_EXPORT int	carla_cocoa_get_window (void *nsViewPtr)
CARLA_PLUGIN_EXPORT void	carla_cocoa_set_transient_window_for (void *nsViewChild, void *nsViewParent)
CARLA_PLUGIN_EXPORT void	carla_x11_reparent_window (uintptr_t winId1, uintptr_t winId2)
CARLA_PLUGIN_EXPORT void	carla_x11_move_window (uintptr_t winId, int x, int y)
CARLA_PLUGIN_EXPORT int *	carla_x11_get_window_pos (uintptr_t winId)

Detailed Description

The Carla Utils API.

This API allows to call advanced features from Python.

Typedef Documentation

CarlaPipeClientHandle

typedef void* CarlaPipeClientHandle

TODO.

CarlaPipeCallbackFunc

typedef void(* CarlaPipeCallbackFunc) (void *ptr, const char *msg)

TODO.

Function Documentation

carla_get_cached_plugin_count()

CARLA_PLUGIN_EXPORT uint carla_get_cached_plugin_count	(	PluginType	ptype,
		const char *	pluginPath )

Get how many cached plugins are available. Internal and LV2 plugin formats are cached and need to be discovered via this function. Do not call this for any other plugin formats.

Note

if this carla build uses JUCE, then you must call carla_juce_init beforehand

for AU plugins, you cannot call this outside the main thread

carla_get_cached_plugin_info()

CARLA_PLUGIN_EXPORT const CarlaCachedPluginInfo * carla_get_cached_plugin_info	(	PluginType	ptype,
		uint	index )

Get information about a cached plugin.

Note

if this carla build uses JUCE, then you must call carla_juce_init beforehand

for AU plugins, you cannot call this outside the main thread

carla_get_complete_license_text()

CARLA_PLUGIN_EXPORT const char * carla_get_complete_license_text

(

void

)

Get the complete license text of used third-party code and features. Returned string is in basic html format.

carla_get_juce_version()

CARLA_PLUGIN_EXPORT const char * carla_get_juce_version

(

void

)

Get the juce version used in the current Carla build.

carla_get_supported_file_extensions()

CARLA_PLUGIN_EXPORT const char *const * carla_get_supported_file_extensions

(

void

)

Get the list of supported file extensions in carla_load_file().

carla_get_supported_features()

CARLA_PLUGIN_EXPORT const char *const * carla_get_supported_features

(

void

)

Get the list of supported features in the current Carla build.

carla_get_library_filename()

CARLA_PLUGIN_EXPORT const char * carla_get_library_filename

(

void

)

Get the absolute filename of this carla library.

carla_get_library_folder()

CARLA_PLUGIN_EXPORT const char * carla_get_library_folder

(

void

)

Get the folder where this carla library resides.

carla_juce_init()

CARLA_PLUGIN_EXPORT void carla_juce_init

(

void

)

Initialize data structures and GUI support for JUCE. This is only needed when carla builds use JUCE and you call cached-plugin related APIs.

Idle must then be called at somewhat regular intervals, though in practice there is no reason for it yet.

Make sure to call carla_juce_cleanup after you are done with APIs that need JUCE.

carla_juce_idle()

CARLA_PLUGIN_EXPORT void carla_juce_idle

(

void

)

Give idle time to JUCE stuff. Currently only used for Linux.

carla_juce_cleanup()

CARLA_PLUGIN_EXPORT void carla_juce_cleanup

(

void

)

Cleanup the JUCE stuff that was initialized by carla_juce_init.

carla_pipe_client_new()

CARLA_PLUGIN_EXPORT CarlaPipeClientHandle carla_pipe_client_new	(	const char *	argv[],
		CarlaPipeCallbackFunc	callbackFunc,
		void *	callbackPtr )

TODO.

carla_pipe_client_idle()

CARLA_PLUGIN_EXPORT void carla_pipe_client_idle

(

CarlaPipeClientHandle

handle

)

TODO.

carla_pipe_client_is_running()

CARLA_PLUGIN_EXPORT bool carla_pipe_client_is_running

(

CarlaPipeClientHandle

handle

)

TODO.

carla_pipe_client_lock()

CARLA_PLUGIN_EXPORT void carla_pipe_client_lock

(

CarlaPipeClientHandle

handle

)

TODO.

carla_pipe_client_unlock()

CARLA_PLUGIN_EXPORT void carla_pipe_client_unlock

(

CarlaPipeClientHandle

handle

)

TODO.

carla_pipe_client_readlineblock()

CARLA_PLUGIN_EXPORT const char * carla_pipe_client_readlineblock	(	CarlaPipeClientHandle	handle,
		uint	timeout )

TODO.

carla_pipe_client_readlineblock_bool()

CARLA_PLUGIN_EXPORT bool carla_pipe_client_readlineblock_bool	(	CarlaPipeClientHandle	handle,
		uint	timeout )

Extras. TODO.

carla_pipe_client_readlineblock_int()

CARLA_PLUGIN_EXPORT int carla_pipe_client_readlineblock_int	(	CarlaPipeClientHandle	handle,
		uint	timeout )

carla_pipe_client_readlineblock_float()

CARLA_PLUGIN_EXPORT double carla_pipe_client_readlineblock_float	(	CarlaPipeClientHandle	handle,
		uint	timeout )

carla_pipe_client_write_msg()

CARLA_PLUGIN_EXPORT bool carla_pipe_client_write_msg	(	CarlaPipeClientHandle	handle,
		const char *	msg )

TODO.

carla_pipe_client_write_and_fix_msg()

CARLA_PLUGIN_EXPORT bool carla_pipe_client_write_and_fix_msg	(	CarlaPipeClientHandle	handle,
		const char *	msg )

TODO.

carla_pipe_client_flush()

CARLA_PLUGIN_EXPORT bool carla_pipe_client_flush

(

CarlaPipeClientHandle

handle

)

TODO.

carla_pipe_client_flush_and_unlock()

CARLA_PLUGIN_EXPORT bool carla_pipe_client_flush_and_unlock

(

CarlaPipeClientHandle

handle

)

TODO.

carla_pipe_client_destroy()

CARLA_PLUGIN_EXPORT void carla_pipe_client_destroy

(

CarlaPipeClientHandle

handle

)

TODO.

carla_fflush()

CARLA_PLUGIN_EXPORT void carla_fflush

(

bool

err

)

Flush stdout or stderr.

carla_fputs()

CARLA_PLUGIN_EXPORT void carla_fputs	(	bool	err,
		const char *	string )

Print the string string to stdout or stderr.

carla_set_process_name()

CARLA_PLUGIN_EXPORT void carla_set_process_name

(

const char *

name

)

Set the current process name to name.

carla_get_desktop_scale_factor()

CARLA_PLUGIN_EXPORT double carla_get_desktop_scale_factor

(

void

)

Get the global/desktop scale factor.

carla_cocoa_get_window()

CARLA_PLUGIN_EXPORT int carla_cocoa_get_window

(

void *

nsViewPtr

)

carla_cocoa_set_transient_window_for()

CARLA_PLUGIN_EXPORT void carla_cocoa_set_transient_window_for	(	void *	nsViewChild,
		void *	nsViewParent )

carla_x11_reparent_window()

CARLA_PLUGIN_EXPORT void carla_x11_reparent_window	(	uintptr_t	winId1,
		uintptr_t	winId2 )

carla_x11_move_window()

CARLA_PLUGIN_EXPORT void carla_x11_move_window	(	uintptr_t	winId,
		int	x,
		int	y )

carla_x11_get_window_pos()

CARLA_PLUGIN_EXPORT int * carla_x11_get_window_pos

(

uintptr_t

winId

)