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

Projects support loading, saving, playback and act as containers for all other sound objects. More...

import"bseapi.idl";

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

Public Member Functions

void change_name (String name)
 Change a project name without recording undo steps.
 
ErrorType play ()
 Activate a project and start project playback (an already playing project is first halted).
 
ErrorType activate ()
 Activate a project, precondition to start playback.
 
bool can_play ()
 Check whether project playback would makes sense.
 
bool is_playing ()
 Check whether a project is currently playing (song sequencing).
 
bool is_active ()
 Check whether a project is active (currently synthesizing).
 
void start_playback ()
 Start playback in an activated project.
 
void stop_playback ()
 Stop project playback.
 
void deactivate ()
 Deactivate the project, automatically stop playback.
 
void stop ()
 Stop project playback and deactivate project.
 
void auto_deactivate (int32 msec_delay)
 Automatically deactivate a few milliseconds after playback stopped.
 
int32 undo_depth ()
 Check whether a project can perform undo steps.
 
void undo ()
 Undo a previous operation in a project.
 
int32 redo_depth ()
 Get the number of times redo can be called on the project.
 
void redo ()
 Redo a previously undone operation in a project.
 
void clear_undo ()
 Delete all recorded undo or redo steps.
 
void clean_dirty ()
 Clear a project's dirty flags.
 
bool is_dirty ()
 Check whether a project needs saving. More...
 
void inject_midi_control (int32 midi_channel, int32 midi_control, float64 control_value)
 Inject a MIDI control event into the project's MIDI receiver.
 
ErrorType import_midi_file (String file_name)
 List uname paths for all items of a specified type within a project. More...
 
ErrorType restore_from_file (String file_name)
 Load a project from file.
 
ErrorType store_bse (Super super, SfiString file_name, Bool self_contained)
 
CSynth create_csynth (SfiString name)
 
MidiSynth create_midi_synth (SfiString name)
 
Song create_song (SfiString name)
 
Item find_item (SfiString uname_path)
 
DataPocket get_data_pocket (SfiString name)
 
MidiNotifier get_midi_notifier ()
 
ProjectState get_state ()
 
ItemSeq get_supers ()
 
WaveRepo get_wave_repo ()
 
StringSeq list_uname_paths (SfiString item_type)
 
ItemSeq match_items_by_uname (SfiString item_type, SfiString uname)
 
void remove_snet (SNet snet)
 
signal state_changed (ProjectState a)
 
- 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)
 
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 set_name (SfiString name)
 
void set_parasite (SfiString path, Rec parasite)
 
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 Bool dirty
 
- 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

Projects support loading, saving, playback and act as containers for all other sound objects.

See also the corresponding C++ servant class ProjectIface.

See also the corresponding C++ stub class ProjectHandle.

Member Function Documentation

ErrorType Bse::Project::import_midi_file ( String  file_name)

List uname paths for all items of a specified type within a project.

By their uname paths, items are uniquely identifyable within a project. Retrieve all items of a specific type within a project with matching uname. Save super objects of a project into a BSE file. If no Super is specified, the project itself is stored. The references to other objects (e.g. samples) can be stored by reference (self_contained=false) or embedded in the output file (self_contained=true). Import a song from a MIDI file.

bool Bse::Project::is_dirty ( )

Check whether a project needs saving.


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