Anklang-0.3.0.dev956+gd75ac925 anklang-0.3.0.dev956+gd75ac925
ASE — Anklang Sound Engine (C++)

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Ase::Plugin Class Referenceabstract

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

#include "api.hh"

Inheritance diagram for Ase::Plugin:
[legend]

Public Member Functions

virtual String plugin_type () const =0
 Plugin type identifier.
 
virtual bool is_enabled () const =0
 Check if plugin is enabled.
 
virtual void set_enabled (bool enabled)=0
 Enable or disable the plugin.
 
virtual bool is_frozen () const =0
 Check if plugin is frozen.
 
virtual void set_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 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 >
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)
 

Additional Inherited Members

- Public Attributes inherited from Ase::Emittable
const EventHandlereventhandler
 

Detailed Description

Plugin wrapper for tracktion_engine plugins on tracks.

Definition at line 217 of file api.hh.

Member Function Documentation

◆ is_enabled()

virtual bool Ase::Plugin::is_enabled ( ) const
pure virtual

Check if plugin is enabled.

Implemented in Ase::PluginImpl.

◆ is_frozen()

virtual bool Ase::Plugin::is_frozen ( ) const
pure virtual

Check if plugin is frozen.

Implemented in Ase::PluginImpl.

◆ plugin_type()

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

Plugin type identifier.

Implemented in Ase::PluginImpl.

◆ set_enabled()

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

Enable or disable the plugin.

Implemented in Ase::PluginImpl.

◆ set_frozen()

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

Freeze or unfreeze the plugin.

Implemented in Ase::PluginImpl.


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