diff finch/gntsound.h @ 19100:68a3b83795c6

Added sound to Finch. Currently it's directly into Finch, but later we'll most likely move it into a plugin since some have argued well that sound in a console app might not be an all around favored thing.
author Eric Polino <aluink@pidgin.im>
date Thu, 14 Jun 2007 03:54:49 +0000
parents
children 907c41608ada
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/finch/gntsound.h	Thu Jun 14 03:54:49 2007 +0000
@@ -0,0 +1,67 @@
+/**
+ * @file gntsound.h GNT Sound API
+ * @ingroup finch
+ *
+ * finch
+ *
+ * Finch is the legal property of its developers, whose names are too numerous
+ * to list here.  Please refer to the COPYRIGHT file distributed with this
+ * source distribution.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+#ifndef _GNT_SOUND_H
+#define _GNT_SOUND_H
+
+#include "sound.h"
+
+/**********************************************************************/
+/** @name GNT Sound API																								*/
+/**********************************************************************/
+/*@{*/
+
+/**
+* Get the prefs option for an event.
+*
+* @param event The event.
+* @return The option.
+*/
+const char *finch_sound_get_event_option(PurpleSoundEventID event);
+
+/**
+* Get the label for an event.
+*
+* @param event The event.
+* @return The label.
+*/
+const char *finch_sound_get_event_label(PurpleSoundEventID event);
+
+/**
+* Gets GNT sound UI ops.
+*
+* @return The UI operations structure.
+*/
+PurpleSoundUiOps *finch_sound_get_ui_ops(void);
+
+/**
+* Get the handle for the GNT sound system.
+*
+* @return The handle to the sound system
+*/
+void *finch_sound_get_handle(void);
+
+/*@}*/
+
+#endif