XMMS2
Data Structures | Macros | Typedefs | Functions
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>

Data Structures

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

Macros

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

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. More...
 

Functions

void xmms_output_plugin_methods_set (xmms_output_plugin_t *output, xmms_output_methods_t *methods)
 Register the output plugin functions. More...
 
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. More...
 
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. More...
 
void xmms_output_stream_type_add (xmms_output_t *output,...)
 Add format to list of supported formats. More...
 
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. More...
 
gint xmms_output_bytes_available (xmms_output_t *output)
 Gets Number of available bytes in the output buffer. More...
 
void xmms_output_set_error (xmms_output_t *output, xmms_error_t *error)
 Set an error. More...
 
gboolean xmms_output_plugin_format_set_always (xmms_output_plugin_t *plugin)
 Check if an output plugin needs format updates on each track change. More...
 
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. More...
 
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. More...
 
xmms_config_property_txmms_output_config_lookup (xmms_output_t *output, const gchar *path)
 Lookup a configuration directive for the output plugin. More...
 
xmms_medialib_entry_t xmms_output_current_id (xmms_output_t *output)
 Get the currently medialib id of the currently played entry. More...