Project class
Projects support loading, saving, playback and act as containers for all other sound objects.
Base classes
Public functions
- void _activate() pure virtual
- Add AudioProcessor to the Engine and start processing.
- auto _audio_processor() const → AudioProcessorP pure virtual
- Retrieve the corresponding AudioProcessor.
- void _deactivate() pure virtual
- Stop processing the corresponding AudioProcessor.
- void _disconnect_remove() pure virtual
- Disconnect the device and remove all object references.
- auto _parent() const → GadgetImpl* pure virtual
- Retrieve parent container.
- auto _project() const → ProjectImpl*
- Find Project in parent ancestry.
- void _set_parent(GadgetImpl* parent) pure virtual
- Assign parent container.
- auto _track() const → Track*
- Find Track in parent ancestry.
- auto access_properties() → PropertyS pure virtual
- Retrieve handles for all properties.
- auto access_property(String ident) → PropertyP virtual
- Retrieve handle for a Property.
- auto all_tracks() → TrackS pure virtual
- List all tracks of the project.
- auto can_redo() → bool pure virtual
- Check if any redo steps have been recorded.
- auto can_undo() → bool pure virtual
- Check if any undo steps have been recorded.
- auto create_track() → TrackP pure virtual
- Create and append a new Track.
- auto device_info() → DeviceInfo pure virtual
- Describe this Device type.
- void discard() pure virtual
- Discard project and associated resources.
- auto get_data(const String& key) const → Value pure virtual
- Retrieve session data.
- auto get_value(String ident) → Value
- Get native property value.
- void group_undo(const String& undoname) pure virtual
- Merge upcoming undo steps.
- auto gui_supported() → bool pure virtual
- Has GUI display facilities.
- void gui_toggle() pure virtual
- Toggle GUI display.
- auto gui_visible() → bool pure virtual
- Is GUI currently visible.
- auto is_active() → bool pure virtual
- Check whether this is the active synthesis engine project.
- auto is_playing() → bool pure virtual
- Check whether a project is currently playing (song sequencing).
- auto list_devices() → DeviceS pure virtual
- List devices in order of processing, notified via "devs".
- auto list_properties() → StringS virtual
- List all property identifiers.
- auto load_project(const String& utf8filename) → Error pure virtual
- Load project from file
filename. - auto master_track() → TrackP pure virtual
- Retrieve the master track.
- auto match_serialized(const String& regex, int group = 0) → String pure virtual
- Match
regexagainst the serialized project state. - void redo() pure virtual
- Redo the last undo modification.
- void remove_self()
- Remove device from its container.
- auto remove_track(Track&) → bool pure virtual
- Remove a track owned by this Project.
- auto save_project(const String& utf8filename, bool collect) → Error pure virtual
- Store Project and collect external files.
- auto saved_filename() → String pure virtual
- Retrieve UTF-8 filename for save or from load.
- auto set_data(const String& key, const Value& v) → bool pure virtual
- Assign session data, prefix ephemerals with '_'.
- auto set_value(String ident, const Value& v) → bool
- void start_playback() pure virtual
- Start playback of a project, requires active sound engine.
- void stop_playback() pure virtual
- Stop project playback.
- auto telemetry() const → TelemetryFieldS pure virtual
- Retrieve project telemetry locations.
- void undo() pure virtual
- Undo the last project modification.
- void ungroup_undo() pure virtual
- Stop merging undo steps.