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

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Ase::DeviceImpl Class Reference
Inheritance diagram for Ase::DeviceImpl:
[legend]

Public Member Functions

void _activate () override
 Add AudioProcessor to the Engine and start processing.
 
void _deactivate () override
 Stop processing the corresponding AudioProcessor.
 
DeviceS get_devices () const override
 List devices in order of processing, notified via "devs".
 
void set_devices (const DeviceS &newdevices) override
 Set the list of devices.
 
bool is_active () override
 Check whether this is the active synthesis engine project.
 
bool gui_supported () override
 Has GUI display facilities.
 
bool gui_visible () override
 Is GUI currently visible.
 
void gui_toggle () override
 Toggle GUI display.
 
void _disconnect_remove () override
 Disconnect the device and remove all object references.
 
- Public Member Functions inherited from Ase::GadgetImpl
String get_name () const override
 
void set_name (const std::string &n) override
 
void _set_parent (GadgetImpl *parent) override
 Assign parent container.
 
GadgetImpl_parent () const override
 Retrieve parent container.
 
String type_nick () const override
 
PropertyS access_properties () override
 Retrieve handles for all properties.
 
bool set_data (const String &key, const Value &v) override
 Assign session data, prefix ephemerals with '_'.
 
Value get_data (const String &key) const override
 Retrieve session data.
 
template<class O , class M >
void _register_parameter (O *, M *, const Param::ExtraVals &) const
 
- Public Member Functions inherited from Ase::EmittableImpl
ASE_USE_RESULT Connection on_event (const String &eventselector, const EventHandler &eventhandler) override
 
void emit_event (const String &type, const String &detail, const ValueR fields={}) override
 
void emit_notify (const String &detail) override
 Emit notify:detail, multiple notifications maybe coalesced if a CoalesceNotifies instance exists.
 
- Public Member Functions inherited from Ase::Emittable
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 Member Functions inherited from Ase::CustomDataContainer
template<class T >
void set_custom_data (CustomDataKey< T > *key, T data)
 Assign data to the custom keyed data member, deletes any previously set data.
 
template<class T >
get_custom_data (CustomDataKey< T > *key) const
 Retrieve contents of the custom keyed data member, returns DataKey::fallback if nothing was set.
 
template<class T >
bool has_custom_data (CustomDataKey< T > *key) const
 Retrieve wether contents of the custom keyed data member exists.
 
template<class T >
bool del_custom_data (CustomDataKey< T > *key)
 Delete the current contents of the custom keyed data member, invokes DataKey::destroy.
 
- Public Member Functions inherited from Ase::Gadget
ProjectImpl_project () const
 Find Project in parent ancestry.
 
virtual StringS list_properties ()
 List all property identifiers.
 
virtual PropertyP access_property (String ident)
 Retrieve handle for a Property.
 
Value get_value (String ident)
 Get native property value.
 
bool set_value (String ident, const Value &v)
 
- 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 DeviceInfo device_info ()=0
 Describe this Device type.
 
void remove_self ()
 Remove device from its container.
 

Static Public Member Functions

static DeviceInfo extract_info (const String &aseid, const AudioProcessor::StaticInfo &static_info)
 

Protected Member Functions

void _set_parent (GadgetImpl *parent) override
 Assign parent container.
 
virtual DeviceS list_devices ()
 
- Protected Member Functions inherited from Ase::GadgetImpl
uint64_t gadget_flags () const
 
uint64_t gadget_flags (uint64_t setbits, uint64_t mask=~uint64_t(0))
 
virtual String fallback_name () const
 
void serialize (WritNode &xs) override
 Serialize members and childern.
 
virtual void create_properties ()
 
- Protected Member Functions inherited from Ase::CustomDataContainer
void custom_data_destroy ()
 

Additional Inherited Members

- Public Types inherited from Ase::GadgetImpl
using MemberAccessF = std::function< bool(GadgetImpl *, const Value *, Value *)>
 
using MemberInfosP = const StringS &(*)()
 
using MemberClassT = bool(*)(const SharedBase &)
 
- Public Attributes inherited from Ase::Emittable
const EventHandlereventhandler
 
