Zrythm
a highly automated and intuitive digital audio workstation
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Guile scripting interface.

Enumerations

enum  GuileScriptLanguage { GUILE_SCRIPT_LANGUAGE_SCHEME , GUILE_SCRIPT_LANGUAGE_ECMASCRIPT , NUM_GUILE_SCRIPT_LANGUAGES }
 

Functions

const char * guile_get_script_language_str (GuileScriptLanguage lang)
 
const char * guile_get_script_language_canonical_str (GuileScriptLanguage lang)
 
GuileScriptLanguage guile_get_script_language_from_str (const char *str)
 
int guile_init (int argc, char **argv)
 Inits the guile subsystem.
 
void guile_define_modules (void)
 Defines all available modules to be used by scripts.
 
char * guile_run_script (const char *script, GuileScriptLanguage lang)
 Runs the script and returns the output message in Pango markup.
 
bool guile_script_succeeded (const char *pango_markup)
 Returns whether the script succeeded based on the markup.
 
void guile_actions_channel_send_action_define_module (void)
 
void guile_actions_tracklist_selections_action_define_module (void)
 
void guile_actions_port_connection_action_define_module (void)
 
void guile_actions_undo_manager_define_module (void)
 
void guile_audio_channel_define_module (void)
 
void guile_audio_midi_note_define_module (void)
 
void guile_audio_midi_region_define_module (void)
 
void guile_audio_port_define_module (void)
 
void guile_audio_position_define_module (void)
 
void guile_audio_supported_file_define_module (void)
 
void guile_audio_track_define_module (void)
 
void guile_audio_track_processor_define_module (void)
 
void guile_audio_tracklist_define_module (void)
 
void guile_plugins_plugin_define_module (void)
 
void guile_plugins_plugin_manager_define_module (void)
 
void guile_project_define_module (void)
 
void guile_zrythm_define_module (void)
 
int guile_project_generator_generate_project_from_string (const char *script, const char *prj_path)
 Generates a Zrythm project from the script contained in script.
 
int guile_project_generator_generate_project_from_file (const char *filepath, const char *prj_path)
 Generates a Zrythm project from the filepath containing a generator script.
 

Variables

SCM position_type
 Guile function prefix.
 
SCM track_type
 
SCM tracklist_type
 

Detailed Description

Enumeration Type Documentation

◆ GuileScriptLanguage

enum GuileScriptLanguage

Definition at line 24 of file guile.h.

Function Documentation

◆ guile_define_modules()

void guile_define_modules ( void )

Defines all available modules to be used by scripts.

This must be called in guile mode.

◆ guile_project_generator_generate_project_from_file()

int guile_project_generator_generate_project_from_file ( const char * filepath,
const char * prj_path )

Generates a Zrythm project from the filepath containing a generator script.

Parameters
filepathPath of the script file.
prj_pathPath to save the project at.
Returns
Non-zero if fail.

◆ guile_project_generator_generate_project_from_string()

int guile_project_generator_generate_project_from_string ( const char * script,
const char * prj_path )

Generates a Zrythm project from the script contained in script.

Parameters
scriptScript content.
prj_pathPath to save the project at.
Returns
Non-zero if fail.

◆ guile_run_script()

char * guile_run_script ( const char * script,
GuileScriptLanguage lang )

Runs the script and returns the output message in Pango markup.

Parameters
scriptThe script to run as text.
langThe language of the script.

Variable Documentation

◆ position_type

SCM position_type
extern

Guile function prefix.

Macro.