XMMS2
Data Structures | Macros | Typedefs | Functions
xmms_plugin.h File Reference
#include <xmms/xmms_object.h>
#include <xmms/xmms_plugin.h>
#include <xmms/xmms_config.h>
#include <gmodule.h>

Data Structures

struct  xmms_plugin_St
 

Macros

#define XMMS_BUILTIN_DEFINE(type, api_ver, shname, name, ver, desc, setupfunc)
 

Typedefs

typedef struct xmms_plugin_St xmms_plugin_t
 
typedef gboolean(* xmms_plugin_foreach_func_t) (xmms_plugin_t *, gpointer)
 

Functions

gboolean xmms_plugin_load (const xmms_plugin_desc_t *desc, GModule *module)
 
gboolean xmms_plugin_init (const gchar *path)
 
void xmms_plugin_shutdown (void)
 
void xmms_plugin_destroy (xmms_plugin_t *plugin)
 
void xmms_plugin_foreach (xmms_plugin_type_t type, xmms_plugin_foreach_func_t func, gpointer user_data)
 
xmms_plugin_txmms_plugin_find (xmms_plugin_type_t type, const gchar *name)
 
xmms_plugin_type_t xmms_plugin_type_get (const xmms_plugin_t *plugin)
 
const char * xmms_plugin_name_get (const xmms_plugin_t *plugin)
 
const gchar * xmms_plugin_shortname_get (const xmms_plugin_t *plugin)
 
const gchar * xmms_plugin_version_get (const xmms_plugin_t *plugin)
 
const char * xmms_plugin_description_get (const xmms_plugin_t *plugin)
 
xmms_config_property_txmms_plugin_config_lookup (xmms_plugin_t *plugin, const gchar *key)
 
xmms_config_property_txmms_plugin_config_property_register (xmms_plugin_t *plugin, const gchar *name, const gchar *default_value, xmms_object_handler_t cb, gpointer userdata)
 

Macro Definition Documentation

◆ XMMS_BUILTIN_DEFINE

#define XMMS_BUILTIN_DEFINE ( type,
api_ver,
shname,
name,
ver,
desc,
setupfunc )
Value:
const xmms_plugin_desc_t xmms_builtin_##shname = { \
type, \
api_ver, \
G_STRINGIFY(shname), \
name, \
ver, \
desc, \
setupfunc \
};

Typedef Documentation

◆ xmms_plugin_foreach_func_t

typedef gboolean(* xmms_plugin_foreach_func_t) (xmms_plugin_t *, gpointer)

◆ xmms_plugin_t

typedef struct xmms_plugin_St xmms_plugin_t

Function Documentation

◆ xmms_plugin_config_lookup()

xmms_config_property_t * xmms_plugin_config_lookup ( xmms_plugin_t * plugin,
const gchar * key )

◆ xmms_plugin_config_property_register()

xmms_config_property_t * xmms_plugin_config_property_register ( xmms_plugin_t * plugin,
const gchar * name,
const gchar * default_value,
xmms_object_handler_t cb,
gpointer userdata )

◆ xmms_plugin_description_get()

const char * xmms_plugin_description_get ( const xmms_plugin_t * plugin)

◆ xmms_plugin_destroy()

void xmms_plugin_destroy ( xmms_plugin_t * plugin)

◆ xmms_plugin_find()

xmms_plugin_t * xmms_plugin_find ( xmms_plugin_type_t type,
const gchar * name )

◆ xmms_plugin_foreach()

void xmms_plugin_foreach ( xmms_plugin_type_t type,
xmms_plugin_foreach_func_t func,
gpointer user_data )

◆ xmms_plugin_init()

gboolean xmms_plugin_init ( const gchar * path)

Referenced by main().

◆ xmms_plugin_load()

gboolean xmms_plugin_load ( const xmms_plugin_desc_t * desc,
GModule * module )

◆ xmms_plugin_name_get()

const char * xmms_plugin_name_get ( const xmms_plugin_t * plugin)

◆ xmms_plugin_shortname_get()

const gchar * xmms_plugin_shortname_get ( const xmms_plugin_t * plugin)

◆ xmms_plugin_shutdown()

void xmms_plugin_shutdown ( void )

◆ xmms_plugin_type_get()

xmms_plugin_type_t xmms_plugin_type_get ( const xmms_plugin_t * plugin)

◆ xmms_plugin_version_get()

const gchar * xmms_plugin_version_get ( const xmms_plugin_t * plugin)