BEAST - Free Software Audio Synthesizer and Tracker  0.9.2
Public Member Functions | Public Attributes | List of all members
Bse::Server Interface Reference

Main Bse remote origin object. More...

import"bseapi.idl";

Inheritance diagram for Bse::Server:
Inheritance graph
[legend]

Public Member Functions

signal void user_message (UserMessage umsg)
 Notification signal for user messages from BSE.
 
TestObject get_test_object ()
 Retrieve object for API, signal, etc tests.
 
Object from_proxy (int64 proxyid)
 Find an Object from its associated BseObject proxy id.
 
String get_mp3_version ()
 Retrieve BSE MP3 handler version.
 
String get_vorbis_version ()
 Retrieve BSE Vorbis handler version.
 
String get_ladspa_path ()
 Retrieve ladspa search path.
 
String get_plugin_path ()
 Retrieve plugin search path.
 
String get_script_path ()
 Retrieve script search path.
 
String get_instrument_path ()
 Retrieve instrument search path.
 
String get_sample_path ()
 Retrieve sample search path.
 
String get_effect_path ()
 Retrieve effect search path.
 
String get_demo_path ()
 Retrieve demo search path.
 
String get_custom_instrument_dir ()
 Retrieve user specific instruments directory.
 
String get_custom_effect_dir ()
 Retrieve user specific effects directory.
 
String get_version ()
 Retrieve BSE version.
 
void save_preferences ()
 Save the bse-preferences property to disk.
 
void register_ladspa_plugins ()
 Register LADSPA (Linux Audio Developer's Simple Plugin API) plugins.
 
void register_core_plugins ()
 Register core plugins.
 
void register_scripts ()
 Register external scripts.
 
bool preferences_locked ()
 Returns whether the bse-preferences property is currently locked against modifications or not.
 
int32 n_scripts ()
 Return the number of scripts currently running on this server.
 
bool can_load (String file_name)
 Check whether a loader can be found for a wave file.
 
void start_recording (String wave_file, float64 n_seconds)
 Start recording to a WAV file.
 
Project create_project (String project_name)
 Create a new project (name is modified to be unique if necessary.
 
void destroy_project (Project project)
 Destroy a previously created new project.
 
signal registration (RegistrationType a, SfiString b, SfiString c)
 
signal script_start (Janitor a)
 
signal script_error (SfiString a, SfiString b, SfiString c)
 
- Public Member Functions inherited from Bse::Container
Item lookup_item (String uname)
 Find an immediate child of a container by name (unique per container child).
 
Item get_item (SfiString item_type, Int seq_id)
 
ItemSeq list_children ()
 
signal item_added (Item a)
 
signal item_remove (Item a, Int b)
 
- Public Member Functions inherited from Bse::Source
Source ichannel_get_osource (int32 input_channel, int32 input_joint)
 Retrieve output module connected to a specific joint of an input channel.
 
void clear_inputs ()
 
void clear_outputs ()
 
Int get_automation_channel (SfiString property_name)
 
MidiControlType get_automation_control (SfiString property_name)
 
Bool has_output (Int ochannel)
 
Bool has_outputs ()
 
SfiString ichannel_blurb (Int input_channel)
 
Int ichannel_get_n_joints (Int input_channel)
 
Int ichannel_get_ochannel (Int input_channel, Int input_joint)
 
SfiString ichannel_ident (Int input_channel)
 
SfiString ichannel_label (Int input_channel)
 
Bool is_joint_ichannel (SfiString input_channel)
 
Bool is_joint_ichannel_by_id (Int input_channel)
 
Bool is_prepared ()
 
Int n_ichannels ()
 
Int n_ochannels ()
 
SfiString ochannel_blurb (Int output_channel)
 
SfiString ochannel_ident (Int output_channel)
 
SfiString ochannel_label (Int output_channel)
 
ErrorType set_automation (SfiString property_name, Int midi_channel, MidiControlType control_type)
 
ErrorType set_input (SfiString input_channel, Source omodule, SfiString output_channel)
 
ErrorType set_input_by_id (Int input_channel, Source omodule, Int output_channel)
 
void set_pos (Real x_pos, Real y_pos)
 
ErrorType unset_input (SfiString input_channel, Source omodule, SfiString output_channel)
 
ErrorType unset_input_by_id (Int input_channel, Source omodule, Int output_channel)
 
signal probes (ProbeSeq a)
 
signal io_changed ()
 
- Public Member Functions inherited from Bse::Item
Item common_ancestor (Item other)
 Find a common container (parent or grand-parent) of two items if any.
 
void add_parasite (SfiString path, Rec parasite)
 
Bool check_is_a (SfiString type_name)
 
void clear_undo ()
 
Bool editable_property (SfiString property_name)
 
Icon get_icon ()
 
SfiString get_name ()
 
SfiString get_name_or_type ()
 
Rec get_parasite (SfiString path)
 
Item get_parent ()
 
Item get_project ()
 
PropertyCandidates get_property_candidates (SfiString property_name)
 
Int get_seqid ()
 
SfiString get_type ()
 
SfiString get_type_authors ()
 
SfiString get_type_blurb ()
 
SfiString get_type_license ()
 
SfiString get_type_name ()
 
SfiString get_uname_path ()
 
void group_undo (SfiString name)
 
Bool internal ()
 
StringSeq list_parasites (SfiString path)
 
void redo ()
 
Int redo_depth ()
 
void set_name (SfiString name)
 
void set_parasite (SfiString path, Rec parasite)
 
void undo ()
 
Int undo_depth ()
 
void ungroup_undo ()
 
void unuse ()
 
Item use ()
 
signal parasites_added (SfiString a)
 
signal parasite_changed (SfiString a)
 
- Public Member Functions inherited from Bse::Object
String debug_name ()
 Object name useful for debugging output.
 
int64 proxy_id ()
 Retrieve the BseObject proxy ID for an Object.
 

Public Attributes

property Rec bse_preferences
 
property SfiString wave_file
 
property Bool log_messages
 
- Public Attributes inherited from Bse::Source
property Real pos_x
 
property Real pos_y
 
- Public Attributes inherited from Bse::Item
property Int seqid
 

Detailed Description

Main Bse remote origin object.

See also the corresponding C++ servant class ServerIface.

See also the corresponding C++ stub class ServerHandle.

The Bse::Server object controls the main BSE thread and keeps track of all objects used in the BSE context.


The documentation for this interface was generated from the following files: