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

#include "api.hh"

Inheritance diagram for Ase::Project:

Public Member Functions
virtual void	set_bpm (double bpm)=0

virtual double	get_bpm () const =0

virtual void	set_numerator (double num)=0

virtual double	get_numerator () const =0

virtual void	set_denominator (double den)=0

virtual double	get_denominator () const =0

virtual void	discard ()=0
	Discard project and associated resources.

virtual void	start_playback ()=0
	Start playback of a project, requires active sound engine.

virtual void	stop_playback ()=0
	Stop project playback.

virtual bool	is_playing ()=0
	Check whether a project is currently playing (song sequencing).

virtual TrackP	create_track ()=0
	Create and append a new Track.

virtual bool	remove_track (Track &)=0
	Remove a track owned by this Project.

virtual TrackS	all_tracks ()=0
	List all tracks of the project.

virtual TrackP	master_track ()=0
	Retrieve the master track.

virtual Error	save_project (const String &utf8filename, bool collect)=0
	Store Project and collect external files.

virtual String	saved_filename ()=0
	Retrieve UTF-8 filename for save or from load.

virtual Error	load_project (const String &utf8filename)=0
	Load project from file `filename`.

virtual TelemetryFieldS	telemetry () const =0
	Retrieve project telemetry locations.

virtual void	group_undo (const String &undoname)=0
	Merge upcoming undo steps.

virtual void	ungroup_undo ()=0
	Stop merging undo steps.

virtual void	undo ()=0
	Undo the last project modification.

virtual bool	can_undo ()=0
	Check if any undo steps have been recorded.

virtual void	redo ()=0
	Redo the last undo modification.

virtual bool	can_redo ()=0
	Check if any redo steps have been recorded.

virtual String	match_serialized (const String &regex, int group=0)=0
	Match `regex` against the serialized project state.

Public Member Functions inherited from Ase::Device
Track *	_track () const
	Find Track in parent ancestry.

virtual AudioProcessorP	_audio_processor () const =0
	Retrieve the corresponding AudioProcessor.

virtual void	_set_event_source (AudioProcessorP esource)=0

virtual void	_activate ()=0
	Add AudioProcessor to the Engine and start processing.

virtual void	_deactivate ()=0
	Stop processing the corresponding AudioProcessor.

virtual void	_disconnect_remove ()=0
	Disconnect the device and remove all object references.

virtual bool	is_active ()=0
	Check whether this is the active synthesis engine project.

virtual DeviceInfo	device_info ()=0
	Describe this Device type.

virtual DeviceS	get_devices () const =0
	List devices in order of processing, notified via "devs".

virtual void	set_devices (const DeviceS &devices)=0
	Set the list of devices.

void	remove_self ()
	Remove device from its container.

virtual void	gui_toggle ()=0
	Toggle GUI display.

virtual bool	gui_supported ()=0
	Has GUI display facilities.

virtual bool	gui_visible ()=0
	Is GUI currently visible.

Public Member Functions inherited from Ase::Gadget
virtual GadgetImpl *	_parent () const =0
	Retrieve parent container.

virtual void	_set_parent (GadgetImpl *parent)=0
	Assign parent container.

ProjectImpl *	_project () const
	Find Project in parent ancestry.

virtual String	get_name () const =0

virtual void	set_name (const std::string &n)=0

virtual String	type_nick () const =0

virtual StringS	list_properties ()
	List all property identifiers.

virtual PropertyP	access_property (String ident)
	Retrieve handle for a Property.

virtual PropertyS	access_properties ()=0
	Retrieve handles for all properties.

Value	get_value (String ident)
	Get native property value.

bool	set_value (String ident, const Value &v)

virtual bool	set_data (const String &key, const Value &v)=0
	Assign session data, prefix ephemerals with '_'.

virtual Value	get_data (const String &key) const =0
	Retrieve session data.

Public Member Functions inherited from Ase::Emittable
virtual void	emit_event (const String &type, const String &detail, const ValueR fields={})=0

virtual void	emit_notify (const String &detail)=0

void	js_trigger (const String &eventselector, JsTrigger callback)

Public Member Functions inherited from std::enable_shared_from_this< SharedBase >
T	enable_shared_from_this (T... args)

T	operator= (T... args)

T	shared_from_this (T... args)

T	weak_from_this (T... args)

T	~enable_shared_from_this (T... args)

Static Public Member Functions
static ProjectP	last_project ()

Public Attributes
Member<&Project::get_bpm,&Project::set_bpm >	bpm

Member<&Project::get_numerator,&Project::set_numerator >	numerator

Member<&Project::get_denominator,&Project::set_denominator >	denominator

Public Attributes inherited from Ase::Device
Member<&Device::get_devices,&Device::set_devices >	devices

Public Attributes inherited from Ase::Gadget
Member<&Gadget::get_name,&Gadget::set_name >	name

