Ase::Plugin implementation wrapping tracktion::Plugin. More...

#include "plugin.hh"

Inheritance diagram for Ase::PluginImpl:

Classes
class	PluginStateListener

Public Member Functions
	PluginImpl (tracktion::Plugin &plugin)

String	name () const override

void	name (const std::string &) override

DeviceInfo	device_info () override
	Describe this Device type.

String	plugin_type () const override
	Plugin type identifier.

bool	enabled () const override
	Check if plugin is enabled.

void	enabled (bool enabled) override
	Enable or disable the plugin.

bool	frozen () const override
	Check if plugin is frozen.

void	frozen (bool frozen) override
	Freeze or unfreeze the plugin.

void	remove_self () override
	Remove self from parent container.

StringS	read_only_properties () const override
	List x()/x (v) properties that this object can't change, their setters ignore the value or warn.

tracktion::Plugin *	plugin () const noexcept
	Access underlying tracktion::Plugin (for internal use).

Public Member Functions inherited from Ase::GadgetImpl
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 >
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)

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)
	Set native property value.

Static Public Member Functions
static PluginImplP	from_trkn (tracktion::Plugin &)

Protected Attributes
SelectableWeakref< tracktion::Plugin >	plugin_

std::string	plugin_type_

Protected Attributes inherited from Ase::GadgetImpl
PropertyImplS	props_

Friends
class	TrackImpl

class	PluginStateListener

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 EventHandler &	eventhandler

Protected Types inherited from Ase::GadgetImpl
enum	: uint64_t { GADGET_DESTROYED , DEVICE_ACTIVE , MASTER_TRACK }

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 void	create_properties ()

Static Protected Member Functions inherited from Ase::GadgetImpl
static String	canonify_key (const String &input)

Detailed Description

Ase::Plugin implementation wrapping tracktion::Plugin.

Definition at line 10 of file plugin.hh.

Constructor & Destructor Documentation

◆ ~PluginImpl()

Ase::PluginImpl::~PluginImpl ( )

protectedvirtual

Definition at line 72 of file plugin.cc.

◆ PluginImpl()

Ase::PluginImpl::PluginImpl ( tracktion::Plugin & plugin )

explicit

Definition at line 65 of file plugin.cc.

Member Function Documentation

◆ device_info()

DeviceInfo Ase::PluginImpl::device_info ( )

overridevirtual

Describe this Device type.

Implements Ase::Device.

Definition at line 135 of file plugin.cc.

◆ enabled() [1/2]

bool Ase::PluginImpl::enabled ( ) const

overridevirtual

Check if plugin is enabled.

Implements Ase::Plugin.

Definition at line 105 of file plugin.cc.

Referenced by enabled().

◆ enabled() [2/2]

void Ase::PluginImpl::enabled ( bool enabled )

overridevirtual

Enable or disable the plugin.

Implements Ase::Plugin.

Definition at line 113 of file plugin.cc.

References enabled().

◆ from_trkn()

PluginImplP Ase::PluginImpl::from_trkn ( tracktion::Plugin & p )

static

Definition at line 56 of file plugin.cc.

◆ frozen() [1/2]

bool Ase::PluginImpl::frozen ( ) const

overridevirtual

Check if plugin is frozen.

Implements Ase::Plugin.

Definition at line 120 of file plugin.cc.

Referenced by frozen().

◆ frozen() [2/2]

void Ase::PluginImpl::frozen ( bool frozen )

overridevirtual

Freeze or unfreeze the plugin.

Implements Ase::Plugin.

Definition at line 128 of file plugin.cc.

References frozen().

◆ name() [1/2]

String Ase::PluginImpl::name ( ) const

overridevirtual

Implements Ase::Gadget.

Definition at line 80 of file plugin.cc.

◆ name() [2/2]

void Ase::PluginImpl::name ( const std::string & n )

overridevirtual

Implements Ase::Gadget.

Definition at line 88 of file plugin.cc.

◆ plugin()

tracktion::Plugin * Ase::PluginImpl::plugin ( ) const

noexcept

Access underlying tracktion::Plugin (for internal use).

Definition at line 32 of file plugin.hh.

Referenced by remove_self().

◆ plugin_type()

String Ase::PluginImpl::plugin_type ( ) const

overridevirtual

Plugin type identifier.

Implements Ase::Plugin.

Definition at line 99 of file plugin.cc.

◆ read_only_properties()

StringS Ase::PluginImpl::read_only_properties ( ) const

overridevirtual

List x()/x (v) properties that this object can't change, their setters ignore the value or warn.

Reimplemented from Ase::Gadget.

Definition at line 147 of file plugin.cc.

◆ remove_self()

void Ase::PluginImpl::remove_self ( )

overridevirtual

Remove self from parent container.

Reimplemented from Ase::GadgetImpl.

Definition at line 153 of file plugin.cc.

References plugin(), and Ase::GadgetImpl::remove_self().

Friends And Related Symbol Documentation

◆ PluginStateListener

friend class PluginStateListener

friend

Definition at line 15 of file plugin.hh.

◆ TrackImpl

friend class TrackImpl

friend

Definition at line 14 of file plugin.hh.

Member Data Documentation

◆ plugin_

SelectableWeakref<tracktion::Plugin> Ase::PluginImpl::plugin_

protected

Definition at line 17 of file plugin.hh.

◆ plugin_type_

std::string Ase::PluginImpl::plugin_type_

protected

Definition at line 18 of file plugin.hh.

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

ase/plugin.hh
ase/plugin.cc

Classes

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~PluginImpl()

◆ PluginImpl()

Member Function Documentation

◆ device_info()

◆ enabled() [1/2]

◆ enabled() [2/2]

◆ from_trkn()

◆ frozen() [1/2]

◆ frozen() [2/2]

◆ name() [1/2]

◆ name() [2/2]

◆ plugin()

◆ plugin_type()

◆ read_only_properties()

◆ remove_self()

Friends And Related Symbol Documentation

◆ PluginStateListener

◆ TrackImpl

Member Data Documentation

◆ plugin_

◆ plugin_type_