BSE Interface Reference

/opt/src/beast/docs/psource/bse-interface.scad

SYNOPSIS

struct  BseCategory;
struct  BseCategorySeq;
struct  BseDot;
struct  BseDotSeq;
struct  BseGConfig;
struct  BseIcon;
struct  BseIntSeq;
struct  BseItemSeq;
struct  BseMessage;
struct  BseMidiChannelEvent;
struct  BseNoteDescription;
struct  BseNoteSeq;
struct  BseNoteSequence;
struct  BsePartControl;
struct  BsePartControlSeq;
struct  BsePartLink;
struct  BsePartLinkSeq;
struct  BsePartNote;
struct  BsePartNoteSeq;
struct  BseProbe;
struct  BseProbeFeatures;
struct  BseProbeRequest;
struct  BseProbeRequestSeq;
struct  BseProbeSeq;
struct  BsePropertyCandidates;
struct  BseSampleFileInfo;
struct  BseSongTiming;
struct  BseStringSeq;
struct  BseThreadInfo;
struct  BseThreadInfoSeq;
struct  BseThreadTotals;
struct  BseTrackPart;
struct  BseTrackPartSeq;
struct  BseTypeSeq;
   
BseErrorType  bse_bus_connect_bus  (sbus, bus);
BseErrorType  bse_bus_connect_track  (sbus, track);
BseErrorType  bse_bus_disconnect_bus  (sbus, bus);
BseErrorType  bse_bus_disconnect_track  (sbus, track);
BseErrorType  bse_bus_ensure_output  (bus);
BseCategorySeq*  bse_categories_match  (pattern);
BseCategorySeq*  bse_categories_match_method  (pattern, type);
BseCategorySeq*  bse_categories_match_typed  (pattern, type);
BseCategory*  bse_category_from_id  (category_id);
BseItem*  bse_container_get_item  (container, item_type, seq_id);
BseItemSeq*  bse_container_list_children  (container);
BseItem*  bse_container_lookup_item  (container, uname);
SfiInt  bse_data_pocket_create_entry  (data_pocket);
BseErrorType  bse_data_pocket_delete_entry  (data_pocket, entry_id);
SfiReal  bse_data_pocket_get_float  (data_pocket, entry_id, name);
SfiInt  bse_data_pocket_get_int  (data_pocket, entry_id, name);
SfiInt  bse_data_pocket_get_n_entries  (data_pocket);
SfiInt  bse_data_pocket_get_nth_entry_id  (data_pocket, entry_index);
BseItem*  bse_data_pocket_get_object  (data_pocket, entry_id, name);
const gchar*  bse_data_pocket_get_string  (data_pocket, entry_id, name);
BseErrorType  bse_data_pocket_set_float  (data_pocket, entry_id, name, number);
BseErrorType  bse_data_pocket_set_int  (data_pocket, entry_id, name, number);
BseErrorType  bse_data_pocket_set_object  (data_pocket, entry_id, name, item);
BseErrorType  bse_data_pocket_set_string  (data_pocket, entry_id, name, string);
void  bse_editable_sample_close  (esample);
SfiFBlock*  bse_editable_sample_collect_stats  (esample, voffset, offset_scale, block_size, stepping, max_pairs);
SfiInt  bse_editable_sample_get_length  (esample);
SfiInt  bse_editable_sample_get_n_channels  (esample);
SfiReal  bse_editable_sample_get_osc_freq  (esample);
BseErrorType  bse_editable_sample_open  (esample);
SfiFBlock*  bse_editable_sample_read_samples  (esample, voffset);
const gchar*  bse_error_blurb  (error);
const gchar*  bse_error_name  (error);
void  bse_item_add_parasite  (item, path, parasite);
SfiBool  bse_item_check_is_a  (item, type_name);
void  bse_item_clear_undo  (item);
BseItem*  bse_item_common_ancestor  (item, item2);
SfiBool  bse_item_editable_property  (item, property_name);
SfiFBlock*  bse_item_fixme_get_parasite  (item, name);
void  bse_item_fixme_set_parasite  (item, name, parasite);
BseIcon*  bse_item_get_icon  (item);
const gchar*  bse_item_get_name  (item);
const gchar*  bse_item_get_name_or_type  (item);
SfiRec*  bse_item_get_parasite  (item, path);
BseItem*  bse_item_get_parent  (item);
BseItem*  bse_item_get_project  (item);
BsePropertyCandidates*  bse_item_get_property_candidates  (item, property_name);
SfiInt  bse_item_get_seqid  (item);
const gchar*  bse_item_get_type  (item);
const gchar*  bse_item_get_type_authors  (item);
const gchar*  bse_item_get_type_blurb  (item);
const gchar*  bse_item_get_type_license  (item);
const gchar*  bse_item_get_type_name  (item);
const gchar*  bse_item_get_uname_path  (item);
void  bse_item_group_undo  (item, name);
SfiBool  bse_item_internal  (item);
BseStringSeq*  bse_item_list_parasites  (item, path);
void  bse_item_redo  (item);
SfiInt  bse_item_redo_depth  (item);
void  bse_item_set_name  (item, name);
void  bse_item_set_parasite  (item, path, parasite);
void  bse_item_undo  (item);
SfiInt  bse_item_undo_depth  (item);
void  bse_item_ungroup_undo  (item);
void  bse_item_unuse  (item);
BseItem*  bse_item_use  (item);
const gchar*  bse_janitor_get_action  (janitor, nth_action);
const gchar*  bse_janitor_get_action_blurb  (janitor, nth_action);
const gchar*  bse_janitor_get_action_name  (janitor, nth_action);
const gchar*  bse_janitor_get_proc_name  (janitor);
const gchar*  bse_janitor_get_script_name  (janitor);
void  bse_janitor_kill  (janitor);
SfiInt  bse_janitor_n_actions  (janitor);
void  bse_janitor_trigger_action  (janitor, action);
SfiInt  bse_midi_notifier_current_time  (midi_notifier);
BseNoteDescription*  bse_note_construct  (musical_tuning, semitone, octave, fine_tune);
BseNoteDescription*  bse_note_describe  (musical_tuning, note, fine_tune);
BseNoteDescription*  bse_note_describe_from_freq  (musical_tuning, freq);
SfiInt  bse_note_from_freq  (musical_tuning, frequency);
BseNoteDescription*  bse_note_from_string  (musical_tuning, name);
SfiReal  bse_note_to_freq  (musical_tuning, note, fine_tune);
BseErrorType  bse_part_change_control  (part, id, tick, control_type, value);
BseErrorType  bse_part_change_note  (part, id, tick, duration, note, fine_tune, velocity);
BsePartNoteSeq*  bse_part_check_overlap  (part, tick, duration, note);
BseErrorType  bse_part_delete_event  (part, id);
void  bse_part_deselect_controls  (part, tick, duration, control_type);
void  bse_part_deselect_event  (part, id);
void  bse_part_deselect_notes  (part, tick, duration, min_note, max_note);
BsePartControlSeq*  bse_part_get_channel_controls  (part, channel, tick, duration, control_type);
BsePartControlSeq*  bse_part_get_controls  (part, tick, control_type);
SfiInt  bse_part_get_max_note  (part);
SfiInt  bse_part_get_min_note  (part);
BsePartNoteSeq*  bse_part_get_notes  (part, tick, note);
BseSongTiming*  bse_part_get_timing  (part, tick);
SfiInt  bse_part_insert_control  (part, tick, control_type, value);
SfiInt  bse_part_insert_note  (part, channel, tick, duration, note, fine_tune, velocity);
SfiInt  bse_part_insert_note_auto  (part, tick, duration, note, fine_tune, velocity);
SfiBool  bse_part_is_event_selected  (part, id);
BsePartControlSeq*  bse_part_list_controls  (part, tick, duration, control_type);
BsePartLinkSeq*  bse_part_list_links  (part);
BsePartNoteSeq*  bse_part_list_notes_crossing  (part, tick, duration);
BsePartNoteSeq*  bse_part_list_notes_within  (part, channel, tick, duration);
BsePartControlSeq*  bse_part_list_selected_controls  (part, control_type);
BsePartNoteSeq*  bse_part_list_selected_notes  (part);
void  bse_part_queue_controls  (part, tick, duration);
void  bse_part_queue_notes  (part, tick, duration, min_note, max_note);
void  bse_part_select_controls  (part, tick, duration, control_type);
void  bse_part_select_controls_exclusive  (part, tick, duration, control_type);
void  bse_part_select_event  (part, id);
void  bse_part_select_notes  (part, tick, duration, min_note, max_note);
void  bse_part_select_notes_exclusive  (part, tick, duration, min_note, max_note);
BseErrorType  bse_project_activate  (project);
void  bse_project_auto_deactivate  (project, msec_delay);
SfiBool  bse_project_can_play  (project);
void  bse_project_change_name  (project, name);
void  bse_project_clean_dirty  (project);
void  bse_project_clear_undo  (project);
BseCSynth*  bse_project_create_csynth  (project, name);
BseMidiSynth*  bse_project_create_midi_synth  (project, name);
BseSong*  bse_project_create_song  (project, name);
void  bse_project_deactivate  (project);
BseItem*  bse_project_find_item  (project, uname_path);
BseDataPocket*  bse_project_get_data_pocket  (project, name);
BseMidiNotifier*  bse_project_get_midi_notifier  (project);
BseProjectState  bse_project_get_state  (project);
BseItemSeq*  bse_project_get_supers  (project);
BseWaveRepo*  bse_project_get_wave_repo  (project);
BseErrorType  bse_project_import_midi_file  (project, file_name);
void  bse_project_inject_midi_control  (project, midi_channel, midi_control, control_value);
SfiBool  bse_project_is_active  (project);
SfiBool  bse_project_is_dirty  (project);
SfiBool  bse_project_is_playing  (project);
BseStringSeq*  bse_project_list_uname_paths  (project, item_type);
BseItemSeq*  bse_project_match_items_by_uname  (project, item_type, uname);
BseErrorType  bse_project_play  (project);
void  bse_project_redo  (project);
SfiInt  bse_project_redo_depth  (project);
void  bse_project_remove_snet  (project, snet);
BseErrorType  bse_project_restore_from_file  (project, file_name);
void  bse_project_start_playback  (project);
void  bse_project_stop  (project);
void  bse_project_stop_playback  (project);
BseErrorType  bse_project_store_bse  (project, super, file_name, self_contained);
void  bse_project_undo  (project);
SfiInt  bse_project_undo_depth  (project);
SfiBool  bse_proxy_check  (item, type_name);
BseSampleFileInfo*  bse_sample_file_info  (file_name);
void  bse_script_add_action  (action, name, blurb);
BseJanitor*  bse_script_janitor  ();
void  bse_script_mixer_splitup_by_track  (song);
void  bse_script_modules2grid  (synth_net);
void  bse_script_part_harmonic_transposer  (part, harmony_sequence, transpose_down_starting_at);
void  bse_script_progress  (progress);
void  bse_script_progressor  (n_iterations, n_wait_spins, update_percentage);
void  bse_script_quit  ();
void  bse_script_record_midi  (part, start_now);
void  bse_script_remove_action  (action);
void  bse_script_send_message  (domain, msg_type, title, primary, secondary, details, config_check);
void  bse_script_set_status  (message);
void  bse_script_song_parts_crop  (song);
void  bse_script_song_parts_duplicate  (song);
SfiBool  bse_server_can_load  (server, file_name);
const gchar*  bse_server_get_custom_effect_dir  (server);
const gchar*  bse_server_get_custom_instrument_dir  (server);
const gchar*  bse_server_get_demo_path  (server);
const gchar*  bse_server_get_effect_path  (server);
const gchar*  bse_server_get_instrument_path  (server);
const gchar*  bse_server_get_ladspa_path  (server);
const gchar*  bse_server_get_mp3_version  (server);
const gchar*  bse_server_get_plugin_path  (server);
const gchar*  bse_server_get_sample_path  (server);
const gchar*  bse_server_get_script_path  (server);
const gchar*  bse_server_get_version  (server);
const gchar*  bse_server_get_vorbis_version  (server);
SfiInt  bse_server_n_scripts  (server);
SfiBool  bse_server_preferences_locked  (server);
void  bse_server_register_core_plugins  (server);
void  bse_server_register_ladspa_plugins  (server);
void  bse_server_register_scripts  (server);
void  bse_server_save_preferences  (server);
void  bse_server_start_recording  (server, wave_file, n_seconds);
BseProject*  bse_server_use_new_project  (server, name);
BseErrorType  bse_snet_can_create_source  (snet, module_type);
BseSource*  bse_snet_create_source  (snet, module_type);
BseErrorType  bse_snet_remove_source  (snet, module);
SfiBool  bse_snet_supports_user_synths  (snet);
BseBus*  bse_song_create_bus  (song);
BsePart*  bse_song_create_part  (song);
BseTrack*  bse_song_create_track  (song);
BseBus*  bse_song_ensure_master_bus  (song);
void  bse_song_ensure_track_links  (song);
BseTrack*  bse_song_find_any_track_for_part  (song, part);
BseTrack*  bse_song_find_track_for_part  (song, part);
BseBus*  bse_song_get_master_bus  (song);
BseSongTiming*  bse_song_get_timing  (song, tick);
void  bse_song_remove_bus  (song, bus);
void  bse_song_remove_part  (song, part);
void  bse_song_remove_track  (song, track);
void  bse_song_synthesize_note  (song, track, duration, note, fine_tune, velocity);
void  bse_source_clear_inputs  (module);
void  bse_source_clear_outputs  (module);
SfiInt  bse_source_get_automation_channel  (source, property_name);
BseMidiControlType  bse_source_get_automation_control  (source, property_name);
SfiBool  bse_source_has_output  (module, ochannel);
SfiBool  bse_source_has_outputs  (module);
const gchar*  bse_source_ichannel_blurb  (module, input_channel);
SfiInt  bse_source_ichannel_get_n_joints  (module, input_channel);
SfiInt  bse_source_ichannel_get_ochannel  (module, input_channel, input_joint);
BseSource*  bse_source_ichannel_get_osource  (module, input_channel, input_joint);
const gchar*  bse_source_ichannel_ident  (module, input_channel);
const gchar*  bse_source_ichannel_label  (module, input_channel);
SfiBool  bse_source_is_joint_ichannel  (module, input_channel);
SfiBool  bse_source_is_joint_ichannel_by_id  (module, input_channel);
SfiBool  bse_source_is_prepared  (source);
SfiInt  bse_source_n_ichannels  (module);
SfiInt  bse_source_n_ochannels  (module);
const gchar*  bse_source_ochannel_blurb  (module, output_channel);
const gchar*  bse_source_ochannel_ident  (module, output_channel);
const gchar*  bse_source_ochannel_label  (module, output_channel);
BseErrorType  bse_source_set_automation  (source, property_name, midi_channel, control_type);
BseErrorType  bse_source_set_input  (imodule, input_channel, omodule, output_channel);
BseErrorType  bse_source_set_input_by_id  (imodule, input_channel, omodule, output_channel);
void  bse_source_set_pos  (module, x_pos, y_pos);
BseErrorType  bse_source_unset_input  (module, input_channel, omodule, output_channel);
BseErrorType  bse_source_unset_input_by_id  (module, input_channel, omodule, output_channel);
SfiReal  bse_string_extract_number  (string, format, aux_base, dflt);
BseErrorType  bse_track_ensure_output  (track);
SfiInt  bse_track_get_last_tick  (track);
BseSource*  bse_track_get_output_source  (track);
BsePart*  bse_track_get_part  (track, tick);
BseSongTiming*  bse_track_get_timing  (track, tick);
SfiInt  bse_track_insert_part  (track, tick, part);
BseTrackPartSeq*  bse_track_list_parts  (track);
BseItemSeq*  bse_track_list_parts_uniq  (track);
void  bse_track_remove_link  (track, id);
void  bse_track_remove_tick  (track, tick);
const gchar*  bse_type_authors  (type);
const gchar*  bse_type_blurb  (type);
const gchar*<