Class Ase::DeviceImpl

ClassList > Ase > DeviceImpl

Inherits the following classes: Ase::GadgetImpl, Ase::Device

Inherited by the following classes: Ase::ClapDeviceImpl, Ase::NativeDeviceImpl, Ase::ProjectImpl, Ase::TrackImpl

Public Types inherited from Ase::GadgetImpl

See Ase::GadgetImpl

Type	Name
typedef std::function< bool(GadgetImpl *, const Value *, Value *)>	MemberAccessF
typedef bool(*)(const SharedBase &)	MemberClassT
typedef const StringS &(*)()	MemberInfosP

Public Attributes inherited from Ase::Gadget

See Ase::Gadget

Type	Name
Member<&Gadget::name_ >	name

Public Attributes inherited from Ase::Device

See Ase::Device

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
void	_activate () override
void	_deactivate () override
void	_disconnect_remove () override
bool	gui_supported () override
void	gui_toggle () override
bool	gui_visible () override
bool	is_active () override
DeviceS	list_devices () override

Public Functions inherited from Ase::GadgetImpl

See Ase::GadgetImpl

Type	Name
virtual GadgetImpl *	_parent () override const Retrieve parent container.
void	_register_parameter (O * obj, M * memb, const Param::ExtraVals & ev) const
virtual void	_set_parent (GadgetImpl * parent) override Assign parent container.
virtual PropertyS	access_properties () override Retrieve handles for all properties.
virtual Value	get_data (const String & key) override const Retrieve session data.
virtual bool	set_data (const String & key, const Value & v) override Assign session data, prefix ephemerals with '_'.
virtual String	type_nick () override const

Public Functions inherited from Ase::EmittableImpl

See Ase::EmittableImpl

Type	Name
virtual void	emit_event (const String & type, const String & detail, const ValueR fields={}) override
virtual void	emit_notify (const String & detail) override Emit notify:detail , multiple notifications maybe coalesced if a CoalesceNotifies instance exists.
virtual ASE_USE_RESULT Connection	on_event (const String & eventselector, const EventHandler & eventhandler) override

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

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

Public Functions inherited from Ase::CustomDataContainer

See Ase::CustomDataContainer

Type	Name
bool	del_custom_data (CustomDataKey< T > * key) Delete the current contents of the custom keyed data member, invokes DataKey::destroy.
T	get_custom_data (CustomDataKey< T > * key) const Retrieve contents of the custom keyed data member, returns DataKey::fallback if nothing was set.
bool	has_custom_data (CustomDataKey< T > * key) const Retrieve wether contents of the custom keyed data member exists.
void	set_custom_data (CustomDataKey< T > * key, T data) Assign data to the custom keyed data member, deletes any previously set data.

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

Public Functions inherited from Ase::Device

See Ase::Device

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

Public Static Functions

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

Protected Types inherited from Ase::GadgetImpl

See Ase::GadgetImpl

Type	Name
enum uint64_t	GadgetImpl

Protected Attributes inherited from Ase::GadgetImpl

See Ase::GadgetImpl

Type	Name
PropertyImplS	props_

Protected Functions

Type	Name
	DeviceImpl ()
void	_set_parent (GadgetImpl * parent) override

Protected Functions inherited from Ase::GadgetImpl

See Ase::GadgetImpl

Type	Name
virtual void	create_properties ()
virtual String	fallback_name () const
uint64_t	gadget_flags () const
uint64_t	gadget_flags (uint64_t setbits, uint64_t mask=~uint64_t(0))
virtual bool	name_ (const std::string * n, std::string * q) override
virtual void	serialize (WritNode & xs) override Serialize members and childern.
virtual	~GadgetImpl ()

Protected Functions inherited from Ase::ObjectImpl

See Ase::ObjectImpl

Type	Name
virtual	~ObjectImpl () = 0

Protected Functions inherited from Ase::EmittableImpl

See Ase::EmittableImpl

Type	Name
virtual	~EmittableImpl ()

Protected Functions inherited from Ase::VirtualBase

See Ase::VirtualBase

Type	Name
virtual	~VirtualBase () noexcept = 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

Protected Functions inherited from Ase::CustomDataContainer

See Ase::CustomDataContainer

Type	Name
void	custom_data_destroy ()
	~CustomDataContainer ()

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

Protected Functions inherited from Ase::Serializable

See Ase::Serializable

Type	Name
virtual void	serialize (WritNode & xs) = 0 Serialize members and childern.

Protected Functions inherited from Ase::VirtualBase

See Ase::VirtualBase

Type	Name
virtual	~VirtualBase () noexcept = 0

Protected Functions inherited from Ase::Device

See Ase::Device

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

Protected Static Functions inherited from Ase::GadgetImpl

See Ase::GadgetImpl

Type	Name
String	canonify_key (const String & input)

Public Functions Documentation

function _activate

void Ase::DeviceImpl::_activate () override

---

function _deactivate

void Ase::DeviceImpl::_deactivate () override

---

function _disconnect_remove

void Ase::DeviceImpl::_disconnect_remove () override

---

function gui_supported

inline bool Ase::DeviceImpl::gui_supported () override

---

function gui_toggle

inline void Ase::DeviceImpl::gui_toggle () override

---

function gui_visible

inline bool Ase::DeviceImpl::gui_visible () override

---

function is_active

inline bool Ase::DeviceImpl::is_active () override

---

function list_devices

inline DeviceS Ase::DeviceImpl::list_devices () override

---

Public Static Functions Documentation

function extract_info

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

---

Protected Functions Documentation

function DeviceImpl

inline explicit Ase::DeviceImpl::DeviceImpl () 

---

function _set_parent

void Ase::DeviceImpl::_set_parent (
    GadgetImpl * parent
) override

---

---

The documentation for this class was generated from the following file /__w/anklang/anklang/ase/device.hh