Anklang 0.3.0-460-gc4ef46ba
ASE — Anklang Sound Engine (C++)

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Ase::Server Class Referenceabstract

Central singleton, serves as API entry point. More...

#include "api.hh"

Inheritance diagram for Ase::Server:
[legend]

Public Types

using ServerP = std::shared_ptr< Server >
 

Public Member Functions

virtual void shutdown ()=0
 Shutdown ASE.
 
virtual String get_version ()=0
 Retrieve ASE version.
 
virtual String get_build_id ()=0
 Retrieve ASE build id.
 
virtual String get_opus_version ()=0
 Retrieve Opus handler version.
 
virtual String get_flac_version ()=0
 Retrieve FLAC handler version.
 
virtual String get_clap_version ()=0
 Retrieve CLAP support version.
 
virtual String get_sndfile_version ()=0
 Retrieve libsndfile support version.
 
virtual String error_blurb (Error error) const =0
 
virtual String musical_tuning_label (MusicalTuning musicaltuning) const =0
 
virtual String musical_tuning_blurb (MusicalTuning musicaltuning) const =0
 
virtual uint64 user_note (const String &text, const String &channel="misc", UserNote::Flags flags=UserNote::TRANSIENT, const String &rest="")=0
 
virtual bool user_reply (uint64 noteid, uint r)=0
 
virtual bool broadcast_telemetry (const TelemetrySegmentS &segments, int32 interval_ms)=0
 Broadcast telemetry memory segments to the current Jsonipc connection.
 
virtual StringS list_preferences ()=0
 Retrieve a list of all preference identifiers.
 
virtual PropertyP access_preference (const String &ident)=0
 Retrieve property handle for a Preference identifier.
 
String engine_stats ()
 Print engine state.
 
void exit_program (int status=0)
 End program (without saving).
 
virtual ProjectP last_project ()=0
 Retrieve the last created project.
 
virtual ProjectP create_project (String projectname)=0
 Create a new project (name is modified to be unique if necessary.
 
ResourceCrawlerP dir_crawler (const String &cwd)
 Create crawler to navigate directories.
 
ResourceCrawlerP url_crawler (const String &url)
 Create crawler to navigate URL contents.
 
- 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 >
enable_shared_from_this (T... args)
 
operator= (T... args)
 
shared_from_this (T... args)
 
weak_from_this (T... args)
 
~enable_shared_from_this (T... args)
 

Static Public Member Functions

static Serverinstance ()
 Retrieve global Server instance.
 
static ServerP instancep ()
 Retrieve global Server instance as std::shared_ptr.
 

Additional Inherited Members

- Public Attributes inherited from Ase::Gadget
Member<&Gadget::get_name,&Gadget::set_name > name
 
- Public Attributes inherited from Ase::Emittable
const EventHandlereventhandler
 

Detailed Description

Central singleton, serves as API entry point.

Definition at line 400 of file api.hh.

Member Typedef Documentation

◆ ServerP

Definition at line 403 of file api.hh.

Member Function Documentation

◆ access_preference()

virtual PropertyP Ase::Server::access_preference ( const String ident)
pure virtual

Retrieve property handle for a Preference identifier.

Implemented in Ase::ServerImpl.

◆ broadcast_telemetry()

virtual bool Ase::Server::broadcast_telemetry ( const TelemetrySegmentS &  segments,
int32  interval_ms 
)
pure virtual

Broadcast telemetry memory segments to the current Jsonipc connection.

Implemented in Ase::ServerImpl.

◆ create_project()

virtual ProjectP Ase::Server::create_project ( String  projectname)
pure virtual

Create a new project (name is modified to be unique if necessary.

Implemented in Ase::ServerImpl.

◆ dir_crawler()

ResourceCrawlerP Ase::Server::dir_crawler ( const String cwd)

Create crawler to navigate directories.

Definition at line 168 of file server.cc.

◆ engine_stats()

String Ase::Server::engine_stats ( )

Print engine state.

Definition at line 185 of file server.cc.

◆ exit_program()

void Ase::Server::exit_program ( int  status = 0)

End program (without saving).

Definition at line 193 of file server.cc.

◆ get_build_id()

virtual String Ase::Server::get_build_id ( )
pure virtual

Retrieve ASE build id.

Implemented in Ase::ServerImpl.

◆ get_clap_version()

virtual String Ase::Server::get_clap_version ( )
pure virtual

Retrieve CLAP support version.

Implemented in Ase::ServerImpl.

◆ get_flac_version()

virtual String Ase::Server::get_flac_version ( )
pure virtual

Retrieve FLAC handler version.

Implemented in Ase::ServerImpl.

◆ get_opus_version()

virtual String Ase::Server::get_opus_version ( )
pure virtual

Retrieve Opus handler version.

Implemented in Ase::ServerImpl.

◆ get_sndfile_version()

virtual String Ase::Server::get_sndfile_version ( )
pure virtual

Retrieve libsndfile support version.

Implemented in Ase::ServerImpl.

◆ get_version()

virtual String Ase::Server::get_version ( )
pure virtual

Retrieve ASE version.

Implemented in Ase::ServerImpl.

◆ instance()

Server & Ase::Server::instance ( )
static

Retrieve global Server instance.

Definition at line 161 of file server.cc.

◆ instancep()

ServerP Ase::Server::instancep ( )
static

Retrieve global Server instance as std::shared_ptr.

Definition at line 155 of file server.cc.

◆ last_project()

virtual ProjectP Ase::Server::last_project ( )
pure virtual

Retrieve the last created project.

Implemented in Ase::ServerImpl.

◆ list_preferences()

virtual StringS Ase::Server::list_preferences ( )
pure virtual

Retrieve a list of all preference identifiers.

Implemented in Ase::ServerImpl.

◆ shutdown()

virtual void Ase::Server::shutdown ( )
pure virtual

Shutdown ASE.

Implemented in Ase::ServerImpl.

◆ url_crawler()

ResourceCrawlerP Ase::Server::url_crawler ( const String url)

Create crawler to navigate URL contents.

Definition at line 174 of file server.cc.

References std::string::empty().


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