Mercurial > pidgin
annotate src/sound.h @ 10478:d497f3a2686f
[gaim-migrate @ 11765]
Kevin, does this sound good?
committer: Tailor Script <tailor@pidgin.im>
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Thu, 06 Jan 2005 05:49:36 +0000 |
parents | 2a132b73a6e6 |
children | 58bc500cf226 |
rev | line source |
---|---|
4561 | 1 /** |
2 * @file sound.h Sound API | |
9938 | 3 * @ingroup core |
4561 | 4 * |
5 * gaim | |
6 * | |
8046 | 7 * Gaim is the legal property of its developers, whose names are too numerous |
8 * to list here. Please refer to the COPYRIGHT file distributed with this | |
9 * source distribution. | |
4561 | 10 * |
11 * This program is free software; you can redistribute it and/or modify | |
12 * it under the terms of the GNU General Public License as published by | |
13 * the Free Software Foundation; either version 2 of the License, or | |
14 * (at your option) any later version. | |
15 * | |
16 * This program is distributed in the hope that it will be useful, | |
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 * GNU General Public License for more details. | |
20 * | |
21 * You should have received a copy of the GNU General Public License | |
22 * along with this program; if not, write to the Free Software | |
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
24 */ | |
4581 | 25 #ifndef _GAIM_SOUND_H_ |
26 #define _GAIM_SOUND_H_ | |
4561 | 27 |
28 /**************************************************************************/ | |
29 /** Data Structures */ | |
30 /**************************************************************************/ | |
31 | |
32 | |
33 /** | |
5684 | 34 * A type of sound. |
4561 | 35 */ |
36 | |
37 typedef enum _GaimSoundEventID | |
38 { | |
39 GAIM_SOUND_BUDDY_ARRIVE = 0, /**< Buddy signs on. */ | |
40 GAIM_SOUND_BUDDY_LEAVE, /**< Buddy signs off. */ | |
41 GAIM_SOUND_RECEIVE, /**< Receive an IM. */ | |
42 GAIM_SOUND_FIRST_RECEIVE, /**< Receive an IM that starts a conv. */ | |
43 GAIM_SOUND_SEND, /**< Send an IM. */ | |
44 GAIM_SOUND_CHAT_JOIN, /**< Someone joins a chat. */ | |
45 GAIM_SOUND_CHAT_LEAVE, /**< Someone leaves a chat. */ | |
46 GAIM_SOUND_CHAT_YOU_SAY, /**< You say something in a chat. */ | |
47 GAIM_SOUND_CHAT_SAY, /**< Someone else says somthing in a chat. */ | |
48 GAIM_SOUND_POUNCE_DEFAULT, /**< Default sound for a buddy pounce. */ | |
49 GAIM_SOUND_CHAT_NICK, /**< Someone says your name in a chat. */ | |
50 GAIM_NUM_SOUNDS /**< Total number of sounds. */ | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
51 |
4561 | 52 } GaimSoundEventID; |
53 | |
5684 | 54 typedef struct _GaimSoundUiOps |
55 { | |
56 void (*init)(void); | |
10322 | 57 void (*uninit)(void); |
5684 | 58 void (*play_file)(const char *filename); |
59 void (*play_event)(GaimSoundEventID event); | |
60 | |
61 } GaimSoundUiOps; | |
62 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
63 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
64 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
65 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
66 |
4561 | 67 /**************************************************************************/ |
68 /** @name Sound API */ | |
69 /**************************************************************************/ | |
70 /*@{*/ | |
71 | |
72 /** | |
10322 | 73 * Plays the specified sound file. |
74 * | |
75 * @param filename The file to play. | |
76 */ | |
77 void gaim_sound_play_file(const char *filename); | |
78 | |
79 /** | |
80 * Plays the sound associated with the specified event. | |
81 * | |
82 * @param event The event. | |
83 */ | |
84 void gaim_sound_play_event(GaimSoundEventID event); | |
85 | |
86 /** | |
5684 | 87 * Sets the UI sound operations |
88 * | |
89 * @param ops The UI sound operations structure. | |
4561 | 90 */ |
7035
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
91 void gaim_sound_set_ui_ops(GaimSoundUiOps *ops); |
4561 | 92 |
93 /** | |
5684 | 94 * Gets the UI sound operations |
95 * | |
96 * @return The UI sound operations structure. | |
4561 | 97 */ |
7035
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
98 GaimSoundUiOps *gaim_sound_get_ui_ops(void); |
5684 | 99 |
100 /** | |
101 * Initializes the sound subsystem | |
102 */ | |
103 void gaim_sound_init(void); | |
104 | |
105 /** | |
106 * Shuts down the sound subsystem | |
107 */ | |
10322 | 108 void gaim_sound_uninit(void); |
4561 | 109 |
110 /*@}*/ | |
111 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
112 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
113 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
114 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
115 |
4581 | 116 #endif /* _GAIM_SOUND_H_ */ |