Recent changes to plugin

plugin modified by Joel Krähemann

Joel Krähemann — Sun, 30 Nov 2014 08:33:56 -0000

--- v4
+++ v5
@@ -1,6 +1,8 @@
 Plugin interface to do abstraction
 ==================
 The AgsPlugin interface defines some elementary functions like get_name() or set_name() and therefor get_version(), set_version(), get_build_id() and set_build_id(). Further it contains functions used to persist it using XML. This would be get_xml_type(), set_xml_type(), read() and write(). And get_ports() and set_ports() to allow thread safe communication between the different layers of Advanced Gtk+ Sequencer but to be said those functions accomplish for persisting and restoring.
+
+[[img src=AGS_plugin.png alt=Diagram width=600]]

 Hands-on
 ==================

plugin modified by Joel Krähemann

Joel Krähemann — Sun, 30 Nov 2014 02:43:07 -0000

--- v3
+++ v4
@@ -1,4 +1,100 @@
 Plugin interface to do abstraction
 ==================
-The AgsPlugin interface defines some elementary functions like get_name() or set_name() and therefor get_version(), set_version(), get_build_id() and set_build_id(). Further it contains functions used to persist it using XML. This would be get_xml_type(), set_xml_type(), read() and write(). And get_ports() and set_ports() to allow thread safe communication between the different layers of Advanced Gtk+ Sequencer.
+The AgsPlugin interface defines some elementary functions like get_name() or set_name() and therefor get_version(), set_version(), get_build_id() and set_build_id(). Further it contains functions used to persist it using XML. This would be get_xml_type(), set_xml_type(), read() and write(). And get_ports() and set_ports() to allow thread safe communication between the different layers of Advanced Gtk+ Sequencer but to be said those functions accomplish for persisting and restoring.

+Hands-on
+==================
+The following example illustrates the usage of AgsPluginInterface with ags-echo effect.
+
+First you need to tell object type system to use the AgsPluginInterface this is normally done in the classes get_type() function.
+
+~~~~~~
+GType
+ags_echo_channel_get_type()
+{
+  static GType ags_type_echo_channel = 0;
+
+  if(!ags_type_echo_channel){
+    static const GTypeInfo ags_echo_channel_info = {
+      sizeof (AgsEchoChannelClass),
+      NULL, /* base_init */
+      NULL, /* base_finalize */
+      (GClassInitFunc) ags_echo_channel_class_init,
+      NULL, /* class_finalize */
+      NULL, /* class_channel */
+      sizeof (AgsEchoChannel),
+      0,    /* n_preallocs */
+      (GInstanceInitFunc) ags_echo_channel_init,
+    };
+
+    static const GInterfaceInfo ags_plugin_interface_info = {
+      (GInterfaceInitFunc) ags_echo_channel_plugin_interface_init,
+      NULL, /* interface_finalize */
+      NULL, /* interface_data */
+    };
+
+    ags_type_echo_channel = g_type_register_static(AGS_TYPE_RECALL_CHANNEL,
+                                                  "AgsEchoChannel\0",
+                                                  &ags_echo_channel_info,
+                                                  0);
+
+    g_type_add_interface_static(ags_type_echo_channel,
+                                AGS_TYPE_PLUGIN,
+                                &ags_plugin_interface_info);
+  }
+
+  return(ags_type_echo_channel);
+}
+~~~~~~
+
+Implement its set_ports() function.
+
+~~~~~~
+void
+ags_echo_channel_plugin_interface_init(AgsPluginInterface *plugin)
+{
+  ags_echo_channel_parent_plugin_interface = g_type_interface_peek_parent(plugin);
+
+
+  plugin->set_ports = ags_echo_channel_set_ports;
+}
+~~~~~~
+
+Finally load the ports restored of XML file.
+
+~~~~~~
+ags_echo_channel_set_ports(AgsPlugin *plugin, GList *port)
+{
+  while(port != NULL){
+    if(!strncmp(AGS_PORT(port->data)->specifier,
+                "./delay[0]\0",
+                10)){
+      g_object_set(G_OBJECT(plugin),
+                   "delay\0", AGS_PORT(port->data),
+                   NULL);
+    }else if(!strncmp(AGS_PORT(port->data)->specifier,
+                      "./repeat[0]\0",
+                      11)){
+      g_object_set(G_OBJECT(plugin),
+                   "repeat\0", AGS_PORT(port->data),
+                   NULL);
+    }else if(!strncmp(AGS_PORT(port->data)->specifier,
+                      "./fade[0]\0",
+                      9)){
+      g_object_set(G_OBJECT(plugin),
+                   "fade\0", AGS_PORT(port->data),
+                   NULL);
+    }else if(!strncmp(AGS_PORT(port->data)->specifier,
+                      "./dry[0]\0",
+                      8)){
+      g_object_set(G_OBJECT(plugin),
+                   "dry\0", AGS_PORT(port->data),
+                   NULL);
+    }
+
+    port = port->next;
+  }
+}
+~~~~~~
+
+Wow that's all.

plugin modified by Joel Krähemann

Joel Krähemann — Sun, 30 Nov 2014 02:21:27 -0000

--- v2
+++ v3
@@ -1,4 +1,4 @@
 Plugin interface to do abstraction
 ==================
-The AgsPlugin interface defines some elementary functions like get_name() or set_name() and therefor get_version(), set_version(), get_build_id() and set_build_id(). Further it contains functions used to persist it using XML. This would be get_xml_type(), set_xml_type(), read() and write(). And get_ports() and set_ports() to allow thread safe communication between the different layers of Advanced Gtk+ Sequencer.
+The AgsPlugin interface defines some elementary functions like get_name() or set_name() and therefor get_version(), set_version(), get_build_id() and set_build_id(). Further it contains functions used to persist it using XML. This would be get_xml_type(), set_xml_type(), read() and write(). And get_ports() and set_ports() to allow thread safe communication between the different layers of Advanced Gtk+ Sequencer.

plugin modified by Joel Krähemann

Joel Krähemann — Sun, 30 Nov 2014 02:19:50 -0000

--- v1
+++ v2
@@ -1,3 +1,4 @@
 Plugin interface to do abstraction
 ==================
+The AgsPlugin interface defines some elementary functions like get_name() or set_name() and therefor get_version(), set_version(), get_build_id() and set_build_id(). Further it contains functions used to persist it using XML. This would be get_xml_type(), set_xml_type(), read() and write(). And get_ports() and set_ports() to allow thread safe communication between the different layers of Advanced Gtk+ Sequencer.

plugin modified by Joel Krähemann

Joel Krähemann — Sun, 30 Nov 2014 02:14:00 -0000

Plugin interface to do abstraction