libempathy-gtk/empathy-sound-manager.h

   1 /*
   2  * empathy-sound-manager.h - Various sound related utility functions.
   3  * Copyright (C) 2009 Collabora Ltd.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library 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 GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18  */
  19
  20
  21 #ifndef __EMPATHY_SOUND_MANAGER_H__
  22 #define __EMPATHY_SOUND_MANAGER_H__
  23
  24 #include <gtk/gtk.h>
  25
  26 #include <canberra-gtk.h>
  27
  28 G_BEGIN_DECLS
  29
  30 /* NOTE: Keep this sync with sound_entries in empathy-sound-manager.c */
  31 typedef enum {
  32   EMPATHY_SOUND_MESSAGE_INCOMING = 0,
  33   EMPATHY_SOUND_MESSAGE_OUTGOING,
  34   EMPATHY_SOUND_CONVERSATION_NEW,
  35   EMPATHY_SOUND_CONTACT_CONNECTED,
  36   EMPATHY_SOUND_CONTACT_DISCONNECTED,
  37   EMPATHY_SOUND_ACCOUNT_CONNECTED,
  38   EMPATHY_SOUND_ACCOUNT_DISCONNECTED,
  39   EMPATHY_SOUND_PHONE_INCOMING,
  40   EMPATHY_SOUND_PHONE_OUTGOING,
  41   EMPATHY_SOUND_PHONE_HANGUP,
  42   LAST_EMPATHY_SOUND,
  43 } EmpathySound;
  44
  45 #define EMPATHY_TYPE_SOUND_MANAGER         (empathy_sound_manager_get_type ())
  46 #define EMPATHY_SOUND_MANAGER(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), EMPATHY_TYPE_SOUND_MANAGER, EmpathySoundManager))
  47 #define EMPATHY_SOUND_MANAGER_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), EMPATHY_TYPE_SOUND_MANAGER, EmpathySoundManagerClass))
  48 #define EMPATHY_IS_SOUND_MANAGER(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), EMPATHY_TYPE_SOUND_MANAGER))
  49 #define EMPATHY_IS_SOUND_MANAGER_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), EMPATHY_TYPE_SOUND_MANAGER))
  50 #define EMPATHY_SOUND_MANAGER_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), EMPATHY_TYPE_SOUND_MANAGER, EmpathySoundManagerClass))
  51
  52 typedef struct _EmpathySoundManager EmpathySoundManager;
  53 typedef struct _EmpathySoundManagerClass EmpathySoundManagerClass;
  54 typedef struct _EmpathySoundManagerPrivate EmpathySoundManagerPrivate;
  55
  56 struct _EmpathySoundManager
  57 {
  58   GObject parent;
  59   EmpathySoundManagerPrivate *priv;
  60 };
  61
  62 struct _EmpathySoundManagerClass
  63 {
  64   GObjectClass parent_class;
  65 };
  66
  67 GType empathy_sound_manager_get_type (void) G_GNUC_CONST;
  68
  69 EmpathySoundManager * empathy_sound_manager_dup_singleton (void);
  70
  71 gboolean empathy_sound_manager_play (EmpathySoundManager *self,
  72     GtkWidget *widget,
  73     EmpathySound sound_id);
  74
  75 void empathy_sound_manager_stop (EmpathySoundManager *self,
  76     EmpathySound sound_id);
  77
  78 gboolean empathy_sound_manager_start_playing (EmpathySoundManager *self,
  79     GtkWidget *widget,
  80     EmpathySound sound_id,
  81     guint timeout_before_replay);
  82
  83 gboolean empathy_sound_manager_play_full (EmpathySoundManager *self,
  84     GtkWidget *widget,
  85     EmpathySound sound_id,
  86     ca_finish_callback_t callback,
  87     gpointer user_data);
  88
  89 G_END_DECLS
  90
  91 #endif /* #ifndef __EMPATHY_SOUND_MANAGER_H__ */