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

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

Interface to access Device instances. More...

#include "api.hh"

Inheritance diagram for Ase::Device:
[legend]

Public Member Functions

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)
 

Public Attributes

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 Device instances.

Definition at line 214 of file api.hh.

Constructor & Destructor Documentation

◆ Device()

Ase::Device::Device ( )
explicitprotected

Definition at line 8 of file device.cc.

Member Function Documentation

◆ _activate()

virtual void Ase::Device::_activate ( )
pure virtual

Add AudioProcessor to the Engine and start processing.

Implemented in Ase::ClapDeviceImpl, Ase::DeviceImpl, Ase::NativeDeviceImpl, Ase::ProjectImpl, and Ase::TrackImpl.

◆ _audio_processor()

virtual AudioProcessorP Ase::Device::_audio_processor ( ) const
pure virtual

Retrieve the corresponding AudioProcessor.

Implemented in Ase::ClapDeviceImpl, Ase::NativeDeviceImpl, Ase::ProjectImpl, and Ase::TrackImpl.

◆ _deactivate()

virtual void Ase::Device::_deactivate ( )
pure virtual

Stop processing the corresponding AudioProcessor.

Implemented in Ase::DeviceImpl, Ase::NativeDeviceImpl, Ase::ProjectImpl, and Ase::TrackImpl.

◆ _disconnect_remove()

virtual void Ase::Device::_disconnect_remove ( )
pure virtual

Disconnect the device and remove all object references.

Implemented in Ase::ClapDeviceImpl, Ase::DeviceImpl, and Ase::NativeDeviceImpl.

◆ _track()

Track * Ase::Device::_track ( ) const

Find Track in parent ancestry.

Definition at line 87 of file device.cc.

References Ase::Gadget::_parent().

◆ device_info()

virtual DeviceInfo Ase::Device::device_info ( )
pure virtual

◆ get_devices()

virtual DeviceS Ase::Device::get_devices ( ) const
pure virtual

List devices in order of processing, notified via "devs".

Implemented in Ase::DeviceImpl.

◆ gui_supported()

virtual bool Ase::Device::gui_supported ( )
pure virtual

Has GUI display facilities.

Implemented in Ase::ClapDeviceImpl, and Ase::DeviceImpl.

◆ gui_toggle()

virtual void Ase::Device::gui_toggle ( )
pure virtual

Toggle GUI display.

Implemented in Ase::ClapDeviceImpl, and Ase::DeviceImpl.

◆ gui_visible()

virtual bool Ase::Device::gui_visible ( )
pure virtual

Is GUI currently visible.

Implemented in Ase::ClapDeviceImpl, and Ase::DeviceImpl.

◆ is_active()

virtual bool Ase::Device::is_active ( )
pure virtual

Check whether this is the active synthesis engine project.

Implemented in Ase::DeviceImpl.

◆ remove_self()

void Ase::Device::remove_self ( )

Remove device from its container.

Definition at line 78 of file device.cc.

References Ase::NativeDevice::remove_device().

◆ set_devices()

virtual void Ase::Device::set_devices ( const DeviceS &  devices)
pure virtual

Set the list of devices.

Implemented in Ase::DeviceImpl.

Member Data Documentation

◆ devices

Definition at line 235 of file api.hh.


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