Public Attributes inherited from Ase::Emittable
const EventHandler &	eventhandler

Detailed Description

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

Definition at line 317 of file api.hh.

Constructor & Destructor Documentation

◆ Project()

Ase::Project::Project ( )

explicitprotected

Definition at line 31 of file project.cc.

Member Function Documentation

◆ all_tracks()

virtual TrackS Ase::Project::all_tracks ( )

pure virtual

List all tracks of the project.

Implemented in Ase::ProjectImpl.

◆ can_redo()

virtual bool Ase::Project::can_redo ( )

pure virtual

Check if any redo steps have been recorded.

Implemented in Ase::ProjectImpl.

◆ can_undo()

virtual bool Ase::Project::can_undo ( )

pure virtual

Check if any undo steps have been recorded.

Implemented in Ase::ProjectImpl.

◆ create_track()

virtual TrackP Ase::Project::create_track ( )

pure virtual

Create and append a new Track.

Implemented in Ase::ProjectImpl.

◆ discard()

virtual void Ase::Project::discard ( )

pure virtual

Discard project and associated resources.

Implemented in Ase::ProjectImpl.

◆ group_undo()

virtual void Ase::Project::group_undo ( const String & undoname )

pure virtual

Merge upcoming undo steps.

Implemented in Ase::ProjectImpl.

◆ is_playing()

virtual bool Ase::Project::is_playing ( )

pure virtual

Check whether a project is currently playing (song sequencing).

Implemented in Ase::ProjectImpl.

◆ last_project()

ProjectP Ase::Project::last_project ( )

static

Definition at line 38 of file project.cc.

◆ load_project()

virtual Error Ase::Project::load_project ( const String & utf8filename )

pure virtual

Load project from file filename.

Implemented in Ase::ProjectImpl.

◆ master_track()

virtual TrackP Ase::Project::master_track ( )

pure virtual

Retrieve the master track.

Implemented in Ase::ProjectImpl.

◆ match_serialized()

virtual String Ase::Project::match_serialized	(	const String &	regex,
		int	group = `0`
	)

pure virtual

Match regex against the serialized project state.

Implemented in Ase::ProjectImpl.

◆ redo()

virtual void Ase::Project::redo ( )

pure virtual

Redo the last undo modification.

Implemented in Ase::ProjectImpl.

◆ remove_track()

virtual bool Ase::Project::remove_track ( Track & )

pure virtual

Remove a track owned by this Project.

Implemented in Ase::ProjectImpl.

◆ save_project()

virtual Error Ase::Project::save_project	(	const String &	utf8filename,
		bool	collect
	)

pure virtual

Store Project and collect external files.

Implemented in Ase::ProjectImpl.

◆ saved_filename()

virtual String Ase::Project::saved_filename ( )

pure virtual

Retrieve UTF-8 filename for save or from load.

Implemented in Ase::ProjectImpl.

◆ start_playback()

virtual void Ase::Project::start_playback ( )

pure virtual

Start playback of a project, requires active sound engine.

Implemented in Ase::ProjectImpl.

◆ stop_playback()

virtual void Ase::Project::stop_playback ( )

pure virtual

Stop project playback.

Implemented in Ase::ProjectImpl.

◆ telemetry()

virtual TelemetryFieldS Ase::Project::telemetry ( ) const

pure virtual

Retrieve project telemetry locations.

Implemented in Ase::ProjectImpl.

◆ undo()

virtual void Ase::Project::undo ( )

pure virtual

Undo the last project modification.

Implemented in Ase::ProjectImpl.

◆ ungroup_undo()

virtual void Ase::Project::ungroup_undo ( )

pure virtual

Stop merging undo steps.

Implemented in Ase::ProjectImpl.

Member Data Documentation

◆ bpm

Member<&Project::get_bpm,&Project::set_bpm> Ase::Project::bpm

Definition at line 347 of file api.hh.

◆ denominator

Member<&Project::get_denominator,&Project::set_denominator> Ase::Project::denominator

Definition at line 349 of file api.hh.

◆ numerator

Member<&Project::get_numerator,&Project::set_numerator> Ase::Project::numerator

Definition at line 348 of file api.hh.

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

ase/api.hh
ase/project.cc

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Project()

Member Function Documentation

◆ all_tracks()

◆ can_redo()

◆ can_undo()

◆ create_track()

◆ discard()

◆ group_undo()

◆ is_playing()

◆ last_project()

◆ load_project()

◆ master_track()

◆ match_serialized()

◆ redo()

◆ remove_track()

◆ save_project()

◆ saved_filename()

◆ start_playback()

◆ stop_playback()

◆ telemetry()

◆ undo()

◆ ungroup_undo()

Member Data Documentation

◆ bpm

◆ denominator

◆ numerator