Classes | |
| struct | _CarlaPluginDiscoveryMetadata |
| struct | _CarlaPluginDiscoveryIO |
| struct | _CarlaPluginDiscoveryInfo |
| struct | _CarlaCachedPluginInfo |
Typedefs | |
| typedef void * | CarlaPluginDiscoveryHandle |
| typedef struct _CarlaPluginDiscoveryMetadata | CarlaPluginDiscoveryMetadata |
| typedef struct _CarlaPluginDiscoveryIO | CarlaPluginDiscoveryIO |
| typedef struct _CarlaPluginDiscoveryInfo | CarlaPluginDiscoveryInfo |
| typedef void(* | CarlaPluginDiscoveryCallback) (void *ptr, const CarlaPluginDiscoveryInfo *info, const char *sha1) |
| typedef bool(* | CarlaPluginCheckCacheCallback) (void *ptr, const char *filename, const char *sha1) |
| typedef struct _CarlaCachedPluginInfo | CarlaCachedPluginInfo |
| typedef void * | CarlaPipeClientHandle |
| typedef void(* | CarlaPipeCallbackFunc) (void *ptr, const char *msg) |
Detailed Description
The Carla Utils API.
This API allows to call advanced features from Python.
Typedef Documentation
◆ CarlaCachedPluginInfo
| typedef struct _CarlaCachedPluginInfo CarlaCachedPluginInfo |
Information about a cached plugin.
- See also
- carla_get_cached_plugin_info()
◆ CarlaPipeCallbackFunc
Callback for when a message has been received (in the context of carla_pipe_client_idle()). If extra data is required, use any of the carla_pipe_client_readlineblock* functions.
◆ CarlaPipeClientHandle
| typedef void* CarlaPipeClientHandle |
◆ CarlaPluginCheckCacheCallback
Optional callback triggered before starting to scan a plugin binary. This allows to load plugin information from cache and skip scanning for that binary. Return true to skip loading the binary specified by filename.
◆ CarlaPluginDiscoveryCallback
| typedef void(* CarlaPluginDiscoveryCallback) (void *ptr, const CarlaPluginDiscoveryInfo *info, const char *sha1) |
Callback triggered when either a plugin has been found, or a scanned binary contains no plugins.
For the case of plugins found while discovering info will be valid. On formats where discovery is expensive, sha1 will contain a string hash related to the binary being scanned.
When a plugin binary contains no actual plugins, info will be null but sha1 is valid. This allows to mark a plugin binary as scanned, even without plugins, so we dont bother to check again next time.
- Note
- This callback might be triggered multiple times for a single binary, and thus for a single hash too.
◆ CarlaPluginDiscoveryHandle
| typedef void* CarlaPluginDiscoveryHandle |
◆ CarlaPluginDiscoveryInfo
| typedef struct _CarlaPluginDiscoveryInfo CarlaPluginDiscoveryInfo |
Plugin discovery information.
◆ CarlaPluginDiscoveryIO
| typedef struct _CarlaPluginDiscoveryIO CarlaPluginDiscoveryIO |
Plugin discovery input/output information. These are extra fields not required for loading plugins but still useful for extra filtering.
◆ CarlaPluginDiscoveryMetadata
| typedef struct _CarlaPluginDiscoveryMetadata CarlaPluginDiscoveryMetadata |
Plugin discovery meta-data. These are extra fields not required for loading plugins but still useful for showing to the user.
Function Documentation
◆ 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_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_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, LV2 and SFZ plugin formats are cached and can be discovered via this function. Do not call this for any other plugin formats.
◆ 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.
◆ 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_desktop_scale_factor()
| CARLA_PLUGIN_EXPORT double carla_get_desktop_scale_factor | ( | void | ) |
Get the global/desktop scale factor.
◆ carla_get_juce_version()
| CARLA_PLUGIN_EXPORT const char * carla_get_juce_version | ( | void | ) |
- Deprecated
- do not use
Get the juce version used 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_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_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_juce_cleanup()
| CARLA_PLUGIN_EXPORT void carla_juce_cleanup | ( | void | ) |
- Deprecated
- do not use
◆ carla_juce_idle()
| CARLA_PLUGIN_EXPORT void carla_juce_idle | ( | void | ) |
- Deprecated
- do not use
◆ carla_juce_init()
| CARLA_PLUGIN_EXPORT void carla_juce_init | ( | void | ) |
- Deprecated
- do not use
◆ carla_pipe_client_destroy()
| CARLA_PLUGIN_EXPORT void carla_pipe_client_destroy | ( | CarlaPipeClientHandle | handle | ) |
Destroy a previously created pipes instance.
◆ carla_pipe_client_flush()
| CARLA_PLUGIN_EXPORT bool carla_pipe_client_flush | ( | CarlaPipeClientHandle | handle | ) |
◆ carla_pipe_client_flush_and_unlock()
| CARLA_PLUGIN_EXPORT bool carla_pipe_client_flush_and_unlock | ( | CarlaPipeClientHandle | handle | ) |
◆ carla_pipe_client_idle()
| CARLA_PLUGIN_EXPORT void carla_pipe_client_idle | ( | CarlaPipeClientHandle | handle | ) |
Check the pipe for new messages and send them to the callback function.
◆ carla_pipe_client_is_running()
| CARLA_PLUGIN_EXPORT bool carla_pipe_client_is_running | ( | CarlaPipeClientHandle | handle | ) |
Check if the pipe is running.
◆ carla_pipe_client_lock()
| CARLA_PLUGIN_EXPORT void carla_pipe_client_lock | ( | CarlaPipeClientHandle | handle | ) |
Lock the pipe write mutex.
◆ carla_pipe_client_new()
| CARLA_PLUGIN_EXPORT CarlaPipeClientHandle carla_pipe_client_new | ( | const char * | argv[], |
| CarlaPipeCallbackFunc | callbackFunc, | ||
| void * | callbackPtr ) |
Create and connect to pipes as used by a server. argv must match the arguments set the by server.
◆ carla_pipe_client_readlineblock()
| CARLA_PLUGIN_EXPORT const char * carla_pipe_client_readlineblock | ( | CarlaPipeClientHandle | handle, |
| uint | timeout ) |
Read the next line as a string.
◆ carla_pipe_client_readlineblock_bool()
| CARLA_PLUGIN_EXPORT bool carla_pipe_client_readlineblock_bool | ( | CarlaPipeClientHandle | handle, |
| uint | timeout ) |
Read the next line as a boolean.
◆ carla_pipe_client_readlineblock_float()
| CARLA_PLUGIN_EXPORT double carla_pipe_client_readlineblock_float | ( | CarlaPipeClientHandle | handle, |
| uint | timeout ) |
Read the next line as a floating point number (double precision).
◆ carla_pipe_client_readlineblock_int()
| CARLA_PLUGIN_EXPORT int carla_pipe_client_readlineblock_int | ( | CarlaPipeClientHandle | handle, |
| uint | timeout ) |
Read the next line as an integer.
◆ carla_pipe_client_sync()
| CARLA_PLUGIN_EXPORT bool carla_pipe_client_sync | ( | CarlaPipeClientHandle | handle | ) |
Sync all messages currently in cache. This call will forcely write any messages in cache to any relevant IO.
◆ carla_pipe_client_sync_and_unlock()
| CARLA_PLUGIN_EXPORT bool carla_pipe_client_sync_and_unlock | ( | CarlaPipeClientHandle | handle | ) |
Convenience call for doing both sync and unlock in one-go.
◆ carla_pipe_client_unlock()
| CARLA_PLUGIN_EXPORT void carla_pipe_client_unlock | ( | CarlaPipeClientHandle | handle | ) |
Unlock the pipe write mutex.
◆ carla_pipe_client_write_and_fix_msg()
| CARLA_PLUGIN_EXPORT bool carla_pipe_client_write_and_fix_msg | ( | CarlaPipeClientHandle | handle, |
| const char * | msg ) |
Write and fix a message.
◆ carla_pipe_client_write_msg()
| CARLA_PLUGIN_EXPORT bool carla_pipe_client_write_msg | ( | CarlaPipeClientHandle | handle, |
| const char * | msg ) |
Write a valid message. A valid message has only one '
' character and it's at the end.
◆ carla_plugin_discovery_idle()
| CARLA_PLUGIN_EXPORT bool carla_plugin_discovery_idle | ( | CarlaPluginDiscoveryHandle | handle | ) |
Continue discovering plugins, triggering callbacks along the way. Returns false when there is nothing else to scan, then you MUST call carla_plugin_discovery_stop.
◆ carla_plugin_discovery_set_option()
| CARLA_PLUGIN_EXPORT void carla_plugin_discovery_set_option | ( | EngineOption | option, |
| int | value, | ||
| const char * | valueStr ) |
Set a plugin discovery setting, to be applied globally.
◆ carla_plugin_discovery_skip()
| CARLA_PLUGIN_EXPORT void carla_plugin_discovery_skip | ( | CarlaPluginDiscoveryHandle | handle | ) |
Skip the current plugin being discovered. Carla automatically skips a plugin if 30s have passed without a reply from the discovery side, this function allows to manually abort earlier than that.
◆ carla_plugin_discovery_start()
| CARLA_PLUGIN_EXPORT CarlaPluginDiscoveryHandle carla_plugin_discovery_start | ( | const char * | discoveryTool, |
| BinaryType | btype, | ||
| PluginType | ptype, | ||
| const char * | pluginPath, | ||
| CarlaPluginDiscoveryCallback | discoveryCb, | ||
| CarlaPluginCheckCacheCallback | checkCacheCb, | ||
| void * | callbackPtr ) |
Start plugin discovery with the selected tool (must be absolute filename to executable file). Different plugin types/formats must be scanned independently. The path specified by @pluginPath can contain path separators (so ";" on Windows, ":" everywhere else). The discoveryCb is required, while checkCacheCb is optional.
Returns a non-null handle if there are plugins to be scanned. carla_plugin_discovery_idle must be called at regular intervals afterwards.
◆ carla_plugin_discovery_stop()
| CARLA_PLUGIN_EXPORT void carla_plugin_discovery_stop | ( | CarlaPluginDiscoveryHandle | handle | ) |
Stop plugin discovery. Can be called early while the scanning is still active.
◆ carla_set_process_name()
| CARLA_PLUGIN_EXPORT void carla_set_process_name | ( | const char * | name | ) |
Set the current process name to name.
◆ carla_x11_get_window_pos()
| CARLA_PLUGIN_EXPORT int * carla_x11_get_window_pos | ( | uintptr_t | winId | ) |
◆ carla_x11_move_window()
| CARLA_PLUGIN_EXPORT void carla_x11_move_window | ( | uintptr_t | winId, |
| int | x, | ||
| int | y ) |
◆ carla_x11_reparent_window()
| CARLA_PLUGIN_EXPORT void carla_x11_reparent_window | ( | uintptr_t | winId1, |
| uintptr_t | winId2 ) |
Generated on for LMMS by
1.16.1