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

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

Public Member Functions

PropertyS access_properties () override
 Retrieve handles for all properties.
 
AudioProcessorP _audio_processor () const override
 Retrieve the corresponding AudioProcessor.
 
AudioComboP audio_combo () const
 
bool is_combo_device () override
 Retrieve wether this NativeDevice handles sub devices.
 
DeviceInfo device_info () override
 Describe this Device type.
 
DeviceS list_devices () override
 
void remove_device (Device &sub) override
 Remove a directly contained device.
 
DeviceP append_device (const String &uri) override
 Append a new device, see list_device_types().
 
DeviceP insert_device (const String &uri, Device &beforesibling) override
 Insert a new device, before beforesibling.
 
void remove_all_devices ()
 
void _set_event_source (AudioProcessorP esource) override
 
void _disconnect_remove () override
 Disconnect the device and remove all object references.
 
- Public Member Functions inherited from Ase::DeviceImpl
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.
 
- Public Member Functions inherited from Ase::GadgetImpl
String get_name () const override
 
void set_name (const std::string &n) override
 
GadgetImpl_parent () const override
 Retrieve parent container.
 
String type_nick () const override
 
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.
 
void remove_self ()
 Remove device from its container.
 
- Public Member Functions inherited from Ase::NativeDevice
DeviceInfoS list_device_types ()
 List registered Device types with their unique uri.
 

Protected Member Functions

void serialize (WritNode &xs) override
 Serialize members and childern.
 
void _set_parent (GadgetImpl *parent) override
 Assign parent container.
 
void _activate () override
 Add AudioProcessor to the Engine and start processing.
 
void _deactivate () override
 Stop processing the corresponding AudioProcessor.
 
 NativeDeviceImpl (const String &aseid, AudioProcessor::StaticInfo, AudioProcessorP)
 
- 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
 
virtual void create_properties ()
 
- Protected Member Functions inherited from Ase::CustomDataContainer
void custom_data_destroy ()
 

Static Protected Member Functions

static DeviceP create_native_device (AudioEngine &engine, const String &registryuri)
 
- Static Protected Member Functions inherited from Ase::GadgetImpl
static String canonify_key (const String &input)
 

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 &)
 
- Static Public Member Functions inherited from Ase::DeviceImpl
static DeviceInfo extract_info (const String &aseid, const AudioProcessor::StaticInfo &static_info)
 
- 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 }
 
- Protected Attributes inherited from Ase::GadgetImpl
PropertyImplS props_
 

Detailed Description

Definition at line 10 of file nativedevice.hh.

Constructor & Destructor Documentation

◆ NativeDeviceImpl()

Ase::NativeDeviceImpl::NativeDeviceImpl ( const String aseid,
AudioProcessor::StaticInfo  static_info,
AudioProcessorP  aproc 
)
explicitprotected

Definition at line 13 of file nativedevice.cc.

Member Function Documentation

◆ _activate()

void Ase::NativeDeviceImpl::_activate ( )
overrideprotectedvirtual

Add AudioProcessor to the Engine and start processing.

Reimplemented from Ase::DeviceImpl.

Definition at line 80 of file nativedevice.cc.

References assert_return.

◆ _audio_processor()

AudioProcessorP Ase::NativeDeviceImpl::_audio_processor ( ) const
overridevirtual

Retrieve the corresponding AudioProcessor.

Implements Ase::Device.

Definition at line 27 of file nativedevice.hh.

◆ _deactivate()

void Ase::NativeDeviceImpl::_deactivate ( )
overrideprotectedvirtual

Stop processing the corresponding AudioProcessor.

Reimplemented from Ase::DeviceImpl.

Definition at line 89 of file nativedevice.cc.

References assert_return.

◆ _disconnect_remove()

void Ase::NativeDeviceImpl::_disconnect_remove ( )
overridevirtual

Disconnect the device and remove all object references.

Reimplemented from Ase::DeviceImpl.

Definition at line 176 of file nativedevice.cc.

References Ase::AudioEngine::async_jobs.

◆ _set_event_source()

void Ase::NativeDeviceImpl::_set_event_source ( AudioProcessorP  esource)
overridevirtual

Implements Ase::Device.

Definition at line 53 of file nativedevice.cc.

◆ _set_parent()

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

Assign parent container.

Reimplemented from Ase::DeviceImpl.

Definition at line 73 of file nativedevice.cc.

References assert_warn.

◆ access_properties()

PropertyS Ase::NativeDeviceImpl::access_properties ( )
overridevirtual

Retrieve handles for all properties.

Reimplemented from Ase::GadgetImpl.

Definition at line 47 of file nativedevice.cc.

◆ append_device()

DeviceP Ase::NativeDeviceImpl::append_device ( const String uri)
overridevirtual

Append a new device, see list_device_types().

Implements Ase::NativeDevice.

Definition at line 164 of file nativedevice.cc.

◆ audio_combo()

AudioComboP Ase::NativeDeviceImpl::audio_combo ( ) const

Definition at line 28 of file nativedevice.hh.

◆ create_native_device()

DeviceP Ase::NativeDeviceImpl::create_native_device ( AudioEngine engine,
const String registryuri 
)
staticprotected

Definition at line 192 of file nativedevice.cc.

◆ device_info()

DeviceInfo Ase::NativeDeviceImpl::device_info ( )
overridevirtual

Describe this Device type.

Implements Ase::Device.

Definition at line 30 of file nativedevice.hh.

◆ insert_device()

DeviceP Ase::NativeDeviceImpl::insert_device ( const String uri,
Device beforesibling 
)
overridevirtual

Insert a new device, before beforesibling.

Implements Ase::NativeDevice.

Definition at line 170 of file nativedevice.cc.

◆ is_combo_device()

bool Ase::NativeDeviceImpl::is_combo_device ( )
overridevirtual

Retrieve wether this NativeDevice handles sub devices.

Implements Ase::NativeDevice.

Definition at line 29 of file nativedevice.hh.

◆ list_devices()

DeviceS Ase::NativeDeviceImpl::list_devices ( )
overridevirtual

Reimplemented from Ase::DeviceImpl.

Definition at line 32 of file nativedevice.hh.

◆ remove_all_devices()

void Ase::NativeDeviceImpl::remove_all_devices ( )

Definition at line 66 of file nativedevice.cc.

◆ remove_device()

void Ase::NativeDeviceImpl::remove_device ( Device sub)
overridevirtual

Remove a directly contained device.

Implements Ase::NativeDevice.

Definition at line 107 of file nativedevice.cc.

References Ase::Gadget::_parent(), and assert_return.

◆ serialize()

void Ase::NativeDeviceImpl::serialize ( WritNode xs)
overrideprotectedvirtual

Serialize members and childern.

Reimplemented from Ase::GadgetImpl.

Definition at line 20 of file nativedevice.cc.

References std::string::empty(), Ase::WritNode::in_load(), Ase::WritNode::in_save(), Ase::WritNode::push(), and Ase::WritNode::to_nodes().


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