finch/gntsound.h

   1 /**
   2  * @file gntsound.h GNT Sound API
   3  * @ingroup finch
   4  */
   5
   6 /* finch
   7  *
   8  * Finch is the legal property of its developers, whose names are too numerous
   9  * to list here.  Please refer to the COPYRIGHT file distributed with this
  10  * source distribution.
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  25  */
  26 #ifndef _GNT_SOUND_H
  27 #define _GNT_SOUND_H
  28
  29 #include "sound.h"
  30
  31 /**********************************************************************/
  32 /** @name GNT Sound API                                               */
  33 /**********************************************************************/
  34 /*@{*/
  35
  36 /**
  37  * Get the name of the active sound profile.
  38  *
  39  * @return The name of the profile
  40  *
  41  * @since 2.1.0
  42  */
  43 const char *finch_sound_get_active_profile(void);
  44
  45 /**
  46  * Set the active profile.  If the profile doesn't exist, nothing is changed.
  47  *
  48  * @param name  The name of the profile
  49  *
  50  * @since 2.1.0
  51  */
  52 void finch_sound_set_active_profile(const char *name);
  53
  54 /**
  55  * Get a list of available sound profiles.
  56  *
  57  * @return A list of strings denoting sound profile names.
  58  *         Caller must free the list (but not the data).
  59  *
  60  * @since 2.1.0
  61  */
  62 GList *finch_sound_get_profiles(void);
  63
  64 /**
  65  * Determine whether any sound will be played or not.
  66  *
  67  * @return Returns FALSE if preference is set to 'No sound', or if volume is
  68  *         set to zero.
  69  *
  70  * @since 2.2.0
  71  */
  72 gboolean finch_sound_is_enabled(void);
  73
  74 /**
  75  * Gets GNT sound UI ops.
  76  *
  77  * @return The UI operations structure.
  78  *
  79  * @since 2.1.0
  80  */
  81 PurpleSoundUiOps *finch_sound_get_ui_ops(void);
  82
  83 /**
  84  * Show the sound settings dialog.
  85  *
  86  * @since 2.1.0
  87  */
  88 void finch_sounds_show_all(void);
  89
  90 /*@}*/
  91
  92 #endif