#include "api.hh"

Inheritance diagram for Project:

Public Member Functions
virtual TrackS	all_tracks ()=0

virtual bool	can_redo ()=0

virtual bool	can_undo ()=0

virtual TrackP	create_track ()=0

virtual void	discard ()=0

virtual double	get_bpm () const =0

virtual double	get_denominator () const =0

virtual double	get_numerator () const =0

virtual void	group_undo (const String &undoname)=0

virtual bool	is_playing ()=0

virtual Error	load_project (const String &utf8filename)=0

virtual TrackP	master_track ()=0

virtual String	match_serialized (const String &regex, int group=0)=0

virtual void	redo ()=0

virtual bool	remove_track (Track &)=0

virtual Error	save_project (const String &utf8filename, bool collect)=0

virtual String	saved_filename ()=0

virtual void	set_bpm (double bpm)=0

virtual void	set_denominator (double den)=0

virtual void	set_numerator (double num)=0

virtual void	start_playback ()=0

virtual void	stop_playback ()=0

virtual TelemetryFieldS	telemetry () const =0

virtual void	undo ()=0

virtual void	ungroup_undo ()=0

Public Member Functions inherited from Device
virtual void	_activate ()=0

virtual AudioProcessorP	_audio_processor () const =0

virtual void	_deactivate ()=0

virtual void	_disconnect_remove ()=0

virtual void	_set_event_source (AudioProcessorP esource)=0

Track *	_track () const

virtual DeviceInfo	device_info ()=0

virtual DeviceS	get_devices () const =0

virtual bool	gui_supported ()=0

virtual void	gui_toggle ()=0

virtual bool	gui_visible ()=0

virtual bool	is_active ()=0

void	remove_self ()

virtual void	set_devices (const DeviceS &devices)=0

Public Member Functions inherited from Gadget
virtual GadgetImpl *	_parent () const =0

ProjectImpl *	_project () const

virtual void	_set_parent (GadgetImpl *parent)=0

virtual PropertyS	access_properties ()=0

virtual PropertyP	access_property (String ident)

virtual Value	get_data (const String &key) const =0

virtual String	get_name () const =0

Value	get_value (String ident)

virtual StringS	list_properties ()

virtual bool	set_data (const String &key, const Value &v)=0

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

bool	set_value (String ident, const Value &v)

virtual String	type_nick () const =0

Public Member Functions inherited from 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)

virtual ASE_USE_RESULT Connection	on_event (const String &eventselector, const EventHandler &eventhandler)=0

Static Public Member Functions
static ProjectP	last_project ()

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

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

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

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

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

Protected Member Functions
	Project ()

Protected Member Functions inherited from Device
	Device ()

Protected Member Functions inherited from Gadget
	Gadget ()

Protected Member Functions inherited from Object
virtual	~Object ()=0

Protected Member Functions inherited from VirtualBase
virtual	~VirtualBase () noexcept=0

Detailed Description

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

Constructor & Destructor Documentation

◆Project()

Project ( )

explicitprotected

Member Function Documentation

◆set_bpm()

virtual void set_bpm ( double bpm )

pure virtual

Implemented in ProjectImpl.

◆get_bpm()

virtual double get_bpm ( ) const

pure virtual

Implemented in ProjectImpl.

◆set_numerator()

virtual void set_numerator ( double num )

pure virtual

Implemented in ProjectImpl.

◆get_numerator()

virtual double get_numerator ( ) const

pure virtual

Implemented in ProjectImpl.

◆set_denominator()

virtual void set_denominator ( double den )

pure virtual

Implemented in ProjectImpl.

◆get_denominator()

virtual double get_denominator ( ) const

pure virtual

Implemented in ProjectImpl.

◆discard()

virtual void discard ( )

pure virtual

Discard project and associated resources.

Implemented in ProjectImpl.

◆start_playback()

virtual void start_playback ( )

pure virtual

Start playback of a project, requires active sound engine.

Implemented in ProjectImpl.

◆stop_playback()

virtual void stop_playback ( )

pure virtual

Stop project playback.

Implemented in ProjectImpl.

◆is_playing()

virtual bool is_playing ( )

pure virtual

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

Implemented in ProjectImpl.

◆create_track()

virtual TrackP create_track ( )

pure virtual

Create and append a new Track.

Implemented in ProjectImpl.

◆remove_track()

virtual bool remove_track ( Track & )

pure virtual

Remove a track owned by this Project.

Implemented in ProjectImpl.

◆all_tracks()

virtual TrackS all_tracks ( )

pure virtual

List all tracks of the project.

Implemented in ProjectImpl.

◆master_track()

virtual TrackP master_track ( )

pure virtual

Retrieve the master track.

Implemented in ProjectImpl.

◆save_project()

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

pure virtual

Store Project and collect external files.

Implemented in ProjectImpl.

◆saved_filename()

virtual String saved_filename ( )

pure virtual

Retrieve UTF-8 filename for save or from load.

Implemented in ProjectImpl.

◆load_project()

virtual Error load_project ( const String & utf8filename )

pure virtual

Load project from file `filename`.

Implemented in ProjectImpl.

◆telemetry()

virtual TelemetryFieldS telemetry ( ) const

pure virtual

Retrieve project telemetry locations.

Implemented in ProjectImpl.

◆group_undo()

virtual void group_undo ( const String & undoname )

pure virtual

Merge upcoming undo steps.

Implemented in ProjectImpl.

◆ungroup_undo()

virtual void ungroup_undo ( )

pure virtual

Stop merging undo steps.

Implemented in ProjectImpl.

◆undo()

virtual void undo ( )

pure virtual

Undo the last project modification.

Implemented in ProjectImpl.

◆can_undo()

virtual bool can_undo ( )

pure virtual

Check if any undo steps have been recorded.

Implemented in ProjectImpl.

◆redo()

virtual void redo ( )

pure virtual

Redo the last undo modification.

Implemented in ProjectImpl.

◆can_redo()

virtual bool can_redo ( )

pure virtual

Check if any redo steps have been recorded.

Implemented in ProjectImpl.

◆match_serialized()

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

pure virtual

Match `regex` against the serialized project state.

Implemented in ProjectImpl.

◆last_project()

ProjectP last_project ( )

static

Member Data Documentation

◆bpm

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

◆numerator

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

◆denominator

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

Anklang C++ API 0.0.0

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆Project()

Member Function Documentation

◆set_bpm()

◆get_bpm()

◆set_numerator()

◆get_numerator()

◆set_denominator()

◆get_denominator()

◆discard()

◆start_playback()

◆stop_playback()

◆is_playing()

◆create_track()

◆remove_track()

◆all_tracks()

◆master_track()

◆save_project()

◆saved_filename()

◆load_project()

◆telemetry()

◆group_undo()

◆ungroup_undo()

◆undo()

◆can_undo()

◆redo()

◆can_redo()

◆match_serialized()

◆last_project()

Member Data Documentation

◆bpm

◆numerator

◆denominator