Class Ase::Device
Interface to access Device instances.
#include <api.hh>
Inherits the following classes: Ase::Gadget
Inherited by the following classes: Ase::DeviceImpl, Ase::NativeDevice, Ase::Project, Ase::Track
Public Attributes
| Type | Name |
|---|---|
| Member<&Device::devs_ > | devs |
Public Attributes inherited from Ase::Gadget
See Ase::Gadget
| Type | Name |
|---|---|
| Member<&Gadget::name_ > | name |
Public Functions
| Type | Name |
|---|---|
| virtual void | _activate () = 0 Add AudioProcessor to the Engine and start processing. |
| virtual AudioProcessorP | _audio_processor () const = 0 Retrieve the corresponding AudioProcessor . |
| virtual void | _deactivate () = 0 Stop processing the corresponding AudioProcessor . |
| virtual void | _disconnect_remove () = 0 Disconnect the device and remove all object references. |
| virtual void | _set_event_source (AudioProcessorP esource) = 0 |
| Track * | _track () const Find Track in parent ancestry. |
| virtual DeviceInfo | device_info () = 0 Describe this Device type. |
| virtual bool | gui_supported () = 0 Has GUI display facilities. |
| virtual void | gui_toggle () = 0 Toggle GUI display. |
| virtual bool | gui_visible () = 0 Is GUI currently visible. |
| virtual bool | is_active () = 0 Check whether this is the active synthesis engine project. |
| virtual DeviceS | list_devices () = 0 List devices in order of processing, notified via "devs". |
| void | remove_self () Remove device from its container. |
Public Functions inherited from Ase::Gadget
See Ase::Gadget
| Type | Name |
|---|---|
| virtual GadgetImpl * | _parent () const = 0 Retrieve parent container. |
| ProjectImpl * | _project () const Find Project in parent ancestry. |
| virtual void | _set_parent (GadgetImpl * parent) = 0 Assign parent container. |
| virtual PropertyS | access_properties () = 0 Retrieve handles for all properties. |
| virtual PropertyP | access_property (String ident) Retrieve handle for a Property . |
| virtual Value | get_data (const String & key) const = 0 Retrieve session data. |
| Value | get_value (String ident) Get native property value. |
| virtual StringS | list_properties () List all property identifiers. |
| virtual bool | set_data (const String & key, const Value & v) = 0 Assign session data, prefix ephemerals with '_'. |
| bool | set_value (String ident, const Value & v) |
| virtual String | type_nick () const = 0 |
Public Functions inherited from Ase::Emittable
See Ase::Emittable
| Type | Name |
|---|---|
| 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 |
Protected Functions
| Type | Name |
|---|---|
| Device () |
Protected Functions inherited from Ase::Gadget
See Ase::Gadget
| Type | Name |
|---|---|
| Gadget () |
|
| virtual bool | name_ (const std::string * n, std::string * q) = 0 |
Protected Functions inherited from Ase::Object
See Ase::Object
| Type | Name |
|---|---|
| virtual | ~Object () = 0 |
Protected Functions inherited from Ase::VirtualBase
See Ase::VirtualBase
| Type | Name |
|---|---|
| virtual | ~VirtualBase () noexcept = 0 |
Public Attributes Documentation
variable devs
Member<&Device::devs_> Ase::Device::devs;
Public Functions Documentation
function _activate
virtual void Ase::Device::_activate () = 0
function _audio_processor
virtual AudioProcessorP Ase::Device::_audio_processor () const = 0
function _deactivate
virtual void Ase::Device::_deactivate () = 0
function _disconnect_remove
virtual void Ase::Device::_disconnect_remove () = 0
function _set_event_source
virtual void Ase::Device::_set_event_source (
AudioProcessorP esource
) = 0
function _track
Track * Ase::Device::_track () const
function device_info
virtual DeviceInfo Ase::Device::device_info () = 0
function gui_supported
virtual bool Ase::Device::gui_supported () = 0
function gui_toggle
virtual void Ase::Device::gui_toggle () = 0
function gui_visible
virtual bool Ase::Device::gui_visible () = 0
function is_active
virtual bool Ase::Device::is_active () = 0
function list_devices
virtual DeviceS Ase::Device::list_devices () = 0
function remove_self
void Ase::Device::remove_self ()
Protected Functions Documentation
function Device
explicit Ase::Device::Device ()
The documentation for this class was generated from the following file /__w/anklang/anklang/ase/api.hh