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

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

Interface to access NativeDevice instances. More...

#include "api.hh"

Inheritance diagram for Ase::NativeDevice:
[legend]

Public Member Functions

virtual bool is_combo_device ()=0
 Retrieve wether this NativeDevice handles sub devices.
 
DeviceInfoS list_device_types ()
 List registered Device types with their unique uri.
 
virtual void remove_device (Device &sub)=0
 Remove a directly contained device.
 
virtual DeviceP append_device (const String &uri)=0
 Append a new device, see list_device_types().
 
virtual DeviceP insert_device (const String &uri, Device &beforesibling)=0
 Insert a new device, before beforesibling.
 
- 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 >
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)
 

Additional Inherited Members

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

Detailed Description

Interface to access NativeDevice instances.

Definition at line 239 of file api.hh.

Member Function Documentation

◆ append_device()

virtual DeviceP Ase::NativeDevice::append_device ( const String uri)
pure virtual

Append a new device, see list_device_types().

Implemented in Ase::NativeDeviceImpl.

◆ insert_device()

virtual DeviceP Ase::NativeDevice::insert_device ( const String uri,
Device beforesibling 
)
pure virtual

Insert a new device, before beforesibling.

Implemented in Ase::NativeDeviceImpl.

◆ is_combo_device()

virtual bool Ase::NativeDevice::is_combo_device ( )
pure virtual

Retrieve wether this NativeDevice handles sub devices.

Implemented in Ase::NativeDeviceImpl.

◆ list_device_types()

DeviceInfoS Ase::NativeDevice::list_device_types ( )

◆ remove_device()

virtual void Ase::NativeDevice::remove_device ( Device sub)
pure virtual

Remove a directly contained device.

Implemented in Ase::NativeDeviceImpl.

Referenced by Ase::Device::remove_self().


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