AgsPlugin

AgsPlugin — interfacing plugins

Functions

Object Hierarchy

    GInterface
    ╰── AgsPlugin

Known Implementations

AgsPlugin is implemented by AgsAudioFileLink, AgsBufferAudioSignal, AgsBufferChannel, AgsBufferChannelRun, AgsBufferRecycling, AgsCopyAudioSignal, AgsCopyChannel, AgsCopyChannelRun, AgsCopyNotationAudio, AgsCopyNotationAudioRun, AgsCopyPatternAudio, AgsCopyPatternAudioRun, AgsCopyPatternChannel, AgsCopyPatternChannelRun, AgsCopyRecycling, AgsCountBeatsAudio, AgsCountBeatsAudioRun, AgsDelayAudio, AgsDelayAudioRun, AgsDrum, AgsDrumInputLine, AgsDrumInputPad, AgsDrumOutputLine, AgsDrumOutputPad, AgsDssiBridge, AgsEffectBridge, AgsEffectBulk, AgsEffectLine, AgsEffectPad, AgsEnvelopeAudioSignal, AgsEnvelopeChannel, AgsEnvelopeChannelRun, AgsEnvelopeRecycling, AgsFFPlayer, AgsFFPlayerBridge, AgsFFPlayerBulkInput, AgsFFPlayerInputLine, AgsFFPlayerInputPad, AgsFileLink, AgsLadspaBridge, AgsLine, AgsLoopChannel, AgsLoopChannelRun, AgsLv2Bridge, AgsMachine, AgsMatrix, AgsMatrixBridge, AgsMatrixBulkInput, AgsMixer, AgsMixerInputLine, AgsMixerInputPad, AgsMuteAudio, AgsMuteAudioRun, AgsMuteAudioSignal, AgsMuteChannel, AgsMuteChannelRun, AgsMuteRecycling, AgsPad, AgsPanel, AgsPanelInputLine, AgsPanelInputPad, AgsPeakAudioSignal, AgsPeakChannel, AgsPeakChannelRun, AgsPeakRecycling, AgsPlayAudio, AgsPlayAudioFile, AgsPlayAudioSignal, AgsPlayChannel, AgsPlayChannelRun, AgsPlayChannelRunMaster, AgsPlayNotationAudio, AgsPlayNotationAudioRun, AgsPlayNote, AgsPlayRecycling, AgsRecall, AgsRecallAudio, AgsRecallAudioRun, AgsRecallAudioSignal, AgsRecallChannel, AgsRecallChannelRun, AgsRecallChannelRunDummy, AgsRecallDssi, AgsRecallDssiRun, AgsRecallLadspa, AgsRecallLadspaRun, AgsRecallLv2, AgsRecallLv2Run, AgsRecallRecycling, AgsRecallRecyclingDummy, AgsRecordMidiAudio, AgsRecordMidiAudioRun, AgsRouteDssiAudio, AgsRouteDssiAudioRun, AgsRouteLv2Audio, AgsRouteLv2AudioRun, AgsStreamAudioSignal, AgsStreamChannel, AgsStreamChannelRun, AgsStreamRecycling, AgsSynth, AgsSynthGenerator, AgsSynthInputLine, AgsSynthInputPad, AgsVolumeAudioSignal, AgsVolumeChannel, AgsVolumeChannelRun and AgsVolumeRecycling.

Includes

#include <ags/object/ags_plugin.h>

Description

The AgsPlugin interface gives you a unique access to recalls, line members, lines, pads or machines ...

Functions

ags_plugin_get_name ()

gchar *
ags_plugin_get_name (AgsPlugin *plugin);

Retrieve the name of the plugin.

Parameters

plugin

an AgsPlugin

 

Returns

the plugins name

Since: 0.4.0


ags_plugin_set_name ()

void
ags_plugin_set_name (AgsPlugin *plugin,
                     gchar *name);

Set the name of the plugin.

Parameters

plugin

an AgsPlugin

 

name

the name of plugin

 

Since: 0.4.0


ags_plugin_get_version ()

gchar *
ags_plugin_get_version (AgsPlugin *plugin);

Retrieve the version of the plugin.

Parameters

plugin

an AgsPlugin

 

Returns

the plugins version

Since: 0.4.0


ags_plugin_set_version ()

void
ags_plugin_set_version (AgsPlugin *plugin,
                        gchar *version);

Set the version of the plugin.

Parameters

plugin

an AgsPlugin

 

version

the version of plugin

 

Since: 0.4.0


ags_plugin_get_build_id ()

gchar *
ags_plugin_get_build_id (AgsPlugin *plugin);

Retrieve the build id of the plugin.

Parameters

plugin

an AgsPlugin

 

Returns

the plugins build id

Since: 0.4.0


ags_plugin_set_build_id ()

void
ags_plugin_set_build_id (AgsPlugin *plugin,
                         gchar *build_id);

Set the build id of the plugin.

Parameters

plugin

an AgsPlugin

 

build_id

the build id of plugin

 

Since: 0.4.0


ags_plugin_get_xml_type ()

gchar *
ags_plugin_get_xml_type (AgsPlugin *plugin);

Retrieve the xml type of the plugin.

Parameters

plugin

an AgsPlugin

 

Returns

the plugins xml type

Since: 0.4.0


ags_plugin_set_xml_type ()

void
ags_plugin_set_xml_type (AgsPlugin *plugin,
                         gchar *xml_type);

Set the build id of the plugin.

Parameters

plugin

an AgsPlugin

 

xml_type

the build id of plugin

 

Since: 0.4.0


ags_plugin_get_ports ()

GList *
ags_plugin_get_ports (AgsPlugin *plugin);

Retrieve the ports of the plugin.

Parameters

plugin

an AgsPlugin

 

Returns

the plugins ports

Since: 0.4.0


ags_plugin_set_ports ()

void
ags_plugin_set_ports (AgsPlugin *plugin,
                      GList *ports);

Set the build id of the plugin.

Parameters

plugin

an AgsPlugin

 

ports

the build id of plugin

 

Since: 0.4.0


ags_plugin_read ()

void
ags_plugin_read (AgsFile *file,
                 xmlNode *node,
                 AgsPlugin *plugin);

Read of file.

Parameters

file

the AgsFile

 

node

the node

 

plugin

the AgsPlugin

 

Since: 0.4.0


ags_plugin_write ()

xmlNode *
ags_plugin_write (AgsFile *file,
                  xmlNode *parent,
                  AgsPlugin *plugin);

Write to file.

Parameters

file

the AgsFile

 

parent

the parent node

 

plugin

the AgsPlugin

 

Returns

the new node you created

Since: 0.4.0

Types and Values