- Public Attributes inherited from Ase::Gadget
Member<&Gadget::get_name,&Gadget::set_name > name
 
- Public Attributes inherited from Ase::Device
Member<&Device::get_devices,&Device::set_devicesdevices
 
- Protected Types inherited from Ase::GadgetImpl
enum  : uint64_t { GADGET_DESTROYED , DEVICE_ACTIVE , MASTER_TRACK }
 
- Static Protected Member Functions inherited from Ase::GadgetImpl
static String canonify_key (const String &input)
 
- Protected Attributes inherited from Ase::GadgetImpl
PropertyImplS props_
 

Detailed Description

Definition at line 10 of file device.hh.

Constructor & Destructor Documentation

◆ DeviceImpl()

Ase::DeviceImpl::DeviceImpl ( )
explicitprotected

Definition at line 13 of file device.hh.

Member Function Documentation

◆ _activate()

void Ase::DeviceImpl::_activate ( )
overridevirtual

Add AudioProcessor to the Engine and start processing.

Implements Ase::Device.

Reimplemented in Ase::NativeDeviceImpl, Ase::ProjectImpl, and Ase::TrackImpl.

Definition at line 21 of file device.cc.

References assert_return.

Referenced by Ase::TrackImpl::_activate().

◆ _deactivate()

void Ase::DeviceImpl::_deactivate ( )
overridevirtual

Stop processing the corresponding AudioProcessor.

Implements Ase::Device.

Reimplemented in Ase::NativeDeviceImpl, Ase::ProjectImpl, and Ase::TrackImpl.

Definition at line 28 of file device.cc.

References assert_return.

Referenced by Ase::TrackImpl::_deactivate().

◆ _disconnect_remove()

void Ase::DeviceImpl::_disconnect_remove ( )
overridevirtual

Disconnect the device and remove all object references.

Implements Ase::Device.

Reimplemented in Ase::NativeDeviceImpl.

Definition at line 44 of file device.cc.

References Ase::AudioEngine::async_jobs, and return_unless.

◆ _set_parent()

void Ase::DeviceImpl::_set_parent ( GadgetImpl parent)
overrideprotectedvirtual

Assign parent container.

Implements Ase::Gadget.

Reimplemented in Ase::NativeDeviceImpl, and Ase::TrackImpl.

Definition at line 14 of file device.cc.

References assert_warn.

Referenced by Ase::ClapDeviceImpl::_set_parent(), and Ase::TrackImpl::_set_parent().

◆ extract_info()

DeviceInfo Ase::DeviceImpl::extract_info ( const String aseid,
const AudioProcessor::StaticInfo &  static_info 
)
static

Definition at line 60 of file device.cc.

◆ get_devices()

DeviceS Ase::DeviceImpl::get_devices ( ) const
overridevirtual

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

Implements Ase::Device.

Definition at line 19 of file device.hh.

◆ gui_supported()

bool Ase::DeviceImpl::gui_supported ( )
overridevirtual

Has GUI display facilities.

Implements Ase::Device.

Definition at line 22 of file device.hh.

◆ gui_toggle()

void Ase::DeviceImpl::gui_toggle ( )
overridevirtual

Toggle GUI display.

Implements Ase::Device.

Definition at line 24 of file device.hh.

◆ gui_visible()

bool Ase::DeviceImpl::gui_visible ( )
overridevirtual

Is GUI currently visible.

Implements Ase::Device.

Definition at line 23 of file device.hh.

◆ is_active()

bool Ase::DeviceImpl::is_active ( )
overridevirtual

Check whether this is the active synthesis engine project.

Implements Ase::Device.

Definition at line 21 of file device.hh.

Referenced by Ase::TrackImpl::_activate(), and Ase::TrackImpl::_deactivate().

◆ list_devices()

virtual DeviceS Ase::DeviceImpl::list_devices ( )
protectedvirtual

Definition at line 15 of file device.hh.

◆ set_devices()

void Ase::DeviceImpl::set_devices ( const DeviceS &  devices)
overridevirtual

Set the list of devices.

Implements Ase::Device.

Definition at line 20 of file device.hh.


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