src/include/xmms/xmms_outputplugin.h File Reference

#include <glib.h>
#include <string.h>
#include "xmmsc/xmmsc_idnumbers.h"
#include "xmms/xmms_sample.h"
#include "xmms/xmms_plugin.h"
#include "xmms/xmms_error.h"
#include "xmms/xmms_config.h"
#include "xmms/xmms_streamtype.h"
#include "xmms/xmms_medialib.h"

Go to the source code of this file.

Data Structures

struct  xmms_output_methods_St
 Output functions that lets XMMS2 talk to the soundcard. More...

Defines

#define XMMS_OUTPUT_API_VERSION   8
 The current API version.
#define XMMS_OUTPUT_PLUGIN(shname, name, ver, desc, setupfunc)   XMMS_PLUGIN(XMMS_PLUGIN_TYPE_OUTPUT, XMMS_OUTPUT_API_VERSION, shname, name, ver, desc, (gboolean (*)(gpointer))setupfunc)
 Register the output plugin.
#define XMMS_OUTPUT_METHODS_INIT(m)   memset (&m, 0, sizeof (xmms_output_methods_t))
 Initialize the xmms_output_methods_t struct.
#define xmms_output_format_add(output, fmt, ch, rate)
 Add a format that the output plugin can feed the soundcard with.

Typedefs

typedef struct xmms_output_St xmms_output_t
typedef struct
xmms_output_plugin_St 
xmms_output_plugin_t
typedef struct
xmms_output_methods_St 
xmms_output_methods_t
 Output functions that lets XMMS2 talk to the soundcard.

Functions

void xmms_output_plugin_methods_set (xmms_output_plugin_t *output, xmms_output_methods_t *methods)
 Register the output plugin functions.
gpointer xmms_output_private_data_get (xmms_output_t *output)
 Retrieve the private data for the plugin that was set with xmms_output_private_data_set.
void xmms_output_private_data_set (xmms_output_t *output, gpointer data)
 Set the private data for the plugin that can be retrived with xmms_output_private_data_get later.
void xmms_output_stream_type_add (xmms_output_t *output,...)
 Add format to list of supported formats.
gint xmms_output_read (xmms_output_t *output, char *buffer, gint len)
 Read a number of bytes of data from the output buffer into a buffer.
void xmms_output_set_error (xmms_output_t *output, xmms_error_t *error)
 Set an error.
gboolean xmms_output_plugin_format_set_always (xmms_output_plugin_t *plugin)
 Check if an output plugin needs format updates on each track change.
xmms_config_property_txmms_output_plugin_config_property_register (xmms_output_plugin_t *plugin, const gchar *name, const gchar *default_value, xmms_object_handler_t cb, gpointer userdata)
 Register a configuration directive in the plugin setup function.
xmms_config_property_txmms_output_config_property_register (xmms_output_t *output, const gchar *name, const gchar *default_value, xmms_object_handler_t cb, gpointer userdata)
 Register a configuration directive.
xmms_config_property_txmms_output_config_lookup (xmms_output_t *output, const gchar *path)
 Lookup a configuration directive for the output plugin.
xmms_medialib_entry_t xmms_output_current_id (xmms_output_t *output)
 Get the currently medialib id of the currently played entry.

Generated on Tue Feb 23 18:14:36 2010 for XMMS2 by  doxygen 1.6.1