Ase::Plugin Class Reference

Plugin wrapper for tracktion_engine plugins on tracks. More...

#include "api.hh"

Inheritance diagram for Ase::Plugin:

Public Member Functions
virtual String	plugin_type () const =0
	Plugin type identifier.
virtual bool	enabled () const =0
	Check if plugin is enabled.
virtual void	enabled (bool enabled)=0
	Enable or disable the plugin.
virtual bool	frozen () const =0
	Check if plugin is frozen.
virtual void	frozen (bool frozen)=0
	Freeze or unfreeze the plugin.
Public Member Functions inherited from Ase::Device
virtual DeviceInfo	device_info ()=0
	Describe this Device type.
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	name () const =0
virtual void	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)
	Set native property value.
virtual StringS	read_only_properties () const
	List x()/x (v) properties that this object can't change, their setters ignore the value or warn.
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.
virtual void	remove_self ()=0
	Remove self from parent container.
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 >
T	enable_shared_from_this (T... args)
T	operator= (T... args)
T	shared_from_this (T... args)
T	weak_from_this (T... args)
T	~enable_shared_from_this (T... args)

Additional Inherited Members
Public Attributes inherited from Ase::Emittable
const EventHandler &	eventhandler

Detailed Description

Plugin wrapper for tracktion_engine plugins on tracks.

Definition at line 219 of file api.hh.

Member Function Documentation

enabled() [1/2]

virtual bool Ase::Plugin::enabled ( ) const

pure virtual

Check if plugin is enabled.

Implemented in Ase::PluginImpl.

enabled() [2/2]

virtual void Ase::Plugin::enabled ( bool  enabled )

pure virtual

Enable or disable the plugin.

Implemented in Ase::PluginImpl.

frozen() [1/2]

virtual bool Ase::Plugin::frozen ( ) const

pure virtual

Check if plugin is frozen.

Implemented in Ase::PluginImpl.

frozen() [2/2]

virtual void Ase::Plugin::frozen ( bool  frozen )

pure virtual

Freeze or unfreeze the plugin.

Implemented in Ase::PluginImpl.

plugin_type()

virtual String Ase::Plugin::plugin_type ( ) const

pure virtual

Plugin type identifier.

Implemented in Ase::PluginImpl.

---

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

• ase/api.hh