mixer_plugin Struct Reference

#include <mixer_plugin.h>

Data Fields

struct mixer *(* init )(const struct config_param *param)
 Alocates and configures a mixer device.
void(* finish )(struct mixer *data)
 Finish and free mixer data.
bool(* open )(struct mixer *data)
 Open mixer device.
void(* close )(struct mixer *data)
 Close mixer device.
int(* get_volume )(struct mixer *mixer)
 Reads the current volume.
bool(* set_volume )(struct mixer *mixer, unsigned volume)
 Sets the volume.
bool global
 If true, then the mixer is automatically opened, even if its audio output is not open.

Detailed Description

Definition at line 35 of file mixer_plugin.h.


Field Documentation

void(* mixer_plugin::close)(struct mixer *data)

Close mixer device.

Definition at line 54 of file mixer_plugin.h.

void(* mixer_plugin::finish)(struct mixer *data)

Finish and free mixer data.

Definition at line 44 of file mixer_plugin.h.

Reads the current volume.

Returns:
the current volume (0..100 including) or -1 on error

Definition at line 62 of file mixer_plugin.h.

If true, then the mixer is automatically opened, even if its audio output is not open.

If false, then the mixer is disabled as long as its audio output is closed.

Definition at line 77 of file mixer_plugin.h.

struct mixer*(* mixer_plugin::init)(const struct config_param *param) [read]

Alocates and configures a mixer device.

Definition at line 39 of file mixer_plugin.h.

bool(* mixer_plugin::open)(struct mixer *data)

Open mixer device.

Definition at line 49 of file mixer_plugin.h.

bool(* mixer_plugin::set_volume)(struct mixer *mixer, unsigned volume)

Sets the volume.

Parameters:
volume the new volume (0..100 including)
Returns:
true on success

Definition at line 70 of file mixer_plugin.h.


The documentation for this struct was generated from the following file:
Generated on Sun May 2 21:28:33 2010 for MPD by  doxygen 1.6.3