pidgin/gtksound.h

/* pidgin
 *
 * Pidgin 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., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 */

#if !defined(PIDGIN_GLOBAL_HEADER_INSIDE) && !defined(PIDGIN_COMPILATION)
# error "only <pidgin.h> may be included directly"
#endif

#ifndef _PIDGINSOUND_H_
#define _PIDGINSOUND_H_
/**
 * SECTION:gtksound
 * @section_id: pidgin-gtksound
 * @short_description: <filename>gtksound.h</filename>
 * @title: Sound API
 */

#include <purple.h>

G_BEGIN_DECLS

/**************************************************************************/
/* GTK+ Sound API                                                         */
/**************************************************************************/

/**
 * pidgin_sound_get_event_option:
 * @event: The event.
 *
 * Get the prefs option for an event.
 *
 * Returns: The option.
 */
const char *pidgin_sound_get_event_option(PurpleSoundEventID event);

/**
 * pidgin_sound_get_event_label:
 * @event: The event.
 *
 * Get the label for an event.
 *
 * Returns: The label.
 */
const char *pidgin_sound_get_event_label(PurpleSoundEventID event);

/**
 * pidgin_sound_get_ui_ops:
 *
 * Gets GTK+ sound UI ops.
 *
 * Returns: The UI operations structure.
 */
PurpleSoundUiOps *pidgin_sound_get_ui_ops(void);

/**
 * pidgin_sound_get_handle:
 *
 * Get the handle for the GTK+ sound system.
 *
 * Returns: The handle to the sound system
 */
void *pidgin_sound_get_handle(void);

/**
 * pidgin_sound_is_customized:
 *
 * Returns true Pidgin is using customized sounds
 *
 * Returns: TRUE if non default sounds are used.
 */
gboolean pidgin_sound_is_customized(void);

G_END_DECLS

#endif /* _PIDGINSOUND_H_ */