src/mixer_control.h

   1 /*
   2  * Copyright (C) 2003-2010 The Music Player Daemon Project
   3  * http://www.musicpd.org
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  */
  19
  20 /** \file
  21  *
  22  * Functions which manipulate a #mixer object.
  23  */
  24
  25 #ifndef MPD_MIXER_CONTROL_H
  26 #define MPD_MIXER_CONTROL_H
  27
  28 #include <glib.h>
  29
  30 #include <stdbool.h>
  31
  32 struct mixer;
  33 struct mixer_plugin;
  34 struct config_param;
  35
  36 struct mixer *
  37 mixer_new(const struct mixer_plugin *plugin, void *ao,
  38           const struct config_param *param,
  39           GError **error_r);
  40
  41 void
  42 mixer_free(struct mixer *mixer);
  43
  44 bool
  45 mixer_open(struct mixer *mixer, GError **error_r);
  46
  47 void
  48 mixer_close(struct mixer *mixer);
  49
  50 /**
  51  * Close the mixer unless the plugin's "global" flag is set.  This is
  52  * called when the #audio_output is closed.
  53  */
  54 void
  55 mixer_auto_close(struct mixer *mixer);
  56
  57 int
  58 mixer_get_volume(struct mixer *mixer, GError **error_r);
  59
  60 bool
  61 mixer_set_volume(struct mixer *mixer, unsigned volume, GError **error_r);
  62
  63 #endif