Methods provided by an xform plugin. More...

#include <xmms_xformplugin.h>

Data Fields
gboolean(*	init )(xmms_xform_t *)
	Initialisation method. More...

void(*	destroy )(xmms_xform_t *)
	Destruction method. More...

gint(*	read )(xmms_xform_t , gpointer, gint, xmms_error_t )
	Read method. More...

gint64(*	seek )(xmms_xform_t , gint64, xmms_xform_seek_mode_t, xmms_error_t )
	Seek method. More...

gboolean(*	browse )(xmms_xform_t , const gchar , xmms_error_t *)
	browse method. More...

Detailed Description

Methods provided by an xform plugin.

Field Documentation

gboolean(* xmms_xform_methods_St::browse)(xmms_xform_t *, const gchar *, xmms_error_t *)

browse method.

Called when a users wants to do some server side browsing. This is called without init() beeing called.

void(* xmms_xform_methods_St::destroy)(xmms_xform_t *)

Destruction method.

Called when the xform isn't needed anymore. Should free any resources used by the xform.

gboolean(* xmms_xform_methods_St::init)(xmms_xform_t *)

Initialisation method.

Called when a new xform is to be instantiated. It should prepare for the transformation and use xmms_xform_outdata_type_add to inform what type of data it outputs.

Returns: TRUE if initialisation was successful, FALSE otherwise.

gint(* xmms_xform_methods_St::read)(xmms_xform_t *, gpointer, gint, xmms_error_t *)

Read method.

Called to read data from the xform.

gint64(* xmms_xform_methods_St::seek)(xmms_xform_t *, gint64, xmms_xform_seek_mode_t, xmms_error_t *)

Seek method.

Called to change the offset in the stream. Observe that the offset is measured in "natural" units; audio/pcm-data is measured in samples, application/octet-stream in bytes.

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

src/include/xmms/xmms_xformplugin.h

Data Fields

Detailed Description

Field Documentation